Add support for Application Keys.

CC-5

Author: gdethier

comodit_client/api/__init__.py

@@ -95,7 +95,7 @@ class Client(object):
     access to ComodIT entities.
     """
 
-    def __init__(self, endpoint, username, password, insecure_upload = False):
+    def __init__(self, endpoint, username, password, token, insecure_upload = False):
         """
         Client constructor. In order to create a client, the URL to a ComodIT
         server's REST API (e.g. http://my.comodit.com/api) must be provided, in
@@ -107,9 +107,11 @@ def __init__(self, endpoint, username, password, insecure_upload = False):
         @type username: String
         @param password: A password
         @type password: String
+        @param token: A token
+        @type token: String
         """
 
-        self._http_client = HttpClient(endpoint, username, password, insecure_upload)
+        self._http_client = HttpClient(endpoint, username, password, token, insecure_upload)
         self._organizations = OrganizationCollection(self)
         self._flavors = FlavorCollection(self)
         self._app_store = AppStoreCollection(self)
@@ -375,3 +377,35 @@ def get_host(self, org_name, env_name, name):
         """
 
         return self.hosts(org_name, env_name).get(name)
+
+
+    # Application Keys helpers
+
+    def application_keys(self, org_name):
+        """
+        Instantiates the collection of environments associated to named
+        organization.
+
+        @param org_name: The name of the organization owning requested collection.
+        @type org_name: string
+        @rtype: L{EnvironmentCollection}
+        """
+
+        return self.__get_unresolved_org(org_name).application_keys()
+
+    def __get_unresolved_application_key(self, org_name, token):
+        return self.application_keys(org_name).new(token)
+
+    def get_application_key(self, org_name, token):
+        """
+        Fetches an environment given the name of owning organization and its
+        name.
+
+        @param org_name: The name of the organization owning requested platform.
+        @type org_name: string
+        @param name: The name of the environment.
+        @type name: string
+        @rtype: L{Environment}
+        """
+
+        return self.application_keys(org_name).get(token)

comodit_client/api/application_key.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+"""
+Provides the classes related to application key entity: L{ApplicationKey}
+and L{ApplicationKeyCollection}.
+"""
+
+from collection import Collection
+from comodit_client.api.entity import Entity
+
+
+class ApplicationKeyCollection(Collection):
+    """
+    Collection of application keys. An application key collection is owned by an
+    L{Organization}.
+    """
+
+    def _new(self, json_data = None):
+        return ApplicationKey(self, json_data)
+
+    def new(self, token):
+        """
+        Instantiates a new application key object.
+
+        @param name: The name of new application key.
+        @type name: string
+        @rtype: L{ApplicationKey}
+        """
+
+        key = self._new()
+        key.token = token
+        return key
+
+    def create(self, token):
+        """
+        Creates a remote application key entity and returns associated local
+        object.
+
+        @param name: The name of new application key.
+        @type name: string
+        @rtype: L{ApplicationKey}
+        """
+
+        key = self.new(token)
+        key.create()
+        return key
+
+
+class ApplicationKey(Entity):
+    """
+    Application Key entity representation. An application key defines a token that can be used to authenticate
+    and perform some action in a particular organization.
+    """
+
+    @property
+    def organization(self):
+        """
+        The name of the organization owning this environment.
+
+        @rtype: string
+        """
+
+        return self._get_field("organization")
+
+    @property
+    def token(self):
+        """
+        The token associated with this application key.
+
+        @rtype: string
+        """
+
+        return self._get_field("token")
+
+    @property
+    def expiration_date(self):
+        """
+        The expiration date associated with this application key.
+
+        @rtype: string
+        """
+
+        return self._get_field("expirationDate")
+    
+    @property
+    def group(self):
+        """
+        The group associated with this application key.
+
+        @rtype: string
+        """
+
+        return self._get_field("group")
+    
+    @property
+    def creator(self):
+        """
+        The creator associated with this application key. Its username is actually returned.
+
+        @rtype: string
+        """
+
+        return self._get_field("creator")
+
+    def _show(self, indent = 0):
+        super(ApplicationKey, self)._show(indent)
+        print " "*indent, "Token:", self.token
+        print " "*indent, "Expiration date:", self.expiration_date
+        print " "*indent, "Group:", self.group
+        print " "*indent, "Creator:", self.creator

comodit_client/api/organization.py

@@ -16,6 +16,7 @@
 from comodit_client.api.audit import AuditLogCollection
 from comodit_client.api.purchased import PurchasedCollection
 from comodit_client.util.json_wrapper import JsonWrapper
+from comodit_client.api.application_key import ApplicationKeyCollection
 
 
 class User(JsonWrapper):
@@ -468,3 +469,13 @@ def get_purchased_dist(self, uuid):
 
         return self.purchased_dists().get(uuid)
 
+    def application_keys(self):
+        """
+        Instantiates the collection of application keys associated to this organization.
+
+        @return: The collection of application keys associated to this organization.
+        @rtype: L{ApplicationKeyCollection}
+        """
+
+        return ApplicationKeyCollection(self.client, self.url + "applicationkeys/")
+

comodit_client/config.py

