droplet_kit 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc932d61ca690fb4a81e55d15b6f8c733ffa1599
-  data.tar.gz: 0451b7c0f8fb34965cb6bb4450b8794f0cd5591c
+SHA256:
+  metadata.gz: e0cf3b3acb6383c2bb59033a01b8d3d14e14c4387db6f921ba0d06530d0d5a13
+  data.tar.gz: b9c37f5787739cb2f6256ac3d4654bda66c4ca34179152c9243aa327079e7083
 SHA512:
-  metadata.gz: 98cbeaaaa47c810447898415d480e3d5a6ba0bb3f0bad57da13192411dd109c0ae569760a92771f8f738bdac758eedd66ee9ce18b21b49cb0c2b7f2409407094
-  data.tar.gz: 71a7bf51defafd88379603eb7f6525be77ef7b20c00d13bc9b6ea4050545f535f22cae2b3fd58de9df68cdd7a86ad4f45ca3a038fc1ceca04c478b5ab2216ad6
+  metadata.gz: 2d69f2d18487aa8f742f3fe7973367dc183976ca0ffdf7853fc4577f572e09ebaa8e880ca4231214517cefb48d98f6a2f4fd914974aa75c47935c7718b6a4c41
+  data.tar.gz: 992888c5e18630c67ed28e584e81775e65c4787aacfad5bcce037cc681c6a5ce69c5dc526e282e8d51257750409acc731adc71d8c68001fa7e5799c433f5a3d6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### [2.8.0] - 2018-12-11
+* #144 Adds the ability to set timeout options for Faraday - @tgturner
+* #145 Bump Faraday version to 0.15 - @petems
+* #170 Remove test rb file - @scottcrawford03
+
 ### Version 2.7.0
 * Added KubernetesCluster resource
 * Added KubernetesOptions resource

data/README.md

@@ -29,6 +29,19 @@ require 'droplet_kit'
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
 ```
 
+### Timeout
+
+You may also set timeout and time to first byte options on the client.
+
+```ruby
+require 'droplet_kit'
+client = DropletKit::Client.new(
+  access_token: 'YOUR_TOKEN',
+  open_timeout: 60, # time to first byte in seconds
+  timeout:      120, # response timeout in seconds
+)
+```
+
 ### Custom User-Agent
 
 If you would like to include a custom User-Agent header beyond what DropletKit

data/droplet_kit.gemspec

@@ -24,12 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "resource_kit", '~> 0.1.5'
   spec.add_dependency "kartograph", '~> 0.2.3'
   spec.add_dependency "activesupport", '> 3.0', '< 6'
-  spec.add_dependency "faraday", '~> 0.9'
+  spec.add_dependency "faraday", '~> 0.15'
 
   spec.add_development_dependency "bundler", ">= 1.11.0"
   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

data/lib/droplet_kit/client.rb

@@ -2,18 +2,24 @@ require 'faraday'
 
 module DropletKit
   class Client
+    DEFAULT_OPEN_TIMEOUT = 60
+    DEFAULT_TIMEOUT = 120
     DIGITALOCEAN_API = 'https://api.digitalocean.com'
 
-    attr_reader :access_token, :user_agent
+    attr_reader :access_token, :timeout, :open_timeout, :user_agent
 
     def initialize(options = {})
       @access_token = options.with_indifferent_access[:access_token]
-      @user_agent = options.with_indifferent_access[:user_agent]
+      @open_timeout = options.with_indifferent_access[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+      @timeout      = options.with_indifferent_access[:timeout] || DEFAULT_TIMEOUT
+      @user_agent   = options.with_indifferent_access[:user_agent]
     end
 
     def connection
       @faraday ||= Faraday.new connection_options do |req|
         req.adapter :net_http
+        req.options.open_timeout = open_timeout
+        req.options.timeout = timeout
       end
     end
 

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "2.7.0"
+  VERSION = "2.8.0"
 end

data/spec/lib/droplet_kit/client_spec.rb

@@ -13,6 +13,36 @@ RSpec.describe DropletKit::Client do
       client = DropletKit::Client.new('access_token' => 'my-token')
       expect(client.access_token).to eq('my-token')
     end
+
+    it 'has default open_timeout for faraday' do
+      client = DropletKit::Client.new('access_token' => 'my-token')
+      expect(client.open_timeout).to eq(DropletKit::Client::DEFAULT_OPEN_TIMEOUT)
+    end
+
+    it 'allows open_timeout to be set' do
+      open_timeout = 10
+      client = DropletKit::Client.new(
+        'access_token' => 'my-token',
+        'open_timeout' => open_timeout
+      )
+
+      expect(client.open_timeout).to eq(open_timeout)
+    end
+
+    it 'has default timeout' do
+      client = DropletKit::Client.new('access_token' => 'my-token')
+      expect(client.timeout).to eq(DropletKit::Client::DEFAULT_TIMEOUT)
+    end
+
+    it 'allows timeout to be set' do
+      timeout = 10
+      client = DropletKit::Client.new(
+        'access_token' => 'my-token',
+        'timeout' => timeout
+      )
+
+      expect(client.timeout).to eq(timeout)
+    end
   end
 
   describe "#method_missing" do
@@ -58,6 +88,14 @@ RSpec.describe DropletKit::Client do
       client.connection.use AcmeApp::CustomLogger
       expect(client.connection.builder.handlers).to include(AcmeApp::CustomLogger)
     end
+
+    it 'has open_timeout set' do
+      expect(client.connection.options.open_timeout).to eq(DropletKit::Client::DEFAULT_OPEN_TIMEOUT)
+    end
+
+    it 'has timeout set' do
+      expect(client.connection.options.timeout).to eq(DropletKit::Client::DEFAULT_TIMEOUT)
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Robert Ross
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,20 +128,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
@@ -450,7 +436,6 @@ files:
 - spec/support/shared_examples/common_errors.rb
 - spec/support/shared_examples/paginated_endpoint.rb
 - spec/support/shared_examples/unprocessable_entity.rb
-- test.rb
 homepage: https://github.com/digitalocean/droplet_kit
 licenses:
 - MIT
@@ -471,7 +456,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Droplet Kit is the official Ruby library for DigitalOcean's API

data/test.rb

@@ -1,9 +0,0 @@
-require 'pry'
-require 'droplet_kit'
-
-token = '0e833ebb5c6b914eb58586ac14b03166bfd41110904e433e99e926abc6262bd2'
-client = DropletKit::Client.new(access_token: token)
-
-binding.pry
-client
-