api-auth 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a70b97184e4a7a11031e6c7bf62f26227da7e1cd
-  data.tar.gz: d6471c1d3d487b5b24106765d7eedde455e7c534
+  metadata.gz: 79cbdc86c27b9748d521ca8e0efe2038efa0641b
+  data.tar.gz: 2cc39d41382118e60496a8c9ca9693fb6a4baf02
 SHA512:
-  metadata.gz: c4d9d1eb76a1c1de3c65640dc9f44e877bdc62a7faad7773009527cf48034d58dadc304712bd54d70d3c3b934d240f0ce1d0951064183987e1f340066349a8a7
-  data.tar.gz: 13356a10470f99e4d2ab9104ca073cc92cb7f60f9f3696194013a13824b15e060a05ce1a102ca236bd4101a8e6e4523b9043849977a65a6d63f98eaf3a1f10d9
+  metadata.gz: f6f7a9271d443ffc86bb0cbb3f674febbe860832429e677a54c7e03cea418597768b746b8ce90f51789be20f21f97011be1e6ff50f1ba4ec3e665cc4351c6da7
+  data.tar.gz: 28873d74e56b7e7cb9b8aee01811841971a79a2d3fa459ca399ac28088495e9e29f26d35216369db5fd626e9f8917877dbcc53d40cb08a23c66bb48f5a6f4975

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+# 1.5.0 (2016-01-21)
+- Added a sign_with_http_method configuration option to the ActiveResource
+  rails tie to correspond to passing the `:with_http_method => true` into
+  `ApiAuth.sign!`
+
 # 1.4.1 (2016-01-04)
