uri_signer 0.0.1

data/spec/request_signature_spec.rb

@@ -0,0 +1,146 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/uri_signer'))
+
+describe UriSigner::RequestSignature do
+  before do
+    @method = "GET"
+    @base_uri = 'https://example.com/members.json'
+    @query_params = { "page" => 5, "per_page" => 15 }
+  end
+
+  subject { described_class.new(@method, @base_uri, @query_params) }
+
+  it "responds to #http_method" do
+    subject.should respond_to(:http_method)
+  end
+
+  it "responds to #base_uri" do
+    subject.should respond_to(:base_uri)
+  end
+
+  it "responds to #encoded_base_uri" do
+    subject.should respond_to(:encoded_base_uri)
+  end
+
+  it "responds to #query_params" do
+    subject.should respond_to(:query_params)
+  end
+
+  it "responds to #query_params?" do
+    subject.should respond_to(:query_params?)
+  end
+
+  it "responds to #encoded_query_params" do
+    subject.should respond_to(:encoded_query_params)
+  end
+
+  it "responds to #signature" do
+    subject.should respond_to(:signature)
+  end
+
+  context "with duplicate values for a query string param" do
+    before do
+      @query_params = { "format" => ['json', 'json'], 'where' => ["name:nate", "name:nate"] }
+    end
+
+    subject { described_class.new(@method, @base_uri, @query_params) }
+
+    it "returns the encoded query params" do
+      subject.encoded_query_params.should == "format%3Djson%26format%3Djson%26where%3Dname%3Anate%26where%3Dname%3Anate"
+    end
+  end
+
+  context "with multiple keys in the query string" do
+    before do
+      @query_params = {"order"=>["name:desc", "id:desc"], "where"=>["name:nate", "id:123"]}
+    end
+
+    subject { described_class.new(@method, @base_uri, @query_params) }
+
+    it "returns the #signature string" do
+      subject.signature.should == "GET&https%3A%2F%2Fexample.com%2Fmembers.json&order%3Dname%3Adesc%26order%3Did%3Adesc%26where%3Dname%3Anate%26where%3Did%3A123"
+    end
+  end
+
+  context "Handling the signature" do
+    it "returns the #signature string" do
+      subject.signature.should == "GET&https%3A%2F%2Fexample.com%2Fmembers.json&page%3D5%26per_page%3D15"
+    end
+
+    it "removes the trailing ampersand if not query params are provided" do
+      sig = described_class.new(@method, @base_uri, {})
+      sig.signature.should == "GET&https%3A%2F%2Fexample.com%2Fmembers.json"
+    end
+  end
+
+  context "Handling the HTTP Method" do
+    it "returns 'GET' for the #http_method" do
+      subject.http_method.should == "GET"
+    end
+
+    it "allows you to specify the HTTP method in lowercase" do
+      sig = described_class.new('get', @base_uri, @query_params)
+      sig.http_method.should == "GET"
+    end
+  end
+
+  context "Handling the base_uri" do
+    it "returns 'https://example.com/members.json' for the #base_uri" do
+      subject.base_uri.should == "https://example.com/members.json"
+    end
+
+    it "returns the #encoded_base_uri" do
+      subject.encoded_base_uri.should == "https%3A%2F%2Fexample.com%2Fmembers.json"
+    end
+  end
+
+  context "Handling the Query Params" do
+    it "returns the page and per_page query params" do
+      subject.query_params.keys.should include('page', 'per_page')
+    end
+
+    it "converts the keys to strings" do
+      sig = described_class.new(@method, @base_uri, { :page => 4, :per_page => 35 })
+      sig.query_params.keys.should include('page', 'per_page')
+    end
+
+    it "returns true for #query_params?" do
+      subject.query_params?.should be_true
+    end
+
+    it "returns the sorted and #encoded_query_params" do
+      subject.encoded_query_params.should == "page%3D5%26per_page%3D15"
+    end
+  end
+
+  context "Handling when no Query Params are provided" do
+    subject { described_class.new(@method, @base_uri, {}) }
+
+    it "returns an empty hash for query_params" do
+      subject.query_params.should == {}
+    end
+
+    it "returns false for #query_params?" do
+      subject.query_params?.should be_false
+    end
+  end
+
+  context "Validating the HTTP Method" do
+    it "raises a UriSigner::MissingHttpMethodError when empty string is provided" do
+      lambda { described_class.new('', @base_uri, @query_params) }.should raise_error(UriSigner::Errors::MissingHttpMethodError)
+    end
+
+    it "raises a UriSigner::MissingHttpMethodError when nil is provided" do
+      lambda { described_class.new(nil, @base_uri, @query_params) }.should raise_error(UriSigner::Errors::MissingHttpMethodError)
+    end
+  end
+
+  context "Validating the Base URI" do
+    it "raises a UriSigner::MissingBaseUriError when empty string is provided" do
+      lambda { described_class.new(@method, '', @query_params) }.should raise_error(UriSigner::Errors::MissingBaseUriError)
+    end
+
+    it "raises a UriSigner::MissingBaseUriError when nil is provided" do
+      lambda { described_class.new(@method, nil, @query_params) }.should raise_error(UriSigner::Errors::MissingBaseUriError)
+    end
+  end
+end

