droplet_kit 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62abc974f3667b61cb9e9586ea73f408d8921674
-  data.tar.gz: 49265e741c8b097ec93dd0f498e7fd268d12adbf
+  metadata.gz: 025077918c4a61f739d58486166607209439b129
+  data.tar.gz: c66125a6ac2909c842b79242e3c818c0e5228287
 SHA512:
-  metadata.gz: 47de64509760e6cbf3f78ded12d503d8cb2636182535d8fbf77bbcc4fd0b9a3a01ca4355b944aaee20e97d63bdca29bffd4fc67e3dc370f8e7f36ab5344e477d
-  data.tar.gz: f3c3461af6d3750234302eba87d47c6b470cd46c17a6b15cdb86038defef9234ac50d1945b723f0e4667da231153fc8f73ac49b5cd70ee96a9421890067c3f64
+  metadata.gz: 6198f8fc7be8f537cbbbd8996253c877748428ada7078c680f4f95598d3e2d7dbcd8aebb99da5623927c7d8dbaec30ff2dc6f6a2eb7c814c2bd2d6a2029c4e57
+  data.tar.gz: f84a6955aae3e753dcba901b31527bde4048e887779be627b77a68b6a0e3b49801e71b4b3624d3d7043c4c59640af27cae4cf512d2a516ff5a7c38025ae736c8

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+vendor

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### Version 2.1.0
+* Added monitoring to the Droplet resource.
+* Added LoadBalancer resource.
+* Added Certificate resource.
+* Added min_disk_size, size_gigabytes and created_at to the Image resource.
+* Updated DropletActionResource to use tag_name instead of tag.
+
 ### Version 2.0.1
 * Droplet create action now accepts `tags` attribute.
 

data/README.md

@@ -30,7 +30,7 @@ client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
 
 ## Design
 
-DropletKit follows a strict design of resoures as methods on your client. For examples, for droplets, you will call your client like this:
+DropletKit follows a strict design of resources as methods on your client. For examples, for droplets, you will call your client like this:
 
 ```ruby
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
@@ -45,7 +45,7 @@ client.droplets.all
 # => [ DropletKit::Droplet(id: 123, name: 'something.com', ...), DropletKit::Droplet(id: 1066, name: 'bunk.com', ...) ]
 ```
 
-When you'd like to save objects, it's your responsibility to instantiate the objects and persist them using the resource objects. Lets use creating a Droplet as an example:
+When you'd like to save objects, it's your responsibility to instantiate the objects and persist them using the resource objects. Let's use creating a Droplet as an example:
 
 ```ruby
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
@@ -64,6 +64,21 @@ droplet = client.droplets.find(id: 123)
 
 # All Resources and actions.
 
+## Certificate resource
+
+```ruby
+client = DropletKit::Client.new(access_token: 'TOKEN')
+client.certificates #=> DropletKit::CertificateResource
+```
+
+Actions supported:
+
+* `client.certificates.find(id: 'id')`
+* `client.certificates.all()`
+* `client.certificates.create(certificate)`
+* `client.certificates.delete(id: 'id')`
+
+
 ## Droplet resource
 
 ```ruby
@@ -96,25 +111,25 @@ Actions supported:
 
 * `client.droplet_actions.reboot(droplet_id: droplet.id)`
 * `client.droplet_actions.power_cycle(droplet_id: droplet.id)`
-* `client.droplet_actions.power_cycle_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.power_cycle_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.shutdown(droplet_id: droplet.id)`
-* `client.droplet_actions.shutdown_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.shutdown_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.power_off(droplet_id: droplet.id)`
-* `client.droplet_actions.power_off_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.power_off_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.power_on(droplet_id: droplet.id)`
-* `client.droplet_actions.power_on_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.power_on_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.password_reset(droplet_id: droplet.id)`
 * `client.droplet_actions.enable_ipv6(droplet_id: droplet.id)`
-* `client.droplet_actions.enable_ipv6_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.enable_ipv6_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.enable_backups(droplet_id: droplet.id)`
-* `client.droplet_actions.enable_backups_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.enable_backups_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.disable_backups(droplet_id: droplet.id)`
-* `client.droplet_actions.disable_backups_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.disable_backups_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.upgrade(droplet_id: droplet.id)`
 * `client.droplet_actions.enable_private_networking(droplet_id: droplet.id)`
-* `client.droplet_actions.enable_private_networking_for_tag(tag: 'tag_name')`
+* `client.droplet_actions.enable_private_networking_for_tag(tag_name: 'tag_name')`
 * `client.droplet_actions.snapshot(droplet_id: droplet.id, name: 'Snapshot Name')`
-* `client.droplet_actions.snapshot_for_tag(tag: 'tag_name', name: 'Snapshot Name')`
+* `client.droplet_actions.snapshot_for_tag(tag_name: 'tag_name', name: 'Snapshot Name')`
 * `client.droplet_actions.change_kernel(droplet_id: droplet.id, kernel: 'kernel_id')`
 * `client.droplet_actions.rename(droplet_id: droplet.id, name: 'New-Droplet-Name')`
 * `client.droplet_actions.rebuild(droplet_id: droplet.id, image: 'image_id')`
@@ -122,7 +137,7 @@ Actions supported:
 * `client.droplet_actions.resize(droplet_id: droplet.id, size: '1gb')`
 * `client.droplet_actions.find(droplet_id: droplet.id, id: action.id)`
 * `client.droplet_actions.action_for_id(droplet_id: droplet.id, type: 'event_name', param: 'value')`
-* `client.droplet_actions.action_for_tag(tag: 'tag_name', type: 'event_name', param: 'value')`
+* `client.droplet_actions.action_for_tag(tag_name: 'tag_name', type: 'event_name', param: 'value')`
 
 ## Domain resource
 
@@ -189,6 +204,25 @@ Image Actions Supported:
 * `client.image_actions.transfer(image_id: 123, region: 'nyc3')`
 
 
+## Load balancer resource
+```ruby
+client = DropletKit::Client.new(access_token: 'TOKEN')
+client.load_balancers #=> DropletKit::LoadBalancerResource
+```
+
+Actions supported:
+
+* `client.load_balancers.find(id: 'id')`
+* `client.load_balancers.all()`
+* `client.load_balancers.create(load_balancer)`
+* `client.load_balancers.update(load_balancer, id: 'id')`
+* `client.load_balancers.delete(id: 'id')`
+* `client.load_balancers.add_droplets([droplet.id], id: 'id')`
+* `client.load_balancers.remove_droplets([droplet.id], id: 'id')`
+* `client.load_balancers.add_forwarding_rules([forwarding_rule], id: 'id')`
+* `client.load_balancers.remove_forwarding_rules([forwarding_rule], id: 'id')`
+
+
 ## Region resource
 
 ```ruby

data/droplet_kit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rross@digitalocean.com"]
   spec.summary       = %q{Droplet Kit is the official Ruby library for DigitalOcean's API}
   spec.description   = %q{Droplet Kit is the official Ruby library for DigitalOcean's API}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/digitalocean/droplet_kit"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
 
   # FakeServe
   spec.add_development_dependency 'sinatra', '~> 1.4'

data/lib/droplet_kit.rb

@@ -28,6 +28,11 @@ module DropletKit
   autoload :TaggedResources, 'droplet_kit/models/tagged_resources'
   autoload :TaggedDropletsResources, 'droplet_kit/models/tagged_droplets_resources'
   autoload :Volume, 'droplet_kit/models/volume'
+  autoload :LoadBalancer, 'droplet_kit/models/load_balancer'
+  autoload :StickySession, 'droplet_kit/models/sticky_session'
+  autoload :HealthCheck, 'droplet_kit/models/health_check'
+  autoload :ForwardingRule, 'droplet_kit/models/forwarding_rule'
+  autoload :Certificate, 'droplet_kit/models/certificate'
 
   # Resources
   autoload :DropletResource, 'droplet_kit/resources/droplet_resource'
@@ -48,6 +53,8 @@ module DropletKit
   autoload :VolumeResource, 'droplet_kit/resources/volume_resource'
   autoload :VolumeActionResource, 'droplet_kit/resources/volume_action_resource'
   autoload :SnapshotResource, 'droplet_kit/resources/snapshot_resource'
+  autoload :LoadBalancerResource, 'droplet_kit/resources/load_balancer_resource'
+  autoload :CertificateResource, 'droplet_kit/resources/certificate_resource'
 
   # JSON Maps
   autoload :DropletMapping, 'droplet_kit/mappings/droplet_mapping'
@@ -71,6 +78,11 @@ module DropletKit
   autoload :TaggedResourcesMapping, 'droplet_kit/mappings/tagged_resources_mapping'
   autoload :TaggedDropletsResourcesMapping, 'droplet_kit/mappings/tagged_droplets_resources_mapping'
   autoload :VolumeMapping, 'droplet_kit/mappings/volume_mapping'
+  autoload :LoadBalancerMapping, 'droplet_kit/mappings/load_balancer_mapping'
+  autoload :StickySessionMapping, 'droplet_kit/mappings/sticky_session_mapping'
+  autoload :HealthCheckMapping, 'droplet_kit/mappings/health_check_mapping'
+  autoload :ForwardingRuleMapping, 'droplet_kit/mappings/forwarding_rule_mapping'
+  autoload :CertificateMapping, 'droplet_kit/mappings/certificate_mapping'
 
   # Utils
   autoload :PaginatedResource, 'droplet_kit/paginated_resource'

data/lib/droplet_kit/client.rb

@@ -19,12 +19,14 @@ module DropletKit
     def self.resources
       {
         actions: ActionResource,
+        certificates: CertificateResource,
         droplets: DropletResource,
         domains: DomainResource,
         domain_records: DomainRecordResource,
         droplet_actions: DropletActionResource,
         images: ImageResource,
         image_actions: ImageActionResource,
+        load_balancers: LoadBalancerResource,
         regions: RegionResource,
         sizes: SizeResource,
         ssh_keys: SSHKeyResource,

data/lib/droplet_kit/mappings/certificate_mapping.rb

@@ -0,0 +1,25 @@
+module DropletKit
+  class CertificateMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping Certificate
+      root_key singular: 'certificate', plural: 'certificates', scopes: [:read]
+
+      scoped :read do
+        property :id
+        property :name
+        property :not_after
+        property :sha1_fingerprint
+        property :created_at
+      end
+
+      scoped :create do
+        property :name
+        property :private_key
+        property :leaf_certificate
+        property :certificate_chain
+      end
+    end
+  end
+end

data/lib/droplet_kit/mappings/droplet_mapping.rb

@@ -35,6 +35,7 @@ module DropletKit
       property :image, scopes: [:create]
       property :ssh_keys, scopes: [:create]
       property :backups, scopes: [:create]
+      property :monitoring, scopes: [:create]
       property :ipv6, scopes: [:create]
       property :user_data, scopes: [:create]
       property :private_networking, scopes: [:create]

data/lib/droplet_kit/mappings/forwarding_rule_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class ForwardingRuleMapping
+    include Kartograph::DSL
+
+    kartograph do
+      root_key plural: 'forwarding_rules', scopes: [:create, :update]
+      mapping ForwardingRule
+
+      scoped :read, :create, :update do
+        property :entry_protocol
+        property :entry_port
+        property :target_protocol
+        property :target_port
+        property :certificate_id
+        property :tls_passthrough
+      end
+    end
+  end
+end

data/lib/droplet_kit/mappings/health_check_mapping.rb

@@ -0,0 +1,19 @@
+module DropletKit
+  class HealthCheckMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping HealthCheck
+
+      scoped :read, :create, :update do
+        property :protocol
+        property :port
+        property :path
+        property :check_interval_seconds
+        property :response_timeout_seconds
+        property :healthy_threshold
+        property :unhealthy_threshold
+      end
+    end
+  end
+end

data/lib/droplet_kit/mappings/image_mapping.rb

@@ -15,6 +15,10 @@ module DropletKit
       property :public, scopes: [:read, :read_snapshot, :read_backup]
       property :regions, scopes: [:read, :read_snapshot, :read_backup]
       property :type, scopes: [:read, :read_snapshot, :read_backup]
+
+      property :min_disk_size, scopes: [:read, :read_snapshot, :read_backup]
+      property :created_at, scopes: [:read, :read_snapshot, :read_backup]
+      property :size_gigabytes, scopes: [:read, :read_snapshot, :read_backup]
     end
   end
-end
+end

data/lib/droplet_kit/mappings/load_balancer_mapping.rb

@@ -0,0 +1,33 @@
+module DropletKit
+  class LoadBalancerMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping LoadBalancer
+      root_key singular: 'load_balancer', plural: 'load_balancers', scopes: [:read]
+
+      scoped :read do
+        property :id
+        property :ip
+        property :status
+        property :created_at
+        property :region, include: RegionMapping
+      end
+
+      scoped :read, :update, :create do
+        property :name
+        property :algorithm
+        property :tag
+        property :redirect_http_to_https
+        property :droplet_ids
+        property :sticky_sessions, include: StickySessionMapping
+        property :health_check, include: HealthCheckMapping
+        property :forwarding_rules, plural: true, include: ForwardingRuleMapping
+      end
+
+      scoped  :update, :create do
+        property :region
+      end
+    end
+  end
+end

data/lib/droplet_kit/mappings/sticky_session_mapping.rb

@@ -0,0 +1,15 @@
+module DropletKit
+  class StickySessionMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping StickySession
+
+      scoped :read, :create, :update do
+        property :type
+        property :cookie_name
+        property :cookie_ttl_seconds
+      end
+    end
+  end
+end

data/lib/droplet_kit/models/certificate.rb

@@ -0,0 +1,12 @@
+module DropletKit
+  class Certificate < BaseModel
+    attribute :id
+    attribute :name
+    attribute :not_after
+    attribute :sha1_fingerprint
+    attribute :created_at
+    attribute :private_key
+    attribute :leaf_certificate
+    attribute :certificate_chain
+  end
+end

data/lib/droplet_kit/models/droplet.rb

@@ -11,6 +11,7 @@ module DropletKit
     attribute :volumes
     attribute :ssh_keys
     attribute :backups
+    attribute :monitoring
     attribute :size
     attribute :ipv6
     attribute :user_data

data/lib/droplet_kit/models/forwarding_rule.rb

@@ -0,0 +1,10 @@
+module DropletKit
+  class ForwardingRule < BaseModel
+    attribute :entry_protocol
+    attribute :entry_port
+    attribute :target_protocol
+    attribute :target_port
+    attribute :certificate_id
+    attribute :tls_passthrough
+  end
+end

data/lib/droplet_kit/models/health_check.rb

@@ -0,0 +1,11 @@
+module DropletKit
+  class HealthCheck < BaseModel
+    attribute :protocol
+    attribute :port
+    attribute :path
+    attribute :check_interval_seconds
+    attribute :response_timeout_seconds
+    attribute :healthy_threshold
+    attribute :unhealthy_threshold
+  end
+end

data/lib/droplet_kit/models/image.rb

@@ -1,11 +1,53 @@
 module DropletKit
   class Image < BaseModel
+    # @!attribute id
+    # @example 12345
+    # @return [Fixnum] A unique number that can be used to identify and reference a specific image.
     attribute :id
+
+    # @!attribute name
+    # @example 'foo'
+    # @return [String] The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.
     attribute :name
+
+    # @!attribute distribution
+    # @example 'Ubuntu'
+    # @return [String] This attribute describes the base distribution used for this image.
     attribute :distribution
+
+    # @!attribute slug
+    # @example 'ubuntu-16-04-x64'
+    # @return [String] A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.
     attribute :slug
+
+    # @!attribute public
+    # @example false
+    # @return [Boolean] This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.
     attribute :public
+
+    # @!attribute regions
+    # @example [ "nyc2", "nyc2" ]
+    # @return [Array<String>] This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
     attribute :regions
+
+    # @!attribute type
+    # @example 'snapshot'
+    # @return [String] The kind of image, describing the duration of how long the image is stored. This is either "snapshot" or "backup".
     attribute :type
+
+    # @!attribute min_disk_size
+    # @example 'snapshot'
+    # @return [Fixnum] The minimum 'disk' required for a size to use this image.
+    attribute :min_disk_size
+
+    # @!attribute size_gigabytes
+    # @example 2.34
+    # @return [Fixnum] The size of the image in gigabytes.
+    attribute :size_gigabytes
+
+    # @!attribute created_at
+    # @example '2014-11-04T22:23:02Z'
+    # @return [String] A time value given in ISO8601 combined date and time format that represents when the Image was created.
+    attribute :created_at
   end
 end

data/lib/droplet_kit/models/load_balancer.rb

@@ -0,0 +1,17 @@
+module DropletKit
+  class LoadBalancer < BaseModel
+    attribute :id
+    attribute :ip
+    attribute :name
+    attribute :algorithm
+    attribute :status
+    attribute :created_at
+    attribute :tag
+    attribute :region
+    attribute :redirect_http_to_https
+    attribute :droplet_ids
+    attribute :sticky_sessions
+    attribute :health_check
+    attribute :forwarding_rules
+  end
+end