garage_client 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0ae5b3ae6c5a36e39aea7fbb4c508248329ceb0
-  data.tar.gz: 951d87cff4b2fa051f523879810c3231b6e95f12
+  metadata.gz: f2fe048281c50ac7a86c5c7e797767aad598ba7d
+  data.tar.gz: 79145a3ccd636a550ff080cfbf645c4b84d039ab
 SHA512:
-  metadata.gz: 35480761fae84cd1ae4df093eb7ca58ff12a0b3942cf62220a28f6dc992297ad38dc070a627726516f701576628c47b9761fe0f36d950bb7139b5116f1a50fac
-  data.tar.gz: dc3709d896cb7c5f4f25d71a286adfe5c2e1ed699aa3ccd773f5205054c3d4a59493f1dab127b22c96e04ad351aa04740a9007dac3bfb65bdd64b30b01e239fb
+  metadata.gz: b0b85356fbc7483e712608039c4fcd3281d624c497e4b5f1af6bb04345733d78b56316d7266d5570f0c70c80ec72f725993477f3f805a739ca77596e115c8f47
+  data.tar.gz: 8f7f45c81e14b3894010566be0af202b28f5dab33dddf7a987069a83ad712dc89fd323606ade7f9e27909f38de250769d7ce231c4f9763a24f6371f65f845e37

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.3.0
+- Add new configuration parameter `name`, which is embedded in User-Agent by default
+
 ## 2.2.0
 - Change all 4xx exceptions to be `GarageClient::ClientError`
 - Change all 5xx exceptions to be `GarageClient::ServerError`

data/README.md

@@ -92,7 +92,8 @@ There are the following options:
 
 - `adapter` - faraday adapter for http client (default: `:net_http`)
 - `cacher` - take a cacher class in which caching logic is defined (default: nil)
-- `headers` - default http headers (default: `{ "Accept" => "application/json", "User-Agent" => "garage_client #{VERSION}" }`)
+- `name` - Client's application name, which is embedded in User-Agent by default (default: nil)
+- `headers` - default http headers (default: `{ "Accept" => "application/json", "User-Agent" => "garage_client #{VERSION} #{name}" }`)
 - `endpoint` - Garage application API endpoint (default: nil)
 - `path_prefix` - API path prefix (default: `'/v1'`)
 - `verbose` - Enable verbose http log (default: `false`)
@@ -102,6 +103,7 @@ You can configure the global settings:
 ```ruby
 GarageClient.configure do |c|
   c.endpoint = "http://localhost:3000"
+  c.name = 'my-awesome-client'
   c.verbose = true
 end
 ```
@@ -113,6 +115,7 @@ client = GarageClient::Client.new(
   adapter: :test,
   headers: { "Host" => "garage.example.com" },
   endpoint: "http://localhost:3000",
+  name: 'my-awesome-client',
   path_prefix: "/v2",
   verbose: true,
 )

data/lib/garage_client/client.rb

@@ -85,6 +85,9 @@ module GarageClient
       if !options[:endpoint] && !default_options.endpoint
         raise "Missing endpoint configuration"
       end
+      if !options[:name] && !default_options.name
+        raise "Missing name configuration"
+      end
     end
 
     def default_options

data/lib/garage_client/configuration.rb

@@ -3,16 +3,12 @@ module GarageClient
     DEFAULTS = {
       adapter: :net_http,
       cacher: nil,
-      headers: {
-        'Accept' => 'application/json',
-        'User-Agent' => "garage_client #{GarageClient::VERSION}",
-      },
       path_prefix: '/v1',
       verbose: false,
     }
 
     def self.keys
-      DEFAULTS.keys + [:endpoint]
+      DEFAULTS.keys + [:endpoint, :headers]
     end
 
     def initialize(options = {})
@@ -45,6 +41,31 @@ module GarageClient
       options[:endpoint] = value
     end
 
+    def name
+      options[:name] or raise 'Configuration error: missing name'
+    end
+
+    def name=(value)
+      options[:name] = value
+    end
+
+    def default_user_agent
+      "garage_client #{GarageClient::VERSION} #{name}"
+    end
+
+    def headers
+      options.fetch(:headers) do
+        {
+          'Accept' => 'application/json',
+          'User-Agent' => default_user_agent,
+        }
+      end
+    end
+
+    def headers=(value)
+      options[:headers] = value
+    end
+
     alias :default_headers :headers
     alias :default_headers= :headers=
   end

data/lib/garage_client/version.rb

@@ -1,3 +1,3 @@
 module GarageClient
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/features/configuration_spec.rb

@@ -23,7 +23,7 @@ describe "Configuration of GarageClient" do
       prev = GarageClient.configuration
       GarageClient.instance_variable_set(
         :@configuration,
-        GarageClient::Configuration.new(endpoint: "https://garage.example.com")
+        GarageClient::Configuration.new(endpoint: "https://garage.example.com", name: "configuration_spec")
       )
 
       example.run

data/spec/garage_client/client_spec.rb

@@ -110,7 +110,7 @@ describe GarageClient::Client do
         client.headers.should == {
           "Accept" => "application/json",
           "Content-Type" => "text/plain",
-          "User-Agent" => "garage_client #{GarageClient::VERSION}"
+          "User-Agent" => "garage_client #{GarageClient::VERSION} garage_client_spec"
         }
       end
     end

data/spec/garage_client/configuration_spec.rb

@@ -42,11 +42,23 @@ describe GarageClient::Configuration do
   end
 
   describe "#headers" do
+    context "name isn't configured" do
+      it "raises RuntimeError" do
+        expect { configuration.headers }.to raise_error(RuntimeError, /missing name/)
+      end
+    end
+
     context "in default configuration" do
+      let(:name) { 'configuration_spec' }
+
+      before do
+        configuration.name = name
+      end
+
       it "returns default headers as Hash" do
         configuration.headers.should == {
           "Accept" => "application/json",
-          "User-Agent" => "garage_client #{GarageClient::VERSION}",
+          "User-Agent" => "garage_client #{GarageClient::VERSION} #{name}",
         }
       end
     end
@@ -63,6 +75,10 @@ describe GarageClient::Configuration do
   end
 
   describe "#default_headers" do
+    before do
+      configuration.name = 'configuration_spec'
+    end
+
     it "returns configuration.headers" do
       configuration.default_headers.should == configuration.headers
     end

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ require 'garage_client'
 GarageClient.configure do |c|
   c.path_prefix = ''
   c.endpoint = "https://garage.example.com"
+  c.name = 'garage_client_spec'
 end
 
 # This workaround is strictly for stubbing purpose.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garage_client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Garage API