data/spec/signer_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/uri_signer'))
+
+describe UriSigner::Signer do
+  before do
+    @http_method = :get
+    @uri = "https://api.example.com/core/people.json?page=5&per_page=25&order=name:desc&select=id,name"
+    @secret = "my_secret"
+  end
+
+  subject { described_class.new(@http_method, @uri, @secret) }
+
+  it "responds to #uri" do
+    subject.should respond_to(:uri)
+  end
+
+  it "responds to #http_method" do
+    subject.should respond_to(:http_method)
+  end
+
+  it "responds to #signature" do
+    subject.should respond_to(:signature)
+  end
+
+  it "responds to #uri_with_signature" do
+    subject.should respond_to(:uri_with_signature)
+  end
+
+  it "responds to #valid?" do
+    subject.should respond_to(:valid?)
+  end
+
+  it "returns the #uri" do
+    subject.uri.should == "https://api.example.com/core/people.json?page=5&per_page=25&order=name:desc&select=id,name"
+  end
+
+  it "returns the upcased #http_method" do
+    subject.http_method.should == "GET"
+  end
+
+  it "returns the signed URI with the secret" do
+    subject.signature.should == "1AaJvChjz%2BZYJKxWsUQWNK1a%2BeGjpCs6uwQKwPw1%2FV8%3D"
+  end
+
+  context "appending the signature" do
+    it "appends the _signature on to the URI" do
+      subject.uri_with_signature.should == "https://api.example.com/core/people.json?page=5&per_page=25&order=name:desc&select=id,name&_signature=1AaJvChjz%2BZYJKxWsUQWNK1a%2BeGjpCs6uwQKwPw1%2FV8%3D"
+    end
+
+    it "appends the _signature when there are no query string params" do
+      uri = "https://api.example.com/core/people.json"
+      signer = described_class.new(@http_method, uri, @secret)
+      signer.uri_with_signature.should == "https://api.example.com/core/people.json?_signature=6G4xiABih7FGvjwB1JsYXoeETtBCOdshIu93X1hltzk%3D"
+    end
+  end
+
+  context "Validating the signature" do
+    it "returns true for #valid?" do
+      subject.valid?('1AaJvChjz%2BZYJKxWsUQWNK1a%2BeGjpCs6uwQKwPw1%2FV8%3D').should be_true
+    end
+
+    it "returns false for #valid?" do
+      subject.valid?('invalid').should be_false
+    end
+  end
+
+  context "Exception handling" do
+    it "raises a UriSigner::MissingHttpMethodError if an empty string is provided" do
+      lambda { described_class.new('', @uri, @secret) }.should raise_error(UriSigner::Errors::MissingHttpMethodError)
+    end
+
+    it "raises a UriSigner::MissingHttpMethodError if nil is provided" do
+      lambda { described_class.new(nil, @uri, @secret) }.should raise_error(UriSigner::Errors::MissingHttpMethodError)
+    end
+
+    it "raises a UriSigner::MissingUriError if an empty string is provided" do
+      lambda { described_class.new(@http_method, '', @secret) }.should raise_error(UriSigner::Errors::MissingUriError)
+    end
+
+    it "raises a UriSigner::MissingUriError if nil is provided" do
+      lambda { described_class.new(@http_method, nil, @secret) }.should raise_error(UriSigner::Errors::MissingUriError)
+    end
+
+    it "raises a UriSigner::MissingSecretError if an empty string is provided" do
+      lambda { described_class.new(@http_method, @uri, '') }.should raise_error(UriSigner::Errors::MissingSecretError)
+    end
+
+    it "raises a UriSigner::MissingSecretError if nil is provided" do
+      lambda { described_class.new(@http_method, @uri, nil) }.should raise_error(UriSigner::Errors::MissingSecretError)
+    end
+  end
+end

data/spec/unit/helpers/hash_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../lib/uri_signer'))
+
+describe UriSigner::Helpers::Hash do
+  before(:each) do
+    @hash = { :first => 'element', 'string' => 'element' }
+    @hash.extend(UriSigner::Helpers::Hash)
+  end
+
+  it "converts all keys to strings" do
+    @hash.stringify_keys.keys.should == ["first", "string"]
+  end
+end

