sitehub 0.5.0.alpha3 → 0.5.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843f0e759d80716e875a4e9c10d7430fa3d3070a
-  data.tar.gz: efb553e0b1090e8ec3fa9fe9a20c3474500dc28e
+  metadata.gz: 0ede66ca937a51aa4de571db5f3080113198429c
+  data.tar.gz: 91540d0d051530439cd2979ba054e5478cb215b6
 SHA512:
-  metadata.gz: 81a3c977deca7ea18f198539f7d458ffb024dec97475be0d3928e9e3de519c58942c81614558fb02251ae2f457b39b8638050ec015505f45a877a834f20ac5ae
-  data.tar.gz: 92576a7ed7130e047cd34ad2aaee32175d71b0fcbca6d9cb2fbf9f54554feb036c64c82dd9561bed5c23cc6acdc754c3dfd0ba8b898b5c6ab88b151d0d9f358b
+  metadata.gz: 8d1c08d30bcf5f0c95b20a7a49433ee214c65afa6d917eb04c5ca869d29fe3bff2bd8afce684b77f9920de2ee2f7f633797ba49b202cf6809fc3a2c25d8b4596
+  data.tar.gz: 9f2ce2edfb124e6b09b835986dd96a224bc7e403afbb20a808f19a0c5b0be83a5b044272b72680db17522b841ac3bbfbe03d982578d2666fd93db1b4f125a6e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sitehub (0.5.0.alpha3)
+    sitehub (0.5.0.alpha4)
       activesupport
       em-http-request
       em-synchrony

data/lib/sitehub/collection.rb

@@ -16,7 +16,7 @@ class SiteHub
           alias_method :add_backup, :add
 
           send(:define_method, :add) do |id, value, *args|
-            raise DuplicateVersionException, UNIQUE_LABELS_MSG if self[id]
+            raise DuplicateVersionException, UNIQUE_LABELS_MSG if key?(id)
             add_backup id, value, *args
           end
         end

data/lib/sitehub/collection/route_collection.rb

@@ -7,7 +7,7 @@ class SiteHub
       end
 
       def valid?
-        !empty?
+        !keys.empty?
       end
 
       def resolve(id: nil, env: nil)

data/lib/sitehub/collection/split_route_collection.rb

@@ -12,12 +12,6 @@ class SiteHub
       MAX = 100
       MIN = 0
 
-      def initialize(hash = {})
-        hash.each do |value, percentage|
-          add(value.id, value, percentage)
-        end
-      end
-
       def add(id, value, percentage)
         raise InvalidSplitException, FIXNUM_ERR_MSG unless percentage.is_a?(Fixnum)
         upper_bound = lower_bound + percentage
@@ -28,20 +22,26 @@ class SiteHub
 
       def resolve(*args)
         random = rand(MAX)
-        result = values.find { |split| random >= split.lower && random < split.upper }
+        result = _values.find { |split| random >= split.lower && random < split.upper }
         result ? result.value.resolve(*args) : nil
       end
 
       def transform(&block)
-        values.each { |split| split.update_value(&block) }
+        _values.each { |split| split.update_value(&block) }
       end
 
       def [](key)
-        key?(key) ? super(key).value : nil
+        key?(key) ? super(key).value : super(key)
+      end
+
+      alias _values values
+
+      def values
+        super().collect(&:value)
       end
 
       def valid?
-        last = values.last
+        last = _values.last
         return true if last && last.upper == MAX
 
         warn(INVALID_SPILTS_MSG)
@@ -51,7 +51,7 @@ class SiteHub
       private
 
       def lower_bound
-        values.empty? ? MIN : values.last.upper
+        _values.empty? ? MIN : _values.last.upper
       end
     end
   end

data/lib/sitehub/identifier.rb

@@ -0,0 +1,37 @@
+class SiteHub
+  class Identifier
+    attr_reader :id, :components
+
+    def initialize(id)
+      @components = id.to_s.split('|').collect(&:to_sym)
+    end
+
+    def child_label(label)
+      components.empty? ? label : "#{self}|#{label}"
+    end
+
+    def root
+      components.first
+    end
+
+    def sub_id
+      Identifier.new(components[1..-1].join('|'))
+    end
+
+    def valid?
+      !@components.empty?
+    end
+
+    def to_s
+      components.join('|')
+    end
+
+    def to_sym
+      to_s.to_sym
+    end
+
+    def ==(other)
+      other.respond_to?(:to_sym) && to_sym == other.to_sym
+    end
+  end
+end

data/lib/sitehub/middleware/route.rb

@@ -9,7 +9,7 @@ class SiteHub
 
     def initialize(app, id:, sitehub_cookie_name:, sitehub_cookie_path: nil)
       @app = app
-      @id = id
+      @id = Identifier.new(id)
       @sitehub_cookie_name = sitehub_cookie_name
       @sitehub_cookie_path = sitehub_cookie_path
     end

data/lib/sitehub/middleware/routes.rb

@@ -23,9 +23,9 @@ class SiteHub
       def call(env)
         source_request = Rack::Request.new(env)
 
-        forward_proxy = mapped_proxy(path: source_request.path, request: source_request)
+        route = mapped_route(path: source_request.path, request: source_request)
 
-        forward_proxy.call(env)
+        route.call(env)
       end
 
       def init
@@ -46,7 +46,7 @@ class SiteHub
         end
       end
 
-      def mapped_proxy(path:, request:)
+      def mapped_route(path:, request:)
         self[mapping(path)].resolve(id: request.cookies[sitehub_cookie_name], env: request.env)
       end
 

data/lib/sitehub/route_builder.rb

@@ -1,5 +1,7 @@
 require 'uuid'
 require 'sitehub/equality'
+require 'sitehub/nil_route'
+require 'sitehub/identifier'
 require 'sitehub/getter_setter_methods'
 require_relative 'collection/split_route_collection'
 require_relative 'rules'
@@ -14,16 +16,18 @@ class SiteHub
     class InvalidDefinitionException < Exception
     end
 
-    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
+    INVALID_SPLIT_MSG = 'url must be defined if not supplying a block'.freeze
+    RULE_NOT_SPECIFIED_MSG = 'rule must be specified when supplying a block'.freeze
+    IGNORING_URL_MSG = 'Block supplied, ignoring URL parameter'.freeze
     URL_REQUIRED_MSG = 'URL must be supplied for splits and routes'.freeze
 
     class << self
       # TODO: support nest splits and routes
       def from_hash(hash, sitehub_cookie_name)
-        new(sitehub_cookie_name: sitehub_cookie_name, sitehub_cookie_path: hash[:sitehub_cookie_path], mapped_path: hash[:path]) do
+        new(sitehub_cookie_name: sitehub_cookie_name,
+            sitehub_cookie_path: hash[:sitehub_cookie_path],
+            mapped_path: hash[:path]) do
           extend CollectionMethods
 
           collection(hash, :splits).each do |split|
@@ -44,11 +48,11 @@ class SiteHub
 
     transient :id
 
-    getter_setters :default_proxy, :sitehub_cookie_path, :sitehub_cookie_name
+    getter_setters :sitehub_cookie_path, :sitehub_cookie_name
     attr_reader :mapped_path, :id
 
-    def initialize(sitehub_cookie_name:, sitehub_cookie_path: nil, mapped_path:, rule: nil, &block)
-      @id = UUID.generate(:compact)
+    def initialize(id: nil, sitehub_cookie_name:, sitehub_cookie_path: nil, mapped_path:, rule: nil, &block)
+      @id = Identifier.new(id)
       @mapped_path = mapped_path
       @sitehub_cookie_name = sitehub_cookie_name
       @sitehub_cookie_path = sitehub_cookie_path
@@ -62,32 +66,42 @@ class SiteHub
       raise InvalidDefinitionException unless valid?
     end
 
-    def build
-      if middleware?
-        build_with_middleware
-        build_default_with_middleware if default_proxy
-      end
+    def add_route(label:, rule: nil, percentage: nil, url: nil, &block)
+      label = id.child_label(label)
+      route = if block
+                raise InvalidDefinitionException, RULE_NOT_SPECIFIED_MSG unless percentage || rule
+                warn(IGNORING_URL_MSG) if url
+                new(rule: rule, id: label, &block).build
+              else
+                raise InvalidDefinitionException, RULE_NOT_SPECIFIED_MSG unless url
+                forward_proxy(url: url, label: label, rule: rule)
+              end
 
-      self
+      routes.add(label, route, percentage)
     end
 
-    def default(url:)
-      default_proxy(forward_proxy(label: :default, url: url))
+    def default_route
+      routes.default
     end
 
-    def endpoints(collection = nil)
-      return @endpoints || Collection::RouteCollection.new unless collection
+    def default_route?
+      !default_route.nil?
+    end
 
-      raise InvalidDefinitionException, ROUTES_WITH_SPLITS_MSG if @endpoints && @endpoints != collection
-      @endpoints = collection
+    def build
+      build_with_middleware if middleware?
+      self
+    end
+
+    def default(url:)
+      routes.default = forward_proxy(label: :default, url: url)
     end
 
     def forward_proxy(label:, url:, rule: nil)
       proxy = ForwardProxy.new(mapped_url: url, mapped_path: mapped_path)
 
-      id = (label || UUID.generate(:compact)).to_sym
       Route.new(proxy,
-                id: id,
+                id: label,
                 sitehub_cookie_path: sitehub_cookie_path,
                 sitehub_cookie_name: sitehub_cookie_name).tap do |wrapper|
         wrapper.rule(rule)
@@ -95,38 +109,34 @@ class SiteHub
     end
 
     def resolve(id: nil, env:)
-      id = id.to_s.to_sym
-      endpoints[id] || endpoints.resolve(id: id, env: env) || default_proxy
+      id = Identifier.new(id)
+      if id.valid? && (route = routes[id.root])
+        route.resolve(id: id.sub_id, env: env)
+      else
+        routes.resolve(env: env) || default_route
+      end
     end
 
-    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)
+    def route(url: nil, label:, rule: nil, &block)
+      routes(@routes)
+      add_route(label: label, rule: rule, url: url, &block)
     end
 
-    def split(percentage:, url: nil, label: nil, &block)
-      raise InvalidDefinitionException, INVALID_SPLIT_MSG unless block || url
+    def routes(collection = nil)
+      return @endpoints ||= Collection::RouteCollection.new unless collection
 
-      proxy = if block
-                warn(IGNORING_URL_LABEL_MSG) if url || label
-                new(&block).build
-              else
-                forward_proxy(label: label, url: url)
-              end
+      raise InvalidDefinitionException, ROUTES_WITH_SPLITS_MSG if @endpoints && !@endpoints.equal?(collection)
+      @endpoints = collection
+    end
 
-      splits.add proxy.id, proxy, percentage
+    def split(percentage:, url: nil, label:, &block)
+      routes(@splits)
+      add_route(label: label, percentage: percentage, url: url, &block)
     end
 
     def valid?
-      return true if default_proxy
-      endpoints.valid?
+      return true if default_route?
+      routes.valid?
     end
 
     private
@@ -138,34 +148,24 @@ class SiteHub
       end
     end
 
-    def build_default_with_middleware
-      add_middleware_to_proxy(default_proxy)
-      default_proxy.init
-    end
-
     def build_with_middleware
-      endpoints.values.each do |proxy|
-        add_middleware_to_proxy(proxy)
-        proxy.init
+      routes = routes().values.find_all { |route| route.is_a?(Route) }
+
+      routes << default_route if default_route?
+
+      routes.each do |route|
+        add_middleware_to_proxy(route)
+        route.init
       end
     end
 
-    def new(rule: nil, &block)
-      self.class.new(sitehub_cookie_name: sitehub_cookie_name,
+    def new(id:, rule: nil, &block)
+      self.class.new(id: id,
+                     sitehub_cookie_name: sitehub_cookie_name,
+                     sitehub_cookie_path: sitehub_cookie_path,
                      mapped_path: mapped_path,
                      rule: rule,
-                     &block).tap do |builder|
-        builder.sitehub_cookie_name sitehub_cookie_name
-        builder.sitehub_cookie_path sitehub_cookie_path
-      end
-    end
-
-    def splits
-      endpoints(@splits)
-    end
-
-    def routes
-      endpoints(@routes)
+                     &block)
     end
   end
 end

data/lib/sitehub/version.rb

@@ -1,3 +1,3 @@
 class SiteHub
-  VERSION = '0.5.0.alpha3'.freeze
+  VERSION = '0.5.0.alpha4'.freeze
 end

data/spec/sitehub/collection/split_route_collection_spec.rb

@@ -22,6 +22,14 @@ class SiteHub
       expect(subject).to be_a(Collection)
     end
 
+    describe '#[]' do
+      context 'key exists' do
+      end
+
+      context 'key does not exist' do
+      end
+    end
+
     describe '#add' do
       before do
         subject.add route_1.id, route_1, 50
@@ -32,8 +40,8 @@ class SiteHub
 
       it 'sets the selection boundary which is used to choose routes' do
         subject.add route_2.id, route_2, 50
-        first = subject.values.first
-        second = subject.values.last
+        first = subject._values.first
+        second = subject._values.last
 
         expect(first.lower).to eq(0)
         expect(first.upper).to eq(50)
@@ -117,5 +125,13 @@ class SiteHub
         end
       end
     end
+
+    describe '#values' do
+      it 'returns values contained inside splits' do
+        subject.add route_1.id, route_1, 50
+        subject.add route_2.id, route_2, 50
+        expect(subject.values).to eq([route_1, route_2])
+      end
+    end
   end
 end

data/spec/sitehub/collection_spec.rb

@@ -26,6 +26,7 @@ class SiteHub
 
             inheritor.new
           end
+
           it 'raises an error' do
             duplicate = Struct.new(:id).new(1)
             subject.add(duplicate.id, duplicate)

data/spec/sitehub/core_spec.rb

@@ -123,7 +123,7 @@ class SiteHub
 
         it 'passes the block to the route constructor' do
           expected_route.split url: :endpoint, percentage: 100, label: :label
-          expect(subject.routes['/app'].endpoints).to eq(expected_route.endpoints)
+          expect(subject.routes['/app'].routes).to eq(expected_route.routes)
         end
       end
     end

data/spec/sitehub/identifier_spec.rb

@@ -0,0 +1,89 @@
+class SiteHub
+  describe Identifier do
+    subject(:valid_identifer) do
+      described_class.new(:root_id)
+    end
+
+    subject(:blank) do
+      described_class.new(nil)
+    end
+
+    describe '#initialize' do
+      context 'id supplied' do
+        it 'it returns a concatenated id' do
+          expect(valid_identifer.child_label(:label)).to eq('root_id|label')
+        end
+      end
+
+      context 'id not set' do
+        it 'it returns the given value' do
+          expect(blank.child_label(:label)).to eq(:label)
+        end
+      end
+    end
+
+    describe '#valid?' do
+      context 'has at least one component' do
+        it 'returns true' do
+          expect(valid_identifer).to be_valid
+        end
+      end
+
+      context 'does not have at least one component' do
+        it 'returns false' do
+          expect(blank).to_not be_valid
+        end
+      end
+    end
+
+    describe '#sub_id' do
+      context 'id contains more than one pipe seperated value' do
+        subject do
+          described_class.new('root|first|second')
+        end
+
+        it 'removes the first value in the list' do
+          expect(subject.sub_id).to eq(:'first|second')
+        end
+
+        it 'returns an object of type Identifier' do
+          expect(subject.sub_id).to be_a(described_class)
+        end
+      end
+    end
+
+    describe '#to_s' do
+      subject do
+        described_class.new(:root_id)
+      end
+      it 'returns the id as a string' do
+        expect(valid_identifer.to_s).to eq(:root_id.to_s)
+      end
+    end
+
+    describe '#to_sym' do
+      it 'returns the id as a string' do
+        expect(valid_identifer.to_sym).to eq(:root_id)
+      end
+    end
+
+    describe '#==' do
+      subject do
+        described_class.new(:root_id)
+      end
+
+      context 'other can be converted to a matching symbol' do
+        it 'returns true' do
+          expect(subject).to eq(:root_id)
+          expect(subject).to eq('root_id')
+        end
+      end
+
+      context 'other can not be converted to a matching symbol' do
+        it 'returns true' do
+          expect(subject).to_not eq('different')
+        end
+      end
+    end
+  end
+end