-- Fixed an issue where getters wouldn't immdiately have the correct value after
+- Fixed an issue where getters wouldn't immediately have the correct value after
   setting a date or content md5 in some of the request drivers (#91)
 
 # 1.4 (2015-12-16)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.5.0

data/gemfiles/rails_23.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_30.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_31.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_32.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_41.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/gemfiles/rails_42.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    api-auth (1.4.1)
+    api-auth (1.5.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/api_auth/railtie.rb

@@ -3,21 +3,21 @@ module ApiAuth
   # Integration with Rails
   #
   class Rails # :nodoc:
-    
+
     module ControllerMethods # :nodoc:
-      
+
       module InstanceMethods # :nodoc:
-        
+
         def get_api_access_id_from_request
           ApiAuth.access_id(request)
         end
-        
+
         def api_authenticated?(secret_key)
           ApiAuth.authentic?(request, secret_key)
         end
-        
+
       end
-      
+
       unless defined?(ActionController)
         begin
           require 'rubygems'
@@ -29,65 +29,71 @@ module ApiAuth
           nil
         end
       end
-      
-      if defined?(ActionController::Base)        
+
+      if defined?(ActionController::Base)
         ActionController::Base.send(:include, ControllerMethods::InstanceMethods)
       end
-      
+
     end # ControllerMethods
-  
+
     module ActiveResourceExtension  # :nodoc:
-    
+
       module ActiveResourceApiAuth # :nodoc:
-      
+
         def self.included(base)
           base.extend(ClassMethods)
-          
+
           if base.respond_to?('class_attribute')
             base.class_attribute :hmac_access_id
             base.class_attribute :hmac_secret_key
             base.class_attribute :use_hmac
+            base.class_attribute :sign_with_http_method
           else
-            base.class_inheritable_accessor :hmac_access_id            
-            base.class_inheritable_accessor :hmac_secret_key            
-            base.class_inheritable_accessor :use_hmac            
+            base.class_inheritable_accessor :hmac_access_id
+            base.class_inheritable_accessor :hmac_secret_key
+            base.class_inheritable_accessor :use_hmac
+            base.class_inheritable_accessor :sign_with_http_method
           end
-        
+
         end
-      
+
         module ClassMethods
 
-          def with_api_auth(access_id, secret_key)
+          def with_api_auth(access_id, secret_key, options = {})
+            sign_with_http_method = options[:sign_with_http_method] || false
+
             self.hmac_access_id = access_id
             self.hmac_secret_key = secret_key
+            self.sign_with_http_method = sign_with_http_method
             self.use_hmac = true
-          
+
             class << self
               alias_method_chain :connection, :auth
             end
           end
-        
-          def connection_with_auth(refresh = false) 
+
+          def connection_with_auth(refresh = false)
             c = connection_without_auth(refresh)
             c.hmac_access_id = self.hmac_access_id
             c.hmac_secret_key = self.hmac_secret_key
             c.use_hmac = self.use_hmac
+            c.sign_with_http_method = self.sign_with_http_method
             c
-          end   
-               
+          end
+
         end # class methods
-      
+
         module InstanceMethods
         end
-      
+
       end # BaseApiAuth
-    
+
       module Connection
-      
+
         def self.included(base)
           base.send :alias_method_chain, :request, :auth
           base.class_eval do
-            attr_accessor :hmac_secret_key, :hmac_access_id, :use_hmac
+            attr_accessor :hmac_secret_key, :hmac_access_id, :use_hmac, :sign_with_http_method
           end
         end
 
@@ -96,17 +102,17 @@ module ApiAuth
             h = arguments.last
             tmp = "Net::HTTP::#{method.to_s.capitalize}".constantize.new(path, h)
             tmp.body = arguments[0] if arguments.length > 1
-            ApiAuth.sign!(tmp, hmac_access_id, hmac_secret_key)
+            ApiAuth.sign!(tmp, hmac_access_id, hmac_secret_key, {:with_http_method => (sign_with_http_method || false)})
             arguments.last['Content-MD5'] = tmp['Content-MD5'] if tmp['Content-MD5']
             arguments.last['DATE'] = tmp['DATE']
             arguments.last['Authorization'] = tmp['Authorization']
           end
-        
+
           request_without_auth(method, path, *arguments)
         end
-      
+
       end # Connection
-          
+
       unless defined?(ActiveResource)
         begin
           require 'rubygems'
@@ -116,14 +122,14 @@ module ApiAuth
           nil
         end
       end
-    
+
       if defined?(ActiveResource)
-        ActiveResource::Base.send(:include, ActiveResourceApiAuth)        
+        ActiveResource::Base.send(:include, ActiveResourceApiAuth)
         ActiveResource::Connection.send(:include, Connection)
-      end 
-        
+      end
+
     end # ActiveResourceExtension
-  
+
   end # Rails
-  
+
 end # ApiAuth

data/spec/railtie_spec.rb

@@ -116,7 +116,7 @@ describe "Rails integration" do
 
     it "should send signed requests automagically" do
       timestamp = Time.parse("Mon, 23 Jan 1984 03:29:56 GMT")
-      expect(Time).to receive(:now).at_least(1).times.and_return(timestamp)
+      allow(Time).to receive(:now).at_least(1).times.and_return(timestamp)
       ActiveResource::HttpMock.respond_to do |mock|
         mock.get "/test_resources/1.xml",
           {
@@ -126,9 +126,34 @@ describe "Rails integration" do
           },
           { :id => "1" }.to_xml(:root => 'test_resource')
       end
+      expect(ApiAuth).to receive(:sign!).with(anything, "1044", API_KEY_STORE["1044"], { :with_http_method => false }).and_call_original
       TestResource.find(1)
     end
 
+    context "when telling it to include the http method in the signature" do
+      class TestResourceForHttpMethod < ActiveResource::Base
+        with_api_auth "1044", API_KEY_STORE["1044"], :sign_with_http_method => true
+        self.site = "http://localhost/"
+        self.format = :xml
+      end
+
+      it "signs with the http method" do
+        timestamp = Time.parse("Mon, 23 Jan 1984 03:29:56 GMT")
+        allow(Time).to receive(:now).at_least(1).times.and_return(timestamp)
+        ActiveResource::HttpMock.respond_to do |mock|
+          mock.get "/test_resource_for_http_methods/1.xml",
+            {
+              'Authorization' => 'APIAuth 1044:Gq190cxgKm7oWH1fc+y8+wmD9ts=',
+              'Accept' => 'application/xml',
+              'DATE' => "Mon, 23 Jan 1984 03:29:56 GMT"
+            },
+            { :id => "1" }.to_xml(:root => 'test_resource')
+        end
+        expect(ApiAuth).to receive(:sign!).with(anything, "1044", API_KEY_STORE["1044"], { :with_http_method => true }).and_call_original
+        TestResourceForHttpMethod.find(1)
+      end
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-auth
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Mauricio Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal