droplet_kit 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8248d66e3b2a7ea6e7525aa221378fefd3089202
-  data.tar.gz: 2fc041cce279e282b2775a7dfc183aff9fd3dbb8
+  metadata.gz: a8c9257511fd600be1a477ae31232ffa4b3ca0b6
+  data.tar.gz: e8879d2fff128825f6c5f9096f7e1ec658b32660
 SHA512:
-  metadata.gz: f8546836585fd8f04ed333ab3a66e66e3d7ac9bc34690e09e91323090d9d60c2a908ed968dc3412826177f4b67e72482f51fe190d6d9e31cfceba60ab9c6279b
-  data.tar.gz: 5b3bbc5443f5119c09bfeca6138f6d0636ea6b193e50cf75011ee6df591ab93cd85621cc34c591e8b651a4a6b690f6e72cb1c434094ea7acd350fd1e71412f88
+  metadata.gz: 27af0a122b1a597f1a07145687ca8abb46ccbad633007e524e4fc81137be3d6c6da8ecaa1a6387d733cf776ffc6a399b5ff9788a59780953422947245faff66a
+  data.tar.gz: 5a146409578196f9fe891a9253d8fd1652f6259ca815aa5d90de20500807bd400cbc0ee3cfaf9ae2bc4db08242d82ddfcbbf7a912121c77fa8a7edef688864cd

data/README.md

@@ -227,7 +227,7 @@ Actions supported:
 
 ## Contributing
 
-1. Fork it ( https://github.com/digitaloceancloud/droplet_kit/fork )
+1. Fork it ( https://github.com/digitalocean/droplet_kit/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/droplet_kit.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'virtus', '~> 1.0.3'
-  spec.add_dependency "resource_kit", '~> 0.1.1'
-  spec.add_dependency "kartograph", '~> 0.2.1'
+  spec.add_dependency "resource_kit", '~> 0.1.4'
+  spec.add_dependency "kartograph", '~> 0.2.3'
   spec.add_dependency "activesupport", '> 3.0', '< 5.0.0'
   spec.add_dependency "faraday", '~> 0.9.1'
 

data/lib/droplet_kit.rb

@@ -25,6 +25,7 @@ module DropletKit
   autoload :MetaInformation, 'droplet_kit/models/meta_information'
   autoload :Account, 'droplet_kit/models/account'
   autoload :DropletUpgrade, 'droplet_kit/models/droplet_upgrade'
+  autoload :FloatingIp, 'droplet_kit/models/floating_ip'
 
   # Resources
   autoload :DropletResource, 'droplet_kit/resources/droplet_resource'
@@ -39,6 +40,8 @@ module DropletKit
   autoload :SizeResource, 'droplet_kit/resources/size_resource'
   autoload :AccountResource, 'droplet_kit/resources/account_resource'
   autoload :DropletUpgradeResource, 'droplet_kit/resources/droplet_upgrade_resource'
+  autoload :FloatingIpResource, 'droplet_kit/resources/floating_ip_resource'
+  autoload :FloatingIpActionResource, 'droplet_kit/resources/floating_ip_action_resource'
 
   # JSON Maps
   autoload :DropletMapping, 'droplet_kit/mappings/droplet_mapping'
@@ -58,13 +61,27 @@ module DropletKit
   autoload :SSHKeyMapping, 'droplet_kit/mappings/ssh_key_mapping'
   autoload :AccountMapping, 'droplet_kit/mappings/account_mapping'
   autoload :DropletUpgradeMapping, 'droplet_kit/mappings/droplet_upgrade_mapping'
-
+  autoload :FloatingIpMapping, 'droplet_kit/mappings/floating_ip_mapping'
 
   # Utils
   autoload :PaginatedResource, 'droplet_kit/paginated_resource'
+  autoload :ErrorHandlingResourcable, 'droplet_kit/error_handling_resourcable'
 
   # Errors
   autoload :ErrorMapping, 'droplet_kit/mappings/error_mapping'
-  FailedCreate = Class.new(StandardError)
-  FailedUpdate = Class.new(StandardError)
+  Error = Class.new(StandardError)
+  FailedCreate = Class.new(DropletKit::Error)
+  FailedUpdate = Class.new(DropletKit::Error)
+
+  class RateLimitReached < DropletKit::Error
+    attr_accessor :limit, :remaining, :reset_at
+
+    def limit
+      @limit.to_i if @limit
+    end
+
+    def remaining
+      @remaining.to_i if @remaining
+    end
+  end
 end

data/lib/droplet_kit/client.rb

@@ -29,6 +29,8 @@ module DropletKit
         sizes: SizeResource,
         ssh_keys: SSHKeyResource,
         account: AccountResource,
+        floating_ips: FloatingIpResource,
+        floating_ip_actions: FloatingIpActionResource,
       }
     end
 

data/lib/droplet_kit/error_handling_resourcable.rb

@@ -0,0 +1,19 @@
+module ErrorHandlingResourcable
+  def self.included(base)
+    base.send(:resources) do
+      default_handler do |response|
+        if (200...299).include?(response.status)
+          next
+        elsif response.status == 429
+          error = DropletKit::RateLimitReached.new("#{response.status}: #{response.body}")
+          error.limit = response.headers['RateLimit-Limit']
+          error.remaining = response.headers['RateLimit-Remaining']
+          error.reset_at = response.headers['RateLimit-Reset']
+          raise error
+        else
+          raise DropletKit::Error.new("#{response.status}: #{response.body}")
+        end
+      end
+    end
+  end
+end

data/lib/droplet_kit/mappings/domain_record_mapping.rb

@@ -7,12 +7,12 @@ module DropletKit
       root_key plural: 'domain_records', singular: 'domain_record', scopes: [:read]
 
       property :id, scopes: [:read]
-      property :type, scopes: [:read, :create]
+      property :type, scopes: [:read, :create, :update]
       property :name, scopes: [:read, :create, :update]
-      property :data, scopes: [:read, :create]
-      property :priority, scopes: [:read, :create]
-      property :port, scopes: [:read, :create]
-      property :weight, scopes: [:read, :create]
+      property :data, scopes: [:read, :create, :update]
+      property :priority, scopes: [:read, :create, :update]
+      property :port, scopes: [:read, :create, :update]
+      property :weight, scopes: [:read, :create, :update]
     end
   end
-end
+end

data/lib/droplet_kit/mappings/floating_ip_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class FloatingIpMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping FloatingIp
+      root_key plural: 'floating_ips', singular: 'floating_ip', scopes: [:read]
+
+      property :ip, scopes: [:read]
+
+      property :region, scopes: [:read], include: RegionMapping
+      property :droplet, scopes: [:read], include: DropletMapping
+
+      # Create properties aren't quite the same
+      property :droplet_id, scopes: [:create]
+      property :region, scopes: [:create]
+    end
+  end
+end

data/lib/droplet_kit/models/floating_ip.rb

@@ -0,0 +1,10 @@
+module DropletKit
+  class FloatingIp < BaseModel
+    attribute :ip
+    attribute :region
+    attribute :droplet
+
+    # Used for creates
+    attribute :droplet_id
+  end
+end

data/lib/droplet_kit/paginated_resource.rb

@@ -45,7 +45,7 @@ module DropletKit
 
     def total_pages
       return nil if self.total.nil?
-      
+
       (self.total.to_f / per_page.to_f).ceil
     end
 

data/lib/droplet_kit/resources/account_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class AccountResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       default_handler(:ok) {|r| AccountMapping.extract_single(r.body, :read) }
       get '/v2/account' => :info

data/lib/droplet_kit/resources/action_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class ActionResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/actions' do
         query_keys :per_page, :page

data/lib/droplet_kit/resources/domain_record_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class DomainRecordResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/domains/:for_domain/records' do
         query_keys :per_page, :page

data/lib/droplet_kit/resources/domain_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class DomainResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/domains' do
         query_keys :per_page, :page

data/lib/droplet_kit/resources/droplet_action_resource.rb

@@ -1,9 +1,13 @@
 module DropletKit
   class DropletActionResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     ACTIONS_WITHOUT_INPUT = %w(reboot power_cycle shutdown power_off
       power_on password_reset enable_ipv6 disable_backups enable_private_networking)
 
     resources do
+      default_handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+
       ACTIONS_WITHOUT_INPUT.each do |action_name|
         action action_name.to_sym, 'POST /v2/droplets/:droplet_id/actions' do
           body { |_| { type: action_name }.to_json }

data/lib/droplet_kit/resources/droplet_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class DropletResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/droplets' do
         query_keys :per_page, :page
@@ -12,7 +14,7 @@ module DropletKit
 
       action :create, 'POST /v2/droplets' do
         body { |object| DropletMapping.representation_for(:create, object) }
-        handler(202) { |response| DropletMapping.extract_single(response.body, :read) }
+        handler(202) { |response, droplet| DropletMapping.extract_into_object(droplet, response.body, :read) }
         handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
       end
 

data/lib/droplet_kit/resources/droplet_upgrade_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class DropletUpgradeResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/droplet_upgrades' do
         handler(200) { |response| DropletUpgradeMapping.extract_collection(response.body, :read) }

data/lib/droplet_kit/resources/floating_ip_action_resource.rb

@@ -0,0 +1,30 @@
+module DropletKit
+  class FloatingIpActionResource < ResourceKit::Resource
+    resources do
+      default_handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+
+      action :assign, 'POST /v2/floating_ips/:ip/actions' do
+        body { |hash| { type: 'assign', droplet_id: hash[:droplet_id] }.to_json }
+        handler(201, 200) { |response| ActionMapping.extract_single(response.body, :read) }
+      end
+
+      action :unassign, 'POST /v2/floating_ips/:ip/actions' do
+        body { |hash| { type: 'unassign' }.to_json }
+        handler(201, 200) { |response| ActionMapping.extract_single(response.body, :read) }
+      end
+
+      action :find, 'GET /v2/floating_ips/:ip/actions/:id' do
+        handler(200) { |response| ActionMapping.extract_single(response.body, :read) }
+      end
+
+      action :all, 'GET /v2/floating_ips/:ip/actions' do
+        query_keys :per_page, :page
+        handler(200) { |response| ActionMapping.extract_collection(response.body, :read) }
+      end
+    end
+
+    def all(*args)
+      PaginatedResource.new(action(:all), self, *args)
+    end
+  end
+end

data/lib/droplet_kit/resources/floating_ip_resource.rb

@@ -0,0 +1,29 @@
+module DropletKit
+  class FloatingIpResource < ResourceKit::Resource
+    resources do
+      action :all, 'GET /v2/floating_ips' do
+        query_keys :per_page, :page
+        handler(200) { |response| FloatingIpMapping.extract_collection(response.body, :read) }
+      end
+
+      action :find, 'GET /v2/floating_ips/:ip' do
+        handler(200) { |response| FloatingIpMapping.extract_single(response.body, :read) }
+      end
+
+      action :create, 'POST /v2/floating_ips' do
+        body { |object| FloatingIpMapping.representation_for(:create, object) }
+        handler(202) { |response| FloatingIpMapping.extract_single(response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :delete, 'DELETE /v2/floating_ips/:ip' do
+        handler(202) { |response| ActionMapping.extract_single(response.body, :read) }
+        handler(204) { |response| true }
+      end
+    end
+
+    def all(*args)
+      PaginatedResource.new(action(:all), self, *args)
+    end
+  end
+end

data/lib/droplet_kit/resources/image_action_resource.rb

@@ -1,6 +1,10 @@
 module DropletKit
   class ImageActionResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
+      default_handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+
       action :transfer, 'POST /v2/images/:image_id/actions' do
         body { |object| { type: 'transfer', region: object[:region] }.to_json }
         handler(200, 201) { |response| ImageActionMapping.extract_single(response.body, :read) }

data/lib/droplet_kit/resources/image_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class ImageResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/images' do
         query_keys :page, :per_page, :type, :private

data/lib/droplet_kit/resources/region_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class RegionResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/regions' do
         query_keys :per_page, :page

data/lib/droplet_kit/resources/size_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class SizeResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       action :all, 'GET /v2/sizes' do
         query_keys :per_page, :page

data/lib/droplet_kit/resources/ssh_key_resource.rb

@@ -1,5 +1,7 @@
 module DropletKit
   class SSHKeyResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
     resources do
       default_handler(:ok, :created) {|r| SSHKeyMapping.extract_single(r.body, :read) }
 

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 end

data/spec/fixtures/droplet_actions/change_kernel.json

@@ -0,0 +1,27 @@
+{
+  "action": {
+    "id": 2,
+    "status": "in-progress",
+    "type": "change_kernel",
+    "started_at": "2014-07-29T14:35:27Z",
+    "completed_at": null,
+    "resource_id": 12,
+    "resource_type": "droplet",
+    "region_slug": "nyc1",
+    "region": {
+      "name": "New York",
+      "slug": "nyc1",
+      "available": true,
+      "sizes": [
+        "512mb"
+      ],
+      "features": [
+        "virtio",
+        "private_networking",
+        "backups",
+        "ipv6",
+        "metadata"
+      ]
+    }
+  }
+}

data/spec/fixtures/droplet_actions/disable_backups.json

@@ -0,0 +1,27 @@
+{
+  "action": {
+    "id": 2,
+    "status": "in-progress",
+    "type": "disable_backups",
+    "started_at": "2014-07-29T14:35:27Z",
+    "completed_at": null,
+    "resource_id": 12,
+    "resource_type": "droplet",
+    "region_slug": "nyc1",
+    "region": {
+      "name": "New York",
+      "slug": "nyc1",
+      "available": true,
+      "sizes": [
+        "512mb"
+      ],
+      "features": [
+        "virtio",
+        "private_networking",
+        "backups",
+        "ipv6",
+        "metadata"
+      ]
+    }
+  }
+}

data/spec/fixtures/droplet_actions/enable_ipv6.json

@@ -0,0 +1,27 @@
+{
+  "action": {
+    "id": 2,
+    "status": "in-progress",
+    "type": "enable_ipv6",
+    "started_at": "2014-07-29T14:35:27Z",
+    "completed_at": null,
+    "resource_id": 12,
+    "resource_type": "droplet",
+    "region_slug": "nyc1",
+    "region": {
+      "name": "New York",
+      "slug": "nyc1",
+      "available": true,
+      "sizes": [
+        "512mb"
+      ],
+      "features": [
+        "virtio",
+        "private_networking",
+        "backups",
+        "ipv6",
+        "metadata"
+      ]
+    }
+  }
+}