sitehub 0.4.2 → 0.4.3

data/lib/sitehub/request_mapping.rb

@@ -4,40 +4,42 @@ class SiteHub
     attr_reader :source_url, :mapped_url, :mapped_path
 
     BASE_URL_MATCHER = %r{^\w+://[\w+\.-]+(:\d+)?}
-    CAPTURE_GROUP_REFERENCE='$%s'
+    CAPTURE_GROUP_REFERENCE = '$%s'.freeze
     USER_SUPPLIED_CAPTURE = 1..-1
 
     def initialize(source_url:, downstream_url: EMPTY_STRING, mapped_url: EMPTY_STRING, mapped_path:)
-      @source_url, @mapped_url = source_url, mapped_url.dup
+      @source_url = source_url
+      @mapped_url = mapped_url.dup
       @mapped_path = mapped_path.is_a?(Regexp) ? mapped_path : Regexp.new(mapped_path)
       @downstream_url = downstream_url
     end
 
     def cookie_path
-      if mapped_path.is_a?(Regexp)
-        mapped_path.source[/^(.*)?\(/,1].gsub(/\/$/, '')
-      end
+      mapped_path.source[/^(.*)?\(/, 1].gsub(%r{/$}, '') if mapped_path.is_a?(Regexp)
     end
 
-
     def computed_uri
       @computed_uri ||= begin
         url_components = url_scanner_regex.match(source_url).captures[USER_SUPPLIED_CAPTURE]
         mapped_url.tap do |url|
           url_components.each_with_index do |match, index|
-            url.gsub!(CAPTURE_GROUP_REFERENCE % (index+1), match)
+            url.gsub!(CAPTURE_GROUP_REFERENCE % (index + 1), match)
           end
         end
       end
     end
 
-    def == other
-      other.is_a?(RequestMapping) && source_url == other.source_url && mapped_url == other.mapped_url && mapped_path == other.mapped_path
+    def ==(other)
+      other.is_a?(RequestMapping) &&
+        source_url == other.source_url &&
+        mapped_url == other.mapped_url &&
+        mapped_path == other.mapped_path
     end
 
     private
+
     def url_scanner_regex
-      %r{#{BASE_URL_MATCHER.source}#{mapped_path.source}}
+      /#{BASE_URL_MATCHER.source}#{mapped_path.source}/
     end
   end
-end
+end

data/lib/sitehub/resolver.rb

@@ -1,11 +1,10 @@
-=begin
-TODO - this helper module is for the benefit of middleware that may not otherwse respond to resolve. THis is to ensure that middleware wrapping the core forward proxy apps had the resolve method also.
-
-=end
+# TODO: - this helper module is for the benefit of middleware that may not otherwse respond to resolve.
+# THis is to ensure that middleware wrapping the core forward proxy apps had the resolve method also.
+#
 class SiteHub
   module Resolver
-    def resolve(*args)
+    def resolve(*_args)
       self
     end
   end
-end
+end

data/lib/sitehub/reverse_proxy.rb

@@ -9,14 +9,12 @@ class SiteHub
 
     attr_reader :path_directives
 
-    def initialize app, directives
+    def initialize(app, directives)
       @app = app
       @path_directives = PathDirectives.new(directives)
     end
 
-
-
-    def call env
+    def call(env)
       downstream_response = @app.call(env)
 
       request_mapping = env[REQUEST_MAPPING]
@@ -24,19 +22,25 @@ class SiteHub
       begin
         downstream_status, downstream_headers, downstream_body = downstream_response.to_a
 
-        if downstream_headers[HttpHeaders::LOCATION_HEADER]
-          downstream_uri = URI(downstream_headers[HttpHeaders::LOCATION_HEADER])
-          mapped_downstream_uri = URI(request_mapping.mapped_url)
-          if downstream_uri.host == mapped_downstream_uri.host && downstream_uri.port == mapped_downstream_uri.port
-            downstream_headers[HttpHeaders::LOCATION_HEADER] = interpolate_location(downstream_headers[HttpHeaders::LOCATION_HEADER], request_mapping.source_url)
-          end
-        end
+        transform_headers(downstream_headers, request_mapping)
 
-        rewrite_cookies(downstream_headers, substitute_domain: URI(request_mapping.source_url).host) if downstream_headers[HttpHeaders::SET_COOKIE]
+        if downstream_headers[HttpHeaders::SET_COOKIE]
+          rewrite_cookies(downstream_headers, substitute_domain: URI(request_mapping.source_url).host)
+        end
 
         Rack::Response.new(downstream_body, downstream_status, downstream_headers)
       end
+    end
 
+    def transform_headers(downstream_headers, request_mapping)
+      if downstream_headers[HttpHeaders::LOCATION_HEADER]
+        downstream_uri = URI(downstream_headers[HttpHeaders::LOCATION_HEADER])
+        mapped_downstream_uri = URI(request_mapping.mapped_url)
+        if downstream_uri.host == mapped_downstream_uri.host && downstream_uri.port == mapped_downstream_uri.port
+          location = interpolate_location(downstream_headers[HttpHeaders::LOCATION_HEADER], request_mapping.source_url)
+          downstream_headers[HttpHeaders::LOCATION_HEADER] = location
+        end
+      end
     end
 
     def interpolate_location(old_location, source_url)

data/lib/sitehub/rules.rb

@@ -1,6 +1,6 @@
 class SiteHub
   module Rules
-    def rule rule=nil
+    def rule(rule = nil)
       return @rule unless rule
       @rule = rule
     end
@@ -10,4 +10,4 @@ class SiteHub
       rule.call(env) == true
     end
   end
-end
+end

data/lib/sitehub/string_sanitiser.rb

@@ -4,4 +4,4 @@ class SiteHub
       string.chomp.strip
     end
   end
-end
+end

data/lib/sitehub/transaction_id.rb

@@ -3,12 +3,12 @@ require 'sitehub/constants'
 class SiteHub
   class TransactionId
     include Constants
-    def initialize app
+    def initialize(app)
       @app = app
     end
 
-    #TODO - don't overwrite
-    def call env
+    # TODO: - don't overwrite
+    def call(env)
       env[RackHttpHeaderKeys::TRANSACTION_ID] ||= UUID.generate(:compact)
       @app.call env
     end

data/lib/sitehub/version.rb

@@ -1,3 +1,3 @@
 class SiteHub
-  VERSION = "0.4.2"
+  VERSION = '0.4.3'.freeze
 end

data/lib/sitehub.rb

@@ -2,7 +2,7 @@ require 'sitehub/constants'
 require 'sitehub/builder'
 class SiteHub
   class << self
-    def build &block
+    def build(&block)
       Builder.new(&block).build
     end
   end

data/sitehub.gemspec

@@ -4,40 +4,38 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sitehub/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sitehub"
+  spec.name          = 'sitehub'
   spec.version       = SiteHub::VERSION
-  spec.authors       = ["Ladtech"]
-  spec.email         = ["team@lad-tech.com"]
-  spec.summary       = %q{A/B testing enabled HTTP proxy}
-  spec.description   = %q{A/B testing enabled HTTP proxy}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Ladtech']
+  spec.email         = ['team@lad-tech.com']
+  spec.summary       = 'A/B testing enabled HTTP proxy'
+  spec.description   = 'A/B testing enabled HTTP proxy'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(spec)/*.rb})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
+  spec.add_dependency 'rack'
+  spec.add_dependency 'uuid'
+  spec.add_dependency 'em-http-request'
+  spec.add_dependency 'rack-ssl-enforcer'
+  spec.add_dependency 'rack-fiber_pool'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'em-synchrony'
+  spec.add_dependency 'thin'
 
-  spec.add_dependency "rack"
-  spec.add_dependency "uuid"
-  spec.add_dependency "em-http-request"
-  spec.add_dependency "rack-ssl-enforcer"
-  spec.add_dependency "rack-fiber_pool"
-  spec.add_dependency "faraday"
-  spec.add_dependency "em-synchrony"
-  spec.add_dependency "thin"
-
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.2.0"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "geminabox"
-  spec.add_development_dependency "simplecov"
-  #spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "memory_profiler"
-  
-  spec.add_development_dependency "ruby-prof"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'geminabox'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'memory_profiler'
 
+  spec.add_development_dependency 'ruby-prof'
 end

data/spec/sitehub/builder_spec.rb

@@ -1,10 +1,8 @@
+# rubocop:disable Metrics/ClassLength
 require 'sitehub/builder'
 
 class SiteHub
-
-
   describe Builder do
-
     include_context :middleware_test
 
     subject do
@@ -19,14 +17,12 @@ class SiteHub
 
     describe '#proxy' do
       context 'no version explicitly defined' do
-
         subject do
           described_class.new do
             proxy '/app1' => :endpoint
           end
         end
 
-
         it 'the defined route is used 100% of the time' do
           expected_proxy = ForwardProxyBuilder.new(mapped_path: '/path').tap do |route|
             route.default(url: :endpoint)
@@ -54,7 +50,7 @@ class SiteHub
       end
     end
 
-    describe "#access_logger" do
+    describe '#access_logger' do
       it ' sets the logger' do
         subject.access_logger :access_logger
         sitehub = subject.build
@@ -69,13 +65,12 @@ class SiteHub
         logger_middleware = find_middleware(sitehub, Logging::AccessLogger)
         expect(logger_middleware.logger).to eq(Logging::LogWrapper.new(:stdout_logger))
       end
-
     end
 
     describe '#reverse_proxy' do
       it 'registers a reverse proxy' do
-        subject.reverse_proxy(:downstream_url => :upstream_path)
-        expect(subject.reverse_proxies).to eq({:downstream_url => :upstream_path})
+        subject.reverse_proxy(downstream_url: :upstream_path)
+        expect(subject.reverse_proxies).to eq(downstream_url: :upstream_path)
       end
     end
 
@@ -91,7 +86,7 @@ class SiteHub
       end
     end
 
-    describe "#error_logger" do
+    describe '#error_logger' do
       it 'sets the logger' do
         subject.error_logger :error_logger
         sitehub = subject.build
@@ -106,11 +101,9 @@ class SiteHub
         logger_middleware = find_middleware(sitehub, SiteHub::Logging::ErrorLogger)
         expect(logger_middleware.logger).to eq(Logging::LogWrapper.new(:stderr_logger))
       end
-
     end
 
     describe '#build' do
-
       it 'initializes the forward_proxies' do
         expect(subject.forward_proxies).to receive(:init).and_call_original
         subject.build
@@ -142,17 +135,24 @@ class SiteHub
           end
 
           it 'uses configured reverse proxy directives' do
-            subject.reverse_proxy({:downstream_url => :upstream_path.to_s})
+            subject.reverse_proxy(downstream_url: :upstream_path.to_s)
             reverse_proxy = find_middleware(subject.build, ReverseProxy)
 
-            expect(reverse_proxy.path_directives).to eq(PathDirectives.new(:downstream_url => :upstream_path.to_s))
+            expect(reverse_proxy.path_directives).to eq(PathDirectives.new(downstream_url: :upstream_path.to_s))
           end
         end
 
-
         it 'adds them in the right order' do
-          middleware_stack = collect_middleware(subject.build).collect{|m| m.class}
-          expect(middleware_stack).to eq([Rack::FiberPool, Logging::ErrorLogger, Logging::AccessLogger,TransactionId, ReverseProxy, ForwardProxies])
+          middleware_stack = collect_middleware(subject.build).collect(&:class)
+
+          expected_middleware = [Rack::FiberPool,
+                                 Logging::ErrorLogger,
+                                 Logging::AccessLogger,
+                                 TransactionId,
+                                 ReverseProxy,
+                                 ForwardProxies]
+
+          expect(middleware_stack).to eq(expected_middleware)
         end
       end
 
@@ -195,9 +195,7 @@ class SiteHub
             expect(sitehub).to_not be_using(Rack::SslEnforcer)
           end
         end
-
       end
     end
-
   end
-end
+end

data/spec/sitehub/collection/route_collection_spec.rb

@@ -2,10 +2,8 @@ require 'sitehub/collection/route_collection'
 require 'sitehub/forward_proxy'
 
 class SiteHub
-
   describe Collection::RouteCollection do
-
-    let(:route_without_rule) { ForwardProxy.new(url: :url, id: :id,sitehub_cookie_name: :cookie_name) }
+    let(:route_without_rule) { ForwardProxy.new(url: :url, id: :id, sitehub_cookie_name: :cookie_name) }
 
     it 'is a collection' do
       expect(subject).to be_a(Collection)
@@ -34,7 +32,7 @@ class SiteHub
     describe '#valid?' do
       context 'route added' do
         it 'returns true' do
-          subject.add :id,route_without_rule
+          subject.add :id, route_without_rule
           expect(subject).to be_valid
         end
       end
@@ -47,21 +45,21 @@ class SiteHub
     end
 
     describe '#resolve' do
-
       context 'no rule on route' do
         it 'returns the route' do
-          route_without_rule = ForwardProxy.new(url: :url, id: :id,sitehub_cookie_name: :cookie_name)
+          route_without_rule = ForwardProxy.new(url: :url, id: :id, sitehub_cookie_name: :cookie_name)
           subject.add(:id, route_without_rule)
           expect(subject.resolve({})).to be(route_without_rule)
         end
       end
       context 'rule on route' do
-
         it 'passes the environment to the rule' do
           request_env = {}
-          rule = proc {|env| env[:env_passed_in] = true}
+          rule = proc { |env| env[:env_passed_in] = true }
 
-          proxy = ForwardProxy.new(url: :url, id: :id, sitehub_cookie_name: :cookie_name)
+          proxy = ForwardProxy.new(url: :url,
+                                   id: :id,
+                                   sitehub_cookie_name: :cookie_name)
           proxy.rule(rule)
           subject.add(:id, proxy)
           subject.resolve(env: request_env)
@@ -70,16 +68,21 @@ class SiteHub
 
         context 'rule applies' do
           it 'returns the route' do
-            route_with_rule = ForwardProxy.new(url: :url, id: :id, rule: proc { true }, sitehub_cookie_name: :cookie_name)
+            route_with_rule = ForwardProxy.new(url: :url,
+                                               id: :id,
+                                               rule: proc { true },
+                                               sitehub_cookie_name: :cookie_name)
             subject.add(:id, route_with_rule)
             expect(subject.resolve({})).to be(route_with_rule)
           end
-
         end
 
         context 'rule does not apply' do
           it 'returns nil' do
-            route_with_rule = ForwardProxy.new(url: :url, id: :id, sitehub_cookie_name: :cookie_name, rule: proc { false })
+            route_with_rule = ForwardProxy.new(url: :url,
+                                               id: :id,
+                                               sitehub_cookie_name: :cookie_name,
+                                               rule: proc { false })
             subject.add(:id, route_with_rule)
             expect(subject.resolve({})).to eq(nil)
           end
@@ -87,5 +90,4 @@ class SiteHub
       end
     end
   end
-
-end
+end

data/spec/sitehub/collection/split_route_collection_spec.rb

@@ -2,11 +2,9 @@ require 'sitehub/collection/split_route_collection'
 require 'sitehub/forward_proxy'
 
 class SiteHub
-
   describe Collection::SplitRouteCollection do
-
-    let(:route_1) { ForwardProxy.new(url: :url, id: :id1,sitehub_cookie_name: :cookie_name) }
-    let(:route_2) { ForwardProxy.new(url: :url, id: :id2,sitehub_cookie_name: :cookie_name) }
+    let(:route_1) { ForwardProxy.new(url: :url, id: :id1, sitehub_cookie_name: :cookie_name) }
+    let(:route_2) { ForwardProxy.new(url: :url, id: :id2, sitehub_cookie_name: :cookie_name) }
 
     it 'is a collection' do
       expect(subject).to be_a(Collection)
@@ -34,13 +32,15 @@ class SiteHub
 
       context 'entry is added which takes splits total over 100%' do
         it 'raises an error' do
-          expect{subject.add route_2.id, route_2, 101}.to raise_exception described_class::InvalidSplitException, 'total split percentages can not be greater than 100%'
+          expect { subject.add route_2.id, route_2, 101 }
+            .to raise_exception described_class::InvalidSplitException, described_class::SPLIT_ERR_MSG
         end
       end
 
       context 'non fixnum passed in' do
         it 'raises and error' do
-          expect{subject.add route_2.id, route_2, 1.1}.to raise_exception described_class::InvalidSplitException, 'splits must be a Fixnum'
+          expect { subject.add route_2.id, route_2, 1.1 }
+            .to raise_exception described_class::InvalidSplitException, described_class::FIXNUM_ERR_MSG
         end
       end
     end
@@ -79,8 +79,7 @@ class SiteHub
       end
     end
 
-    describe "#valid?" do
-
+    describe '#valid?' do
       context 'splits == to 100' do
         it 'returns true' do
           subject.add route_1.id, route_1, 50
@@ -107,5 +106,4 @@ class SiteHub
       end
     end
   end
-
-end
+end

data/spec/sitehub/collection_spec.rb

@@ -4,13 +4,13 @@ class SiteHub
   describe Collection do
     describe '#valid?' do
       it 'must be overiden and raises an exception by default' do
-        expect { subject.valid? }.to raise_exception "implement me"
+        expect { subject.valid? }.to raise_exception 'implement me'
       end
     end
 
     describe '#resolve' do
       it 'must be overiden and raises an exception by default' do
-        expect { subject.resolve }.to raise_exception "implement me"
+        expect { subject.resolve }.to raise_exception 'implement me'
       end
     end
 
@@ -19,7 +19,7 @@ class SiteHub
         context 'duplicate ids added' do
           subject do
             inheritor = Class.new(described_class) do
-              def add id, value, *args
+              def add(id, value, *_args)
                 self[id] = value
               end
             end
@@ -29,12 +29,12 @@ class SiteHub
           it 'raises an error' do
             duplicate = Struct.new(:id).new(1)
             subject.add(duplicate.id, duplicate)
-            expect{subject.add(duplicate.id, duplicate)}.to raise_exception described_class::DuplicateVersionException, 'supply unique labels'
+            expected_message = described_class::ClassMethods::UNIQUE_LABELS_MSG
+            expect { subject.add(duplicate.id, duplicate) }
+              .to raise_exception described_class::DuplicateVersionException, expected_message
           end
         end
       end
-
     end
-
   end
-end
+end

data/spec/sitehub/cookie/attribute_spec.rb

@@ -1,8 +1,8 @@
 class SiteHub
   class Cookie
     describe Attribute do
-      let(:attribute_name){'domain'}
-      let(:attribute_value){'value'}
+      let(:attribute_name) { 'domain' }
+      let(:attribute_value) { 'value' }
       subject do
         described_class.new(attribute_name, attribute_value)
       end
@@ -34,4 +34,4 @@ class SiteHub
       end
     end
   end
-end
+end

data/spec/sitehub/cookie/flag_spec.rb

@@ -2,7 +2,7 @@ class SiteHub
   class Cookie
     describe Flag do
       let(:name) { 'flag' }
-      let(:string_sanitiser){Object.new.tap{|o|o.extend(StringSanitiser)}}
+      let(:string_sanitiser) { Object.new.tap { |o| o.extend(StringSanitiser) } }
       subject do
         described_class.new(name)
       end
@@ -24,4 +24,4 @@ class SiteHub
       end
     end
   end
-end
+end

data/spec/sitehub/cookie_rewriting_spec.rb

@@ -2,12 +2,18 @@ require 'sitehub/cookie_rewriting'
 
 class SiteHub
   describe CookieRewriting do
-    let(:downstream_domain){'.downstream_domain.com'}
-    let(:request_mapping){RequestMapping.new(source_url: 'http://example.org', mapped_url: "http://#{downstream_domain}", mapped_path: '/map')}
-    let(:substitute_domain){URI(request_mapping.source_url).host}
-    let(:substitute_path){'/path'}
-    let(:downstream_response){Rack::Response.new}
-    let(:downstream_domain_cookie_name){'downstream.cookie'}
+    let(:downstream_domain) { '.downstream_domain.com' }
+
+    let(:request_mapping) do
+      RequestMapping.new(source_url: 'http://example.org',
+                         mapped_url: "http://#{downstream_domain}",
+                         mapped_path: '/map')
+    end
+
+    let(:substitute_domain) { URI(request_mapping.source_url).host }
+    let(:substitute_path) { '/path' }
+    let(:downstream_response) { Rack::Response.new }
+    let(:downstream_domain_cookie_name) { 'downstream.cookie' }
 
     subject do
       Object.new.tap do |o|
@@ -28,8 +34,8 @@ class SiteHub
         cookie1 = SiteHub::Cookie.new(cookie_strings[0])
         cookie2 = SiteHub::Cookie.new(cookie_strings[1])
         expected = {
-            cookie1.name => cookie1,
-            cookie2.name => cookie2
+          cookie1.name => cookie1,
+          cookie2.name => cookie2
         }
         result = subject.cookies_string_as_hash(cookie_header)
         expect(result).to eq(expected)
@@ -44,7 +50,6 @@ class SiteHub
     end
 
     describe '#rewrite_cookies' do
-
       context 'subdomain character present' do
         it 'substitues the domain for the mapped domain' do
           downstream_response.set_cookie(downstream_domain_cookie_name, domain: downstream_domain, value: 'value')
@@ -61,7 +66,5 @@ class SiteHub
         end
       end
     end
-
   end
-
-end
+end

data/spec/sitehub/cookie_spec.rb

@@ -2,12 +2,12 @@ require 'sitehub/cookie'
 
 class SiteHub
   describe Cookie do
-    let(:attribute_class){described_class::Attribute}
-    let(:flag_class){described_class::Flag}
-    let(:domain_attribute){attribute_class.new(:domain.to_s, 'example.com')}
-    let(:name){'sitehub.recorded_route'}
-    let(:value){'new'}
-    let(:cookie_string){ "#{name}=#{value}; HttpOnly; #{domain_attribute}"}
+    let(:attribute_class) { described_class::Attribute }
+    let(:flag_class) { described_class::Flag }
+    let(:domain_attribute) { attribute_class.new(:domain.to_s, 'example.com') }
+    let(:name) { 'sitehub.recorded_route' }
+    let(:value) { 'new' }
+    let(:cookie_string) { "#{name}=#{value}; HttpOnly; #{domain_attribute}" }
 
     subject do
       described_class.new cookie_string
@@ -27,9 +27,7 @@ class SiteHub
       end
     end
 
-
     describe '#find' do
-
       context 'entry found' do
         it 'returns the entry with the given name' do
           expect(subject.find(:domain)).to eq(domain_attribute)
@@ -41,14 +39,6 @@ class SiteHub
           expect(subject.find(:missing)).to eq(nil)
         end
       end
-
-    end
-
-    describe '#delete' do
-      it 'removes the entry' do
-        subject.delete(:domain)
-        expect(subject.find(:domain)).to eq(nil)
-      end
     end
 
     describe '#to_s' do
@@ -56,6 +46,5 @@ class SiteHub
         expect(subject.to_s).to eq(cookie_string)
       end
     end
-
   end
-end
+end