Freezer API

First implementation of the freezer API.
Slightly more than a skeleton with basic functionality

Change-Id: Iae04affea3aa0f4a943599b528df49d9d4a5b845
Implements: blueprint freezer-api-first-rel

backups.py

@@ -0,0 +1,68 @@
+"""
+Copyright 2014 Hewlett-Packard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This product includes cryptographic software written by Eric Young
+(eay@cryptsoft.com). This product includes software written by Tim
+Hudson (tjh@cryptsoft.com).
+========================================================================
+"""
+
+import json
+import requests
+
+from freezer.freezerclient import exceptions
+
+
+class BackupsManager(object):
+
+    def __init__(self, client):
+        self.client = client
+        self.endpoint = self.client.endpoint + 'backups/'
+        self.headers = {'X-Auth-Token': client.token}
+
+    def create(self, backup_metadata, username=None, tenant_name=None):
+        r = requests.post(self.endpoint,
+                          data=json.dumps(backup_metadata),
+                          headers=self.headers)
+        if r.status_code != 201:
+            raise exceptions.MetadataCreationFailure(
+                "[*] Error {0}".format(r.status_code))
+        backup_id = r.json()['backup_id']
+        return backup_id
+
+    def delete(self, backup_id, username=None, tenant_name=None):
+        endpoint = self.endpoint + backup_id
+        r = requests.delete(endpoint, headers=self.headers)
+        if r.status_code != 204:
+            raise exceptions.MetadataDeleteFailure(
+                "[*] Error {0}".format(r.status_code))
+
+    def list(self,  username=None, tenant_name=None):
+        r = requests.get(self.endpoint, headers=self.headers)
+        if r.status_code != 200:
+            raise exceptions.MetadataGetFailure(
+                "[*] Error {0}".format(r.status_code))
+
+        return r.json()['backups']
+
+    def get(self, backup_id, username=None, tenant_name=None):
+        endpoint = self.endpoint + backup_id
+        r = requests.get(endpoint, headers=self.headers)
+        if r.status_code == 200:
+            return r.json()
+        if r.status_code == 404:
+            return None
+        raise exceptions.MetadataGetFailure(
+            "[*] Error {0}".format(r.status_code))

client.py

@@ -0,0 +1,65 @@
+"""
+Copyright 2014 Hewlett-Packard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This product includes cryptographic software written by Eric Young
+(eay@cryptsoft.com). This product includes software written by Tim
+Hudson (tjh@cryptsoft.com).
+========================================================================
+"""
+
+import os
+import sys
+
+possible_topdir = os.path.normpath(os.path.join(os.path.abspath(sys.argv[0]),
+                                   os.pardir, os.pardir, os.pardir))
+if os.path.exists(os.path.join(possible_topdir, 'freezer', '__init__.py')):
+    sys.path.insert(0, possible_topdir)
+
+import keystoneclient
+
+from freezer.freezerclient.backups import BackupsManager
+
+
+class Client(object):
+
+    def __init__(self, version='1',
+                 token=None,
+                 username=None,
+                 password=None,
+                 tenant_name=None,
+                 auth_url=None,
+                 endpoint=None,
+                 session=None):
+        if endpoint is None:
+                raise Exception('Missing endpoint information')
+        self.endpoint = endpoint
+
+        if token is not None:
+            # validate the token ?
+            self.token = token
+        elif session is not None:
+            pass
+            # TODO: handle session auth
+            # assert isinstance(session, keystoneclient.session.Session)
+        else:
+            self.username = username
+            self.tenant_name = tenant_name
+            kc = keystoneclient.v2_0.client.Client(
+                username=username,
+                password=password,
+                tenant_name=tenant_name,
+                auth_url=auth_url)
+            self.token = kc.auth_token
+        self.backups = BackupsManager(self)

exceptions.py

@@ -0,0 +1,46 @@
+"""
+Copyright 2014 Hewlett-Packard
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+This product includes cryptographic software written by Eric Young
+(eay@cryptsoft.com). This product includes software written by Tim
+Hudson (tjh@cryptsoft.com).
+========================================================================
+"""
+
+
+class FreezerClientException(Exception):
+    """
+    Base Freezer API Exception
+    """
+    message = ("Unknown exception occurred")
+
+    def __init__(self, message=None, *args, **kwargs):
+        if not message:
+            message = self.message
+        message = message % kwargs
+
+        Exception.__init__(self, message)
+
+
+class MetadataCreationFailure(FreezerClientException):
+    message = "Metadata creation failed: %reason"
+
+
+class MetadataGetFailure(FreezerClientException):
+    message = "Metadata read failed: %reason"
+
+
+class MetadataDeleteFailure(FreezerClientException):
+    message = "Metadata deletion failed: %reason"