flexirest 1.3.14 → 1.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb527b4e0686f41868c0c0074ca60f38c890367b
-  data.tar.gz: d61137bb423545b4f30a915beff69184988eb8f1
+  metadata.gz: 0704471f0511508955b73ff6c1a9f4490d6d2953
+  data.tar.gz: 2edada3ba600208f0df0f13aa06d2d91a4eb1a38
 SHA512:
-  metadata.gz: 344f2accd4f6446496d370879be78d0e2412dd77ee2cec427846503031a626afc1d0f73961ce2a26dca452a15a50c5cc3ec9d5620addda6936b90eced45b8049
-  data.tar.gz: 9cf9485402e1bbcab606f3cbe59be7c1dc07987935f14706e7385aa26e3f46155926599dbcc3109ee2e91c61efe2757c763413780fa5cb7e1b372b2152a9ef8c
+  metadata.gz: 4cd56fe8131e1dd4e835a6ca77c90896283f0441cadaaf7f4e844d51907dc8ddcbcdd39d260c12e9d95d18a12adcd3688bdf1e880c3f719b81068ecc4a4f52f7
+  data.tar.gz: e0901b4f1796580a9eb229609e8f43c5f6500bdef5819857a22d1a3279fc19669cbd49d6069fbd65627d3352c420026e98b272aa980d9f22b209561e71d833cf

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.15
+
+Feature:
+
+- Allows setting of the ApiAuth `:digest` or `:override_http_method` if v2.0 or above of ApiAuth is installed (thanks to Alan Ruth for the request).
+
 ## 1.3.14
 
 Feature:

data/README.md

@@ -538,6 +538,14 @@ end
 
 For more information on how to generate an access id and secret key please read the [Api-Auth](https://github.com/mgomes/api_auth) documentation.
 
+If you want to specify either the `:digest` or `:override_http_method` to ApiAuth, you can pass these in as options after the access ID and secret key, for example:
+
+```ruby
+class Person < Flexirest::Base
+  api_auth_credentials('123456', 'abcdef', digest: "sha256")
+end
+```
+
 ### Body Types
 
 By default Flexirest puts the body in to normal CGI parameters in K=V&K2=V2 format.  However, if you want to use JSON for your PUT/POST requests, you can use either (the other option, the default, is `:form_encoded`):

data/lib/flexirest/configuration.rb

@@ -10,6 +10,7 @@ module Flexirest
       @lazy_load = false
       @api_auth_access_id = nil
       @api_auth_secret_key = nil
+      @api_auth_options = {}
 
       def base_url(value = nil)
         @base_url ||= nil
@@ -136,7 +137,7 @@ module Flexirest
         value ? @whiny_missing = value : @whiny_missing
       end
 
-      def api_auth_credentials(access_id, secret_key)
+      def api_auth_credentials(access_id, secret_key, options = {})
         begin
           require 'api-auth'
         rescue LoadError
@@ -145,6 +146,7 @@ module Flexirest
 
         @api_auth_access_id = access_id
         @api_auth_secret_key = secret_key
+        @api_auth_options = options
       end
 
       def using_api_auth?
@@ -172,6 +174,16 @@ module Flexirest
         return nil
       end
 
+      def api_auth_options
+        if !@api_auth_options.nil?
+          return @api_auth_options
+        elsif self.superclass.respond_to?(:api_auth_options)
+          return self.superclass.api_auth_options
+        end
+
+        return {}
+      end
+
       def verbose!
         @verbose = true
       end

data/lib/flexirest/connection.rb

@@ -116,6 +116,15 @@ module Flexirest
 
     def sign_request(request, api_auth)
       return if api_auth[:api_auth_access_id].nil? || api_auth[:api_auth_secret_key].nil?
+      ApiAuth.sign!(
+        request,
+        api_auth[:api_auth_access_id],
+        api_auth[:api_auth_secret_key],
+        api_auth[:api_auth_options])
+    rescue ArgumentError
+      if api_auth[:api_auth_options] && api_auth[:api_auth_options].keys.size > 0
+        Flexirest::Logger.warn("Specifying Api-Auth options isn't supported with your version of ApiAuth")
+      end
       ApiAuth.sign!(
         request,
         api_auth[:api_auth_access_id],

data/lib/flexirest/connection_manager.rb

@@ -26,7 +26,7 @@ module Flexirest
       end
       session = ConnectionManager.get_connection(base_url).session
       session.in_parallel do
-        yield
+        yield if block_given?
       end
     end
 

data/lib/flexirest/request.rb

@@ -75,6 +75,14 @@ module Flexirest
       end
     end
 
+    def api_auth_options
+      if object_is_class?
+        @object.api_auth_options
+      else
+        @object.class.api_auth_options
+      end
+    end
+
     def username
       if object_is_class?
         @object.username
@@ -338,7 +346,8 @@ module Flexirest
       if using_api_auth?
         request_options[:api_auth] = {
           :api_auth_access_id => api_auth_access_id,
-          :api_auth_secret_key => api_auth_secret_key
+          :api_auth_secret_key => api_auth_secret_key,
+          :api_auth_options => api_auth_options
         }
       end
       if @method[:options][:timeout]

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.14"
+  VERSION = "1.3.15"
 end

data/spec/lib/configuration_spec.rb

@@ -157,11 +157,18 @@ describe Flexirest::Configuration do
       it "should be false using_api_auth?" do
         expect(Flexirest::Base.using_api_auth?).to be_falsey
       end
+
+      it "should raise Flexirest::MissingOptionalLibraryError if api-auth isn't installed" do
+        expect(ConfigurationExample).to receive(:require).with("api-auth").and_raise(LoadError)
+        expect {
+          ConfigurationExample.api_auth_credentials('id123', 'secret123', digest: "sha256")
+        }.to raise_error(Flexirest::MissingOptionalLibraryError)
+      end
     end
 
     context 'setting api auth credentials' do
       before(:each) do
-        ConfigurationExample.api_auth_credentials('id123', 'secret123')
+        ConfigurationExample.api_auth_credentials('id123', 'secret123', digest: "sha256")
       end
 
       it "should remember setting using_api_auth?" do
@@ -176,6 +183,15 @@ describe Flexirest::Configuration do
         expect(ConfigurationExample.api_auth_secret_key).to eq('secret123')
       end
 
+      it "should remember setting api_auth_options" do
+        expect(ConfigurationExample.api_auth_options).to eq({digest: "sha256"})
+      end
+
+      it "should return an empty hash for api_auth_options if it got reset to nil" do
+        ConfigurationExample.instance_variable_set(:@api_auth_options, nil)
+        expect(ConfigurationExample.api_auth_options).to eq({})
+      end
+
       it "should inherit api_auth_credentials when not set" do
         class ConfigurationExtension < ConfigurationExample
         end
@@ -248,7 +264,6 @@ describe Flexirest::Configuration do
 
       ConfigurationExample.faraday_config.call(faraday_double)
     end
-
   end
 
 end

data/spec/lib/connection_manager_spec.rb

@@ -34,10 +34,18 @@ describe Flexirest::ConnectionManager do
     expect(found_connection).to eq(connection)
   end
 
-  it "should call 'in_parllel' for a session and yield procedure inside that block" do
+  it "should call 'in_parallel' for a session and yield procedure inside that block" do
     Flexirest::Base.adapter = :typhoeus
-    session = Flexirest::ConnectionManager.get_connection("http://www.example.com").session
+    Flexirest::ConnectionManager.get_connection("http://www.example.com").session
     expect { |b| Flexirest::ConnectionManager.in_parallel("http://www.example.com", &b)}.to yield_control
     Flexirest::Base._reset_configuration!
   end
+
+  it "should raise Flexirest::MissingOptionalLibraryError if Typhous isn't available" do
+    Flexirest::Base.adapter = :typhoeus
+    Flexirest::ConnectionManager.get_connection("http://www.example.com").session
+    expect(Flexirest::ConnectionManager).to receive(:require).and_raise(LoadError)
+    expect { Flexirest::ConnectionManager.in_parallel("http://www.example.com")}.to raise_error(Flexirest::MissingOptionalLibraryError)
+    Flexirest::Base._reset_configuration!
+  end
 end

data/spec/lib/connection_spec.rb

@@ -111,7 +111,7 @@ describe Flexirest::Connection do
     it 'should set a custom timeout' do
       stub_request(:get, "www.example.com/foo")
         .to_return(body: "{result:true}")
-      expect_any_instance_of(Flexirest::Connection).to receive(:set_per_request_timeout)
+      expect_any_instance_of(Flexirest::Connection).to receive(:set_per_request_timeout).and_call_original
       @connection.get("/foo", {:timeout => "5"})
     end
   end
@@ -124,7 +124,8 @@ describe Flexirest::Connection do
       @options = {
         :api_auth => {
           :api_auth_access_id => 'id123',
-          :api_auth_secret_key => 'secret123'
+          :api_auth_secret_key => 'secret123',
+          :api_auth_options => {}
         }
       }
 
@@ -142,7 +143,37 @@ describe Flexirest::Connection do
         .with(:headers => @default_headers)
         .to_return(body: "{result:true}")
       result = @connection.get("/foo", @options)
-      expect(result.env.request_headers['Authorization']).to eq("APIAuth id123:PMWBThkB8vKbvUccHvoqu9G3eVk=")
+      auth_header = result.env.request_headers['Authorization']
+      expect(auth_header == "APIAuth id123:TQiQIW6vVaDC5jvh99uTNkxIg6Q=" || auth_header == "APIAuth id123:PMWBThkB8vKbvUccHvoqu9G3eVk=").to be_truthy
+    end
+
+    if Gem.loaded_specs["api-auth"].version.to_s >= "2.0.0"
+      it 'should have an Authorization header with a custom digest method' do
+        puts Gem.loaded_specs["api-auth"].version
+        @options[:api_auth][:api_auth_options] = {
+          digest: "sha256"
+        }
+        stub_request(:get, "www.example.com/foo")
+          .with(:headers => @default_headers)
+          .to_return(body: "{result:true}")
+        result = @connection.get("/foo", @options)
+        expect(result.env.request_headers['Authorization']).to eq("APIAuth-HMAC-SHA256 id123:fDrJfQ1fOoPFHtzhqqdHby+v6bbn2K8b2HR5AKo3vmg=")
+      end
+    end
+
+    it "should warn about using custom digest methods with an Authorization header if ApiAuth doesn't support it" do
+      @options[:api_auth][:api_auth_options] = {
+        digest: "sha256"
+      }
+      stub_request(:get, "www.example.com/foo")
+        .with(:headers => @default_headers)
+        .to_return(body: "{result:true}")
+      expect(ApiAuth).to receive(:sign!).once.with(anything, anything, anything, {digest: "sha256"}).and_raise(ArgumentError)
+      expect(ApiAuth).to receive(:sign!).once.with(anything, anything, anything).and_call_original
+      expect(Flexirest::Logger).to receive(:warn)
+      result = @connection.get("/foo", @options)
+      auth_header = result.env.request_headers['Authorization']
+      expect(auth_header == "APIAuth id123:TQiQIW6vVaDC5jvh99uTNkxIg6Q=" || auth_header == "APIAuth id123:PMWBThkB8vKbvUccHvoqu9G3eVk=").to be_truthy
     end
 
     it 'should have an Content-MD5 header' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.14
+  version: 1.3.15
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler