upcloud_api 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb3b2df1271d58f51517885fe64c24496d44f3ec
-  data.tar.gz: 8c80aef63b87be03e27bbddae0fa7022d8ac14c5
+  metadata.gz: 1b145630b5a65cce82856ed253d85e59a598814a
+  data.tar.gz: c125d9477ddb35c16744cc2dbf87ea8c3efc61c5
 SHA512:
-  metadata.gz: 3d11d618d88d8cba71e133f68a514cfab892883b18a7f4c8f29ff7af070023320c122b229c1fb72ba50fc9310c8cf2c374610b7f130f988fc4dbe4898c85aece
-  data.tar.gz: 9a7d37fc71234bad9c02992e3f5c901b5add323267102d0ece786306fa2b79592dadaf0f41246c5db0589acb82db973f5f371f7a2df11fb533ea0c6b8d31d5bc
+  metadata.gz: 4a09082fd8700233b8b14479d86c210b76b075549ddb955fb6f57f4efdb2af95530935607644dd990dc6e7663bea74986a78892fdd1bc8bbe4466ec837752ca9
+  data.tar.gz: dbe49e4b6dc737786fb35217cb894e72375d3c17f7a1f9f5ecf9a63c4498771336d95b1755de68a672a465057930ff084eb50254e4bc5283e670af9ce7c67b74

data/lib/upcloud_api/version.rb

@@ -1,3 +1,3 @@
 class UpcloudApi
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/upcloud_api.rb

@@ -1,4 +1,6 @@
 
+require "timeout"
+
 require "httparty"
 
 class UpcloudApi
@@ -169,7 +171,7 @@ class UpcloudApi
 
         return response if asynchronous
 
-        Timeout 300 do
+        Timeout::timeout 300 do
             loop do
                 details = server_details server_uuid
                 return response if details["server"]["state"] == "stopped"
@@ -205,6 +207,221 @@ class UpcloudApi
         response
     end
 
