sitehub 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af77a45a381dc3d5db1d15d6d4934dd97fcfcf14
-  data.tar.gz: 365f724e5ecc280935665cadc36dbab16b45fe34
+  metadata.gz: 7a6e0a6953fd3b5d361c2e65e2b0b015a22a36b8
+  data.tar.gz: 76336ecd1253d8cf8e593e6bc67a1912b9fde469
 SHA512:
-  metadata.gz: 5a263ad7fde6a5f68b9c3480ae0765b302918cdbd1eccd30bff05704ed9054c171b7c291932bbc5632b32b30162237c5c586e84e9616392a4604e35cff944e74
-  data.tar.gz: 48358f5f31aae39ff3d70a3bc83e2760b53b37b46046c2cd28eddf53537aa3b607bcc22dce3143a7ac41acc387898660b55d87e51c99196532be4a38412df0f6
+  metadata.gz: ecd3cd69815ab6d8755e222e0fbd17ee4b92f09472f67272da3b5f407be8b4a9954009d6b5563e7320ffda0db6b7b5aa8dce8e71e4d39e72f108fa5c522687d0
+  data.tar.gz: e17c0f2deb78badac60445ac189103bb193687ed073202edcf1e12282aaff4e22e77c7bc74596133f3b8d069796bcefda52a01b0d1b19368c8ce966ec9095b07

data/.rubocop.yml

@@ -0,0 +1,17 @@
+Metrics/LineLength:
+  Max: 120
+
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - 'pkg/**/*'
+    - 'vendor/**/*'
+    - 'coverage/**/*'
+    - '.idea/**/*'
+    - '*.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 11

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sitehub.gemspec
 gemspec
-
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sitehub (0.4.2)
+    sitehub (0.4.3)
       em-http-request
       em-synchrony
       faraday
@@ -15,6 +15,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
+    ast (2.2.0)
     builder (3.2.2)
     cookiejar (0.3.0)
     crack (0.4.3)
@@ -50,6 +51,9 @@ GEM
     memory_profiler (0.9.6)
     multipart-post (2.0.0)
     nesty (1.0.2)
+    parser (2.3.1.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     rack (1.6.4)
     rack-fiber_pool (0.9.3)
     rack-protection (1.5.3)
@@ -57,6 +61,7 @@ GEM
     rack-ssl-enforcer (0.2.9)
     rack-test (0.6.3)
       rack (>= 1.0)
+    rainbow (2.1.0)
     rake (10.4.2)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
@@ -71,7 +76,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-prof (0.15.9)
+    ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
     simplecov (0.11.1)
       docile (~> 1.1.0)
@@ -88,6 +100,7 @@ GEM
       eventmachine (~> 1.0, >= 1.0.4)
       rack (~> 1.0)
     tilt (2.0.2)
+    unicode-display_width (1.0.5)
     uuid (2.3.8)
       macaddr (~> 1.0)
     webmock (1.22.5)
@@ -105,6 +118,7 @@ DEPENDENCIES
   rack-test
   rake
   rspec (~> 3.2.0)
+  rubocop
   ruby-prof
   simplecov
   sitehub!

data/README.md

@@ -132,6 +132,29 @@ sitehub = SiteHub.build do
   end
 end
 ```
+### Nesting routes and splits
+Routes and Splits can themselves contain further route or split definitions
+```ruby
+sitehub = SiteHub.build do 
+  proxy '/catalogue' do
+    # Experiment 1
+    split(precentage: 30) do
+      # 30% of overall traffic is split between 2 different prototypes
+      split percentage: 50, url: 'http://version1.com', label: :prototype_1
+      split percentage: 50, url: 'http://version2.com', label: :prototype_2
+    end
+    
+    # Experiment 2
+    split(precentage: 30) do
+      # 30% of overall traffic is split between 2 different prototypes
+      split percentage: 50, url: 'http://version3.com', label: :prototype_3
+      split percentage: 50, url: 'http://version4.com', label: :prototype_4
+    end
+  
+    default url: 'http://current_catalogue.com'
+  end
+end
+```
 ### Labels
 Splits and Routes must be defined with a label. Within a proxy defintion, this label must be unique. This is the value that SiteHub will use to identify the version of a downstream url that a user should stick to once it has been selected.
 

data/Rakefile

@@ -1,11 +1,5 @@
-require 'bundler'
-require "bundler/gem_tasks"
-
-require 'rspec/core/rake_task'
-
-
-RSpec::Core::RakeTask.new(:spec) do
-  ENV['coverage'] = 'true'
+Dir["#{__dir__}/tasks/*.rake"].each do |tasks|
+  import tasks
 end
 
-task :default => :spec
+task default: [:clean, :spec, :coverage_check, 'rubocop:auto_correct', 'rubocop']

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: '2.1'
+test:
+  override:
+    - bundle exec rake

data/lib/sitehub/builder.rb

@@ -8,18 +8,15 @@ require 'sitehub/logging'
 require 'rack/fiber_pool'
 require 'logger'
 
-
 class SiteHub
-
-  class InvalidProxyDefinitionException < Exception;
+  class InvalidProxyDefinitionException < Exception
   end
   class Builder
-
     attr_reader :sitehub, :forward_proxies, :reverse_proxies
 
     include Middleware
 
-    def force_ssl except: []
+    def force_ssl(except: [])
       @force_ssl = true
       @ssl_exclusions = except
     end
@@ -27,20 +24,20 @@ class SiteHub
     def initialize(&block)
       @forward_proxies = ForwardProxies.new
       @reverse_proxies = {}
-      instance_eval &block if block
+      instance_eval(&block) if block
     end
 
-    def access_logger logger=nil
+    def access_logger(logger = nil)
       return @access_logger unless logger
       @access_logger = logger
     end
 
-    def error_logger logger=nil
+    def error_logger(logger = nil)
       return @error_logger unless logger
       @error_logger = logger
     end
 
-    def sitehub_cookie_name name=nil
+    def sitehub_cookie_name(name = nil)
       @sitehub_cookie_name ||= RECORDED_ROUTES_COOKIE
 
       return @sitehub_cookie_name unless name
@@ -49,34 +46,37 @@ class SiteHub
 
     def build
       forward_proxies.init
+      add_default_middleware
+      middlewares.reverse!
+      apply_middleware(forward_proxies)
+    end
+
+    def add_default_middleware
       use ReverseProxy, reverse_proxies
       use TransactionId
       use Logging::AccessLogger, access_logger || ::Logger.new(STDOUT)
       use Logging::ErrorLogger, error_logger || ::Logger.new(STDERR)
       use Rack::FiberPool
       use Rack::SslEnforcer, except: @ssl_exclusions if @force_ssl
-      middlewares.reverse!
-
-      apply_middleware(forward_proxies)
     end
 
-    def proxy opts={}, &block
-      args = {sitehub_cookie_name: sitehub_cookie_name}
+    def proxy(opts = {}, &block)
+      args = { sitehub_cookie_name: sitehub_cookie_name }
 
       if opts.is_a?(Hash)
         mapped_path = opts.keys.first
         url = opts.values.first
-        args.merge!(url: url, mapped_path: mapped_path)
+        args[:url] = url
+        args[:mapped_path] = mapped_path
       else
-        args.merge!(mapped_path: opts)
+        args[:mapped_path] = opts
       end
 
       forward_proxies << ForwardProxyBuilder.new(args, &block)
     end
 
-    def reverse_proxy hash
+    def reverse_proxy(hash)
       reverse_proxies.merge!(hash)
     end
   end
-
-end
+end

data/lib/sitehub/collection/route_collection.rb

@@ -2,27 +2,25 @@ require_relative '../collection'
 class SiteHub
   class Collection < Hash
     class RouteCollection < Collection
-
-      def add id, route, *opts
+      def add(id, route, *_opts)
         self[id] = route
       end
 
       def valid?
-        !self.empty?
+        !empty?
       end
 
       def resolve(env: nil)
-        return self.values.first unless self.values.find { |route| route.rule }
-        result = self.values.find { |route| route.applies?(env) }
+        return values.first unless values.find(&:rule)
+        result = values.find { |route| route.applies?(env) }
         result && result.resolve(env: env)
       end
 
-      def transform &block
-        each  do |id, value|
-          self[id] = block.call(value)
+      def transform
+        each do |id, value|
+          self[id] = yield(value)
         end
       end
-
     end
   end
 end

data/lib/sitehub/collection/split_route_collection/split.rb

@@ -5,14 +5,16 @@ class SiteHub
         attr_reader :upper, :lower
         attr_accessor :value
 
-        def initialize lower, upper, value
-          @upper, @lower, @value = upper, lower, value
+        def initialize(lower, upper, value)
+          @upper = upper
+          @lower = lower
+          @value = value
         end
 
-        def == other
-          other.is_a?(Split) && other.lower == self.lower && other.upper == self.upper
+        def ==(other)
+          other.is_a?(Split) && other.lower == lower && other.upper == upper
         end
       end
     end
   end
-end
+end

data/lib/sitehub/collection/split_route_collection.rb

@@ -3,38 +3,41 @@ require_relative 'split_route_collection/split'
 class SiteHub
   class Collection < Hash
     class SplitRouteCollection < Collection
-      class InvalidSplitException < Exception;
+      class InvalidSplitException < Exception
       end
 
-      def initialize(hash={})
+      FIXNUM_ERR_MSG = 'splits must be a Fixnum'.freeze
+      SPLIT_ERR_MSG = 'total split percentages can not be greater than 100%'.freeze
+
+      def initialize(hash = {})
         hash.each do |value, percentage|
           add(value.id, value, percentage)
         end
       end
 
-      def add id, value, percentage
-        raise InvalidSplitException, 'splits must be a Fixnum' unless percentage.is_a?(Fixnum)
+      def add(id, value, percentage)
+        raise InvalidSplitException, FIXNUM_ERR_MSG unless percentage.is_a?(Fixnum)
         lower = values.last ? values.last.upper : 0
         upper = lower + percentage
 
-        raise InvalidSplitException, 'total split percentages can not be greater than 100%' if upper > 100
+        raise InvalidSplitException, SPLIT_ERR_MSG if upper > 100
         self[id] = Split.new(lower, upper, value)
       end
 
       def resolve(*args)
         random = rand(100)
         result = values.find { |split| random >= split.lower && random < split.upper }
-        result ? result.value : nil
+        result ? result.value.resolve(*args) : nil
       end
 
-      def transform &block
+      def transform
         values.each do |split|
-          split.value = block.call(split.value)
+          split.value = yield(split.value)
         end
       end
 
-      def [] key
-        result = super
+      def [](key)
+        result = super(key)
         result && result.value
       end
 

data/lib/sitehub/collection.rb

@@ -1,35 +1,40 @@
 class SiteHub
   class Collection < Hash
-    class DuplicateVersionException < Exception;
+    class DuplicateVersionException < Exception
+    end
+
+    module ClassMethods
+      def overrides
+        @overrides ||= []
+      end
+
+      UNIQUE_LABELS_MSG = 'supply unique labels'.freeze
+
+      def method_added(name)
+        if name == :add && !overrides.include?(name)
+          overrides << name
+          alias_method :add_backup, :add
+
+          send(:define_method, :add) do |id, value, *args|
+            raise DuplicateVersionException, UNIQUE_LABELS_MSG if self[id]
+            add_backup id, value, *args
+          end
+        end
+      end
     end
 
     def valid?
-      raise "implement me"
+      raise 'implement me'
     end
 
     def resolve
-      raise "implement me"
+      raise 'implement me'
     end
 
     class << self
-      def inherited clazz
-
-        def clazz.overrides
-          @overrides ||=[]
-        end
-
-        def clazz.method_added(name)
-          if name == :add && !overrides.include?(name)
-            overrides << name
-            alias_method :add_backup, :add
-
-            self.send(:define_method, :add) do |id, value, *args|
-              raise DuplicateVersionException, 'supply unique labels' if self[id]
-              add_backup id, value, *args
-            end
-          end
-        end
+      def inherited(clazz)
+        clazz.extend(ClassMethods)
       end
     end
   end
-end
+end

data/lib/sitehub/constants/http_header_keys.rb

@@ -1,9 +1,7 @@
 class SiteHub
   module Constants
     module HttpHeaderKeys
-
-      ShouldNotTransfer = %w(proxy-connection).freeze
-
+      PROXY_CONNECTION = 'proxy-connection'.freeze
       LOCATION_HEADER = 'location'.freeze
       HOST_HEADER = 'host'.freeze
       X_FORWARDED_HOST_HEADER = 'x-forwarded-host'.freeze
@@ -18,8 +16,6 @@ class SiteHub
       CONTENT_ENCODING = 'content-encoding'.freeze
       SET_COOKIE = 'Set-Cookie'.freeze
       CONTENT_LENGTH = 'Content-Length'.freeze
-
-      HopByHop = [CONNECTION_HEADER, KEEP_ALIVE, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, TE, TRAILERS, TRANSFER_ENCODING, CONTENT_ENCODING].freeze
     end
   end
-end
+end

data/lib/sitehub/constants/rack_http_header_keys.rb

@@ -9,9 +9,9 @@ class SiteHub
       REMOTE_ADDR = 'REMOTE_ADDR'.freeze
       REMOTE_USER = 'REMOTE_USER'.freeze
       HTTP_VERSION = 'HTTP_VERSION'.freeze
-      REMOTE_ADDRESS_ENV_KEY = "REMOTE_ADDR".freeze
+      REMOTE_ADDRESS_ENV_KEY = 'REMOTE_ADDR'.freeze
       HTTP_HEADER_FILTER_EXCEPTIONS = %w(CONTENT_TYPE CONTENT_LENGTH).freeze
       TRANSACTION_ID = 'HTTP_SITEHUB_TRANSACTION_ID'.freeze
     end
   end
-end
+end

data/lib/sitehub/constants.rb

@@ -7,17 +7,17 @@ class SiteHub
   ASYNC_CALLBACK = 'async.callback'.freeze
   RECORDED_ROUTES_COOKIE = 'sitehub.recorded_route'.freeze
   ERRORS = 'sitehub.errors'.freeze
-  TIME_STAMP_FORMAT = "%d/%b/%Y:%H:%M:%S %z".freeze
+  TIME_STAMP_FORMAT = '%d/%b/%Y:%H:%M:%S %z'.freeze
   EMPTY_STRING = ''.freeze
   UNDERSCORE = '_'.freeze
   SEMICOLON = ';'.freeze
   SPACE = ' '.freeze
   SEMICOLON_WITH_SPACE = "#{SEMICOLON}#{SPACE}".freeze
-  COMMA_WITH_SPACE = ", "
+  COMMA_WITH_SPACE = ', '.freeze
 
   HYPHEN = '-'.freeze
   QUESTION_MARK = '?'.freeze
   EQUALS_SIGN = '='.freeze
   FULL_STOP = '.'.freeze
   NEW_LINE = "\n".freeze
-end
+end

data/lib/sitehub/cookie/attribute.rb

@@ -5,7 +5,7 @@ class SiteHub
       include StringSanitiser
       attr_accessor :name, :value
 
-      def initialize name, value
+      def initialize(name, value)
         @name = sanitise(name).to_s.to_sym
         @value = sanitise(value || EMPTY_STRING)
       end
@@ -14,9 +14,9 @@ class SiteHub
         "#{name}=#{value}"
       end
 
-      def == other
-        other.is_a?(Attribute) && self.name == other.name && self.value == other.value
+      def ==(other)
+        other.is_a?(Attribute) && name == other.name && value == other.value
       end
     end
   end
-end
+end

data/lib/sitehub/cookie/flag.rb

@@ -5,7 +5,7 @@ class SiteHub
       include StringSanitiser
       attr_accessor :name
 
-      def initialize flag
+      def initialize(flag)
         @name = sanitise(flag).to_sym
       end
 
@@ -13,10 +13,9 @@ class SiteHub
         name.to_s
       end
 
-      def == other
-        other.is_a?(Flag) && self.name == other.name
+      def ==(other)
+        other.is_a?(Flag) && name == other.name
       end
     end
-
   end
-end
+end

data/lib/sitehub/cookie.rb

@@ -8,8 +8,7 @@ class SiteHub
 
     FIRST = 0
 
-    def initialize cookie_string
-      @attributes_and_flags =[]
+    def initialize(cookie_string)
       pairs = cookie_string.split(SEMICOLON).map do |entry|
         if entry.include?(EQUALS_SIGN)
           Cookie::Attribute.new(*entry.split(EQUALS_SIGN))
@@ -19,9 +18,8 @@ class SiteHub
       end
 
       name_attribute = pairs.delete_at(FIRST)
-      attributes_and_flags.concat(pairs)
+      @attributes_and_flags = pairs
       @name_attribute = Cookie::Attribute.new(name_attribute.name.to_s, name_attribute.value)
-
     end
 
     def name
@@ -32,23 +30,21 @@ class SiteHub
       name_attribute.value
     end
 
-    def find name
-      attributes_and_flags.find{|entry| entry.name == name}
+    def find(name)
+      attributes_and_flags.find { |entry| entry.name == name }
     end
 
-    def delete name
-      entry = find(name)
-      @attributes_and_flags = attributes_and_flags.delete_if{|e| e.name == name}
-      entry
+    def ==(other)
+      other.is_a?(self.class) &&
+        sorted_attributes_and_flags(attributes_and_flags) == sorted_attributes_and_flags(other.attributes_and_flags)
     end
 
-    def == other
-      other.is_a?(self.class) && self.attributes_and_flags.sort{|entry1, entry2| entry1.name <=> entry2.name} == other.attributes_and_flags.sort{|entry1, entry2| entry1.name <=> entry2.name}
+    def sorted_attributes_and_flags(attributes_and_flags)
+      attributes_and_flags.sort { |entry1, entry2| entry1.name <=> entry2.name }
     end
 
     def to_s
       [name_attribute].concat(attributes_and_flags).join(SEMICOLON_WITH_SPACE)
     end
-
   end
-end
+end

data/lib/sitehub/cookie_rewriting.rb

@@ -1,35 +1,33 @@
 require 'sitehub/cookie'
 require 'sitehub/constants'
 class SiteHub
-
   module CookieRewriting
-
     ENDING_WITH_NEWLINE = /#{NEW_LINE}$/
 
     def rewrite_cookies(headers, substitute_domain:)
       cookies_hash = cookies_string_as_hash(headers[Constants::HttpHeaderKeys::SET_COOKIE])
 
       cookies_hash.values.each do |cookie|
-        if domain_attribute = cookie.find(:domain)
-          value = domain_attribute.value
-          domain_attribute.value = substitute_domain.dup
-          domain_attribute.value.prepend(FULL_STOP) if value.start_with?(FULL_STOP)
-        end
+        domain_attribute = cookie.find(:domain) || next
+        value = domain_attribute.value
+        domain_attribute.value = substitute_domain.dup
+        domain_attribute.value.prepend(FULL_STOP) if value.start_with?(FULL_STOP)
       end
       headers[HttpHeaders::SET_COOKIE] = cookies_hash_to_string(cookies_hash)
     end
 
-    def cookies_hash_to_string cookies_hash
+    def cookies_hash_to_string(cookies_hash)
       cookies_hash.values.inject(EMPTY_STRING.dup) do |cookie_string, cookie|
-        cookie_string << "#{cookie.to_s}#{NEW_LINE}"
+        cookie_string << "#{cookie}#{NEW_LINE}"
       end.sub(ENDING_WITH_NEWLINE, EMPTY_STRING)
     end
 
-    def cookies_string_as_hash cookie_string
-      cookie_string.lines.inject({}) do |cookies, cookie_line|
+    def cookies_string_as_hash(cookie_string)
+      cookie_string.lines.each_with_object({}) do |cookie_line, cookies|
         cookie = SiteHub::Cookie.new(cookie_line)
-        cookies[cookie.name] = cookie; cookies
+        cookies[cookie.name] = cookie
+        cookies
       end
     end
   end
-end
+end