wp-hmac 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b1fee8fa88eb3443cba2874b60dff707e07604e
-  data.tar.gz: 8d90cec9afaa7e183bab2bff42c645373368d8fa
+  metadata.gz: db868028407a6446871761f00d2344bdaea894f8
+  data.tar.gz: 6ac7ab349d36f90aa6ab398f72b1c53632a23ef4
 SHA512:
-  metadata.gz: b0cde112d23e27ac62ed9269b3047506002c2fd8c4e16fc1ee75005282ca15de773f5271087ed6610336b66fb534fe125869ababfc9ec1e844fb57768d7cd498
-  data.tar.gz: 6d149a01edfa78c6ab700ab8e2c60eca946acb712702d5e49256749660c27aec353a3de7b39a912e4a4c78c3d5b19f58e876d459cac09d4fc101af167fcb0b32
+  metadata.gz: 91a8b8aa1a81fddaf79f577455a43671b0cdc4dbb0da28c55be29c550695917da42e441905724dd8abf08a20dbdd3b9d490f1d208bc747dcdf4b80308b828114
+  data.tar.gz: e2927f2c94c822d9220e41ebb71ae76d09ce7c23e6183880061ec9cadb6979f661cd55066ce0c063bc45fce4e1c1dde8677b20ecaa1c4cc94425acd471af1db0

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  RunRailsCops: true
+  Exclude:
+    - spec/app/**/*
+Style/Documentation:
+  Enabled: false
+Style/TrivialAccessors:
+  Exclude:
+    - lib/wp/hmac.rb

data/README.md

@@ -64,13 +64,13 @@ use WP::HMAC::Server
 Use like this ...
 ``` ruby
    WP::HMAC::Client.get('https://www.example.com/api/staff')
-   WP::HMAC::Client.post('https://www.example.com/api/schedules, {'HEADER' => 'foo'}, StringIO.new('data'))
+   WP::HMAC::Client.post('https://www.example.com/api/schedules, {'HEADER' => 'foo'}, 'data')
 ```
  ... or like this:
 ``` ruby
    client = WP::HMAC::Client.new('https://www.example.com')
    client.get('api/staff')
-   client.post('api/schedules', {}, StringIO.new('data'))
+   client.post('api/schedules', {}, 'data')
 ```
 See Rack::Client docs for more.
 

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/lib/wp/hmac.rb

@@ -18,7 +18,7 @@ module WP
     end
 
     def self.add_key(id:, auth_key:)
-      KeyCabinet.add_key( { id: id, auth_key: auth_key } )
+      KeyCabinet.add_key(id: id, auth_key: auth_key)
     end
 
     def self.add_hmac_enabled_route(route_regex)
@@ -30,7 +30,8 @@ module WP
     end
 
     def self.auth_id
-      raise MissingConfiguration('Set get_auth_id_for_request in the initializer') unless @callable
+      msg = 'Set get_auth_id_for_request in the initializer'
+      fail MissingConfiguration, msg unless @callable
       @callable.call
     end
 

data/lib/wp/hmac/client.rb

@@ -1,13 +1,25 @@
 module WP
   module HMAC
+    # = HMAC Client
+    # This client uses EY::ApiHMAC to hash a request with a secret key in order
+    # to authenticate the client.
+    #
+    # See here for the implementation details:
+    # https://github.com/engineyard/ey_api_hmac
     class Client
       class UnsuccessfulResponse < StandardError; end
 
-      def initialize(url = nil, app = Rack::Client::Handler::NetHTTP)
-        build_rack_client(url, app)
+      @rack_app = Rack::Client::Handler::NetHTTP
+      # Enable injection of another Rack app for testing
+      class << self
+        attr_accessor :rack_app
+      end
+
+      def initialize(url = nil)
+        build_rack_client(url)
       end
 
-      def build_rack_client(url, app)
+      def build_rack_client(url)
         id = key_cabinet.id
         auth_key = key_cabinet.auth_key
 
@@ -16,7 +28,7 @@ module WP
             env['HTTP_DATE'] = Time.now.httpdate
           end
           use EY::ApiHMAC::ApiAuth::Client, id, auth_key
-          run app
+          run Client.rack_app
         end
         @client
       end
@@ -31,7 +43,7 @@ module WP
       %i(delete get head options post put patch).each do |method|
         define_method(method) do |*args|
           response = @client.send(method, *args)
-          raise UnsuccessfulResponse unless /2\d\d/.match("#{response.status}")
+          fail UnsuccessfulResponse unless /2\d\d/.match("#{response.status}")
           response
         end
       end

data/lib/wp/hmac/key_cabinet.rb

@@ -1,31 +1,33 @@
 module WP
   module HMAC
+    # = Key Cabinet
+    #
+    # Stores the secret keys used in the hash function.
     class KeyCabinet
       class KeyNotFound < Exception; end
 
       class << self
         attr_accessor :keys
+        attr_writer :lookup_block
 
         def add_key(id:, auth_key:)
           @keys ||= {}
           @keys[id] = { id: id, auth_key: auth_key }
         end
 
+        # This method will be called by EY::ApiHMAC. It must return
+        # an object that responds to +id+ and +auth_key+
         def find_by_auth_id(id)
           hash = lookup(id) || @keys[id]
-          raise KeyNotFound, 'Ensure all secret keys are loaded with `HMAC::KeyCabinet.add_key`' if hash.nil?
+          msg = 'Ensure secret keys are loaded with `HMAC::KeyCabinet.add_key`'
+          fail KeyNotFound, msg if hash.nil?
           OpenStruct.new(hash)
         end
 
         def lookup(id)
           return unless @lookup_block
-          if key = @lookup_block.call(id)
-            return { id: id, auth_key: key }
-          end
-        end
-
-        def lookup_block=(block)
-          @lookup_block = block
+          key = @lookup_block.call(id)
+          return { id: id, auth_key: key } if key
         end
       end
     end

data/lib/wp/hmac/server.rb

@@ -1,5 +1,8 @@
 module WP
   module HMAC
+    # = HMAC Server
+    #
+    # Authenticate a request using EY::ApiHMAC
     class Server
       @hmac_enabled_routes = []
 

data/lib/wp/hmac/version.rb

@@ -1,5 +1,5 @@
 module Wp
   module Hmac
-    VERSION = "0.2.2"
+    VERSION = '0.2.3'
   end
 end

data/spec/hmac_spec.rb

@@ -1,4 +1,4 @@
-ENV["RAILS_ENV"] ||= 'test'
+ENV['RAILS_ENV'] ||= 'test'
 require File.expand_path('../../lib/wp/hmac', __FILE__)
 require File.expand_path('../app/config/environment', __FILE__)
 require 'pry'
@@ -8,30 +8,37 @@ RSpec.configure do |config|
 end
 
 class DummyController < ActionController::Base
-  def show
-    render inline: 'Hello, world!'
-  end
-
   def create
     head :bad_request
   end
+
+  def update
+    render inline: 'Hello, updated world!'
+  end
+
+  def show
+    render inline: 'Hello, world!'
+  end
 end
 
 RSpec.describe WP::HMAC, type: :request do
+  let(:app) { App::Application }
+
   before(:example) do
     WP::HMAC.configure do
-      add_key( { id: 'esso', auth_key: 'secret_key' } )
+      add_key(id: 'esso', auth_key: 'secret_key')
       add_hmac_enabled_route %r{^/dummy/}
       get_auth_id_for_request -> { 'esso' }
     end
+
+    WP::HMAC::Client.rack_app = app
   end
 
   after(:example) do
     WP::HMAC.reset
   end
 
-  let(:app) { App::Application }
-  let(:hmac_client) { WP::HMAC::Client.new(nil, app) }
+  let(:hmac_client) { WP::HMAC::Client.new(nil) }
 
   before do
     Rails.application.routes.draw do
@@ -50,9 +57,9 @@ RSpec.describe WP::HMAC, type: :request do
 
     context 'when hmac is enabled for the route' do
       it 'raises an exception' do
-        expect {
+        expect do
           get 'http://esso.example.com/dummy/1'
-        }.to raise_error(WP::HMAC::KeyCabinet::KeyNotFound)
+        end.to raise_error(WP::HMAC::KeyCabinet::KeyNotFound)
       end
     end
 
@@ -68,14 +75,18 @@ RSpec.describe WP::HMAC, type: :request do
   context 'with a key cabinet' do
     it 'fails when a request is not signed' do
       get 'http://esso.example.org/dummy/1'
-      expect(last_response.body).to eql('Authentication failure: no authorization header')
+
+      expect(last_response.body)
+        .to eql('Authentication failure: no authorization header')
     end
 
     it 'fails when a request is signed with a duff hash' do
       header 'Authorization', 'AuthHMAC esso:1234'
       header 'Date', Time.now.httpdate
       get 'http://esso.example.org/dummy/1'
-      expect(last_response.body).to include('Authentication failure: signature mismatch')
+
+      expect(last_response.body)
+        .to include('Authentication failure: signature mismatch')
     end
 
     it 'succeeds when the request is correctly signed' do
@@ -84,29 +95,43 @@ RSpec.describe WP::HMAC, type: :request do
     end
 
     it 'succeeds when the request is correctly signed (alt syntax)' do
-      pending 'Need to work out how to test this'
       rack_response = WP::HMAC::Client.get('http://esso.example.org/dummy/1')
       expect(rack_response.body).to include('Hello, world!')
     end
 
     it 'raises UnsuccessfulResponse when server reponds 400' do
-      expect {
+      expect do
         hmac_client.post('http://esso.example.org/dummy')
-      }.to raise_error(WP::HMAC::Client::UnsuccessfulResponse)
+      end.to raise_error(WP::HMAC::Client::UnsuccessfulResponse)
     end
 
     it 'raises UnsuccessfulResponse when server reponds 400 (alt syntax)' do
-      pending 'Need to work out how to test this'
-      expect {
+      expect do
         WP::HMAC::Client.post('http://esso.example.org/dummy')
-      }.to raise_error(WP::HMAC::Client::UnsuccessfulResponse)
+      end.to raise_error(WP::HMAC::Client::UnsuccessfulResponse)
+    end
+
+    it 'succeeds when the request body resonds to #read' do
+      rack_response = hmac_client.put('http://esso.example.org/dummy/1',
+                                      {},
+                                      StringIO.new('hi'))
+
+      expect(rack_response.body).to include('Hello, updated world!')
+    end
+
+    it 'succeeds when the request body is a string' do
+      rack_response = hmac_client.put('http://esso.example.org/dummy/1',
+                                      {},
+                                      'hi')
+
+      expect(rack_response.body).to include('Hello, updated world!')
     end
   end
 
   context 'with a key configured via a block' do
     before do
       WP::HMAC.configure do
-        lookup_auth_key_with { |id| id == 'account2' ?  'mykey' : nil }
+        lookup_auth_key_with { |id| id == 'account2' ? 'mykey' : nil }
       end
     end
 

data/wp-hmac.gemspec

@@ -4,27 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wp/hmac/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wp-hmac"
+  spec.name          = 'wp-hmac'
   spec.version       = Wp::Hmac::VERSION
-  spec.authors       = ["Andrew Nagi"]
-  spec.email         = ["andrew.nagi@gmail.com"]
-  spec.summary       = %q{HMAC for Rack Apps}
-  spec.description   = %q{Enable different HMAC keys on different routes / subdomains.}
-  spec.homepage      = "https://github.com/workplacesystems/wp-hmac"
-  spec.license       = "MIT"
+  spec.authors       = ['Andrew Nagi']
+  spec.email         = ['andrew.nagi@gmail.com']
+  spec.summary       = 'HMAC for Rack Apps'
+  spec.description   =
+    'Enable different HMAC keys on different routes / subdomains.'
+  spec.homepage      = 'https://github.com/workplacesystems/wp-hmac'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  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.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "ey_api_hmac", "0.4.12"
+  spec.add_dependency 'ey_api_hmac', '0.4.12'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rails", "4.1.4"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "fuubar", "~> 2.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rails', '4.1.4'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.29'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wp-hmac
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Andrew Nagi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ey_api_hmac
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -217,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: HMAC for Rack Apps
@@ -279,4 +294,3 @@ test_files:
 - spec/app/vendor/assets/javascripts/.keep
 - spec/app/vendor/assets/stylesheets/.keep
 - spec/hmac_spec.rb
-has_rdoc: