rack-request_replication 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f86b1abca6aee060bc978f2d9d03cc0241ff51e
-  data.tar.gz: 8f5e982046204fc40f2c4369805b5b073795c679
+  metadata.gz: f066360d1270ffe1fd8bf8c0f6045c40884e7c4b
+  data.tar.gz: 3cb0501284af15b165271922a71627b418873907
 SHA512:
-  metadata.gz: b67f6d7ecbf05611b54da1c862ce67fdd6e3ea58e53c01867bc0eb6f62d71aa845b2d23b762ac81aa5ad17a8033778f232eef6b264a4ad4854935c173f373a75
-  data.tar.gz: cfe08f90f63f11b7232330c81c2ba43faea3f5bc9c13ea42cb9a5ba5c8fc8f0fab060b4d4eb37f8ac7126528edd0d0390530e8ebf68c540058c8089d5bde189e
+  metadata.gz: d38e8f9f3e53f44c2df81d9ee16b9e8459e54b8a8c454ef5c9abe2e2dbd5c8276dbcaecca6342d10421c616c942ce7e16f27bda9f03995223f5671c41d8c85ef
+  data.tar.gz: aad6649afb76b4b38beab7586e24fedf87640d66a98b35e98ad4b42e4b45d34c427b84064ace3f839a95088dd39400f0c1b8e03ca601a5e6fd014732169f6c5c

data/README.md

@@ -1,8 +1,20 @@
-# Rack::RequestReplication
+# Rack::RequestReplication - Replicate Rack app HTTP requests
 
 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.
+We replicate all live requests to our staging environment to test new
+code before it goes live. With real traffic!
+
+## Session support
+
+It has support for sessions. To make use of it, you need to have Redis
+running. Redis serves as a key-value store where sessions from the
+Source App are linked to sessions from the Forward App. This way both
+apps can have their own session management.
+
+## API Docs
+
+Check out the official [API docs](http://rubydoc.info/gems/rack-request_replication)
 
 ## Installation
 
@@ -24,11 +36,20 @@ Or install it yourself as:
 
 ```ruby
 require 'sinatra/base'
+require 'sinatra/cookies'
 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
+  use Rack::RequestReplication::Forwarder,
+        host: 'localhost',
+        port: 4568,
+        session_key: 'rack.session',
+        redis: {
+          host: 'localhost',
+          port: 6379,
+          db: 'rack-request-replication'
+        }
 
   get '/' do
     'Hello World'

data/lib/rack/request_replication/forwarder.rb

@@ -17,9 +17,13 @@ module Rack
       ##
       # @param  [#call]                  app
       # @param  [Hash{Symbol => Object}] options
-      # @option options [String]  :host  ('localhost')
-      # @option options [Integer] :port  (8080)
-      # @option options [String]  :session_key ('rack.session')
+      # @option options [String]                 :host  ('localhost')
+      # @option options [Integer]                :port  (8080)
+      # @option options [String]                 :session_key ('rack.session')
+      # @option options [Hash{Symbol => Object}] :redis
+      #   @option redis [String]  :host ('localhost')
+      #   @option redis [Integer] :port (6379)
+      #   @option redis [String]  :db   ('rack-request-replication')
       #
       def initialize( app, options = {} )
         @app = app
@@ -70,6 +74,14 @@ module Rack
         end
       end
 
+      ##
+      # Update cookies from the forwarded request using the session id
+      # from the cookie of the source app as a key. The cookie is stored
+      # in Redis.
+      #
+      # @param [Rack::Request] request
+      # @param [Net::HTTP::Response] response
+      #
       def update_cookies( request, response )
         return unless cookies_id( request )
         cookie = response.to_hash['set-cookie'].collect{|ea|ea[/^.*?;/]}.join rescue {}
@@ -77,13 +89,32 @@ module Rack
         redis.set( cookies_id( request), cookie )
       end
 
+      ##
+      # Cookies Hash to use for the forwarded request.
+      #
+      # Tries to find the cookies from earlier forwarded
+      # requests in the Redis store, otherwise falls back
+      # to the cookies from the source app.
+      #
+      # @param   [Rack::Request] request
+      # @returns [Hash]
+      #
       def cookies( request )
         return ( request.cookies || "" ) unless cookies_id( request )
-        cs = redis.get( cookies_id( request )) ||
+        redis.get( cookies_id( request )) ||
           request.cookies ||
           {}
       end
 
+      ##
+      # The key to use when looking up cookie stores in
+      # Redis for forwarding requests. Needed for session
+      # persistence over forwarded requests for the same
+      # user in the source app.
+      #
+      # @param   [Rack::Request] request
+      # @returns [String]
+      #
       def cookies_id( request )
         cs = request.cookies
         sess = cs && cs[options[:session_key]]
@@ -91,32 +122,89 @@ module Rack
         sess_id
       end
 
+      ##
+      # Prepare a GET request to the forward app.
+      #
+      # The passed in options hash is ignored.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Get]
+      #
       def create_get_request( uri, opts = {} )
         Net::HTTP::Get.new uri.request_uri
       end
 
+      ##
+      # Prepare a POST request to the forward app.
+      #
+      # The passed in options hash contains all the
+      # data from the request that needs to be forwarded.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Post]
+      #
       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
 
+      ##
+      # Prepare a PUT request to the forward app.
+      #
+      # The passed in options hash contains all the
+      # data from the request that needs to be forwarded.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Put]
+      #
       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
 
+      ##
+      # Prepare a PATCH request to the forward app.
+      #
+      # The passed in options hash contains all the
+      # data from the request that needs to be forwarded.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Patch]
+      #
       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
 
+      ##
+      # Prepare a DELETE request to the forward app.
+      #
+      # The passed in options hash is ignored.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Delete]
+      #
       def create_delete_request( uri, opts = {} )
         Net::HTTP::Delete.new uri.request_uri
       end
 
+      ##
+      # Prepare a OPTIONS request to the forward app.
+      #
+      # The passed in options hash is ignored.
+      #
+      # @param   [URI] uri
+      # @param   [Hash{Symbol => Object}] opts ({})
+      # @returns [Net:HTTP::Options]
+      #
       def create_options_request( uri, opts = {} )
         Net::HTTP::Options.new uri.request_uri
       end
@@ -162,6 +250,13 @@ module Rack
         URI(url)
       end
 
+      ##
+      # The host to forward to including the port if
+      # the port does not match the current scheme.
+      #
+      # @param   [Rack::Request] request
+      # @returns [String]
+      #
       def forward_host_with_port( request )
         host = options[:host].to_s
         host = "#{host}:#{options[:port]}" unless port_matches_scheme? request
@@ -179,6 +274,7 @@ module Rack
           db: 'rack-request-replication'
         }.merge(options[:redis]))
       end
+
       ##
       # Checks if the request scheme matches the destination port.
       #
@@ -189,10 +285,21 @@ module Rack
         options[:port].to_i == Rack::Request::DEFAULT_PORTS[clean_scheme(request)]
       end
 
+      ##
+      # Request scheme without the ://
+      #
+      # @param   [Rack::Request] request
+      # @returns [String]
+      #
       def clean_scheme( request )
         request.scheme.match(/^\w+/)[0]
       end
 
+      ##
+      # Logger that logs to STDOUT
+      #
+      # @returns [Logger]
+      #
       def logger
         @logger ||= ::Logger.new(STDOUT)
       end

data/lib/rack/request_replication/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module RequestReplication
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/app/test_app.rb

@@ -9,7 +9,14 @@ class TestApp < Sinatra::Base
 
   enable :logging
 
-  use Rack::RequestReplication::Forwarder, port: 4568
+  use Rack::RequestReplication::Forwarder, host: 'localhost',
+        port: 4568,
+        session_key: 'rack.session',
+        redis: {
+          host: 'localhost',
+          port: 6379,
+          db: 'rack-request-replication'
+        }
 
   get '/' do
     'GET OK'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-request_replication
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Wouter de Vos
@@ -151,7 +151,6 @@ files:
 - 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

data/lib/rack/request_replication/logger.rb

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