data/spec/unit/helpers/string_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../lib/uri_signer'))
+
+describe UriSigner::Helpers::String do
+  before(:each) do
+    @string = "this is the string"
+    @string.extend(UriSigner::Helpers::String)
+  end
+
+  context "Escaping with Rack::Utils" do
+    subject  { "This & That = Your's + Mine"}
+
+    it "escapes the string properly" do
+      subject.extend(UriSigner::Helpers::String).escaped.should == "This+%26+That+%3D+Your%27s+%2B+Mine"
+    end
+  end
+
+  context "Unescaping with Rack::Utils" do
+    subject { "This+%26+That+%3D+Your%27s+%2B+Mine" }
+
+    it "unescapes the string properly" do
+      subject.extend(UriSigner::Helpers::String).unescaped.should == "This & That = Your's + Mine"
+    end
+  end
+
+  context "Base64 encoding" do
+    subject { "abcd\n" }
+
+    it "base64 encodes the string and removes the newline character at the end" do
+      Base64.stub!(:encode64).and_return("bcdf\n")
+      subject.extend(UriSigner::Helpers::String).base64_encoded.should == "bcdf"
+    end
+  end
+
+  context "URI Parsed string" do
+    subject { "https://example.com/core/person.json" }
+
+    it "returns an Addressable parsed URI" do
+      subject.extend(UriSigner::Helpers::String).to_parsed_uri.should be_a_kind_of(Addressable::URI)
+    end
+  end
+end

data/spec/uri_signature_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/uri_signer'))
+
+describe UriSigner::UriSignature do
+  before do
+    @signature_string = "GET&https://test.example.com"
+    @secret = "abcd1234"
+  end
+
+  subject { described_class.new(@signature_string, @secret) }
+
+  it "responds to #signature_string" do
+    subject.should respond_to(:signature_string)
+  end
+
+  it "responds to #signature" do
+    subject.should respond_to(:signature)
+  end
+
+  it "signs the request" do
+    # NOTE: Want to somehow refactor this when looking into the players of signing (String Helpers)
+    subject.signature.should == "KwLgbFRjaoQ8IBQs3xje6uhgyoT6gQR04YQs36lAXmk%3D"
+  end
+
+  context "Validations" do
+    it "raises UriSigner::MissingSignatureStringError when empty string is provided" do
+      lambda { described_class.new('', @secret) }.should raise_error(UriSigner::Errors::MissingSignatureStringError)
+    end
+
+    it "raises UriSigner::MissingSignatureStringError when nil is provided" do
+      lambda { described_class.new(nil, @secret) }.should raise_error(UriSigner::Errors::MissingSignatureStringError)
+    end
+
+    it "raises UriSigner::MissingSecretError when empty string is provided" do
+      lambda { described_class.new(@signature_string, '') }.should raise_error(UriSigner::Errors::MissingSecretError)
+    end
+
+    it "raises UriSigner::MissingSecretError when nil is provided" do
+      lambda { described_class.new(@signature_string, nil) }.should raise_error(UriSigner::Errors::MissingSecretError)
+    end
+  end
+end

data/uri_signer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uri_signer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uri_signer"
+  spec.version       = UriSigner::VERSION
+  spec.authors       = ["Nate Klaiber"]
+  spec.email         = ["nklaiber@kissmetrics.com"]
+  spec.description   = %q{ Handle the generation of a URI signature for API }
+  spec.summary       = %q{ Given a client secret, we can digitally sign the URL and make requests to the API. }
+  spec.homepage      = "https://github.com/kissmetrics/uri_signer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', ">=3.0.0"
+  spec.add_dependency 'rack'
+  spec.add_dependency 'addressable'
+  spec.add_dependency 'ruby-hmac'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet'
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: uri_signer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nate Klaiber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-hmac
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Handle the generation of a URI signature for API '
+email:
+- nklaiber@kissmetrics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc.sample
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uri_signer.rb
+- lib/uri_signer/errors.rb
+- lib/uri_signer/errors/missing_base_uri_error.rb
+- lib/uri_signer/errors/missing_http_method_error.rb
+- lib/uri_signer/errors/missing_query_hash_error.rb
+- lib/uri_signer/errors/missing_secret_error.rb
+- lib/uri_signer/errors/missing_signature_string_error.rb
+- lib/uri_signer/errors/missing_uri_error.rb
+- lib/uri_signer/helpers.rb
+- lib/uri_signer/helpers/hash.rb
+- lib/uri_signer/helpers/string.rb
+- lib/uri_signer/query_hash_parser.rb
+- lib/uri_signer/request_parser.rb
+- lib/uri_signer/request_signature.rb
+- lib/uri_signer/signer.rb
+- lib/uri_signer/uri_signature.rb
+- lib/uri_signer/version.rb
+- reload_yard
+- spec/query_hash_parser_spec.rb
+- spec/request_parser_spec.rb
+- spec/request_signature_spec.rb
+- spec/signer_spec.rb
+- spec/unit/helpers/hash_spec.rb
+- spec/unit/helpers/string_spec.rb
+- spec/uri_signature_spec.rb
+- uri_signer.gemspec
+homepage: https://github.com/kissmetrics/uri_signer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 538882935789920834
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 538882935789920834
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Given a client secret, we can digitally sign the URL and make requests to
+  the API.
+test_files:
+- spec/query_hash_parser_spec.rb
+- spec/request_parser_spec.rb
+- spec/request_signature_spec.rb
+- spec/signer_spec.rb
+- spec/unit/helpers/hash_spec.rb
+- spec/unit/helpers/string_spec.rb
+- spec/uri_signature_spec.rb
+has_rdoc: