sitehub 0.4.3 → 0.4.6

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

@@ -1,9 +1,11 @@
+require 'sitehub/equality'
 class SiteHub
   class Collection
     class SplitRouteCollection < Collection
       class Split
-        attr_reader :upper, :lower
-        attr_accessor :value
+        attr_reader :upper, :lower, :value
+
+        include Equality
 
         def initialize(lower, upper, value)
           @upper = upper
@@ -11,8 +13,8 @@ class SiteHub
           @value = value
         end
 
-        def ==(other)
-          other.is_a?(Split) && other.lower == lower && other.upper == upper
+        def update_value
+          @value = yield(@value)
         end
       end
     end

data/lib/sitehub/constants.rb

@@ -3,6 +3,7 @@ require 'sitehub/constants/rack_http_header_keys'
 
 class SiteHub
   REQUEST_MAPPING = 'sitehub.request_mapping'.freeze
+  REQUEST = 'sitehub.request'.freeze
   RESPONSE = 'sitehub.response'.freeze
   ASYNC_CALLBACK = 'async.callback'.freeze
   RECORDED_ROUTES_COOKIE = 'sitehub.recorded_route'.freeze
@@ -13,7 +14,7 @@ class SiteHub
   SEMICOLON = ';'.freeze
   SPACE = ' '.freeze
   SEMICOLON_WITH_SPACE = "#{SEMICOLON}#{SPACE}".freeze
-  COMMA_WITH_SPACE = ', '.freeze
+  COMMA = ','.freeze
 
   HYPHEN = '-'.freeze
   QUESTION_MARK = '?'.freeze

data/lib/sitehub/constants/http_header_keys.rb

@@ -16,6 +16,8 @@ class SiteHub
       CONTENT_ENCODING = 'content-encoding'.freeze
       SET_COOKIE = 'Set-Cookie'.freeze
       CONTENT_LENGTH = 'Content-Length'.freeze
+      UPGRADE = 'upgrade'.freeze
+      TRANSACTION_ID = 'sitehub-transaction-id'.freeze
     end
   end
 end

data/lib/sitehub/constants/rack_http_header_keys.rb

@@ -12,6 +12,8 @@ class SiteHub
       REMOTE_ADDRESS_ENV_KEY = 'REMOTE_ADDR'.freeze
       HTTP_HEADER_FILTER_EXCEPTIONS = %w(CONTENT_TYPE CONTENT_LENGTH).freeze
       TRANSACTION_ID = 'HTTP_SITEHUB_TRANSACTION_ID'.freeze
+      X_FORWARDED_HOST = 'HTTP_X_FORWARDED_HOST'.freeze
+      HTTP_HOST = 'HTTP_HOST'.freeze
     end
   end
 end

data/lib/sitehub/cookie.rb

@@ -1,15 +1,16 @@
+require 'sitehub/equality'
 require 'sitehub/cookie/attribute'
 require 'sitehub/cookie/flag'
 require 'sitehub/constants'
 class SiteHub
   class Cookie
     attr_reader :attributes_and_flags, :name_attribute
-    include Constants
+    include Constants, Equality
 
     FIRST = 0
 
     def initialize(cookie_string)
-      pairs = cookie_string.split(SEMICOLON).map do |entry|
+      @attributes_and_flags = cookie_string.split(SEMICOLON).map do |entry|
         if entry.include?(EQUALS_SIGN)
           Cookie::Attribute.new(*entry.split(EQUALS_SIGN))
         else
@@ -17,8 +18,7 @@ class SiteHub
         end
       end
 
-      name_attribute = pairs.delete_at(FIRST)
-      @attributes_and_flags = pairs
+      name_attribute = @attributes_and_flags.delete_at(FIRST)
       @name_attribute = Cookie::Attribute.new(name_attribute.name.to_s, name_attribute.value)
     end
 
@@ -34,15 +34,6 @@ class SiteHub
       attributes_and_flags.find { |entry| entry.name == name }
     end
 
