Merge pull request #256 from andrewsomething/asb/custom-images

 Add support of importing custom images.

Author: koalalorenzo

digitalocean/Image.py

@@ -1,7 +1,46 @@
 # -*- coding: utf-8 -*-
 from .baseapi import BaseAPI, POST, DELETE, PUT, NotFoundError
 
+
 class Image(BaseAPI):
+    """
+    An object representing an DigitalOcean Image.
+
+    Attributes accepted at creation time:
+
+    Args:
+        name (str): The name to be given to an image.
+        url (str): A URL from which the virtual machine image may be retrieved.
+        region (str): The slug of the region where the image will be available.
+        distribution (str, optional): The name of the image's distribution.
+        description (str, optional): Free-form text field to describe an image.
+        tags (obj:`list` of `str`, optional): List of tag names to apply to
+            the image.
+
+    Attributes returned by API:
+
+        id (int): A unique number to identify and reference a image.
+        name (str): The display name given to an image.
+        type (str): The kind of image. This will be either "snapshot",
+            "backup", or "custom".
+        distribution (str): The name of the image's distribution.
+        slug (str): A uniquely identifying string that is associated with each
+            of the DigitalOcean-provided public images.
+        public (bool): Indicates whether the image is public or not.
+        regions (obj:`list` of `str`): A list of the slugs of the regions where
+            the image is available for use.
+        created_at (str): A time value given in ISO8601 combined date and time
+            format that represents when the image was created.
+        min_disk_size (int): The minimum disk size in GB required for a Droplet
+            to use this image.
+        size_gigabytes (int): The size of the image in gigabytes.
+        description (str): Free-form text field to describing an image.
+        tags (obj:`list` of `str`): List of tag names to applied to the image.
+        status (str): Indicates the state of a custom image. This may be "NEW",
+            "available", "pending", or "deleted".
+        error_message (str): Information about errors that may occur when
+            importing a custom image.
+    """
     def __init__(self, *args, **kwargs):
         self.id = None
         self.name = None
@@ -12,6 +51,12 @@ def __init__(self, *args, **kwargs):
         self.regions = []
         self.created_at = None
         self.size_gigabytes = None
+        self.description = None
+        self.status = None
+        self.tags = []
+        self.error_message = None
+        self.url = None
+        self.region = None
 
         super(Image, self).__init__(*args, **kwargs)
 
@@ -45,6 +90,26 @@ def _is_string(value):
         else:
             return None
 
+    def create(self):
+        """
+        Creates a new custom DigitalOcean Image from the Linux virtual machine
+        image located at the provided `url`.
+        """
+        params = {'name': self.name,
+                  'region': self.region,
+                  'url': self.url,
+                  'distribution': self.distribution,
+                  'description': self.description,
+                  'tags': self.tags}
+
+        data = self.get_data('images', type=POST, params=params)
+
+        if data:
+            for attr in data['image'].keys():
+                setattr(self, attr, data['image'][attr])
+
+        return self
+
     def load(self, use_slug=False):
         """
             Load slug.

digitalocean/tests/data/images/create.json

@@ -0,0 +1,19 @@
+{
+  "image": {
+    "created_at": "2018-09-20T19:28:00Z",
+    "description": "Cloud-optimized image",
+    "distribution": "Ubuntu",
+    "error_message": "",
+    "id": 38413969,
+    "name": "ubuntu-18.04-minimal",
+    "regions": [
+
+    ],
+    "type": "custom",
+    "tags": [
+      "base-image",
+      "prod"
+    ],
+    "status": "NEW"
+  }
+}

digitalocean/tests/test_image.py

@@ -64,6 +64,35 @@ def test_load_by_slug(self):
         self.assertEqual(self.image_with_slug.size_gigabytes, 2.34)
         self.assertEqual(self.image_with_slug.min_disk_size, 30)
 
+    @responses.activate
+    def test_create(self):
+        data = self.load_from_file('images/create.json')
+        url = self.base_url + "images"
+
+        responses.add(responses.POST,
+                      url,
+                      body=data,
+                      status=202,
+                      content_type='application/json')
+
+        image = digitalocean.Image(name='ubuntu-18.04-minimal',
+                                   url='https://www.example.com/cloud.img',
+                                   distribution='Ubuntu',
+                                   region='nyc3',
+                                   description='Cloud-optimized image',
+                                   tags=['base-image', 'prod'],
+                                   token=self.token)
+        image.create()
+
+        self.assertEqual(image.id, 38413969)
+        self.assertEqual(image.name, 'ubuntu-18.04-minimal')
+        self.assertEqual(image.distribution, 'Ubuntu')
+        self.assertEqual(image.type, 'custom')
+        self.assertEqual(image.status, 'NEW')
+        self.assertEqual(image.description, 'Cloud-optimized image')
+        self.assertEqual(image.tags, ['base-image', 'prod'])
+        self.assertEqual(image.created_at, '2018-09-20T19:28:00Z')
+
     @responses.activate
     def test_destroy(self):
         responses.add(responses.DELETE,