uploadcare-ruby 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a64d207f7ef4f89a13f68834cea937420cc9f3a8
-  data.tar.gz: 4dfa8a074d60bc1a37651fb5c3f138799fe38154
+  metadata.gz: ad96fa0d1ad6cea7d89b3b1bab8c78b9cf065491
+  data.tar.gz: 34783372b519d4b381b915ddcfe95a0e379d69ab
 SHA512:
-  metadata.gz: b23740f26de3e0eeffdb832e431f0a4f739c089afb23f6e9d60a880e1ea2cb497e8288684c8abf96ee4a3daeaaeaea571723e18970fe979dbb1fea77dde4c07f
-  data.tar.gz: 4552d01fa016da894a2ed61e02f4ead93723b65faa76014ba61ef8af673fa20a61203831efe89e1aa552dfc3cdd39c3abe83622ea9ef93ce6f70e274a261f70f
+  metadata.gz: 9336a0ae85297a8e41ad81de42438f4590bb5a08aa0fb1766cbc2d48a09df260a2f38f63174b7549f9fad00961306bf38fa29fb69503fe75d79a394f1ef3520b
+  data.tar.gz: 7d1caa97fdd3126394ddfa57dfed635ecd4b7c564331e5e92b072b8425d72a4f4a40a1ab2c592e00fd733aa7430733fd0e3d973fb3b404866e11da0d448b65c3

data/.gitignore

@@ -3,4 +3,4 @@ Gemfile.lock
 .ruby-version
 
 *.DS_Store
-*.gem
+*.gem

data/CHANGELOG.md

@@ -1,13 +1,37 @@
-#Changelog
+# Changelog
+All notable changes to this project will be documented in this file.
 
