rack-request_replication 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c53f6dc67d9b644ff865a0e0e5db200e19756ad
+  data.tar.gz: 77e9cd22aeab694556c8d2195e766d56c9df25f9
+SHA512:
+  metadata.gz: 6c9e718ca2a6a0688088766e7d7a96e550f32a521e6991fcf5d37937ca905a281f3035c1e6f1532d26eebfd523ba55315ea0b464711f356a64e2e7af1fa46a68
+  data.tar.gz: afd0d4ffa1b81cf3cd5b2cdeb39af9a3e7ee70009f2335c4686c5bc0c33474266442b2d1b5a5bdc5d709d36128a99ae1c7cf46d3a682b8ea2b35b8e98eb1d052

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wouter de Vos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Rack::RequestReplication
+
+Replicate requests from one app instance to another. At
+[Springest](http://www.springest.com) we use this to test new features.
+We replicate all live requests to our staging environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-request_replication'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-request_replication
+
+## Usage
+
+### Sinatra Example
+
+```ruby
+require 'sinatra/base'
+require 'rack/request_replication'
+
+class TestApp < Sinatra::Base
+  # Forward all requests to another app that runs on localhost, port 4568
+  use Rack::RequestReplication::Forwarder, host: 'localhost', port: 4568
+
+  get '/' do
+    'Hello World'
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-request_replication/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/rack/request_replication.rb

@@ -0,0 +1,3 @@
+require "rack/request_replication/version"
+require "rack/request_replication/logger"
+require "rack/request_replication/forwarder"

data/lib/rack/request_replication/forwarder.rb

@@ -0,0 +1,159 @@
+require 'logger'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Rack
+  module RequestReplication
+    ##
+    # This class implements forwarding of requests
+    # to another host and/or port.
+    #
+    class Forwarder
+      attr_reader :app
+      attr_reader :options
+
+      ##
+      # @param  [#call]                  app
+      # @param  [Hash{Symbol => Object}] options
+      # @option options [String]  :host  ('localhost')
+      # @option options [Integer] :port  (8080)
+      #
+      def initialize( app, options = {} )
+        @app = app
+        @options = {
+          host: 'localhost',
+          port: 8080
+        }.merge options
+      end
+
+      ##
+      # @param  [Hash{String => String}] env
+      # @return [Array(Integer, Hash, #each)]
+      # @see    http://rack.rubyforge.org/doc/SPEC.html
+      #
+      def call( env )
+        request = Rack::Request.new env
+        replicate request
+        app.call env
+      end
+
+      ##
+      # Replicates the request and passes it on to the request
+      # forwarder.
+      #
+      # @param  [Rack::Request] request
+      #
+      def replicate( request )
+        opts = replicate_options_and_data request
+        uri = forward_uri request
+
+        http = Net::HTTP.new uri.host, uri.port
+
+        forward_request = send("create_#{opts[:request_method].downcase}_request", uri, opts)
+        forward_request.add_field("Accept", opts[:accept])
+        forward_request.add_field("Accept-Encoding", opts[:accept_encoding])
+        forward_request.add_field("Host", request.host)
+        forward_request.add_field("Cookie", opts[:cookies]) # TODO: we need to link the source session to the session on the destination app. Maybe we can use Redis to store this.
+        Thread.new do
+          begin
+            http.request(forward_request)
+          rescue
+            logger.debug "Request to Forward App failed."
+          end
+        end
+      end
+
+      def create_get_request( uri, opts = {} )
+        Net::HTTP::Get.new uri.request_uri
+      end
+
+      def create_post_request( uri, opts = {} )
+        forward_request = Net::HTTP::Post.new uri.request_uri
+        forward_request.set_form_data opts[:params]
+        forward_request
+      end
+
+      def create_put_request( uri, opts = {} )
+        forward_request = Net::HTTP::Put.new uri.request_uri
+        forward_request.set_form_data opts[:params]
+        forward_request
+      end
+
+      def create_patch_request( uri, opts = {} )
+        forward_request = Net::HTTP::Patch.new uri.request_uri
+        forward_request.set_form_data opts[:params]
+        forward_request
+      end
+
+      def create_delete_request( uri, opts = {} )
+        Net::HTTP::Delete.new uri.request_uri
+      end
+
+      def create_options_request( uri, opts = {} )
+        Net::HTTP::Options.new uri.request_uri
+      end
+
+      ##
+      # Replicates all the options and data that was in
+      # the original request and puts them in a Hash.
+      #
+      # @param   [Rack::Request] request
+      # @returns [Hash]
+      #
+      def replicate_options_and_data( request )
+        replicated_options ||= {}
+        %w(
+          accept_encoding
+          body
+          request_method
+          content_charset
+          cookies
+          media_type
+          media_type_params
+          params
+          referer
+          request_method
+          user_agent
+          url
+        ).map(&:to_sym).each do |m|
+          value = request.send( m )
+          replicated_options[m] = value unless value.nil?
+        end
+        replicated_options
+      end
+
+      ##
+      # Creates a URI based on the request info
+      # and the options set.
+      #
+      # @param   [Rack::Request] request
+      # @returns [URI]
+      #
+      def forward_uri( request )
+        url = "#{request.scheme}://#{options[:host]}"
+        url << ":#{options[:port]}" unless port_matches_scheme? request
+        url << request.fullpath
+        URI(url)
+      end
+
+      ##
+      # Checks if the request scheme matches the destination port.
+      #
+      # @param   [Rack::Request] request
+      # @returns [boolean]
+      #
+      def port_matches_scheme?( request )
+        options[:port].to_i == Rack::Request::DEFAULT_PORTS[clean_scheme(request)]
+      end
+
+      def clean_scheme( request )
+        request.scheme.match(/^\w+/)[0]
+      end
+
+      def logger
+        @logger ||= ::Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/rack/request_replication/logger.rb

@@ -0,0 +1,8 @@
+require 'logger'
+
+module Rack
+  module RequestReplication
+    class Logg
+    end
+  end
+end

data/lib/rack/request_replication/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module RequestReplication
+    VERSION = "0.0.1"
+  end
+end

data/rack-request_replication.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/request_replication/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-request_replication'
+  spec.version       = Rack::RequestReplication::VERSION
+  spec.authors       = ['Wouter de Vos']
+  spec.email         = ['wouter@springest.com']
+  spec.summary       = %q{Request replication MiddleWare for Rack.}
+  spec.description   = %q{Replicate or record HTTP requests to your Rack application and replay them elsewhere or at another time.}
+  spec.homepage      = 'https://github.com/Springest/rack-request_replication'
+  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.add_development_dependency 'bundler',   '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test', '>= 0.5.3'
+  spec.add_development_dependency 'rspec',     '~> 3.0'
+  spec.add_development_dependency 'yard' ,     '>= 0.5.5'
+  spec.add_development_dependency 'sinatra'
+
+  spec.add_runtime_dependency 'rack', '>= 1.0.0'
+end

data/spec/app/test_app.rb

@@ -0,0 +1,72 @@
+require 'sinatra/base'
+require 'rack/request_replication'
+
+$destination_responses ||= []
+
+class TestApp < Sinatra::Base
+  set :port, 4567
+
+  enable :logging
+
+  use Rack::RequestReplication::Forwarder, port: 4568
+
+  get '/' do
+    'GET OK'
+  end
+
+  post '/' do
+    'POST OK'
+  end
+
+  put '/' do
+    'PUT OK'
+  end
+
+  patch '/' do
+    'PATCH OK'
+  end
+
+  delete '/' do
+    'DELETE OK'
+  end
+
+  options '/' do
+    'OPTIONS OK'
+  end
+end
+
+class DestApp < Sinatra::Base
+  set :port, 4568
+
+  enable :logging
+
+  get '/' do
+    $destination_responses << 'GET OK'
+    'Hello, World!'
+  end
+
+  post '/' do
+    $destination_responses << 'POST OK'
+    'Created!'
+  end
+
+  put '/' do
+    $destination_responses << 'PUT OK'
+    'Replaced!'
+  end
+
+  patch '/' do
+    $destination_responses << 'PATCH OK'
+    'Updated'
+  end
+
+  delete '/' do
+    $destination_responses << 'DELETE OK'
+    'Removed!'
+  end
+
+  options '/' do
+    $destination_responses << 'OPTIONS OK'
+    'Appeased!'
+  end
+end

data/spec/forwarder_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+def destination_response
+  sleep 1
+  $destination_responses.last
+end
+
+describe Rack::RequestReplication::Forwarder do
+  include Rack::Test::Methods
+
+  let(:app) { TestApp.new }
+  let(:forwarder) { Rack::RequestReplication::Forwarder.new(app, options) }
+  let(:options) do
+    {
+      port: destination_port
+    }
+  end
+  let(:request) do
+    OpenStruct.new({
+      request_method: request_method,
+      scheme: scheme,
+      port: source_port,
+      path: path
+    })
+  end
+
+  let(:request_method) { 'GET' }
+  let(:scheme) { 'http' }
+  let(:source_port) { 80 }
+  let(:destination_port) { 3000 }
+  let(:host) { 'localhost' }
+  let(:path) { '/' }
+
+  describe 'a GET request' do
+    before { get '/' }
+
+    it { expect(last_response.body).to eq destination_response }
+  end
+
+  describe 'a POST request' do
+    before { post '/', foo: 'bar' }
+
+    it { expect(last_response.body).to eq destination_response }
+  end
+
+  describe 'a PUT request' do
+    before { put '/', foo: 'bar' }
+
+    it { expect(last_response.body).to eq destination_response }
+  end
+
+  describe 'a PATCH request' do
+    before { patch '/', foo: 'bar' }
+
+    it { expect(last_response.body).to eq destination_response }
+  end
+
+  describe 'a DELETE request' do
+    before { delete '/' }
+
+    it { expect(last_response.body).to eq destination_response }
+  end
+
+  describe '#port_matches_scheme?' do
+    subject { forwarder.port_matches_scheme? request }
+    it { is_expected.to be false }
+
+    context 'default port' do
+      let(:destination_port) { 80 }
+      it { is_expected.to be true }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'rack/test'
+require 'rack/request_replication'
+
+ENV['RACK_ENV'] ||= 'test'
+
+require File.expand_path('../app/test_app.rb', __FILE__)
+
+RSpec.configure do |config|
+  config.before :suite do
+    puts "Starting example applications on ports 4567 (source) and 4568 (destination)."
+    @dpid = Thread.new { DestApp.run! }
+    sleep 1
+  end
+
+  config.after :suite do
+    puts "Quitting example applications..."
+    #@spid.kill
+    @dpid.kill
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: rack-request_replication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wouter de Vos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 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
+  name: rake
+  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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Replicate or record HTTP requests to your Rack application and replay
+  them elsewhere or at another time.
+email:
+- wouter@springest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/request_replication.rb
+- lib/rack/request_replication/forwarder.rb
+- lib/rack/request_replication/logger.rb
+- lib/rack/request_replication/version.rb
+- rack-request_replication.gemspec
+- spec/app/test_app.rb
+- spec/forwarder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Springest/rack-request_replication
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Request replication MiddleWare for Rack.
+test_files:
+- spec/app/test_app.rb
+- spec/forwarder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: