endorser 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08157f50cd6166fdac4c1963553e3194946a3322
+  data.tar.gz: fab80bd309b27b9bf427a76969eec0127a8bcca3
+SHA512:
+  metadata.gz: cd1c3a31b36d39294410df7e9b7255c42a08c8a20dce31681c8157a2958250e2d7e12311e1c1e5ce7214065942e440b815904dd9aaca10eb263241aab6941137
+  data.tar.gz: 5887df3d9f83139e26a0f0fb48e8c8200a1b669f82ea454276951b912db8aa652fb25fd444abbe42179d3d3a166c57f4d9136e6bd9dd58cd314120708e1e9521

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+endorse

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.0.0
+ - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in signed-rest-client.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/endorser.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'endorser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "endorser"
+  spec.version       = Endorser::VERSION
+  spec.authors       = ["Matthew Johnston", "Graham Christensen"]
+  spec.email         = ["matt@zippykid.com", "graham@zippykid.com"]
+  spec.description   = %q{A small rest client library that signs the requests}
+  spec.summary       = %q{A small rest client library that signs the requests}
+  spec.homepage      = "https://github.com/zippykid/endorser"
+  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("rest-client", "~> 1.6")
+  spec.add_dependency("endorser-receipt", "~> 1.0.0")
+
+  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rspec", "~> 2.14.0")
+  spec.add_development_dependency("simplecov")
+end

data/lib/endorser/client.rb

@@ -0,0 +1,153 @@
+module Endorser
+
+  class Client
+    attr_reader :key, :secret, :realm
+
+    def initialize(key, secret, realm)
+      @key    = key
+      @secret = secret
+      @realm  = realm
+    end
+
+    # @param [String] url
+    # @param [Hash] headers
+    # @raise [Sacred::Errors::Error] if an error is encountered with sacred
+    # @return [Hash]
+    def get(url, headers={})
+      execute({
+        method: :get,
+        url: url,
+        headers: headers
+      })
+    end
+
+    # @param [String] url
+    # @param [Hash] payload
+    # @param [Hash] headers
+    # @raise [Sacred::Errors::Error] if an error is encountered with sacred
+    # @return [Hash]
+    def post(url, payload={}, headers={})
+      execute({
+        method: :post,
+        url: url,
+        payload: payload,
+        headers: headers
+      })
+    end
+
+    # @param [String] url
+    # @param [Hash] payload
+    # @param [Hash] headers
+    # @raise [Sacred::Errors::Error] if an error is encountered with sacred
+    # @return [Hash]
+    def put(url, payload={}, headers={})
+      execute({
+        method: :put,
+        url: url,
+        payload: payload,
+        headers: headers
+      })
+    end
+
+    # @param [String] url
+    # @param [Hash] headers
+    # @raise [Sacred::Errors::Error] if an error is encountered with sacred
+    # @return [Hash]
+    def delete(url, headers={})
+      execute({
+        method: :delete,
+        url: url,
+        headers: headers
+      })
+    end
+
+    # Wrapper around RestClient::Request.execute method
+    #
+    # @param [Hash] args
+    # @raise [Sacred::Errors::Error] when the request fails
+    # @return [Hash]
+    def execute(args={})
+      RestClient::Request.execute(signed_request(args)) do |response, request, result, &block|
+        Endorser::Response.new(response, request)
+      end
+    rescue RestClient::Exception => error
+      raise Endorser::RequestError.new(error)
+    end
+
+    def signed_request(args={})
+      if args[:headers].nil?
+        args[:headers] = Hash.new
+      end
+
+      headers = args[:headers]
+      headers[:raw_response] = true
+      headers[:content_type] = "application/json;q=0.1;version=1, */*;q=0.0;version=1"
+
+      headers['ZK-Date']  = Time.now.httpdate
+      headers['ZK-Nonce'] = SecureRandom.uuid
+
+      receipt = build_receipt(args)
+
+      signable_headers(headers).each do |k,v|
+        receipt.headers[k] = v
+      end
+
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      validation = OpenSSL::HMAC.hexdigest(digest, secret, receipt.to_s)
+
+      headers["Authorization"] = "#{realm} #{key}:#{validation}"
+
+      args
+    end
+
+    def build_receipt(args={})
+      headers = args[:headers]
+      method  = args[:method].to_s
+      url     = args[:url]
+
+      receipt = Endorser::Receipt.new
+      receipt.host = host(url)
+      receipt.uri = uri_path_and_query(url)
+      receipt.request_method = method
+      receipt.api_key = key
+      receipt.api_secret = secret
+      receipt.content_type = headers['Content-Type']
+      receipt.body = RestClient::Payload.generate(args[:payload]).to_s
+      receipt
+    end
+
+    def uri_path_and_query(url)
+      uri = URI(url)
+      if uri.query.nil?
+        uri.path
+      else
+        [uri.path, '?', uri.query].join
+      end
+    end
+
+    def host(url)
+      uri = URI(url)
+      value = [uri.scheme, '://', uri.host]
+
+      if include_port?(uri)
+        value += [':', uri.port.to_s]
+      end
+
+      value.join
+    end
+
+    def include_port?(uri)
+      (uri.scheme != 'http' || uri.port != 80) && (uri.scheme != 'https' || uri.port != 443)
+    end
+
+    def signable_headers(headers)
+      headers.select { |k,v|
+        k.downcase =~ /^zk-/
+      }.sort_by { |k,v|
+        k.to_s.downcase
+      }
+    end
+  end
+
+
+end

data/lib/endorser/errors/request_error.rb

@@ -0,0 +1,8 @@
+module Endorser
+  module Errors
+
+    class RequestError < ::StandardError
+    end
+
+  end
+end

data/lib/endorser/response.rb

@@ -0,0 +1,55 @@
+module Endorser
+  class Response
+    attr_reader :request, :raw
+
+    def initialize(raw, request)
+      @raw      = raw
+      @request  = request
+    end
+
+    # @return [Hash]
+    def headers
+      raw.raw_headers
+    end
+
+    # @return [Hash]
+    def cookies
+      raw.cookies
+    end
+
+    # @return [String]
+    def body
+      raw.to_s
+    end
+
+    # @return [Integer]
+    def code
+      raw.code
+    end
+
+    # @return [Boolean]
+    def informational?
+      code.between?(100, 199)
+    end
+
+    # @return [Boolean]
+    def success?
+      code.between?(200, 299)
+    end
+
+    # @return [Boolean]
+    def redirection?
+      code.between?(300, 399)
+    end
+
+    # @return [Boolean]
+    def client_error?
+      code.between?(400, 499)
+    end
+
+    # @return [Boolean]
+    def server_error?
+      code.between?(500, 599)
+    end
+  end
+end

data/lib/endorser/version.rb

@@ -0,0 +1,5 @@
+module Endorser
+
+  VERSION = '1.3.0'
+
+end

data/lib/endorser.rb

@@ -0,0 +1,15 @@
+require 'openssl'
+require 'time'
+require 'securerandom'
+require 'rest_client'
+
+require 'endorser/version'
+
+module Endorser
+
+end
+
+require 'endorser/errors/request_error'
+require 'endorser/response'
+require 'endorser/receipt'
+require 'endorser/client'

data/spec/endorser/client_spec.rb

@@ -0,0 +1,200 @@
+require 'spec_helper'
+
+describe Endorser::Client do
+  let(:client) { Endorser::Client.new('abc', '123', 'My Realm') }
+
+  describe '#initialize' do
+    subject { client }
+    its(:key) { should eq('abc') }
+    its(:secret) { should eq('123') }
+  end
+
+  describe '#get' do
+    it 'should execute a GET request' do
+      url = 'http://localhost:3000/'
+      headers = { data: 'headers' }
+      client.stub(execute: true)
+
+      client.get(url, headers)
+
+      expect(client).to have_received(:execute).with({
+        method: :get,
+        url: url,
+        headers: headers
+      })
+    end
+  end
+
+  describe '#put' do
+    it 'should execute a PUT request' do
+      url = 'http://localhost:3000/'
+      payload = { data: 'payload'}
+      headers = { data: 'headers' }
+      client.stub(execute: true)
+
+      client.put(url, payload, headers)
+
+      expect(client).to have_received(:execute).with({
+        method: :put,
+        url: url,
+        headers: headers,
+        payload: payload
+      })
+    end
+  end
+
+  describe '#post' do
+    it 'should execute a POST request' do
+      url = 'http://localhost:3000/'
+      payload = { data: 'payload'}
+      headers = { data: 'headers' }
+      client.stub(execute: true)
+
+      client.post(url, payload, headers)
+
+      expect(client).to have_received(:execute).with({
+        method: :post,
+        url: url,
+        headers: headers,
+        payload: payload
+      })
+    end
+  end
+
+  describe '#delete' do
+    it 'should execute a DELETE request' do
+      url = 'http://localhost:3000/'
+      headers = { data: 'headers' }
+      client.stub(execute: true)
+
+      client.delete(url, headers)
+
+      expect(client).to have_received(:execute).with({
+        method: :delete,
+        url: url,
+        headers: headers
+      })
+    end
+  end
+
+  describe '#signed_request' do
+    context 'when it is a GET request' do
+      it 'should sign the request' do
+        args = {
+          method: :get,
+          url: 'http://localhost:3000'
+        }
+        response = client.signed_request(args)
+      end
+    end
+  end
+
+  describe '#uri_path_and_query' do
+    context 'when the url is "http://example.com:3000/"' do
+      let(:url) { "http://localhost:3000/" }
+      subject { client.uri_path_and_query(url) }
+      it { should eq("/")}
+    end
+
+    context 'when the url is "http://example.com/something/different"' do
+      let(:url) { "http://example.com/something/different" }
+      subject { client.uri_path_and_query(url) }
+      it { should eq("/something/different")}
+    end
+
+    context 'when the url is "http://example.com:3000/?q=abc"' do
+      let(:url) { "http://localhost:3000/?q=abc" }
+      subject { client.uri_path_and_query(url) }
+      it { should eq("/?q=abc")}
+    end
+
+    context 'when the url is "http://example.com/something/different?q=abc"' do
+      let(:url) { "http://example.com/something/different?q=abc" }
+      subject { client.uri_path_and_query(url) }
+      it { should eq("/something/different?q=abc")}
+    end
+  end
+
+  describe '#host' do
+    context 'when the url is "http://example.com:3000/"' do
+      let(:url) { "http://localhost:3000/" }
+      subject { client.host(url) }
+      it { should eq("http://localhost:3000")}
+    end
+
+    context 'when the url is "https://example.com/"' do
+      let(:url) { "https://example.com/" }
+      subject { client.host(url) }
+      it { should eq("https://example.com")}
+    end
+
+    context 'when the url is "http://example.com/something/different"' do
+      let(:url) { "http://example.com/something/different" }
+      subject { client.host(url) }
+      it { should eq("http://example.com")}
+    end
+
+    context 'when the url is "http://example.com:3000/something/different"' do
+      let(:url) { "http://example.com:3000/something/different" }
+      subject { client.host(url) }
+      it { should eq("http://example.com:3000")}
+    end
+  end
+
+  describe '#include_port?' do
+    context 'when the scheme is http' do
+      context 'and when the port is 80' do
+        let(:uri) { double('URI', scheme: 'http', port: 80)}
+        subject { client.include_port?(uri) }
+        it { should be_false }
+      end
+
+      context 'and when the port is 443' do
+        let(:uri) { double('URI', scheme: 'http', port: 443)}
+        subject { client.include_port?(uri) }
+        it { should be_true }
+      end
+    end
+
+    context 'when the scheme is https' do
+      context 'and when the port is 80' do
+        let(:uri) { double('URI', scheme: 'https', port: 80)}
+        subject { client.include_port?(uri) }
+        it { should be_true }
+      end
+
+      context 'and when the port is 443' do
+        let(:uri) { double('URI', scheme: 'https', port: 443)}
+        subject { client.include_port?(uri) }
+        it { should be_false }
+      end
+    end
+
+    context 'when the scheme is something' do
+      context 'and when the port is 80' do
+        let(:uri) { double('URI', scheme: 'something', port: 80)}
+        subject { client.include_port?(uri) }
+        it { should be_true }
+      end
+    end
+  end
+
+  describe '#build_receipt' do
+    def args
+      {
+        method: :post,
+        headers: {},
+        url: 'http://example.com',
+        payload: { data: 'here', another: 'set' }
+      }
+    end
+    subject { client.build_receipt(args) }
+
+    it { should be_a(Endorser::Receipt) }
+    its(:host) { should eq("http://example.com") }
+    its(:request_method) { should eq('POST') }
+    its(:body) { should eq('data=here&another=set') }
+    its(:body_md5) { should eq('f4a4a0348d64714e94a3360af1dc614c') }
+  end
+
+end

data/spec/endorser/response_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe Endorser::Response do
+
+  describe '#initialize' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:request) { double('RestClient::Request') }
+
+    subject { Endorser::Response.new(raw, request) }
+
+    its(:raw) { should eq(raw) }
+    its(:request) { should eq(request) }
+  end
+
+  describe '#headers' do
+    let(:raw_headers) { double('Hash') }
+    let(:raw) { double('RestClient::RawResponse', raw_headers: raw_headers) }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    subject { response.headers }
+    it { should eq(raw_headers) }
+  end
+
+  describe '#cookies' do
+    let(:cookies) { double('Hash') }
+    let(:raw) { double('RestClient::RawResponse', cookies: cookies) }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    subject { response.cookies }
+    it { should eq(cookies) }
+  end
+
+  describe '#code' do
+    let(:raw) { double('RestClient::RawResponse', code: 200) }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    subject { response.code }
+    it { should eq(200) }
+  end
+
+
+  describe '#informational?' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    context 'when the response code is 100' do
+      before { response.stub(code: 100) }
+      subject { response.informational? }
+      it { should be_true }
+    end
+    context 'when the response code is 199' do
+      before { response.stub(code: 199) }
+      subject { response.informational? }
+      it { should be_true }
+    end
+    context 'when the response code is 99' do
+      before { response.stub(code: 99) }
+      subject { response.informational? }
+      it { should be_false }
+    end
+    context 'when the response code is 200' do
+      before { response.stub(code: 200) }
+      subject { response.informational? }
+      it { should be_false }
+    end
+  end
+
+  describe '#success?' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    context 'when the response code is 200' do
+      before { response.stub(code: 200) }
+      subject { response.success? }
+      it { should be_true }
+    end
+    context 'when the response code is 299' do
+      before { response.stub(code: 299) }
+      subject { response.success? }
+      it { should be_true }
+    end
+    context 'when the response code is 199' do
+      before { response.stub(code: 199) }
+      subject { response.success? }
+      it { should be_false }
+    end
+    context 'when the response code is 300' do
+      before { response.stub(code: 300) }
+      subject { response.success? }
+      it { should be_false }
+    end
+  end
+
+  describe '#redirection?' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    context 'when the response code is 300' do
+      before { response.stub(code: 300) }
+      subject { response.redirection? }
+      it { should be_true }
+    end
+    context 'when the response code is 399' do
+      before { response.stub(code: 399) }
+      subject { response.redirection? }
+      it { should be_true }
+    end
+    context 'when the response code is 299' do
+      before { response.stub(code: 299) }
+      subject { response.redirection? }
+      it { should be_false }
+    end
+    context 'when the response code is 400' do
+      before { response.stub(code: 400) }
+      subject { response.redirection? }
+      it { should be_false }
+    end
+  end
+
+  describe '#client_error?' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    context 'when the response code is 400' do
+      before { response.stub(code: 400) }
+      subject { response.client_error? }
+      it { should be_true }
+    end
+    context 'when the response code is 499' do
+      before { response.stub(code: 499) }
+      subject { response.client_error? }
+      it { should be_true }
+    end
+    context 'when the response code is 399' do
+      before { response.stub(code: 399) }
+      subject { response.client_error? }
+      it { should be_false }
+    end
+    context 'when the response code is 500' do
+      before { response.stub(code: 500) }
+      subject { response.client_error? }
+      it { should be_false }
+    end
+  end
+
+  describe '#server_error?' do
+    let(:raw) { double('RestClient::RawResponse') }
+    let(:response) { Endorser::Response.new(raw, nil) }
+
+    context 'when the response code is 500' do
+      before { response.stub(code: 500) }
+      subject { response.server_error? }
+      it { should be_true }
+    end
+    context 'when the response code is 599' do
+      before { response.stub(code: 599) }
+      subject { response.server_error? }
+      it { should be_true }
+    end
+    context 'when the response code is 499' do
+      before { response.stub(code: 499) }
+      subject { response.server_error? }
+      it { should be_false }
+    end
+    context 'when the response code is 600' do
+      before { response.stub(code: 600) }
+      subject { response.server_error? }
+      it { should be_false }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'rspec'
+require 'endorser'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: endorser
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Matthew Johnston
+- Graham Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: endorser-receipt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small rest client library that signs the requests
+email:
+- matt@zippykid.com
+- graham@zippykid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Rakefile
+- endorser.gemspec
+- lib/endorser.rb
+- lib/endorser/client.rb
+- lib/endorser/errors/request_error.rb
+- lib/endorser/response.rb
+- lib/endorser/version.rb
+- spec/endorser/client_spec.rb
+- spec/endorser/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zippykid/endorser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A small rest client library that signs the requests
+test_files:
+- spec/endorser/client_spec.rb
+- spec/endorser/response_spec.rb
+- spec/spec_helper.rb