signature 0.1.4 → 0.1.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    signature (0.1.3)
+    signature (0.1.6)
 
 GEM
   remote: http://rubygems.org/

data/lib/signature.rb

@@ -1,5 +1,7 @@
 require 'openssl'
 
+require 'signature/query_encoder'
+
 module Signature
   class AuthenticationError < RuntimeError; end
 
@@ -18,6 +20,8 @@ module Signature
   class Request
     attr_accessor :path, :query_hash
 
+    include QueryEncoder
+
     # http://www.w3.org/TR/NOTE-datetime
     ISO8601 = "%Y-%m-%dT%H:%M:%SZ"
 
@@ -182,7 +186,9 @@ module Signature
         # Exclude signature from signature generation!
         hash.delete("auth_signature")
 
-        hash.keys.sort.map { |k| "#{k}=#{hash[k]}" }.join("&")
+        hash.sort.map do |k, v|
+          QueryEncoder.encode_param_without_escaping(k, v)
+        end.join('&')
       end
 
       def validate_version!

data/lib/signature/query_encoder.rb

@@ -0,0 +1,47 @@
+module Signature
+  # Query string encoding extracted with thanks from em-http-request
+  module QueryEncoder
+    class << self
+      # URL encodes query parameters:
+      # single k=v, or a URL encoded array, if v is an array of values
+      def encode_param(k, v)
+        if v.is_a?(Array)
+          v.map { |e| escape(k) + "[]=" + escape(e) }.join("&")
+        else
+          escape(k) + "=" + escape(v)
+        end
+      end
+      
+      # Like encode_param, but doesn't url escape keys or values
+      def encode_param_without_escaping(k, v)
+        if v.is_a?(Array)
+          v.map { |e| k + "[]=" + e }.join("&")
+        else
+          k + "=" + v
+        end
+      end
+
+      private
+
+      def escape(s)
+        if defined?(EscapeUtils)
+          EscapeUtils.escape_url(s.to_s)
+        else
+          s.to_s.gsub(/([^a-zA-Z0-9_.-]+)/n) {
+            '%'+$1.unpack('H2'*bytesize($1)).join('%').upcase
+          }
+        end
+      end
+
+      if ''.respond_to?(:bytesize)
+        def bytesize(string)
+          string.bytesize
+        end
+      else
+        def bytesize(string)
+          string.size
+        end
+      end
+    end
+  end
+end

data/lib/signature/version.rb

@@ -1,3 +1,3 @@
 module Signature
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/spec/signature_spec.rb

@@ -60,6 +60,21 @@ describe Signature do
       @request.sign(@token)[:auth_signature].should == @signature
     end
 
+    it "should generate correct string when query hash contains array" do
+      @request.query_hash = {
+        "things" => ["thing1", "thing2"]
+      }
+      @request.send(:string_to_sign).should == "POST\n/some/path\nthings[]=thing1&things[]=thing2"
+    end
+
+    # This may well change in auth version 2
+    it "should not escape keys or values in the query string" do
+      @request.query_hash = {
+        "key;" => "value@"
+      }
+      @request.send(:string_to_sign).should == "POST\n/some/path\nkey;=value@"
+    end
+
     it "should use the path to generate signature" do
       @request.path = '/some/other/path'
       @request.sign(@token)[:auth_signature].should_not == @signature

metadata

@@ -1,62 +1,55 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: signature
-version: !ruby/object:Gem::Version 
-  hash: 3713544621248369165
+version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
 platform: ruby
-authors: 
+authors:
 - Martyn Loughran
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-15 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1156501143490752456
-        segments: 
-        - 2
-        - 9
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: em-spec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 2002549777813010636
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple key/secret based authentication for apis
-email: 
+email:
 - me@mloughran.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -65,43 +58,35 @@ files:
 - README.md
 - Rakefile
 - lib/signature.rb
+- lib/signature/query_encoder.rb
 - lib/signature/version.rb
 - signature.gemspec
 - spec/signature_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/mloughran/signature
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple key/secret based authentication for apis
-test_files: 
+test_files:
 - spec/signature_spec.rb
 - spec/spec_helper.rb