api_signature 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e907dd2adc3e3558f0f5fc7a00131ccac6d71aac
-  data.tar.gz: 7db50a3800bc9c2e77eea7d7a543a1054d40073c
+  metadata.gz: 6b3f7f58448cc08c412e475bd5967b8af6cfb972
+  data.tar.gz: 13783e19a83c42cdbc744036a44065f6deb7a56c
 SHA512:
-  metadata.gz: 527fd053ef63b32c5ce09cfa0e020c7dbc9a125e52b8332703e4bc2b20380e44557e6e51f30fbc64565238236daef9db38716f738c49c23fb2e05bcadece8fb1
-  data.tar.gz: fb6449eb2de6530c14175f8faa775ba0a62466ac8581714255b9f62134d007525a3cc9f3aef62ad2d65402aea39f9f569e13dc748c7c4277fc4a2872e455356b
+  metadata.gz: 73189d7c54d5bef421df7d7f195bc8e2c708e2b5d67e85ee4151e35a02f34165db50420c836e0ee7ab2199f5e2adc5223146ba1560e6767867c1b1b7b1534e07
+  data.tar.gz: 1f61c800c0be84c0874807188774118ba332b57a92dca59b5116244131a9ebdd15cb505fbda2363da87c9662a00019db676f36f68bb21d2874f6a5b2db3e7875

data/README.md

@@ -114,6 +114,67 @@ ApiSignature.setup do |config|
 end
 ```
 
+## Testing
+
+In your `rails_helper.rb`:
+
+```ruby
+require 'api_signature/spec_support/helper'
+
+RSpec.configure do |config|
+  config.include ApiSignature::SpecSupport::Helper, type: :controller
+end
+```
+
+This will enable the following methods in controller tests:
+
+* get_with_signature(client, action_name, params = {})
+* post_with_signature(client, action_name, params = {})
+* put_with_signature(client, action_name, params = {})
+* patch_with_signature(client, action_name, params = {})
+* delete_with_signature(client, action_name, params = {})
+
+`client` object should respond to `#api_key` and `#api_secret`
+
+Example usage:
+
+```ruby
+RSpec.describe Api::V1::OrdersController do
+  let(:client) { FactoryBot.create(:client) }
+  # or any object, that responds to #api_key and #api_secret
+  # let(:client) { OpenStruct.new(api_key: 'some_key', api_secret: 'some_api_secret') }
+
+  it 'should filter orders by state' do
+    get_with_signature client, :index, state: :paid
+
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to have_node(:orders)
+    expect(last_response.body).to have_node(:state).with('paid')
+  end
+
+  let(:order_attributes) { FactoryBot.attributes_for(:order) }
+
+  it 'should create new order' do
+    post_with_signature client, :create, order: order_attributes
+  end
+end
+```
+
+For nested resources path can be specified explicitly using `path` parameter:
+
+```ruby
+# path: /api/v1/orders/:order_id/comments
+
+RSpec.describe Api::V1::CommentsController do
+  let(:client) { OpenStruct.new(api_key: 'some_key', api_secret: 'some_api_secret') }
+  let(:order) { FactoryBot.create(:order) }
+
+  it 'should update comment for order' do
+    put_with_signature client, :update, path: { order_id: order.id }, comment: { content: 'Some value' }
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/api_signature.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
 
   spec.add_dependency 'activesupport', '>= 4.0'
-  spec.add_dependency 'rack', '~> 2.0', '>= 2.0.5'
+  spec.add_dependency 'rack', '>= 2.0'
 end

data/lib/api_signature/spec_support/headers_builder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ApiSignature
+  module SpecSupport
+    class HeadersBuilder
+      attr_reader :access_key, :secret, :http_method, :path
+
+      def initialize(access_key, secret, http_method, path)
+        @access_key = access_key
+        @secret = secret
+        @http_method = http_method
+        @path = path
+      end
+
+      def headers
+        {
+          'HTTP_X_ACCESS_KEY' => access_key,
+          'HTTP_X_TIMESTAMP' => options[:timestamp],
+          'HTTP_X_SIGNATURE' => generator.generate_signature(secret)
+        }
+      end
+
+      private
+
+      def generator
+        @generator ||= ::ApiSignature::Generator.new(options)
+      end
+
+      def options
+        @options ||= {
+          request_method: http_method.to_s.upcase,
+          path: path,
+          access_key: access_key,
+          timestamp: Time.zone.now.to_i
+        }
+      end
+    end
+  end
+end

data/lib/api_signature/spec_support/helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'api_signature/spec_support/path_builder'
+require 'api_signature/spec_support/headers_builder'
+
+module ApiSignature
+  module SpecSupport
+    module Helper
+      include Rack::Test::Methods
+
+      def app
+        Rails.app_class
+      end
+
+      def get_with_signature(client, *args)
+        with_signature(:get, client.api_key, client.api_secret, *args)
+      end
+
+      def post_with_signature(client, *args)
+        with_signature(:post, client.api_key, client.api_secret, *args)
+      end
+
+      def put_with_signature(client, *args)
+        with_signature(:put, client.api_key, client.api_secret, *args)
+      end
+
+      alias patch_with_signature put_with_signature
+
+      def delete_with_signature(client, *args)
+        with_signature(:delete, client.api_key, client.api_secret, *args)
+      end
+
+      private
+
+      def with_signature(http_method, api_key, secret, action_name, params = {})
+        path = PathBuilder.new(controller, action_name, params).path
+        headers = HeadersBuilder.new(api_key, secret, http_method, path).headers
+
+        send(http_method, path, params, headers)
+      end
+    end
+  end
+end

data/lib/api_signature/spec_support/path_builder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ApiSignature
+  module SpecSupport
+    class PathBuilder
+      attr_reader :controller, :action_name, :params
+
+      PRIMARY_KEYS = [:id, :token].freeze
+
+      def initialize(controller, action_name, params = {})
+        @controller = controller
+        @action_name = action_name
+        @params = params
+      end
+
+      def path
+        if params[:path].present?
+          hash = params.delete(:path)
+          url_options.merge!(hash)
+          params.merge!(hash)
+        end
+
+        controller.url_for(url_options)
+      end
+
+      private
+
+      def url_options
+        @url_options ||= {
+          action: action_name,
+          controller: controller.controller_path,
+          only_path: true
+        }.merge(key_options || {})
+      end
+
+      def key_options
+        key = (params.keys.map(&:to_sym) & PRIMARY_KEYS).first
+        { key => params[key] } if params[key].present?
+      end
+    end
+  end
+end

data/lib/api_signature/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApiSignature
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_signature
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Galeta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,22 +105,16 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '2.0'
 description: 
 email:
 - igor.malinovskiy@netfix.xyz
@@ -144,6 +138,9 @@ files:
 - lib/api_signature/builder.rb
 - lib/api_signature/generator.rb
 - lib/api_signature/request.rb
+- lib/api_signature/spec_support/headers_builder.rb
+- lib/api_signature/spec_support/helper.rb
+- lib/api_signature/spec_support/path_builder.rb
 - lib/api_signature/validator.rb
 - lib/api_signature/version.rb
 homepage: https://github.com/psyipm/api_signature
@@ -166,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: Sign API requests with HMAC signature