droplet_kit 3.19.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7aa72baa7a9ea4de7fccdc3953c36aec28083aef5339779376e12306b93b09e
-  data.tar.gz: d539ac1f1fab8846796194ca7f125343ce4749638a277f2d8f3b39afdffc100d
+  metadata.gz: 615cc2a41f53e00443e4a8b59ea4e1af6b2f8edaf56c35fb764e79b5b28b77f3
+  data.tar.gz: 949eb311f59b8923be9c91864482fde4cbf836869c62a095a5aafde54a161bdf
 SHA512:
-  metadata.gz: dfb0481753a0c360839768dc31c4f1b4b6214e24f7ef9a7ed2d0882f973ce90288a47c5f61cc0ae36f3df43badb80e69ac5b918de21a408726a070e35cceceae
-  data.tar.gz: 0a353b970b108ccb455ad87d17f20b63847a44b703fb8e1fa9ea0dabb139c5d5f86c9c4c0e02c312f3344f8fb170541528441480b85fa93781be0d3d6be8efbc
+  metadata.gz: c78d6a1b8b99b43bceb14fe12a6a07aef9d5ca08e6ae6724897082d6b619ae393d0a4332018f05682851bfa89a13247fa97fc58d594b32f76d8518e857c9fa22
+  data.tar.gz: 813777d5eaa8e768291b2b4a0d9c74da033db81ce02f905227afea51283b25108b62a14d08fad46241c4db3677eec94199a9cb2926f5141c8e9ba9cb5fe9f6e7

data/README.md

@@ -52,6 +52,19 @@ require 'droplet_kit'
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN', user_agent: 'custom')
 ```
 
+### Automatically Retry Rate Limited Requests
+
+By default, DropletKit will handle requests that are rate limited by the DigitalOcean API's [burst limit](https://docs.digitalocean.com/reference/api/api-reference/#section/Introduction/Rate-Limit). When the burst rate limit is reached, DropletKit will wait according to the value of the API response's `Retry-After` header. Typically the wait time is less than one minute. When the hourly rate limit is hit, an error is raised.
+
+By default, DropletKit will retry a rate limited request three times before returning an error. If you would like to disable the retry behavior altogether, and instead raise an error when any rate limit is reached, you can set the `retry_max` config value to zero.
+
+DropletKit will also wait zero seconds until retrying a request after the `Retry-After` time has elapsed by default. To change this, set the `retry_wait_min` to a different value.
+
+```ruby
+require 'droplet_kit'
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN', retry_max: 3, retry_wait_min: 1)
+```
+
 ## Design
 
 DropletKit follows a strict design of resources as methods on your client. For examples, for droplets, you will call your client like this:
@@ -61,12 +74,22 @@ client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
 client.droplets #=> DropletsResource
 ```
 
-DropletKit will return Plain Old Ruby objects(tm) that contain the information provided by the API. For example:
+DropletKit will return Plain Old Ruby objects(tm) that contain the information provided by the API. For actions that return multiple objects, the request won't be executed until the result is accessed. For example:
 
 ```ruby
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
+
+# Returns an instance of a Paginated Resource.
 client.droplets.all
-# => [ DropletKit::Droplet(id: 123, name: 'something.com', ...), DropletKit::Droplet(id: 1066, name: 'bunk.com', ...) ]
+# => #<DropletKit::PaginatedResource:0x000000010d556c3a>
+
+# Returns the first Droplet.
+client.droplets.all.first
+# => <DropletKit::Droplet {:@id=>1, :@name=>"mydroplet", ...}>
+
+# Returns an array of Droplet IDs.
+client.droplets.all.map(&:id)
+# => [1]
 ```
 
 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:
@@ -153,7 +176,7 @@ Actions supported:
 * `client.databases.list_backups(id: 'id')`
 * `client.databases.restore_from_backup(database_backup)`
 * `client.databases.delete_cluster(id: 'id')`
-* `client.database.create_db(database, id: 'id')`
+* `client.databases.create_db(database, id: 'id')`
 * `client.databases.find_db(id: 'id', name: 'name')`
 * `client.databases.all_dbs(id: 'id')`
 * `client.databases.delete_db(id: 'id', name: 'name')`
@@ -599,6 +622,20 @@ Actions supported:
 * `client.vpcs.delete(id: 'id')`
 * `client.vpcs.all_members(id: 'id')`
 
+## VPC Peering resource
+
+    client = DropletKit::Client.new(access_token: 'TOKEN')
+    client.vpc_peerings #=> DropletKit::VPCPeeringResource
+
+Actions supported:
+
+* `client.vpc_peerings.find(id: 'id')`
+* `client.vpc_peerings.all()`
+* `client.vpc_peerings.create(vpc_peering)`
+* `client.vpc_peerings.update(vpc_peering, id: 'id')`
+* `client.vpc_peerings.patch(vpc_peering, id: 'id')`
+* `client.vpc_peerings.delete(id: 'id')`
+
 ## Container Registry resource
 
     client = DropletKit::Client.new(access_token: 'TOKEN')

data/lib/droplet_kit/client.rb

@@ -1,23 +1,29 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday/retry'
 require 'droplet_kit/utils'
 
 module DropletKit
   class Client
     DEFAULT_OPEN_TIMEOUT = 60
     DEFAULT_TIMEOUT = 120
+    DEFAULT_RETRY_MAX = 3
+    DEFAULT_RETRY_WAIT_MIN = 0
+
     DIGITALOCEAN_API = 'https://api.digitalocean.com'
 
-    attr_reader :access_token, :api_url, :open_timeout, :timeout, :user_agent
+    attr_reader :access_token, :api_url, :open_timeout, :timeout, :user_agent, :retry_max, :retry_wait_min
 
     def initialize(options = {})
       options = DropletKit::Utils.transform_keys(options, &:to_sym)
-      @access_token = options[:access_token]
-      @api_url      = options[:api_url] || DIGITALOCEAN_API
-      @open_timeout = options[:open_timeout] || DEFAULT_OPEN_TIMEOUT
-      @timeout      = options[:timeout] || DEFAULT_TIMEOUT
-      @user_agent   = options[:user_agent]
+      @access_token   = options[:access_token]
+      @api_url        = options[:api_url] || DIGITALOCEAN_API
+      @open_timeout   = options[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+      @timeout        = options[:timeout] || DEFAULT_TIMEOUT
+      @user_agent     = options[:user_agent]
+      @retry_max      = options[:retry_max] || DEFAULT_RETRY_MAX
+      @retry_wait_min = options[:retry_wait_min] || DEFAULT_RETRY_WAIT_MIN
     end
 
     def connection
@@ -25,6 +31,19 @@ module DropletKit
         req.adapter :net_http
         req.options.open_timeout = open_timeout
         req.options.timeout = timeout
+        unless retry_max.zero?
+          req.request :retry, {
+            max: @retry_max,
+            interval: @retry_wait_min,
+            retry_statuses: [429],
+            # faraday-retry supports both the Retry-After and RateLimit-Reset
+            # headers, however, it favours the RateLimit-Reset one. To force it
+            # to use the Retry-After header, we override the header that it
+            # expects for the RateLimit-Reset header to something that we know
+            # we don't set.
+            rate_limit_reset_header: 'undefined'
+          }
+        end
       end
     end
 
@@ -61,7 +80,8 @@ module DropletKit
         projects: ProjectResource,
         volumes: VolumeResource,
         volume_actions: VolumeActionResource,
-        vpcs: VPCResource
+        vpcs: VPCResource,
+        vpc_peerings: VPCPeeringResource
       }
     end
 
@@ -91,6 +111,11 @@ module DropletKit
           content_type: 'application/json',
           authorization: "Bearer #{access_token}",
           user_agent: "#{user_agent} #{default_user_agent}".strip
+        },
+        request: {
+          context: {
+            retry_max: @retry_max
+          }
         }
       }
     end

data/lib/droplet_kit/error_handling_resourcable.rb

@@ -8,11 +8,13 @@ module ErrorHandlingResourcable
         when 200...299
           next
         when 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
+          unless response.headers.key?('Retry-After') && !connection.options.context.key?(:retry_max)
+            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
+          end
         else
           raise DropletKit::Error, "#{response.status}: #{response.body}"
         end

data/lib/droplet_kit/mappings/account_mapping.rb

@@ -11,9 +11,25 @@ module DropletKit
       scoped :read do
         property :droplet_limit
         property :floating_ip_limit
+        property :name
         property :email
         property :uuid
         property :email_verified
+        property :team
+      end
+    end
+  end
+
+  class AccountTeamMapping
+    include Kartograph::DSL
+
+    kartograph do
+      root_key singular: 'team', scopes: [:read]
+      mapping AccountTeam
+
+      scoped :read do
+        property :uuid
+        property :name
       end
     end
   end

data/lib/droplet_kit/mappings/vpc_peering_mapping.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DropletKit
+  class VPCPeeringMapping
+    include Kartograph::DSL
+
+    kartograph do
+      mapping VPCPeering
+      root_key plural: 'vpc_peerings', singular: 'vpc_peering', scopes: [:read]
+
+      scoped :read do
+        property :id
+        property :name
+        property :vpc_ids
+        property :created_at
+        property :status
+      end
+
+      scoped :update, :patch do
+        property :name
+      end
+
+      scoped :create do
+        property :name
+        property :vpc_ids
+      end
+    end
+  end
+end

data/lib/droplet_kit/models/account.rb

@@ -4,8 +4,15 @@ module DropletKit
   class Account < BaseModel
     attribute :droplet_limit
     attribute :floating_ip_limit
+    attribute :name
     attribute :email
     attribute :uuid
     attribute :email_verified
+    attribute :team
+  end
+
+  class AccountTeam < BaseModel
+    attribute :uuid
+    attribute :name
   end
 end

data/lib/droplet_kit/models/vpc_peering.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DropletKit
+  class VPCPeering < BaseModel
+    attribute :id
+    attribute :name
+    attribute :vpc_ids
+    attribute :created_at
+    attribute :status
+  end
+end

data/lib/droplet_kit/resources/droplet_action_resource.rb

@@ -35,7 +35,7 @@ module DropletKit
       end
 
       TAG_ACTIONS.each do |action_name|
-        action "#{action_name}_for_tag".to_sym, 'POST /v2/droplets/actions' do
+        action :"#{action_name}_for_tag", 'POST /v2/droplets/actions' do
           query_keys :tag_name
           body { |_| { type: action_name }.to_json }
           handler(201, 200) { |response| ActionMapping.extract_collection(response.body, :read) }

data/lib/droplet_kit/resources/vpc_peering_resource.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DropletKit
+  class VPCPeeringResource < ResourceKit::Resource
+    include ErrorHandlingResourcable
+
+    resources do
+      action :find, 'GET /v2/vpc_peerings/:id' do
+        handler(200) do |response|
+          VPCPeeringMapping.extract_single(response.body, :read)
+        end
+      end
+
+      action :all, 'GET /v2/vpc_peerings' do
+        query_keys :per_page, :page
+
+        handler(200) do |response|
+          VPCPeeringMapping.extract_collection(response.body, :read)
+        end
+      end
+
+      action :create, 'POST /v2/vpc_peerings' do
+        body { |vpc_peering| VPCPeeringMapping.representation_for(:create, vpc_peering) }
+        handler(202) { |response| VPCPeeringMapping.extract_single(response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedCreate, response.body) }
+      end
+
+      action :patch, 'PATCH /v2/vpc_peerings/:id' do
+        body { |vpc_peering| VPCPeeringMapping.representation_for(:patch, vpc_peering) }
+        handler(200) { |response| VPCPeeringMapping.extract_single(response.body, :read) }
+        handler(422) { |response| ErrorMapping.fail_with(FailedUpdate, response.body) }
+      end
+
+      action :delete, 'DELETE /v2/vpc_peerings/:id' do
+        handler(202) { |response| VPCPeeringMapping.extract_single(response.body, :read) }
+      end
+    end
+
+    def all(*args)
+      PaginatedResource.new(action(:all), self, *args)
+    end
+  end
+end

data/lib/droplet_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DropletKit
-  VERSION = '3.19.0'
+  VERSION = '3.21.0'
 end

data/lib/droplet_kit.rb

@@ -69,6 +69,7 @@ module DropletKit
   autoload :KubernetesOptions, 'droplet_kit/models/kubernetes_options'
   autoload :VPC, 'droplet_kit/models/vpc'
   autoload :VPCMember, 'droplet_kit/models/vpc_member'
+  autoload :VPCPeering, 'droplet_kit/models/vpc_peering'
 
   # Resources
   autoload :DropletResource, 'droplet_kit/resources/droplet_resource'
@@ -104,6 +105,7 @@ module DropletKit
   autoload :KubernetesClusterResource, 'droplet_kit/resources/kubernetes_cluster_resource'
   autoload :KubernetesOptionsResource, 'droplet_kit/resources/kubernetes_options_resource'
   autoload :VPCResource, 'droplet_kit/resources/vpc_resource'
+  autoload :VPCPeeringResource, 'droplet_kit/resources/vpc_peering_resource'
 
   # JSON Maps
   autoload :DropletMapping, 'droplet_kit/mappings/droplet_mapping'
@@ -168,6 +170,7 @@ module DropletKit
   autoload :KubernetesOptionsMapping, 'droplet_kit/mappings/kubernetes_options_mapping'
   autoload :VPCMapping, 'droplet_kit/mappings/vpc_mapping'
   autoload :VPCMemberMapping, 'droplet_kit/mappings/vpc_member_mapping'
+  autoload :VPCPeeringMapping, 'droplet_kit/mappings/vpc_peering_mapping'
 
   # Utils
   autoload :PaginatedResource, 'droplet_kit/paginated_resource'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 3.19.0
+  version: 3.21.0
 platform: ruby
 authors:
 - DigitalOcean API Engineering team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: kartograph
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +313,7 @@ files:
 - lib/droplet_kit/mappings/volume_mapping.rb
 - lib/droplet_kit/mappings/vpc_mapping.rb
 - lib/droplet_kit/mappings/vpc_member_mapping.rb
+- lib/droplet_kit/mappings/vpc_peering_mapping.rb
 - lib/droplet_kit/models/account.rb
 - lib/droplet_kit/models/action.rb
 - lib/droplet_kit/models/balance.rb
@@ -348,6 +377,7 @@ files:
 - lib/droplet_kit/models/volume.rb
 - lib/droplet_kit/models/vpc.rb
 - lib/droplet_kit/models/vpc_member.rb
+- lib/droplet_kit/models/vpc_peering.rb
 - lib/droplet_kit/paginated_resource.rb
 - lib/droplet_kit/resources/account_resource.rb
 - lib/droplet_kit/resources/action_resource.rb
@@ -381,6 +411,7 @@ files:
 - lib/droplet_kit/resources/tag_resource.rb
 - lib/droplet_kit/resources/volume_action_resource.rb
 - lib/droplet_kit/resources/volume_resource.rb
+- lib/droplet_kit/resources/vpc_peering_resource.rb
 - lib/droplet_kit/resources/vpc_resource.rb
 - lib/droplet_kit/utils.rb
 - lib/droplet_kit/version.rb