Statistics
| Branch: | Tag: | Revision:

root / kamaki / clients / __init__.py @ 2bcb595a

History | View | Annotate | Download (5.1 kB)

1
# Copyright 2011 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 XAuthTokenAuth(AuthBase):
61
    def __init__(self, token):
62
        self.token = token
63
    
64
    def __call__(self, r):
65
        r.headers['X-Auth-Token'] = self.token
66
        return r
67

    
68

    
69
class ClientError(Exception):
70
    def __init__(self, message, status=0, details=''):
71
        self.message = message
72
        self.status = status
73
        self.details = details
74

    
75

    
76
class Client(object):
77
    def __init__(self, base_url, token, include=False, verbose=False):
78
        self.base_url = base_url
79
        self.auth = XAuthTokenAuth(token)
80
        self.include = include
81
        self.verbose = verbose
82
    
83
    def raise_for_status(self, r):
84
        if 400 <= r.status_code < 500:
85
            message, sep, details = r.text.partition('\n')
86
        elif 500 <= r.status_code < 600:
87
            message = '%d Server Error' % (r.status_code,)
88
            details = r.text
89
        else:
90
            message = '%d Unknown Error' % (r.status_code,)
91
            details = r.text
92
        
93
        message = message or "HTTP Error %d" % (r.status_code,)
94
        raise ClientError(message, r.status_code, details)
95

    
96
    def request(self, method, path, **kwargs):
97
        raw = kwargs.pop('raw', False)
98
        success = kwargs.pop('success', 200)
99
        if 'json' in kwargs:
100
            data = json.dumps(kwargs.pop('json'))
101
            kwargs['data'] = data
102
            headers = kwargs.setdefault('headers', {})
103
            headers['content-type'] = 'application/json'
104

    
105
        url = self.base_url + path
106
        kwargs.setdefault('auth', self.auth)
107
        r = requests.request(method, url, **kwargs)
108
        
109
        req = r.request
110
        sendlog.info('%s %s', req.method, req.url)
111
        for key, val in req.headers.items():
112
            sendlog.info('%s: %s', key, val)
113
        sendlog.info('')
114
        if req.data:
115
            sendlog.info('%s', req.data)
116
        
117
        recvlog.info('%d %s', r.status_code, r.status)
118
        for key, val in r.headers.items():
119
            recvlog.info('%s: %s', key, val)
120
        recvlog.info('')
121
        if not raw and r.text:
122
            recvlog.debug(r.text)
123
        
124
        if success is not None:
125
            # Success can either be an in or a collection
126
            success = (success,) if isinstance(success, int) else success
127
            if r.status_code not in success:
128
                self.raise_for_status(r)
129

    
130
        return r
131

    
132
    def delete(self, path, **kwargs):
133
        return self.request('delete', path, **kwargs)
134

    
135
    def get(self, path, **kwargs):
136
        return self.request('get', path, **kwargs)
137

    
138
    def head(self, path, **kwargs):
139
        return self.request('head', path, **kwargs)
140

    
141
    def post(self, path, **kwargs):
142
        return self.request('post', path, **kwargs)
143

    
144
    def put(self, path, **kwargs):
145
        return self.request('put', path, **kwargs)
146

    
147

    
148
from .compute import ComputeClient as compute
149
from .image import ImageClient as image
150
from .storage import StorageClient as storage
151
from .cyclades import CycladesClient as cyclades
152
from .pithos import PithosClient as pithos