faraday_middleware-escher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93e28632c2c22aaa0ab477dbda353b69696d2fb3
-  data.tar.gz: 4712f9d091691aa0b820358acb2db74a4f5c6733
+  metadata.gz: e5baa8d8b8657adbefc20cd4ea7f580589d25be4
+  data.tar.gz: 2fc9ae873439e82ff218edd1a6b57c0490cdf1bb
 SHA512:
-  metadata.gz: 7e0c93b74c6ff5de92c5bfef6aedb253ec62f138753d9a05cba5965c0e771f204f9f39c8d8e1a2ddf7c2bdf5385b5cceb5837258092ab96719c8dd7a609f42b5
-  data.tar.gz: d3ca6593d986eea89548bd44e7b8d6957308ffe54241e69e82832a8a595f5557995fd7c09bdba5ced369d0a805250bfcd60317f94ac8c1046bbdf4e58f177fb2
+  metadata.gz: 148dfca784d915c177d7f1f6c70c4a16fb967c0c05c4d2584a504390deff9dfa7f4fda15aa2a30fa1440ad91f787103f22075ec3d358e5fecea3b53acaefd6c1
+  data.tar.gz: 6c303e8fb87111d00ba302d2437dbf728ffccfd3d73eeaf0e4f0041e6d8c642d95e3a18744ebedbeb6d155664c79edbfad9b354b31370e0f0f81856d833f4f3a

data/README.md

@@ -28,7 +28,7 @@ The FaradayMiddleware::Escher::RequestSigner will help you sign your requests be
     require 'faraday_middleware/escher'
     conn = Faraday.new do |builder|
     
-      builder.use FaradayMiddleware::Escher::RequestSigner, credential_scope: 'example/credential/scope'  do
+      builder.use Faraday::Middleware::Escher::RequestSigner, credential_scope: 'example/credential/scope'  do
                     {api_key_id: 'EscherExample', api_secret: 'TheBeginningOfABeautifulFriendship'}
                   end
     
@@ -38,7 +38,10 @@ The FaradayMiddleware::Escher::RequestSigner will help you sign your requests be
 
 ```
 
-TODO: Write usage instructions here
+
+### Response Validator 
+
+coming soon! @wip
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/faraday_middleware-escher.gemspec

@@ -21,8 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('webmock')
 
   spec.add_dependency('faraday')
-  spec.add_dependency('faraday_middleware')
-
   spec.add_dependency('escher')
 
 end

data/lib/faraday/middleware/escher.rb

@@ -0,0 +1,8 @@
+require 'escher'
+require 'faraday'
+require 'faraday/middleware'
+module Faraday::Middleware::Escher
+  require 'faraday/middleware/escher/base'
+  require 'faraday/middleware/escher/request_signer'
+  require 'faraday/middleware/escher/response_validator'
+end

data/lib/{faraday_middleware/escher/base_middleware.rb → faraday/middleware/escher/base.rb}

@@ -1,5 +1,5 @@
 require 'socket'
-class FaradayMiddleware::Escher::BaseMiddleware < Faraday::Middleware
+class Faraday::Middleware::Escher::Base < Faraday::Middleware
 
   def initialize(app,options={},&escher_keydb_constructor)
 

data/lib/{faraday_middleware → faraday/middleware}/escher/request_signer.rb

@@ -1,8 +1,8 @@
-class FaradayMiddleware::Escher::RequestSigner < FaradayMiddleware::Escher::BaseMiddleware
+class Faraday::Middleware::Escher::RequestSigner < Faraday::Middleware::Escher::Base
 
   def call(env)
 
-    escher = Escher::Auth.new(@escher_credential_scope, @escher_options)
+    escher = ::Escher::Auth.new(@escher_credential_scope, @escher_options)
 
     uri_path = env[:url].path
     endpoint = uri_path.empty? ? '/' : uri_path

data/lib/faraday/middleware/escher/response_validator.rb

@@ -0,0 +1,2 @@
+class Faraday::Middleware::Escher::ResponseValidator
+end

data/lib/faraday_middleware/escher.rb

@@ -1,7 +1,14 @@
-require 'escher'
-require 'faraday_middleware'
-module FaradayMiddleware::Escher
-  require 'faraday_middleware/escher/base_middleware'
-  require 'faraday_middleware/escher/request_signer'
-  require 'faraday_middleware/escher/response_validator'
-end
+#backwardCompatibility
+require 'faraday/middleware/escher'
+
+begin
+  require 'faraday_middleware'
+rescue LoadError
+end
+
+unless defined?(FaradayMiddleware)
+  module FaradayMiddleware
+  end
+end
+
+FaradayMiddleware::Escher ||= ::Faraday::Middleware::Escher

data/spec/escher/{base_middleware_spec.rb → base_spec.rb}

@@ -1,5 +1,5 @@
 require_relative '../spec_helper'
-describe FaradayMiddleware::Escher::BaseMiddleware do
+describe FaradayMiddleware::Escher::Base do
 
   let(:app){double('app')}
 
@@ -8,16 +8,16 @@ describe FaradayMiddleware::Escher::BaseMiddleware do
   let(:api_secret){'superSecret'}
 
   let(:options){
-
     {
-        api_key: api_key,
-        api_secret: api_secret,
-        host: host
+        host: host,
+        credential_scope: 'test/test/test'
     }
-
   }
 
-  subject{ self.described_class.new(app,options) }
+  let(:key_db){{api_key_id: 'EscherExample', api_secret: 'TheBeginningOfABeautifulFriendship'}}
+
+
+  subject{ self.described_class.new(app,options) {key_db} }
 
   before do
     allow(Socket).to receive(:gethostname).and_return(host)
@@ -26,7 +26,7 @@ describe FaradayMiddleware::Escher::BaseMiddleware do
   describe '#initialize' do
     describe 'init take an options hash after app, and catch some of its value' do
 
-      %W[ host api_key api_secret ].each do |element|
+      %W[ host ].each do |element|
         it "should save #{element} hast key's value under @#{element}" do
           expect(subject.instance_variable_get("@#{element}")).to eq options[element.to_sym]
         end

data/spec/escher/request_signer_spec.rb

@@ -1,73 +1,58 @@
 require_relative '../spec_helper'
-describe FaradayMiddleware::Escher::RequestSigner do
+describe Faraday::Middleware::Escher::RequestSigner do
   describe 'this is a faraday middleware witch instance will response to call method' do
 
     let(:api_key) { 'superKey' }
     let(:api_secret) { 'superSecret' }
     let(:host) { 'localhost' }
 
+    let(:target_url) { "http://api-with-escher.example.com" }
     let(:stubs) { Faraday::Adapter::Test::Stubs.new }
 
+    let(:request_expectations){ -> env {} }
+    let(:response_expectations){ -> env {} }
+
     subject do
 
       Faraday.new do |builder|
 
-        builder.use FaradayMiddleware::Escher::RequestSigner,
-                    api_key: api_key,
-                    api_secret: api_secret,
-                    host: host
 
-        builder.adapter :test, stubs do |stub|
-          stub.get('/ebi') { |env| [200, {}, 'shrimp'] }
+        builder.use Faraday::Middleware::Escher::RequestSigner, credential_scope: 'example/credential/scope'  do
+          {api_key_id: 'EscherExample', api_secret: 'TheBeginningOfABeautifulFriendship'}
         end
 
-      end
-
-    end
+        builder.use ExpectsMiddleware, request_expectations: request_expectations
+        builder.use ExpectsMiddleware, response_expectations: response_expectations
 
-    let(:connection) do
-      Faraday.new do |builder|
-        builder.use FaradayMiddleware::Escher::RequestSigner,
-                    api_key: api_key,
-                    api_secret: api_secret,
-                    host: host
+        builder.adapter :test, stubs do |stub|
+          stub.get(target_url) { |env| [200, {}, 'shrimp'] }
+        end
 
-        builder.use FaradayMiddleware::FollowRedirects
-        builder.adapter Faraday.default_adapter
       end
+
     end
 
-    let(:target_url) { "http://api-with-escher.example.com" }
 
     describe '#call' do
 
-      it ''
-
-      it "redirects" do
-
-        # stubs.get('/uni') {[ 200, {}, 'urchin' ]}
-
-        request_mock = stub_request(:get, target_url)
-
-        puts request_mock.methods - Object.methods
-
-        stub_request(:get, "http://facebook.com").to_return(
-            :status => 302,
-            :headers => {"Location" => "http://www.facebook.com/"})
-
-        stub_request(:get, "http://www.facebook.com/").to_return(
-            :status => 302,
-            :headers => {"Location" => "https://www.facebook.com/"})
+      before do
+        @env = nil
+      end
 
-        stub_request(:get, "https://www.facebook.com/")
+      let(:request_expectations) do
+        -> env do
+          @request_env = env
+        end
+      end
 
-        response = connection.get "http://facebook.com"
+      it 'should insert escher request headers for the call' do
 
-        expect(response.env[:url].to_s).to eq("https://www.facebook.com/")
+        expect( subject.get(target_url).status ).to eq 200
+        expect( @request_env[:request_headers]["X-Escher-Auth"].nil? ).to eq false
+        expect( @request_env[:request_headers]["X-Escher-Date"].nil? ).to eq false
 
       end
 
-
     end
 
   end

data/spec/spec_helper.rb

@@ -45,4 +45,24 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+end
+
+class ExpectsMiddleware < Faraday::Middleware
+
+  def initialize(app,request_expectations:nil,response_expectations:nil)
+    super(app)
+    @request_expectations = request_expectations
+    @response_expectations = response_expectations
+  end
+
+  def call(env)
+
+    @request_expectations.call(env) if @request_expectations.respond_to?(:call)
+
+    @app.call(env).on_complete do |env|
+      @response_expectations.call(env) if @response_expectations.respond_to?(:call)
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-escher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: escher
   requirement: !ruby/object:Gem::Requirement
@@ -123,11 +109,12 @@ files:
 - Rakefile
 - VERSION
 - faraday_middleware-escher.gemspec
+- lib/faraday/middleware/escher.rb
+- lib/faraday/middleware/escher/base.rb
+- lib/faraday/middleware/escher/request_signer.rb
+- lib/faraday/middleware/escher/response_validator.rb
 - lib/faraday_middleware/escher.rb
-- lib/faraday_middleware/escher/base_middleware.rb
-- lib/faraday_middleware/escher/request_signer.rb
-- lib/faraday_middleware/escher/response_validator.rb
-- spec/escher/base_middleware_spec.rb
+- spec/escher/base_spec.rb
 - spec/escher/request_signer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/adamluzsi/faraday_middleware-escher
@@ -155,6 +142,6 @@ signing_key:
 specification_version: 4
 summary: escher sign and validation for faraday http rest client
 test_files:
-- spec/escher/base_middleware_spec.rb
+- spec/escher/base_spec.rb
 - spec/escher/request_signer_spec.rb
 - spec/spec_helper.rb

data/lib/faraday_middleware/escher/response_validator.rb

@@ -1,3 +0,0 @@
-class FaradayMiddleware::Escher::ResponseValidator
-
-end