-    def ==(other)
-      other.is_a?(self.class) &&
-        sorted_attributes_and_flags(attributes_and_flags) == sorted_attributes_and_flags(other.attributes_and_flags)
-    end
-
-    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

data/lib/sitehub/cookie/attribute.rb

@@ -1,21 +1,22 @@
-require 'sitehub/string_sanitiser'
+require 'sitehub/string_utils'
+require 'sitehub/equality'
 class SiteHub
   class Cookie
     class Attribute
-      include StringSanitiser
-      attr_accessor :name, :value
+      include Equality
+      attr_reader :name, :value
 
       def initialize(name, value)
-        @name = sanitise(name).to_s.to_sym
-        @value = sanitise(value || EMPTY_STRING)
+        @name = StringUtils.sanitise(name).to_sym
+        @value = StringUtils.sanitise(value)
       end
 
-      def to_s
-        "#{name}=#{value}"
+      def update(value)
+        @value = value
       end
 
-      def ==(other)
-        other.is_a?(Attribute) && name == other.name && value == other.value
+      def to_s
+        "#{name}=#{value}"
       end
     end
   end

data/lib/sitehub/cookie/flag.rb

@@ -1,21 +1,18 @@
-require 'sitehub/string_sanitiser'
+require 'sitehub/string_utils'
+require 'sitehub/equality'
 class SiteHub
   class Cookie
     class Flag
-      include StringSanitiser
-      attr_accessor :name
+      include Equality
+      attr_reader :name
 
       def initialize(flag)
-        @name = sanitise(flag).to_sym
+        @name = StringUtils.sanitise(flag).to_sym
       end
 
       def to_s
         name.to_s
       end
-
-      def ==(other)
-        other.is_a?(Flag) && name == other.name
-      end
     end
   end
 end

data/lib/sitehub/cookie_rewriting.rb

@@ -1,6 +1,7 @@
 require 'sitehub/cookie'
 require 'sitehub/constants'
 class SiteHub
+  # TODO: - change in to object and remove .reek exclusions for UtilityFunction
   module CookieRewriting
     ENDING_WITH_NEWLINE = /#{NEW_LINE}$/
 
@@ -9,11 +10,18 @@ class SiteHub
 
       cookies_hash.values.each do |cookie|
         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)
+        update_domain(domain_attribute, substitute_domain)
+      end
+      headers[Constants::HttpHeaderKeys::SET_COOKIE] = cookies_hash_to_string(cookies_hash)
+    end
+
+    def update_domain(domain_attribute, substitute_domain)
+      substitute = substitute_domain.dup
+      if domain_attribute.value.start_with?(FULL_STOP)
+        domain_attribute.update(substitute.prepend(FULL_STOP))
+      else
+        domain_attribute.update(substitute)
       end
-      headers[HttpHeaders::SET_COOKIE] = cookies_hash_to_string(cookies_hash)
     end
 
     def cookies_hash_to_string(cookies_hash)
@@ -26,7 +34,6 @@ class SiteHub
       cookie_string.lines.each_with_object({}) do |cookie_line, cookies|
         cookie = SiteHub::Cookie.new(cookie_line)
         cookies[cookie.name] = cookie
-        cookies
       end
     end
   end

data/lib/sitehub/downstream_client.rb

@@ -0,0 +1,37 @@
+require 'sitehub/request'
+require 'sitehub/request_mapping'
+require 'sitehub/rules'
+require 'sitehub/resolver'
+require 'faraday'
+require 'sitehub/constants'
+
+# Requirements: https://www.mnot.net/blog/2011/07/11/what_proxies_must_do
+# 1. remove hop by hop headers
+# 2. detect bad framing: where content length and content-encoding clash or are incorrect
+# 3. fix conflicts between header and URL header
+# 4. insert via (optional)
+# 5. Expect header (optional)
+
+class SiteHub
+  class DownstreamClient
+    include Constants
+
+    attr_reader :http_client
+
+    def initialize
+      @http_client = Faraday.new(ssl: { verify: false }) do |con|
+        con.adapter :em_synchrony
+      end
+    end
+
+    def call(sitehub_request)
+      response = http_client.send(sitehub_request.request_method, sitehub_request.uri) do |request|
+        request.headers = sitehub_request.headers
+        request.body = sitehub_request.body
+        request.params = sitehub_request.params
+      end
+
+      Rack::Response.new(response.body, response.status, response.headers)
+    end
+  end
+end

data/lib/sitehub/equality.rb

@@ -0,0 +1,28 @@
+class SiteHub
+  module Equality
+    module ClassMethods
+      def transient_fields
+        @transient_fields ||= []
+      end
+
+      def transient(*fields)
+        transient_fields.concat(fields.collect { |field| "@#{field}".to_sym })
+      end
+    end
+    def self.included(clazz)
+      clazz.extend(ClassMethods)
+    end
+
+    def ==(other)
+      return false unless other.is_a?(_clazz)
+      fields = instance_variables.find_all { |field| !_clazz.transient_fields.include?(field) }
+      fields.all? do |variable|
+        instance_variable_get(variable) == other.instance_variable_get(variable)
+      end
+    end
+
+    def _clazz
+      self.class
+    end
+  end
+end

data/lib/sitehub/forward_proxy.rb

@@ -1,81 +1,38 @@
 # rubocop:disable Metrics/ParameterLists
-require 'sitehub/http_headers'
-require 'sitehub/request_mapping'
-require 'sitehub/rules'
-require 'sitehub/resolver'
-require 'faraday'
-require 'sitehub/constants'
 class SiteHub
   class ForwardProxy
-    ERROR_RESPONSE = Rack::Response.new(['error'], 500, {})
+    include Rules, Resolver
 
-    include HttpHeaders, Rules, Resolver, Constants
+    attr_reader :downstream_client, :sitehub_cookie_name, :sitehub_cookie_path, :id, :mapped_path, :mapped_url
 
-    attr_reader :url, :id, :mapped_path, :http_client, :sitehub_cookie_path, :sitehub_cookie_name
-
-    def initialize(url:, id:, mapped_path: nil, rule: nil, sitehub_cookie_path: nil, sitehub_cookie_name:)
+    def initialize(sitehub_cookie_path: nil, sitehub_cookie_name:, id:, rule: nil, mapped_path:, mapped_url:)
+      @downstream_client = DownstreamClient.new
+      @sitehub_cookie_path = sitehub_cookie_path
+      @sitehub_cookie_name = sitehub_cookie_name
       @id = id
-      @url = url
       @rule = rule
       @mapped_path = mapped_path
-      @sitehub_cookie_path = sitehub_cookie_path
-      @sitehub_cookie_name = sitehub_cookie_name
-      @http_client = Faraday.new(ssl: { verify: false }) do |con|
-        con.adapter :em_synchrony
-      end
+      @mapped_url = mapped_url
     end
 
     def call(env)
-      source_request = Rack::Request.new(env)
-      request_mapping = env[REQUEST_MAPPING] = request_mapping(source_request)
-      mapped_uri = URI(request_mapping.computed_uri)
-
-      downstream_response = proxy_call(request_headers(mapped_uri, source_request), mapped_uri, source_request)
-
-      response(downstream_response, source_request)
-    rescue StandardError => e
-      env[ERRORS] << e.message
-      ERROR_RESPONSE.dup
-    end
-
-    def response(response, source_request)
-      Rack::Response.new(response.body, response.status, sanitise_headers(response.headers)).tap do |r|
-        r.set_cookie(sitehub_cookie_name, path: (sitehub_cookie_path || source_request.path), value: id)
-      end
-    end
+      request = env[REQUEST]
+      request.map(mapped_path, mapped_url)
 
-    def request_headers(mapped_uri, source_request)
-      headers = sanitise_headers(extract_http_headers(source_request.env))
-      headers[HOST_HEADER] = "#{mapped_uri.host}:#{mapped_uri.port}"
-      headers[X_FORWARDED_HOST_HEADER] = append_host(headers[X_FORWARDED_HOST_HEADER].to_s, source_request.url)
-      headers
-    end
-
-    def proxy_call(headers, mapped_uri, source_request)
-      http_client.send(source_request.request_method.downcase, mapped_uri) do |request|
-        request.headers = headers
-        request.body = source_request.body.read
-        request.params = source_request.params
+      downstream_client.call(request).tap do |response|
+        response.set_cookie(sitehub_cookie_name, path: (sitehub_cookie_path || request.path), value: id)
       end
     end
 
-    def request_mapping(source_request)
-      RequestMapping.new(source_url: source_request.url, mapped_url: url, mapped_path: mapped_path)
-    end
-
     def ==(other)
-      other.is_a?(ForwardProxy) && url == other.url
-    end
-
-    private
-
-    def append_host(forwarded_host, destination_uri)
-      destination_uri = URI(destination_uri)
-      if forwarded_host == EMPTY_STRING
-        "#{destination_uri.host}:#{destination_uri.port}"
-      else
-        "#{forwarded_host},#{destination_uri.host}"
-      end
+      expected = [other.mapped_path,
+                  other.mapped_url,
+                  other.rule,
+                  other.id,
+                  other.sitehub_cookie_name,
+                  other.sitehub_cookie_path]
+
+      expected == [mapped_path, mapped_url, rule, id, sitehub_cookie_name, sitehub_cookie_path]
     end
   end
 end

data/lib/sitehub/forward_proxy_builder.rb

@@ -1,41 +1,49 @@
 require 'uuid'
+require 'sitehub/equality'
+require 'sitehub/getter_setter_methods'
 require_relative 'collection/split_route_collection'
 require_relative 'rules'
 require_relative 'resolver'
 require_relative 'collection/route_collection'
 require_relative 'middleware'
+require_relative 'forward_proxy'
+require_relative 'downstream_client'
 
 class SiteHub
   class ForwardProxyBuilder
-    include Middleware
-    include Rules, Resolver
-
     class InvalidDefinitionException < Exception
     end
 
-    INVALID_SPLIT_MSG = 'label and url must be defined if not supplying a block'.freeze
+    INVALID_SPLIT_MSG = 'url must be defined if not supplying a block'.freeze
     ROUTES_WITH_SPLITS_MSG = 'you cant register routes and splits at the same level'.freeze
     INVALID_ROUTE_DEF_MSG = 'rule must be specified when supplying a block'.freeze
+    IGNORING_URL_LABEL_MSG = 'Block supplied, ignoring URL and Label parameters'.freeze
+
+    extend GetterSetterMethods
+    include Rules, Resolver, Equality, Middleware
+
+    transient :id
 
-    attr_reader :mapped_path, :default_proxy, :routes, :middlewares, :splits, :sitehub_cookie_name
+    getter_setters :default_proxy, :sitehub_cookie_path
+    attr_reader :mapped_path, :sitehub_cookie_name, :id
 
     def initialize(url: nil, mapped_path:, rule: nil, sitehub_cookie_name: nil, &block)
+      @id = UUID.generate(:compact)
       @mapped_path = mapped_path
-      @middlewares = []
       @splits = Collection::SplitRouteCollection.new
       @routes = Collection::RouteCollection.new
       @sitehub_cookie_name = sitehub_cookie_name
       rule(rule) if rule
       default(url: url) if url
 
-      return unless block
+      return unless block_given?
 
       instance_eval(&block)
       raise InvalidDefinitionException unless valid?
     end
 
     def valid?
-      return true if @default_proxy
+      return true if default_proxy
       endpoints.valid?
     end
 
@@ -47,70 +55,83 @@ class SiteHub
     end
 
     def split(percentage:, url: nil, label: nil, &block)
-      endpoints(splits)
+      raise InvalidDefinitionException, INVALID_SPLIT_MSG unless block || url
 
-      raise InvalidDefinitionException, INVALID_SPLIT_MSG unless block || [url, label].all?
+      proxy = if block
+                warn(IGNORING_URL_LABEL_MSG) if url || label
+                new(&block).build
+              else
+                forward_proxy(label: label, url: url)
+              end
 
-      label = label ? label.to_sym : UUID.generate(:compact)
-
-      proxy = block ? new(&block).build : forward_proxy(label: label, url: url)
+      splits.add proxy.id, proxy, percentage
+    end
 
-      endpoints.add label, proxy, percentage
+    def route(url: nil, label: nil, rule: nil, &block)
+      endpoint = if block
+                   raise InvalidDefinitionException, INVALID_ROUTE_DEF_MSG unless rule
+                   warn(IGNORING_URL_LABEL_MSG) if url || label
+                   new(rule: rule, &block).build
+                 else
+                   forward_proxy(url: url, label: label, rule: rule)
+                 end
+
+      routes.add(endpoint.id, endpoint)
     end
 
-    def new(&block)
-      self.class.new(mapped_path: mapped_path, &block)
+    def default(url:)
+      default_proxy(forward_proxy(label: :default, url: url))
     end
 
-    def route(url: nil, label: nil, rule: nil, &block)
-      endpoints(routes)
-
-      if block
-        raise InvalidDefinitionException, INVALID_ROUTE_DEF_MSG unless rule
-        builder = self.class.new(mapped_path: mapped_path, rule: rule, &block).build
-        endpoints.add UUID.generate(:compact), builder
-      else
-        endpoints.add label.to_sym, forward_proxy(url: url, label: label, rule: rule)
+    def build
+      if middleware?
+        build_with_middleware
+        build_default_with_middleware if default_proxy
       end
+
+      self
     end
 
-    def default(url:)
-      @default_proxy = forward_proxy(label: :default, url: url)
+    def resolve(id: nil, env:)
+      id = id.to_s.to_sym
+      endpoints[id] || endpoints.resolve(env: env) || default_proxy
     end
 
-    def sitehub_cookie_path(path = nil)
-      return @sitehub_cookie_path unless path
-      @sitehub_cookie_path = path
+    def forward_proxy(label:, url:, rule: nil)
+      label ||= UUID.generate(:compact)
+      ForwardProxy.new(sitehub_cookie_path: sitehub_cookie_path,
+                       sitehub_cookie_name: sitehub_cookie_name,
+                       id: label.to_sym,
+                       rule: rule,
+                       mapped_url: url,
+                       mapped_path: mapped_path)
     end
 
-    def build
+    private
+
+    def routes
+      endpoints(@routes)
+    end
+
+    def splits
+      endpoints(@splits)
+    end
+
+    def build_with_middleware
       endpoints.transform do |proxy|
         apply_middleware(proxy).tap do |wrapped_proxy|
-          wrapped_proxy.extend(Rules)
-          wrapped_proxy.extend(Resolver) unless wrapped_proxy.is_a?(Resolver)
+          wrapped_proxy.extend(Rules, Resolver)
           wrapped_proxy.rule(proxy.rule)
         end
       end
-      @default_proxy = apply_middleware(default_proxy) if default_proxy
-      self
     end
 
-    def resolve(id: nil, env:)
-      id = id.to_s.to_sym
-      endpoints[id] || endpoints.resolve(env: env) || default_proxy
-    end
-
-    def ==(other)
-      other.is_a?(ForwardProxyBuilder) && default_proxy == other.default_proxy && endpoints == other.endpoints
+    def build_default_with_middleware
+      default_proxy(apply_middleware(default_proxy))
     end
 
-    def forward_proxy(label:, url:, rule: nil)
-      ForwardProxy.new(url: url,
-                       id: label.to_sym,
-                       mapped_path: mapped_path,
-                       sitehub_cookie_path: sitehub_cookie_path,
-                       sitehub_cookie_name: sitehub_cookie_name,
-                       rule: rule)
+    def new(rule: nil, &block)
+      self.class.new(mapped_path: mapped_path, rule: rule, &block)
     end
   end
 end