ey_api_hmac 0.3.0 → 0.3.1

data/README.md

@@ -30,3 +30,33 @@ Rack-Client middleware:
 ```
 
 this will add the correct Authorization header to all requests made with this rack-client.
+
+# Imlementation details:
+
+before signed:
+
+    {"REQUEST_URI"=>"http://example.com/api/1/service_accounts/1324/messages", "PATH_INFO"=>"/api/1/service_accounts/1324/messages", "CONTENT_TYPE"=>"application/json", "HTTP_ACCEPT"=>"application/json", "REQUEST_METHOD"=>"POST", "HTTP_DATE"=>"Thu, 15 Dec 2011 23:50:33 GMT", "rack.input"=>#<StringIO:0x007fd9239f6998>}
+
+request body:
+
+    {"message":{"message_type":"status","subject":"Everything looks good.","body":null}}
+
+auth_id:
+
+    123bc211233eabc
+
+auth_key:
+
+    abc474e3fc9bddf6d41236b70cc5a952f3681166e1239214740d13eecd12318f7b8d27123b61eabc
+
+canonical_string:
+
+    "POST\napplication/json\ne8fa80541e3726e2cf4c71d07a7bd9fd\nThu, 15 Dec 2011 23:50:33 GMT\n/api/1/service_accounts/1324/messages"
+
+signature:
+
+    UZDkXszu4dp6Gz2TEGcy/cVt0R0=
+
+now signed:
+
+    {"REQUEST_URI"=>"http://example.com/api/1/service_accounts/1324/messages", "PATH_INFO"=>"/api/1/service_accounts/1324/messages", "CONTENT_TYPE"=>"application/json", "HTTP_ACCEPT"=>"application/json", "REQUEST_METHOD"=>"POST", "HTTP_DATE"=>"Thu, 15 Dec 2011 23:50:33 GMT", "rack.input"=>#<StringIO:0x007fd9239f6998>, "HTTP_AUTHORIZATION"=>"AuthHMAC 123bc211233eabc:UZDkXszu4dp6Gz2TEGcy/cVt0R0="}

data/lib/ey_api_hmac/version.rb

@@ -1,5 +1,5 @@
 module EY
   module ApiHMAC
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/ey_api_hmac.rb

@@ -25,7 +25,7 @@ module EY
       if env["REQUEST_URI"]
         parts << URI.parse(env["REQUEST_URI"]).path
       else
-        parts << expect["PATH_INFO"]
+        parts << (env["SCRIPT_NAME"] + expect["PATH_INFO"])
       end
       parts.join("\n")
     end

data/spec/api_auth_spec.rb

@@ -73,6 +73,14 @@ describe EY::ApiHMAC::ApiAuth do
         AuthHMAC.canonical_string(@request).should == expected
         EY::ApiHMAC.canonical_string(@env).should == expected
       end
+      it "should generate a canonical string with SCRIPT_NAME" do
+        env = @env.merge("SCRIPT_NAME" => "/api")
+        env.delete("REQUEST_URI")
+        expected = "PUT\ntext/plain\n78b9d09661da64f0bc6c146c524bae4a\nThu, 10 Jul 2008 03:29:56 GMT\n/api/path/to/put"
+        request = Rack::Request.new(env)
+        AuthHMAC.canonical_string(request).should == expected
+        EY::ApiHMAC.canonical_string(env).should == expected
+      end
     end
 
     describe ".signature" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ey_api_hmac
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2011-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-client
-  requirement: &70125212725320 !ruby/object:Gem::Requirement
+  requirement: &2161109420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70125212725320
+  version_requirements: *2161109420
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70125212724900 !ruby/object:Gem::Requirement
+  requirement: &2161108660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70125212724900
+  version_requirements: *2161108660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70125212724480 !ruby/object:Gem::Requirement
+  requirement: &2161107340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70125212724480
+  version_requirements: *2161107340
 description: basic wrapper for rack-client + middlewares for HMAC auth + helpers for
   SSO auth
 email:
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ey_api_hmac
-rubygems_version: 1.8.10
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: HMAC Rack basic implementation for Engine Yard services