@@ -36,7 +36,7 @@ def __init__(self, message):
 @singleton
 class Config(object):
     """
-    Cortex client's configuration.
+    ComodIT client's configuration.
     """
 
     _default_config = {
@@ -47,6 +47,7 @@ class Config(object):
             "api": "http://localhost:8000/api",
             "username": "admin",
             "password": "secret",
+            "token": "",
             "vnc_viewer_call": "vinagre %h:%p"
             }
         }
@@ -98,6 +99,9 @@ def get_username(self, profile_name):
 
     def get_password(self, profile_name):
         return self._get_value(profile_name, "password")
+    
+    def get_token(self, profile_name):
+        return self._get_value(profile_name, "token")
 
     def get_vnc_viewer_call(self, profile_name):
         return self._get_value(profile_name, "vnc_viewer_call")
@@ -174,6 +178,7 @@ def _get_config_dict(self, config_path):
         [default]
         username = foologin
         password = foopass
+        token    = token
         api      = url
 
         becomes :
@@ -185,7 +190,8 @@ def _get_config_dict(self, config_path):
             "default": {
                 "api": "http://localhost:8000/api",
                 "username": "admin",
-                "password": "secret"
+                "password": "secret",
+                "token": "token"
             }
         }
 

comodit_client/control/abstract.py

@@ -7,8 +7,6 @@
 # This software cannot be used and/or distributed without prior
 # authorization from Guardis.
 
-import re
-
 from comodit_client.util import globals
 from comodit_client.control.exceptions import ControllerException
 from comodit_client.control.doc import ActionDoc

comodit_client/control/application_keys.py

@@ -0,0 +1,28 @@
+# control.environments - Controller for comodit Environments entities.
+# coding: utf-8
+#
+# Copyright 2010 Guardis SPRL, Liège, Belgium.
+# Authors: Laurent Eschenauer <[email protected]>
+#
+# This software cannot be used and/or distributed without prior
+# authorization from Guardis.
+
+from comodit_client.control.organization_entity import OrganizationEntityController
+
+class ApplicationKeysController(OrganizationEntityController):
+
+    _template = "application_key.json"
+
+    def __init__(self):
+        super(ApplicationKeysController, self).__init__()
+        self._doc = "Application keys handling."
+        self._unregister("clone")
+
+    def _get_collection(self, org_name):
+        return self._client.application_keys(org_name)
+
+    def _prune_json_update(self, json_wrapper):
+        super(ApplicationKeysController, self)._prune_json_update(json_wrapper)
+        json_wrapper._del_field("token")
+        json_wrapper._del_field("creator")
+        json_wrapper._del_field("organization")

comodit_client/dispatch.py

@@ -19,18 +19,17 @@
 from rest.exceptions import ApiException
 from util import globals
 from util.editor import NotModifiedException
-import os
 import argparse
 import traceback
 import sys
-import textwrap
 import control.router
 from config import Config, ConfigException
 from api import Client
 from api.exceptions import PythonApiException
 from comodit_client.api.importer import ImportException
 from comodit_client.api.exporter import ExportException
 from comodit_client.control.store import AppStoreController, DistStoreController
+from comodit_client.control.application_keys import ApplicationKeysController
 
 def run(argv):
     # entities
@@ -43,6 +42,7 @@ def run(argv):
     control.router.register(["hosts"], HostsController())
     control.router.register(["app-store"], AppStoreController())
     control.router.register(["dist-store"], DistStoreController())
+    control.router.register(["application_keys"], ApplicationKeysController())
 
     _parse(argv)
 
@@ -60,6 +60,7 @@ def _get_value_options(parser):
                 "--api",
                 "--user",
                 "--pass",
+                "--token",
                 "--templates",
                 "--profile",
                 "--completions",
@@ -86,6 +87,7 @@ def __get_parser(config):
     environments      Environment defined within an organization
     hosts             Host defined within an environment
     flavors           Available flavors when creating a distribution
+    application_keys  Temporary access tokens related to an organization
 """)
 
     parser.add_argument("entity", help = "An entity")
@@ -115,6 +117,7 @@ def __get_parser(config):
     parser.add_argument("--api", dest = "api", help = "endpoint for the API", default = None)
     parser.add_argument("--user", dest = "username", help = "username on comodit server", default = None)
     parser.add_argument("--pass", dest = "password", help = "password on comodit server", default = None)
+    parser.add_argument("--token", dest = "token", help = "application key token", default = None)
     parser.add_argument("--templates", dest = "templates_path", help = "directory containing JSON templates", default = config.templates_path)
     parser.add_argument("--profile", dest = "profile_name", help = "Name of profile to use", default = None)
 
@@ -200,7 +203,13 @@ def _parse(argv):
         password = config.get_password(globals.options.profile_name)
         globals.options.password = password
 
-    client = Client(api, username, password, globals.options.insecure)
+    if globals.options.token:
+        token = globals.options.token
+    else:
+        token = config.get_token(globals.options.profile_name)
+        globals.options.token = token
+
+    client = Client(api, username, password, token, globals.options.insecure)
 
     entity_args = [] + globals.options.subentities