summon-faraday_middleware 0.1.0

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,41 @@
+# Summon::FaradayMiddleware
+
+[Faraday](https://github.com/lostisland/faraday) middleware to authenticate against the [Serials Solutions Summon Unified Discovery Service](http://www.serialssolutions.com/en/services/summon/) API.
+For more information on the API, see http://api.summon.serialssolutions.com/help/api/.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'summon-faraday_middleware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install summon-faraday_middleware
+
+## Usage
+
+    conn = Faraday.new(:url => 'http://api.summon.serialssolutions.com') do |builder|
+      builder.request :summon_auth,
+        :access_id => 'my_access_id', :secret_key => 'my_secret_key'
+      builder.adapter Faraday.default_adapter # or any other adapter
+    end
+    
+    response = conn.get('/2.0.0/search') do |req|
+      req.headers['Accept'] = 'application/json' # or xml
+      req.params['s.q'] = 'My Query'
+    end
+    
+    puts response.body
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/summon/faraday_middleware.rb

@@ -0,0 +1,12 @@
+require "summon/faraday_middleware/version"
+require 'summon/faraday_middleware/summon_authentication'
+
+module Summon
+  module FaradayMiddleware
+    if Faraday.respond_to? :register_middleware
+      Faraday.register_middleware :request, 
+        :summon_auth => lambda { SummonAuthentication }
+    end
+  end
+end
+

data/lib/summon/faraday_middleware/summon_authentication.rb

@@ -0,0 +1,93 @@
+require 'faraday'
+require 'time'
+require 'openssl'
+
+module Summon
+  module FaradayMiddleware
+    class SummonAuthentication < ::Faraday::Middleware
+
+      AUTH_HEADER     = 'Authorization'.freeze
+      HOST_HEADER     = 'Host'
+      SUMMON_PREFIX   = 'Summon'.freeze
+      SUMMON_DATE     = 'x-summon-date'.freeze
+      SUMMON_SESSION  = 'x-summon-session-id'.freeze
+      CONTENT_TYPE    = 'Content-Type'.freeze
+      ACCEPT_HEADER   = 'Accept'.freeze
+      TYPE_URLENCODED = 'application/x-www-form-urlencoded; charset=utf8'.freeze
+
+      Error = Class.new(StandardError)
+      AuthenticationError = Class.new(Error)
+
+      attr_accessor :access_id, :secret_key
+
+      def call(env)
+        uri = env[:url]
+        headers = env[:request_headers]
+        headers[CONTENT_TYPE]   = TYPE_URLENCODED
+        headers[HOST_HEADER]    = "#{uri.host}:#{uri.port}"
+        headers[SUMMON_DATE]    = httpdate
+        headers[SUMMON_SESSION] = session_id
+        headers[AUTH_HEADER]    = authorization(env)
+        @app.call(env)
+      end
+
+      def initialize(app, options = {})
+        super(app)
+        @access_id  = options.fetch(:access_id)  { |name| handle_missing_parameter(name) }
+        @secret_key = options.fetch(:secret_key) { |name| handle_missing_parameter(name) }
+        @client_key = options[:client_key]
+        @session_id = options[:session_id]
+      end
+
+      def httpdate
+        Time.now.httpdate
+      end
+
+      def session_id
+        @session_id ||= generate_session_id
+      end
+
+      def client_key
+        @client_key.upcase if @client_key
+      end
+
+      def authorization(env)
+        value = [access_id, client_key, digest(env)].compact.join(';')
+        "#{SUMMON_PREFIX} #{value}"
+      end
+
+      def digest(env)
+        uri     = env[:url]
+        headers = env[:request_headers]
+        data = []
+        data << headers.fetch(ACCEPT_HEADER) { |name| handle_missing_header(name) }
+        data << headers.fetch(SUMMON_DATE)   { |name| handle_missing_header(name) }
+        data << headers.fetch(HOST_HEADER)   { |name| handle_missing_header(name) }
+        data << uri.path
+        data << sort_query_params(uri.query)
+        data << ''
+        Digest::HMAC.base64digest(data.join("\n"), @secret_key, Digest::SHA1).chomp
+      end
+
+      private
+
+      def generate_session_id
+        require 'socket'
+        "SUMMON-SESSION-#{Socket.gethostname}-#{$$}-#{object_id}"
+      end
+
+      def handle_missing_parameter(name)
+        raise AuthenticationError, "Missing required parameter: :#{name}"
+      end
+
+      def handle_missing_header(name)
+        raise AuthenticationError, "Missing required header: #{name}"
+      end
+
+      def sort_query_params(query)
+        query.split('&').sort.join('&')
+      end
+
+    end
+  end
+end

data/lib/summon/faraday_middleware/version.rb

@@ -0,0 +1,5 @@
+module Summon
+  module FaradayMiddleware
+    VERSION = "0.1.0"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'summon/faraday_middleware'

data/spec/summon/faraday_middleware/summon_authentication_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Summon::FaradayMiddleware::SummonAuthentication do
+  
+  def perform(params = {}, headers = {})
+    env = {
+      :url => URI('http://example.com/search?' + ::Faraday::Utils.build_query(params)),
+      :request_headers => ::Faraday::Utils::Headers.new.update(headers)
+    }
+    env[:request_headers]['Accept'] = accept if defined? accept
+    app = make_app
+    app.call(env)
+  end
+
+  def make_app
+    described_class.new(lambda{|env| env}, options.reject { |o| o.nil? })
+  end
+
+  context "required parameters: " do
+    context "an access_id" do
+      let(:options) { {:secret_key => 'bar'} }
+      it 'is required' do
+        expect { perform }.to raise_error, "Missing required parameter: :access_id"
+      end
+    end
+    context "a secret_key" do
+      let(:options) { {:access_id => 'foo'} }
+      it 'is required' do
+        expect { perform }.to raise_error, "Missing required parameter: :secret_key"
+      end
+    end
+  end
+
+  context "headers" do
+    let(:options)    { {:access_id => 'foo',
+                       :secret_key => 'bar',
+                       :client_key => 'abcd1234' } }
+
+    it "must include 'Accept'" do
+      expect { perform }.to raise_error, "Missing required header: Accept"
+    end
+  end
+
+  context "applying the middleware" do
+    let(:session_id) { nil }
+    let(:client_key) { nil }
+    let(:accept)     { 'application/json' }
+    let(:options)    { {:access_id => 'foo',
+                       :secret_key => 'bar',
+                       :client_key => client_key,
+                       :session_id => session_id } }
+    let(:env)        { perform("s.q" => "Summon") }
+    let(:headers)    { env[:request_headers] }
+
+    before do
+      Time.stub(:now) { Time.new(2012, 1, 2, 3, 4, 5, 3600*8) }
+    end
+
+    it "sets the summon date header" do
+      headers['x-summon-date'].should eql "Sun, 01 Jan 2012 19:04:05 GMT"
+    end
+
+    it "sets a host header" do
+      headers['Host'].should eql "example.com:80"
+    end
+
+    it "sets the urlencoded content-type header" do
+      headers['Content-Type'].should eql 'application/x-www-form-urlencoded; charset=utf8'
+    end
+
+    it "sets the authorization header" do
+      headers['Authorization'].should eql 'Summon foo;oGfYSxLUZBYt43MoZpI+w85P1vI='
+    end
+
+    context "without a session id" do
+      let(:session_id) { nil }
+      it "generates a session id" do
+        headers['x-summon-session-id'].should_not be_nil
+      end
+    end
+
+    context "with a session id" do
+      let(:session_id) { "provided-session-id" }
+      it "uses the provided session id" do
+        headers['x-summon-session-id'].should eql 'provided-session-id'
+      end
+    end
+
+    context "with a custom client id" do
+      let(:client_key) { 'abcd1234' }
+
+      it "adds the client key to the authentication header, in caps" do
+        headers['Authorization'].should eql "Summon foo;ABCD1234;oGfYSxLUZBYt43MoZpI+w85P1vI="
+      end
+    end
+  end
+
+end

data/spec/summon/faraday_middleware_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Summon::FaradayMiddleware do
+  it 'has a version number' do
+    Summon::FaradayMiddleware::VERSION.should_not be_nil
+  end
+end
+

data/summon-faraday_middleware.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'summon/faraday_middleware/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "summon-faraday_middleware"
+  gem.version       = Summon::FaradayMiddleware::VERSION
+  gem.authors       = ["Daniël van de Burgt"]
+  gem.email         = ["daniel.vandeburgt@serialssolutions.com"]
+  gem.description   = %q{A Faraday Middleware for signing Summon API requests}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/summon/summon-faraday_middleware"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "faraday", "~> 0.8.4"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+  gem.add_development_dependency "rspec", ">= 2.12.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: summon-faraday_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniël van de Burgt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: A Faraday Middleware for signing Summon API requests
+email:
+- daniel.vandeburgt@serialssolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/summon/faraday_middleware.rb
+- lib/summon/faraday_middleware/summon_authentication.rb
+- lib/summon/faraday_middleware/version.rb
+- spec/spec_helper.rb
+- spec/summon/faraday_middleware/summon_authentication_spec.rb
+- spec/summon/faraday_middleware_spec.rb
+- summon-faraday_middleware.gemspec
+homepage: https://github.com/summon/summon-faraday_middleware
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Faraday Middleware for signing Summon API requests
+test_files:
+- spec/spec_helper.rb
+- spec/summon/faraday_middleware/summon_authentication_spec.rb
+- spec/summon/faraday_middleware_spec.rb