droplet_kit 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c4785840d709bf0fb77376b1a0bde83177bf180
-  data.tar.gz: bd3c1da28e541f47c2f701fed55730a618e99af9
+  metadata.gz: 86f7ab1bde3cbd736afb675cef233f4d24775c32
+  data.tar.gz: 8d525afec4d2bf96b3e77cafa35dd475584210f6
 SHA512:
-  metadata.gz: e5ec1fa13b657d29485822b0b4171a39f774398bf89722bfdcf4e81db0afbf01611b689feab1f802508029715bbe4b1df0534aedbcfefa05cd1ff049dce432fd
-  data.tar.gz: 7db985a236a9066c49fe5403418ed0f79cc7016389320e9cb6e851ebd85dd66d5422949b5f06cf7db172d9edfab07d9b016d773ad1f9ef53bb29be8753dd47d6
+  metadata.gz: 9d8b775dea7c1d4f2972e22a4c27d00d697f1f028fe27b9caf232ea3643bd21f545591cc736893730f2cccc0294b563d13a1a003e61396266d4150acd4b34e16
+  data.tar.gz: fed45dc62fe67d39777503472e32345bcb9ac0d886792782fe4ab914cf5f7197d349dcb1ce23c827160531d7a65d7620fa691470abf44aa5a1203dad417a93da

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Version 2.6.1
+* Added custom User-Agent for DropletKit
+
 ### Version 2.6.0
 * Added ability to manage projects.
 

data/README.md

@@ -29,6 +29,16 @@ require 'droplet_kit'
 client = DropletKit::Client.new(access_token: 'YOUR_TOKEN')
 ```
 
+### Custom User-Agent
+
+If you would like to include a custom User-Agent header beyond what DropletKit
+uses, you can pass one in at the client initialization like so:
+
+```ruby
+require 'droplet_kit'
+client = DropletKit::Client.new(access_token: 'YOUR_TOKEN', user_agent: 'custom')
+```
+
 ## Design
 
 DropletKit follows a strict design of resources as methods on your client. For examples, for droplets, you will call your client like this:

data/lib/droplet_kit/client.rb

@@ -4,10 +4,11 @@ module DropletKit
   class Client
     DIGITALOCEAN_API = 'https://api.digitalocean.com'
 
-    attr_reader :access_token
+    attr_reader :access_token, :user_agent
 
     def initialize(options = {})
       @access_token = options.with_indifferent_access[:access_token]
+      @user_agent = options.with_indifferent_access[:user_agent]
     end
 
     def connection
@@ -56,6 +57,10 @@ module DropletKit
       @resources ||= {}
     end
 
+    def default_user_agent
+      "DropletKit/#{DropletKit::VERSION} Faraday/#{Faraday::VERSION}"
+    end
+
     private
 
     def connection_options
@@ -63,7 +68,8 @@ module DropletKit
         url: DIGITALOCEAN_API,
         headers: {
           content_type: 'application/json',
-          authorization: "Bearer #{access_token}"
+          authorization: "Bearer #{access_token}",
+          user_agent: "#{user_agent} #{default_user_agent}".strip
         }
       }
     end

data/lib/droplet_kit/version.rb

@@ -1,3 +1,3 @@
 module DropletKit
-  VERSION = "2.6.0"
+  VERSION = "2.6.1"
 end

data/spec/lib/droplet_kit/client_spec.rb

@@ -39,6 +39,21 @@ RSpec.describe DropletKit::Client do
       expect(client.connection.headers['Content-Type']).to eq("application/json")
     end
 
+    context 'with default user agent' do
+      it 'contains the version of DropletKit and Faraday' do
+        stub_const('DropletKit::VERSION', '1.2.3')
+        stub_const('Faraday::VERSION', '1.2.3')
+        expect(client.connection.headers['User-Agent']).to eq('DropletKit/1.2.3 Faraday/1.2.3')
+      end
+    end
+
+    context 'with user provided user agent' do
+      it 'includes their agent string as well' do
+        client = DropletKit::Client.new(access_token: 'bunk', user_agent: 'tugboat')
+        expect(client.connection.headers['User-Agent']).to include('tugboat')
+      end
+    end
+
     it 'allows access to faraday instance' do
       client.connection.use AcmeApp::CustomLogger
       expect(client.connection.builder.handlers).to include(AcmeApp::CustomLogger)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: droplet_kit
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -447,7 +447,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Droplet Kit is the official Ruby library for DigitalOcean's API