+    # Lists all storages or storages matching to given type.
+    #
+    # Calls GET /1.2/storage or /1.2/storage/#{type}
+    #
+    # Available types:
+    # - public
+    # - private
+    # - normal
+    # - backup
+    # - cdrom
+    # - template
+    # - favorite
+    #
+    # @param type Type of the storages to be returned on nil
+    def storages type: nil
+        response = get(type && "storage/#{type}" || "storage")
+        data = JSON.parse response.body
+        data
+    end
+
+    # Shows detailed information of single storage.
+    #
+    # Calls GET /1.2/storage/#{uuid}
+    #
+    # @param storage_uuid UUID of the storage
+    def storage_details storage_uuid
+        response = get "storage/#{storage_uuid}"
+        data = JSON.parse response.body
+        data
+    end
+
+    # Creates new storage.
+    #
+    # Calls POST /1.2/storage
+    #
+    # backup_rule should be hash with following attributes:
+    # - interval # allowed values: daily / mon / tue / wed / thu / fri / sat / sun
+    # - time # allowed values: 0000-2359
+    # - retention # How many days backup will be kept. Allowed values: 1-1095
+    #
+    # @param size Size of the storage in gigabytes
+    # @param tier Type of the disk. maxiops is SSD powered disk, other allowed value is "hdd"
+    # @param title Name of the disk
+    # @param zone Where the disk will reside. Needs to be within same zone with the server
+    # @param backup_rule Hash of backup information. If not given, no backups will be automatically created.
+    def create_storage size:, tier: "maxiops", title:, zone: "fi-hel1", backup_rule: nil
+        data = {
+            "storage" => {
+                "size" => size,
+                "tier" => tier,
+                "title" => title,
+                "zone" => zone,
+                "backup_rule" => backup_rule
+            }
+        }
+
+        json = JSON.generate data
+
+        response = post "storage", json
+
+        response
+    end
+
+    # Modifies existing storage.
+    #
+    # Calls PUT /1.2/storage/#{uuid}
+    #
+    # backup_rule should be hash with following attributes:
+    # - interval # allowed values: daily / mon / tue / wed / thu / fri / sat / sun
+    # - time # allowed values: 0000-2359
+    # - retention # How many days backup will be kept. Allowed values: 1-1095
+    #
+    # @param storage_uuid UUID of the storage that will be modified
+    # @param size Size of the storage in gigabytes
+    # @param title Name of the disk
+    # @param backup_rule Hash of backup information. If not given, no backups will be automatically created.
+    def modify_storage storage_uuid, size:, title:, backup_rule: nil
+        data = {
+            "storage" => {
+                "size" => size,
+                "title" => title,
+                "backup_rule" => backup_rule
+            }
+        }
+
+        json = JSON.generate data
+
+        response = put "storage/#{storage_uuid}", json
+
+        response
+    end
+
+    # Clones existing storage.
+    #
+    # This operation is asynchronous.
+    #
+    # Calls POST /1.2/storage/#{uuid}/clone
+    #
+    # backup_rule should be hash with following attributes:
+    # - interval # allowed values: daily / mon / tue / wed / thu / fri / sat / sun
+    # - time # allowed values: 0000-2359
+    # - retention # How many days backup will be kept. Allowed values: 1-1095
+    #
+    # @param storage_uuid UUID of the storage that will be modified
+    # @param tier Type of the disk. maxiops is SSD powered disk, other allowed value is "hdd"
+    # @param title Name of the disk
+    # @param zone Where the disk will reside. Needs to be within same zone with the server
+    def clone_storage storage_uuid, zone: "fi-hel1", title:, tier: "maxiops"
+        data = {
+            "storage" => {
+                "zone" => zone,
+                "title" => title,
+                "tier" => tier
+            }
+        }
+
+        json = JSON.generate data
+
+        response = post "storage/#{storage_uuid}/clone", json
+
+        response
+    end
+
+    # Attaches a storage to a server. Server must be stopped before the storage can be attached.
+    #
+    # Calls POST /1.2/server/#{server_uuid}/storage/attach
+    #
+    # Valid values for address are: ide[01]:[01] / scsi:0:[0-7] / virtio:[0-7]
+    #
+    # @param type Type of the disk. Valid values are "disk" and "cdrom".
+    # @param address Address where the disk will be attached to. Defaults to next available address.
+    # @param server_uuid UUID of the server where the disk will be attached to.
+    # @param storage_uuid UUID of the storage that will be attached.
+    def attach_storage type: "disk", address: nil, server_uuid:, storage_uuid:
+        data = {
+            "storage_device" => {
+                "type" => type,
+                "address" => address,
+                "storage" => storage_uuid
+            }
+        }
+
+        json = JSON.generate data
+
+        response = post "server/#{server_uuid}/storage/attach", json
+
+        response
+    end
+
+    # Detaches storage from a server.  Server must be stopped before the storage can be detached.
+    #
+    # Calls POST /1.2/server/#{server_uuid}/storage/detach
+    #
+    # @param address Address where the storage that will be detached resides.
+    def detach_storage address
+        data = {
+            "storage_device" => {
+                "address" => address
+            }
+        }
+
+        json = JSON.generate data
+
+        response = post "server/#{server_uuid}/storage/detach", json
+
+        response
+    end
+
+    # Creates backup from a storage.
+    #
+    # This operation is asynchronous.
+    #
+    # Calls /1.2/storage/#{uuid}/backup
+    #
+    # @param storage_uuid UUID of the storage to be cloned
+    # @param title Name of the backup
+    def create_backup storage_uuid, title:
+        data = {
+            "storage" => {
+                "title" => title
+            }
+        }
+
+        json = JSON.generate data
+
+        response = post "storage/#{storage_uuid}/backup", json
+
+        response
+    end
+
+    # Restores a backup.
+    #
+    # If the storage is attached to server, the server must first be stopped.
+    #
+    # Calls /1.2/storage/#{uuid}/restore.
+    #
+    # @param storage_uuid TODO: is this supposed to be UUID of the storage or the backup?
+    def create_backup storage_uuid
+        response = post "storage/#{storage_uuid}/restore"
+
+        response
+    end
+
+    # Deletes a storage.
+    #
+    # The storage must be in "online" state and it must not be attached to any server.
+    # Backups will not be deleted.
+    #
+    # @param storage_uuid UUID of the storage that will be deleted.
+    def delete_storage storage_uuid
+        response = delete "storage/#{storage_uuid}"
+
+        response
+    end
+
     private
 
     def get action

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upcloud_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Samu Voutilainen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty