Cinder implementation (#27)

* Add Accept and Content Type headers to requests

* Add cinder client implementation

* Add .idea pycharm settings to .gitignore

* Add documentaion for cinder client

Author: giffels

.gitignore

@@ -5,6 +5,7 @@
 /.project
 /.pydevproject
 **/*.orig
+.idea
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.rst

@@ -28,7 +28,7 @@ Usage
 
 .. code-block:: python
 
-    from asyncopenstackclient import NovaClient, GlanceClient, AuthPassword
+    from asyncopenstackclient import NovaClient, GlanceClient, CinderClient, AuthPassword
 
     # you can either pass credentials explicitly (as shown below)
     # or use enviormental variables from OpenStack RC file
@@ -42,13 +42,15 @@ Usage
     )
     nova = NovaClient(session=auth)
     glance = GlanceClient(session=auth)
+    cinder = CinderClient(session=auth)
 
     # api url for each service will be taken from catalog,
     # but you may pass `api_url` param to force custom url eg.
     # nova = NovaClient(session=auth, api_url='http://my-local-nova:9876/v2/')
 
     await nova.init_api()
     await glance.init_api()
+    await cinder.init_api()
 
 
     servers = await nova.servers.list(name='testvm')
@@ -65,6 +67,12 @@ Usage
     response = await nova.servers.create(server=specs)
     print(response)
 
+    volume = {"size": 200,
+              "imageRef": "image_id",
+              "name": "some_name"}
+
+    response = await cinder.volumes.create(volume=volume)
+    print(response)
 
 Available functions
 -------------------
@@ -85,6 +93,13 @@ Available functions
 
   - images.list()
 
+- Cinder (https://developer.openstack.org/api-ref/block-storage/v3/index.html)
+
+  - volumes.list(optional=filter)  # params optional
+  - volumes.get(id)
+  - volumes.create(volume=volume_spec)
+  - volumes.force_delete(id)
+
 
 License
 =======

src/asyncopenstackclient/cinder.py

@@ -0,0 +1,14 @@
+from .client import Client
+
+
+class CinderClient(Client):
+    def __init__(self, session=None, api_url=None):
+        super().__init__('cinder', ['volumes'], session, api_url)
+
+    async def init_api(self, timeout=60):
+        await super().init_api(timeout)
+        self.api.volumes.actions["force_delete"] = {"method": "DELETE", "url": "volumes/{}"}
+        self.api.volumes.actions["get"] = {"method": "GET", "url": "volumes/{}"}
+        self.api.volumes.actions["list"] = {"method": "GET", "url": "volumes/detail"}
+        self.api.volumes.add_action("force_delete")
+        self.api.volumes.add_action("get")

src/asyncopenstackclient/client.py

@@ -22,7 +22,10 @@ async def init_api(self, timeout=60):
         await self.get_credentials()
         self.api = API(
             api_root_url=self.api_url,
-            headers={'X-Auth-Token': self.session.token},
+            headers={'X-Auth-Token': self.session.token,
+                     'Accept': 'application/json',
+                     'Content-Type': 'application/json'
+                     },
             json_encode_body=True,
             timeout=timeout
         )

tests/test_client.py

@@ -75,7 +75,10 @@ async def test_init_api(self):
 
         mock_api().assert_called_once_with(
             api_root_url='mock_url/',
-            headers={'X-Auth-Token': 'mock_token'},
+            headers={'X-Auth-Token': 'mock_token',
+                     'Accept': 'application/json',
+                     'Content-Type': 'application/json'
+                     },
             json_encode_body=True,
             timeout=client_timeout
         )