code.grnet.gr Git - kamaki/blob - kamaki/clients/__init__.py

   1 # Copyright 2011-2012 GRNET S.A. All rights reserved.
   2 #
   3 # Redistribution and use in source and binary forms, with or
   4 # without modification, are permitted provided that the following
   5 # conditions are met:
   6 #
   7 #   1. Redistributions of source code must retain the above
   8 #      copyright notice, this list of conditions and the following
   9 #      disclaimer.
  10 #
  11 #   2. Redistributions in binary form must reproduce the above
  12 #      copyright notice, this list of conditions and the following
  13 #      disclaimer in the documentation and/or other materials
  14 #      provided with the distribution.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 # POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # The views and conclusions contained in the software and
  30 # documentation are those of the authors and should not be
  31 # interpreted as representing official policies, either expressed
  32 # or implied, of GRNET S.A.
  33
  34 import json
  35 import logging
  36
  37 import requests
  38
  39 from requests.auth import AuthBase
  40
  41
  42 sendlog = logging.getLogger('clients.send')
  43 recvlog = logging.getLogger('clients.recv')
  44
  45
  46 # Add a convenience json property to the responses
  47 def _json(self):
  48     try:
  49         return json.loads(self.content) if self.content else {}
  50     except ValueError:
  51         raise ClientError("Invalid JSON reply", self.status_code)
  52 requests.Response.json = property(_json)
  53
  54 # Add a convenience status property to the responses
  55 def _status(self):
  56     return requests.status_codes._codes[self.status_code][0].upper()
  57 requests.Response.status = property(_status)
  58
  59
  60 class ClientError(Exception):
  61     def __init__(self, message, status=0, details=''):
  62         super(ClientError, self).__init__(message, status, details)
  63         self.message = message
  64         self.status = status
  65         self.details = details
  66
  67
  68 class Client(object):
  69     def __init__(self, base_url, token):
  70         self.base_url = base_url
  71         self.token = token
  72
  73     def raise_for_status(self, r):
  74         message = "%d %s" % (r.status_code, r.status)
  75         details = r.text
  76         raise ClientError(message, r.status_code, details)
  77
  78     def request(self, method, path, **kwargs):
  79         raw = kwargs.pop('raw', False)
  80         success = kwargs.pop('success', 200)
  81
  82         data = kwargs.pop('data', None)
  83         headers = kwargs.pop('headers', {})
  84         headers.setdefault('X-Auth-Token', self.token)
  85
  86         if 'json' in kwargs:
  87             data = json.dumps(kwargs.pop('json'))
  88             headers.setdefault('Content-Type', 'application/json')
  89
  90         if data:
  91             headers.setdefault('Content-Length', str(len(data)))
  92
  93         url = self.base_url + path
  94         kwargs.setdefault('verify', False)  # Disable certificate verification
  95         r = requests.request(method, url, headers=headers, data=data, **kwargs)
  96
  97         req = r.request
  98         sendlog.info('%s %s', req.method, req.url)
  99         for key, val in req.headers.items():
 100             sendlog.info('%s: %s', key, val)
 101         sendlog.info('')
 102         if req.data:
 103             sendlog.info('%s', req.data)
 104
 105         recvlog.info('%d %s', r.status_code, r.status)
 106         for key, val in r.headers.items():
 107             recvlog.info('%s: %s', key, val)
 108         recvlog.info('')
 109         if not raw and r.text:
 110             recvlog.debug(r.text)
 111
 112         if success is not None:
 113             # Success can either be an in or a collection
 114             success = (success,) if isinstance(success, int) else success
 115             if r.status_code not in success:
 116                 self.raise_for_status(r)
 117
 118         return r
 119
 120     def delete(self, path, **kwargs):
 121         return self.request('delete', path, **kwargs)
 122
 123     def get(self, path, **kwargs):
 124         return self.request('get', path, **kwargs)
 125
 126     def head(self, path, **kwargs):
 127         return self.request('head', path, **kwargs)
 128
 129     def post(self, path, **kwargs):
 130         return self.request('post', path, **kwargs)
 131
 132     def put(self, path, **kwargs):
 133         return self.request('put', path, **kwargs)
 134
 135
 136 from .compute import ComputeClient as compute
 137 from .image import ImageClient as image
 138 from .storage import StorageClient as storage
 139 from .cyclades import CycladesClient as cyclades
 140 from .pithos import PithosClient as pithos
 141 from .astakos import AstakosClient as astakos