-### 1.1.0, 21.03.2017
+The format is based now on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-- Deprecated `Uploadcare::Api::File#copy` in favor of `#internal_copy` and `#external_copy`.
-- Added to new methods to Uploadcare::Api::File, #internal_copy and #external_copy.
+
+### [1.2.1] - 2018-05-24
+
+### Changed
+- Allow user to override User-Agent header
+- User-Agent format reports gem name, version and environment
+
+
+## 1.1.0 - 2017-03-21
+
+### Added
+- Added to new methods to `Uploadcare::Api::File`, `#internal_copy` and `#external_copy`.
 - Added support of [secure authorization](https://uploadcare.com/documentation/rest/#request) for REST API. It is now used by default (can be overriden in config)
-- Fixed middleware names that could break other gems ([#13](https://github.com/uploadcare/uploadcare-ruby/issues/13}).
 
-### 1.0.6, 30.01.2017
+### Fixed
+- Fixed middleware names that could break other gems ([#13](https://github.com/uploadcare/uploadcare-ruby/issues/13)).
+
+### Deprecated
+- `Uploadcare::Api::File#copy` in favor of `#internal_copy` and `#external_copy`.
+
+
+## 1.0.6 - 2017-01-30
+
+### Added
+- Ruby version and public API key sent via User-Agent header (can be overriden in config)
+
+### Fixed
+- Incorrect dependencies
+
 
-- Fixed incorrect dependencies
-- Added ruby version and public API key to User-Agent header (can be overriden in config)
+[1.2.1]: https://github.com/uploadcare/uploadcare-ruby/compare/6dde...v1.2.1

data/lib/uploadcare.rb

@@ -17,6 +17,7 @@ module Uploadcare
       auth_scheme: :secure
     }
 
+  warn '[DEPRECATION] `Uploadcare::USER_AGENT` constant is deprecated and will be removed in version 3.0'
   USER_AGENT = "uploadcare-ruby/#{Gem.ruby_version}/#{Uploadcare::VERSION}"
 
 
@@ -25,7 +26,7 @@ module Uploadcare
   end
 
   def self.user_agent(options={})
-    return options[:user_agent].to_s if options[:user_agent]
-    [USER_AGENT, options[:public_key]].join('/')
+    warn '[DEPRECATION] `Uploadcare::user_agent` method is deprecated and will be removed in version 3.0'
+    UserAgent.new.call(options)
   end
 end

data/lib/uploadcare/rest/connections/api_connection.rb

@@ -10,7 +10,7 @@ module Uploadcare
           auth_strategy = Auth.strategy(options)
 
           frd.headers['Accept'] = "application/vnd.uploadcare-v#{options[:api_version]}+json"
-          frd.headers['User-Agent'] = Uploadcare::user_agent(options)
+          frd.headers['User-Agent'] = UserAgent.new.call(options)
 
           # order of middleware matters!
 
@@ -27,7 +27,6 @@ module Uploadcare
           frd.adapter :net_http # actually, default adapter, just to be clear
         end
       end
-
     end
   end
 end

data/lib/uploadcare/rest/connections/upload_connection.rb

@@ -10,7 +10,7 @@ module Uploadcare
           frd.request :multipart
           frd.request :url_encoded
           frd.adapter :net_http
-          frd.headers['User-Agent'] = Uploadcare::user_agent(options)
+          frd.headers['User-Agent'] = UserAgent.new.call(options)
 
           frd.response :uploadcare_raise_error
           frd.response :uploadcare_parse_json
@@ -18,4 +18,4 @@ module Uploadcare
       end
     end
   end
-end
+end

data/lib/uploadcare/utils/user_agent.rb

@@ -0,0 +1,44 @@
+module Uploadcare
+  # Determines User-Agent string either taking it from settings or building
+  # in accordance with common Uploadcare format
+  #
+  class UserAgent
+    # @param options [Hash]
+    # @option options [String] :user_agent (nil)
+    # @option options [String] :public_key (nil)
+    # @option options [String] :user_agent_environment (nil)
+    # @return [String]
+    #
+    def call(options)
+      return options[:user_agent].to_s if options[:user_agent]
+
+      user_agent_string(
+        options.fetch(:public_key, nil),
+        options.fetch(:user_agent_environment, {})
+      )
+    end
+
+    private
+
+    def user_agent_string(public_key, extensions)
+      format(
+        '%<library>s/%<pubkey>s (%<environment>s)',
+        library: versioned('UploadcareRuby', Uploadcare::VERSION),
+        pubkey: public_key,
+        environment: environment_string(extensions)
+      )
+    end
+
+    def environment_string(extensions)
+      [
+        versioned('Ruby', Gem.ruby_version),
+        versioned(extensions[:framework_name], extensions[:framework_version]),
+        versioned(extensions[:extension_name], extensions[:extension_version])
+      ].compact.join('; ')
+    end
+
+    def versioned(name, version = nil)
+      name ? [name, version].compact.join('/') : nil
+    end
+  end
+end

data/lib/uploadcare/version.rb

@@ -1,3 +1,3 @@
 module Uploadcare
-  VERSION = "1.1.0"
+  VERSION = "1.2.1"
 end

data/spec/rest/api_connection_spec.rb

@@ -19,7 +19,7 @@ describe Uploadcare::Connections::ApiConnection do
     end
 
     it 'includes correct User-Agent header' do
-      expected = Uploadcare::user_agent(settings)
+      expected = Uploadcare::UserAgent.new.call(settings)
       expect(subject['User-Agent']).to eq expected
     end
   end

data/spec/uploadcare_spec.rb

@@ -1,20 +1,16 @@
 require 'spec_helper'
 
 describe Uploadcare do
-
   describe '::user_agent' do
-    context "if :user_agent is specified in method's options" do
-      it "returns it's stringified version" do
-        expect( Uploadcare.user_agent(user_agent: 123) ).to eq '123'
-      end
-    end
+    subject(:user_agent) { described_class.user_agent(options) }
+    let(:options) { {user_agent: 'user/agent'} }
+    let(:user_agent_builder) { instance_double('Uploadcare::UserAgent') }
 
-    context "if user_agent is not specified in method's options" do
-      it 'builds user-agent from ruby version, gem version and public key' do
-        expected = /#{Gem.ruby_version}\/#{described_class::VERSION}\/test/
-        expect( Uploadcare.user_agent(public_key: 'test') ).to match(expected)
-      end
+    it 'returns user agent string' do
+      allow(Uploadcare::UserAgent).to receive(:new) { user_agent_builder }
+      expect(user_agent_builder).to receive(:call).with(options) { 'user/agent' }
+
+      expect(user_agent).to eq('user/agent')
     end
   end
-
 end

data/spec/utils/user_agent_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Uploadcare::UserAgent do
+  subject(:user_agent) { described_class.new.call(options) }
+
+  before do
+    stub_const('Uploadcare::VERSION', '123')
+    allow(Gem).to receive(:ruby_version) { '456' }
+  end
+
+  context 'when user_agent option is set' do
+    let(:options) do
+      { user_agent: 'predefined user agent' }
+    end
+
+    it { is_expected.to eq('predefined user agent') }
+  end
+
+  context 'when user_agent_environment option is set' do
+    let(:options) do
+      {
+        public_key: 'pubkey',
+        user_agent_environment: {
+          framework_name: 'rails',
+          framework_version: '5.1.0',
+          extension_name: 'UploadcareRails',
+          extension_version: '1.1.0'
+        }
+      }
+    end
+
+    it do
+      is_expected.to eq(
+        'UploadcareRuby/123/pubkey (Ruby/456; rails/5.1.0; UploadcareRails/1.1.0)'
+      )
+    end
+  end
+
+  context 'when user_agent_environment option is not set' do
+    let(:options) do
+      { public_key: 'pubkey' }
+    end
+
+    it { is_expected.to eq('UploadcareRuby/123/pubkey (Ruby/456)') }
+  end
+end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
-- '@rastyagaev (Vadim Rastyagaev)'
-- '@dimituri (Dimitry Solovyov)'
-- '@romanonthego (Roman Dubinin)'
+- "@rastyagaev (Vadim Rastyagaev)"
+- "@dimituri (Dimitry Solovyov)"
+- "@romanonthego (Roman Dubinin)"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   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: mime-types
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: 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'
 description: "                        Ruby wrapper for Uploadcare service API. \n
@@ -119,9 +119,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .DS_Store
-- .gitignore
-- .travis.yml
+- ".DS_Store"
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -151,6 +151,7 @@ files:
 - lib/uploadcare/rest/middlewares/parse_json_middleware.rb
 - lib/uploadcare/rest/middlewares/raise_error_middleware.rb
 - lib/uploadcare/utils/parser.rb
+- lib/uploadcare/utils/user_agent.rb
 - lib/uploadcare/version.rb
 - spec/api/raw_api_spec.rb
 - spec/resources/file_list_spec.rb
@@ -169,6 +170,7 @@ files:
 - spec/uploading/uploading_multiple_spec.rb
 - spec/uploading/uploading_spec.rb
 - spec/utils/parser_spec.rb
+- spec/utils/user_agent_spec.rb
 - spec/view.png
 - spec/view2.jpg
 - uploadcare-ruby.gemspec
@@ -184,17 +186,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby gem for Uploadcare
@@ -216,5 +218,6 @@ test_files:
 - spec/uploading/uploading_multiple_spec.rb
 - spec/uploading/uploading_spec.rb
 - spec/utils/parser_spec.rb
+- spec/utils/user_agent_spec.rb
 - spec/view.png
 - spec/view2.jpg