faraday_middleware-escher 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b85b5e51b037018eae7c305f3b31144d766c886
-  data.tar.gz: 7f2182218b4e33a395a6f986ac8fa9952bd747e8
+  metadata.gz: 93e28632c2c22aaa0ab477dbda353b69696d2fb3
+  data.tar.gz: 4712f9d091691aa0b820358acb2db74a4f5c6733
 SHA512:
-  metadata.gz: 438750ce6f8d5539aa5fb2068eea32113eeecb72edea4e3e0e32dbfcdc4ff2c13853d7ac2398bbcfcc5133f2b8ddd0cf202c31f27208d09b37d44f351ff4656c
-  data.tar.gz: a240c1496a125b90b9749ab3f5dd6b4dd02c87972f1cf4c5b7926850b80d95f249325509c92debae661cba98c35ed63e002dbe04226f9b2694d8b85085b5daa2
+  metadata.gz: 7e0c93b74c6ff5de92c5bfef6aedb253ec62f138753d9a05cba5965c0e771f204f9f39c8d8e1a2ddf7c2bdf5385b5cceb5837258092ab96719c8dd7a609f42b5
+  data.tar.gz: d3ca6593d986eea89548bd44e7b8d6957308ffe54241e69e82832a8a595f5557995fd7c09bdba5ced369d0a805250bfcd60317f94ac8c1046bbdf4e58f177fb2

data/README.md

@@ -18,6 +18,26 @@ Or install it yourself as:
 
 ## Usage
 
+### for sign requests 
+
+The FaradayMiddleware::Escher::RequestSigner will help you sign your requests before sending them
+
+```ruby
+
+ 
+    require 'faraday_middleware/escher'
+    conn = Faraday.new do |builder|
+    
+      builder.use FaradayMiddleware::Escher::RequestSigner, credential_scope: 'example/credential/scope'  do
+                    {api_key_id: 'EscherExample', api_secret: 'TheBeginningOfABeautifulFriendship'}
+                  end
+    
+      builder.adapter  :net_http
+    
+    end
+
+```
+
 TODO: Write usage instructions here
 
 ## Contributing

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/faraday_middleware-escher.gemspec

@@ -1,13 +1,10 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'faraday_middleware/escher/version'
-
 Gem::Specification.new do |spec|
-  spec.name          = "faraday_middleware-escher"
-  spec.version       = FaradayMiddleware::Escher::VERSION
-  spec.authors       = ["Adam Luzsi"]
-  spec.email         = ["adamluzsi@gmail.com"]
+
+  spec.name          = 'faraday_middleware-escher'
+  spec.version       = File.read(File.join(File.dirname(__FILE__),'VERSION')).split("\n")[0].chomp
+  spec.authors       = ['Adam Luzsi']
+  spec.email         = ['adamluzsi@gmail.com']
   spec.summary       = %q{escher sign and validation for faraday http rest client}
   spec.description   = %q{WIP!!! escher sign and validation for faraday http rest client}
   spec.homepage      = 'https://github.com/adamluzsi/faraday_middleware-escher'
@@ -18,6 +15,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', "~> 1.6"
-  spec.add_development_dependency 'rake'
-end
+  spec.add_development_dependency('bundler', '>= 1.6')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  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

@@ -1,7 +1,7 @@
-require "faraday_middleware/escher/version"
-
-module FaradayMiddleware
-  module Escher
-    # Your code goes here...
-  end
-end
+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

data/lib/faraday_middleware/escher/base_middleware.rb

@@ -0,0 +1,15 @@
+require 'socket'
+class FaradayMiddleware::Escher::BaseMiddleware < Faraday::Middleware
+
+  def initialize(app,options={},&escher_keydb_constructor)
+
+    super(app)
+    @host = options[:host] || Socket.gethostname
+
+    @escher_options = options[:options] || {}
+    @escher_credential_scope = options[:credential_scope] || raise(ArgumentError,'missing escher credential scope!')
+    @escher_keydb_constructor = escher_keydb_constructor || raise(ArgumentError,'missing escher constructor')
+
+  end
+
+end

data/lib/faraday_middleware/escher/request_signer.rb

@@ -0,0 +1,30 @@
+class FaradayMiddleware::Escher::RequestSigner < FaradayMiddleware::Escher::BaseMiddleware
+
+  def call(env)
+
+    escher = Escher::Auth.new(@escher_credential_scope, @escher_options)
+
+    uri_path = env[:url].path
+    endpoint = uri_path.empty? ? '/' : uri_path
+
+    request_data = {
+        uri: endpoint,
+        method: env[:method].to_s.upcase,
+        headers: env[:request_headers].map{|k,v| [k,v] }.push(['host',@host])
+    }
+
+    request_data[:body]= env[:body] unless env[:body].nil?
+
+    escher.sign!(
+        request_data,
+        @escher_keydb_constructor.call,
+        request_data[:headers].map{|ary| ary[0] }
+    )
+
+    env[:request_headers].merge!(request_data[:headers])
+
+    return @app.call(env)
+
+  end
+
+end

data/lib/faraday_middleware/escher/response_validator.rb

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

data/spec/escher/base_middleware_spec.rb

@@ -0,0 +1,47 @@
+require_relative '../spec_helper'
+describe FaradayMiddleware::Escher::BaseMiddleware do
+
+  let(:app){double('app')}
+
+  let(:host){'localhost'}
+  let(:api_key){'superKey'}
+  let(:api_secret){'superSecret'}
+
+  let(:options){
+
+    {
+        api_key: api_key,
+        api_secret: api_secret,
+        host: host
+    }
+
+  }
+
+  subject{ self.described_class.new(app,options) }
+
+  before do
+    allow(Socket).to receive(:gethostname).and_return(host)
+  end
+
+  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|
+        it "should save #{element} hast key's value under @#{element}" do
+          expect(subject.instance_variable_get("@#{element}")).to eq options[element.to_sym]
+        end
+      end
+
+      it 'should cache @app from the first argument' do
+        expect(subject.instance_variable_get('@app')).to eq app
+      end
+
+    end
+
+    it 'should child of the Faraday::Middleware class' do
+      expect(subject).to be_a(Faraday::Middleware)
+    end
+
+  end
+
+end

data/spec/escher/request_signer_spec.rb

@@ -0,0 +1,74 @@
+require_relative '../spec_helper'
+describe FaradayMiddleware::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(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+    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'] }
+        end
+
+      end
+
+    end
+
+    let(:connection) do
+      Faraday.new do |builder|
+        builder.use FaradayMiddleware::Escher::RequestSigner,
+                    api_key: api_key,
+                    api_secret: api_secret,
+                    host: host
+
+        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/"})
+
+        stub_request(:get, "https://www.facebook.com/")
+
+        response = connection.get "http://facebook.com"
+
+        expect(response.env[:url].to_s).to eq("https://www.facebook.com/")
+
+      end
+
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+gem_root_dir = File.join(File.dirname(__FILE__),'..')
+$LOAD_PATH.unshift(File.join(gem_root_dir,'lib'))
+
+
+require 'rspec'
+require 'webmock/rspec'
+require 'faraday_middleware/escher'
+
+module EnvCompatibility
+  def faraday_env(env)
+    if defined?(Faraday::Env)
+      Faraday::Env.from(env)
+    else
+      env
+    end
+  end
+end
+
+module ResponseMiddlewareExampleGroup
+  def self.included(base)
+    base.let(:options) { Hash.new }
+    base.let(:headers) { Hash.new }
+    base.let(:middleware) {
+      described_class.new(lambda {|env|
+                            Faraday::Response.new(env)
+                          }, options)
+    }
+  end
+
+  def process(body, content_type = nil, options = {})
+    env = {
+        :body => body, :request => options,
+        :request_headers => Faraday::Utils::Headers.new,
+        :response_headers => Faraday::Utils::Headers.new(headers)
+    }
+    env[:response_headers]['content-type'] = content_type if content_type
+    yield(env) if block_given?
+    middleware.call(faraday_env(env))
+  end
+end
+
+RSpec.configure do |config|
+  config.include EnvCompatibility
+  config.include ResponseMiddlewareExampleGroup, :type => :response
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-escher
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -38,6 +38,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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: faraday
+  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: 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: WIP!!! escher sign and validation for faraday http rest client
 email:
 - adamluzsi@gmail.com
@@ -51,9 +121,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
 - faraday_middleware-escher.gemspec
 - lib/faraday_middleware/escher.rb
-- lib/faraday_middleware/escher/version.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/request_signer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/adamluzsi/faraday_middleware-escher
 licenses:
 - MIT
@@ -78,4 +154,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: escher sign and validation for faraday http rest client
-test_files: []
+test_files:
+- spec/escher/base_middleware_spec.rb
+- spec/escher/request_signer_spec.rb
+- spec/spec_helper.rb

data/lib/faraday_middleware/escher/version.rb

@@ -1,5 +0,0 @@
-module FaradayMiddleware
-  module Escher
-    VERSION = "0.0.0"
-  end
-end