Allow custom user-agent and set a useful default

gini · Jan 14, 2015 · a1c2031 · a1c2031
1 parent d95d32f
commit a1c2031
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/lib/gini-api/client.rb b/lib/gini-api/client.rb
@@ -25,6 +25,7 @@ class Client
       # @option options [String]  :api_uri API URI (https://api.gini.net)
       # @option options [String]  :api_version API version to use (v1)
       # @option options [Logger]  :log logger object to use (initialized with STDOUT otherwise)
+      # @option options [String]  :user_agent HTTP User-Agent (gini-api-ruby/VERSION (Faraday vFaraday::VERSION))
       #
       # @example
       #   api = Gini::Api::Client.new(
@@ -42,6 +43,7 @@ def initialize(options = {})
           upload_timeout: 90,
           processing_timeout: 180,
           log: Logger.new(STDOUT),
+          user_agent: "gini-api-ruby/#{VERSION} (Faraday v#{Faraday::VERSION})"
         }.merge(options)
 
         # Ensure mandatory keys are set

diff --git a/lib/gini-api/oauth.rb b/lib/gini-api/oauth.rb
@@ -28,6 +28,7 @@ def initialize(api, opts)
           token_url: '/oauth/token',
           max_redirects: 0,
           raise_errors: true,
+          connection_opts: { headers: { user_agent: api.user_agent } }
         )
 
         # Verify opts. Prefered authorization methis is auth_code. If no auth_code is present a login from

diff --git a/spec/gini-api/oauth_spec.rb b/spec/gini-api/oauth_spec.rb
@@ -18,7 +18,8 @@
       client_id: 'cid',
       client_secret: 'sec',
       oauth_site: oauth_site,
-      oauth_redirect: redirect
+      oauth_redirect: redirect,
+      user_agent: 'gini-api-ruby/spec'
     )
   end