1and1 1.1 → 1.2.0

data/lib/1and1/ssh_keys.rb

@@ -0,0 +1,227 @@
+module OneAndOne
+
+
+  class SshKey
+
+    
+    attr_accessor :id
+    attr_accessor :specs
+
+
+    def initialize(test: false)
+      @id = nil
+      @specs = nil
+
+      # Check if hitting mock api or live api
+      if test
+        @connection = Excon.new($base_url, :mock => true)
+      else
+        @connection = Excon.new($base_url)
+      end
+
+    end
+
+
+    def list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)
+
+      # Build hash for query parameters
+      keyword_args = {
+        :page => page,
+        :per_page => per_page,
+        :sort => sort,
+        :q => q,
+        :fields => fields
+      }
+
+      # Clean out null query parameters
+      params = OneAndOne.clean_hash(keyword_args)
+
+      # Build URL
+      path = OneAndOne.build_url('/ssh_keys')
+
+      # Perform request
+      response = @connection.request(:method => :get,
+        :path => path,
+        :headers => $header,
+        :query => params)
+
+      # Check response status
+      OneAndOne.check_response(response.body, response.status)
+
+      #JSON-ify the response string
+      JSON.parse(response.body)
+
+    end
+
+
+    def create(name: nil, description: nil, public_key: nil)
+
+      # Build POST body
+      new_storage = {
+        'name' => name,
+        'description' => description,
+        'public_key' => public_key
+      }
+
+      # Clean out null keys in POST body
+      body = OneAndOne.clean_hash(new_storage)
+
+      # Stringify the POST body
+      string_body = body.to_json
+
+      # Build URL
+      path = OneAndOne.build_url('/ssh_keys')
+
+      # Perform request
+      response = @connection.request(:method => :post,
+        :path => path,
+        :headers => $header,
+        :body => string_body)
+
+      # Check response status
+      OneAndOne.check_response(response.body, response.status)
+
+      #JSON-ify the response string
+      json = JSON.parse(response.body)
+
+      # Save new ssh key ID to SshKey instance
+      @id = json['id']
+      @specs = json
+
+      # If all good, return JSON
+      json
+
+    end
+
+
+    def get(ssh_key_id: @id)
+
+      # If user passed in ssh_key ID, reassign
+      @id = ssh_key_id
+
+      # Build URL
+      path = OneAndOne.build_url("/ssh_keys/#{@id}")
+
+      # Perform request
+      response = @connection.request(:method => :get,
+        :path => path,
+        :headers => $header)
+
+      # Check response status
+      OneAndOne.check_response(response.body, response.status)
+
+      #JSON-ify the response string
+      json = JSON.parse(response.body)
+
+      # Reload specs attribute
+      @specs = json
+
+      # If all good, return JSON
+      json
+
+    end
+
+
+    def modify(ssh_key_id: @id, name: nil, description: nil)
+
+      # If user passed in ssh_key ID, reassign
+      @id = ssh_key_id
+
+      # Build PUT body
+      new_storage = {
+        'name' => name,
+        'description' => description
+      }
+
+      # Clean out null keys in POST body
+      body = OneAndOne.clean_hash(new_storage)
+
+      # Stringify the POST body
+      string_body = body.to_json
+
+      # Build URL
+      path = OneAndOne.build_url("/ssh_keys/#{@id}")
+
+      # Perform request
+      response = @connection.request(:method => :put,
+        :path => path,
+        :headers => $header,
+        :body => string_body)
+
+      # Check response status
+      OneAndOne.check_response(response.body, response.status)
+
+      #JSON-ify the response string
+      JSON.parse(response.body)
+
+    end
+
+
+    def delete(ssh_key_id: @id)
+
+      # If user passed in ssh_key ID, reassign
+      @id = ssh_key_id
+
+      # Build URL
+      path = OneAndOne.build_url("/ssh_keys/#{@id}")
+
+      # Perform request
+      response = @connection.request(:method => :delete,
+        :path => path,
+        :headers => $header)
+
+      # Check response status
+      OneAndOne.check_response(response.body, response.status)
+
+      #JSON-ify the response string
+      JSON.parse(response.body)
+
+    end
+
+
+    def reload
+
+      # This reload fx is just a wrapper for the get fx
+      get
+
+    end
+
+
+    def wait_for(timeout: 25, interval: 5)
+
+      # Capture start time
+      start = Time.now
+
+      # Poll ssh key and check initial state
+      initial_response = get
+      ssh_key_state = initial_response['state']
+
+      # Keep polling the ssh key's state until good
+      until $good_states.include? ssh_key_state
+
+        # Wait 5 seconds before polling again
+        sleep interval
+
+        # Check ssh key state again
+        current_response = get
+        ssh_key_state = current_response['state']
+
+        # Calculate current duration and check for timeout
+        duration = (Time.now - start) / 60
+        if duration > timeout
+          puts "The operation timed out after #{timeout} minutes.\n"
+          return
+        end
+
+      end
+
+      # Return Duration
+      {:duration => duration}
+
+    end
+
+
+  end
+
+
+end

data/lib/oneandone.rb

@@ -24,4 +24,7 @@ module OneAndOne
   require_relative '1and1/ping_auth'
   require_relative '1and1/vpn'
   require_relative '1and1/role'
+  require_relative '1and1/block_storage'
+  require_relative '1and1/ssh_keys'
+  require_relative '1and1/recovery_appliance'
 end

data/sphinx/recovery_appliances.rst

@@ -0,0 +1,42 @@
+Recovery Appliances
+*****************
+
+.. rb:class:: OneAndOne::RecoveryAppliance()
+   
+   The :rb:class:`RecoveryAppliance` class allows a user to perform actions against the 1and1 API.
+
+
+   .. rb:method:: list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)
+
+     List all images available for recovering purposes.
+
+     :param page: Allows the use of pagination. Indicate which page to start on.
+     :type page: ``int``
+
+     :param per_page: Number of items per page.
+     :type per_page: ``int``
+
+     :param sort: ``sort: 'name'`` retrieves a list of elements sorted 
+       alphabetically. ``sort: 'creation_date'`` retrieves a list of elements 
+       sorted by their creation date in descending order.
+     :type sort: ``str``
+
+     :param q: ``q`` is for query. Use this parameter to return only the items 
+       that match your search query.
+     :type q: ``str``
+
+     :param fields: Returns only the parameters requested. 
+       (i.e. fields: 'id, name, description, hardware.ram')
+     :type fields: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: get(appliance_id: nil)
+
+     Returns information about a recovery appliance.
+
+     :param appliance_id: the unique identifier for the appliance.
+     :type appliance_id: ``str``
+
+     :rtype: JSON

data/test/mock-api/attach-block-storage.json

@@ -0,0 +1,18 @@
+{
+  "id": "6AD2F180B7B666539EF75A02FE227084",
+  "size": 200,
+  "state": "ACTIVE",
+  "description": "My block storage for containers",
+  "datacenter": {
+    "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+    "location": "USA",
+    "country_code": "US"
+  },
+  "name": "My block storage 1",
+  "creation_date": "2015-05-06T08:33:25+00:00",
+  "server":
+  {
+    "id": "638ED28205B1AFD7ADEF569C725DD85F",
+    "name": "My server 1"
+  }
+}

data/test/mock-api/create-block-storage.json

@@ -0,0 +1,14 @@
+{
+  "id": "6AD2F180B7B666539EF75A02FE227084",
+  "size": 200,
+  "state": "CONFIGURING",
+  "description": "My block storage description",
+  "datacenter": {
+    "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+    "location": "USA",
+    "country_code": "US"
+  },
+  "name": "My block storage 4",
+  "creation_date": "2015-05-06T08:33:25+00:00",
+  "server": null
+}

data/test/mock-api/create-ssh-key.json

@@ -0,0 +1,10 @@
+{
+  "id": "39AA65F5D5B02FA02D58173094EBAF95",
+  "name": "My SSH key 1",
+  "description": "My SSH key description",
+  "state": "ACTIVE",
+  "servers": [],
+  "md5": "5df9f63916ebf8528697b629022993e8",
+  "public_key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUpwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ51s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQAB",
+  "creation_date": "30-06-2015T 14:52:35+00.00"
+}

data/test/mock-api/delete-block-storage.json

@@ -0,0 +1,18 @@
+{
+  "id": "6AD2F180B7B666539EF75A02FE227084",
+  "size": 200,
+  "state": "REMOVING",
+  "description": "My block storage for containers",
+  "datacenter": {
+    "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+    "location": "USA",
+    "country_code": "US"
+  },
+  "name": "My block storage 1",
+  "creation_date": "2015-05-06T08:33:25+00:00",
+  "server":
+  {
+    "id": "638ED28205B1AFD7ADEF569C725DD85F",
+    "name": "My server 1"
+  }
+}

data/test/mock-api/delete-ssh-key.json

@@ -0,0 +1,13 @@
+{
+  "id": "39AA65F5D5B02FA02D58173094EBAF95",
+  "name": "My SSH key 1",
+  "description": "My SSH key description",
+  "state": "DELETING",
+  "servers": [
+    {"id": "D0F6D8C8ED29D3036F94C27BBB789536","name": "Server 1"},
+    {"id": "E0F6D8C8ED29D3036F94C27BBB789537","name": "Server 2"}
+  ],
+  "md5": "5df9f63916ebf8528697b629022993e8",
+  "public_key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUpwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ51s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQAB",
+  "creation_date": "30-06-2015T 14:52:35+00.00"
+}

data/test/mock-api/detach-block-storage.json

@@ -0,0 +1,14 @@
+{
+  "id": "6AD2F180B7B666539EF75A02FE227084",
+  "size": 200,
+  "state": "CONFIGURING",
+  "description": "My block storage for containers",
+  "datacenter": {
+    "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+    "location": "USA",
+    "country_code": "US"
+  },
+  "name": "My block storage 1",
+  "creation_date": "2015-05-06T08:33:25+00:00",
+  "server": null
+}

data/test/mock-api/get-block-storage.json

@@ -0,0 +1,18 @@
+{
+  "id": "6AD2F180B7B666539EF75A02FE227084",
+  "size": 200,
+  "state": "ACTIVE",
+  "description": "My block storage for containers",
+  "datacenter": {
+    "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+    "location": "USA",
+    "country_code": "US"
+  },
+  "name": "My block storage 1",
+  "creation_date": "2015-05-06T08:33:25+00:00",
+  "server":
+  {
+    "id": "638ED28205B1AFD7ADEF569C725DD85F",
+    "name": "My server 1"
+  }
+}

data/test/mock-api/get-recovery-appliance.json

@@ -0,0 +1,13 @@
+{
+  "id": "148CE80B09ED769373921F31CEE85E9E",
+  "name": "Windows 64-bit Rescue-System",
+  "os": "Other Windows",
+  "os_family": "Windows",
+  "os_version": "WindowsDatacenter",
+  "architecture": 64,
+  "available_datacenters": [
+    "908DC2072407C94C8054610AD5A53C2D",
+    "4EFAD5836CE43ACA502FD5B99BEE48GH",
+    "908DC2072407C94C8054610AD5A53C4D"
+  ]
+}

data/test/mock-api/get-ssh-key.json

@@ -0,0 +1,13 @@
+{
+  "id": "39AA65F5D5B02FA02D58173094EBAF95",
+  "name": "My SSH key 1",
+  "description": "My SSH key description",
+  "state": "ACTIVE",
+  "servers": [
+    {"id": "D0F6D8C8ED29D3036F94C27BBB789536","name": "Server 1"},
+    {"id": "E0F6D8C8ED29D3036F94C27BBB789537","name": "Server 2"}
+  ],
+  "md5": "5df9f63916ebf8528697b629022993e8",
+  "public_key": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUpwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ51s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQAB",
+  "creation_date": "30-06-2015T 14:52:35+00.00"
+}

data/test/mock-api/list-block-storages.json

@@ -0,0 +1,52 @@
+[
+  {
+    "id": "6AD2F180B7B666539EF75A02FE227084",
+    "size": 200,
+    "state": "ACTIVE",
+    "description": "My block storage for containers",
+    "datacenter": {
+      "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+      "location": "USA",
+      "country_code": "US"
+    },
+    "name": "My block storage 1",
+    "creation_date": "2015-05-06T08:33:25+00:00",
+    "server":
+    {
+      "id": "638ED28205B1AFD7ADEF569C725DD85F",
+      "name": "My server 1"
+    }
+  },
+  {
+    "id": "4406CE4723BB441C7956E25C51CE8C1B",
+    "size": 50,
+    "state": "ACTIVE",
+    "description": "My block storage description",
+    "datacenter": {
+      "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+      "location": "USA",
+      "country_code": "US"
+    },
+    "name": "My block storage 3",
+    "creation_date": "2015-03-17T11:57:48+00:00",
+    "server": null
+  },
+  {
+    "id": "1A5418172DD3BD39F8010A6633F1018A",
+    "size": 250,
+    "state": "ACTIVE",
+    "description": "",
+    "datacenter": {
+      "id": "D0F6D8C8ED29D3036F94C27BBB7BAD36",
+      "location": "USA",
+      "country_code": "US"
+    },
+    "name": "My block storage 2",
+    "creation_date": "2015-05-05T09:36:31+00:00",
+    "server":
+    {
+      "id": "748ED28205B1AFD7ADEF569C725DD85E",
+      "name": "My server 2"
+    }
+  }
+]