determinator 0.1.0

data/lib/determinator/retrieve/routemaster.rb

@@ -0,0 +1,70 @@
+require 'uri'
+require 'routemaster/drain/caching'
+require 'routemaster/responses/hateoas_response'
+require 'determinator/retrieve/routemaster_indexing_middleware'
+
+module Determinator
+  module Retrieve
+    # A storage and retrieval engine for Determinator using routemaster-drain.
+    #
+    # To use this correctly you will need the following environment variables set to appropriate values
+    # for your instance of Routemaster:
+    #
+    # ROUTEMASTER_DRAIN_TOKENS
+    # ROUTEMASTER_DRAIN_REDIS
+    # ROUTEMASTER_CACHE_REDIS
+    # ROUTEMASTER_CACHE_AUTH
+    # ROUTEMASTER_QUEUE_NAME
+    # ROUTEMASTER_CALLBACK_URL
+    class Routemaster
+      attr_reader :routemaster_app
+
+      CALLBACK_PATH = (URI.parse(ENV['ROUTEMASTER_CALLBACK_URL']).path rescue '/events').freeze
+
+      # @param :discovery_url [String] The bootstrap URL of the instance of Florence which defines Features.
+      def initialize(discovery_url:)
+        client = ::Routemaster::APIClient.new(
+          response_class: ::Routemaster::Responses::HateoasResponse,
+          middlewares: [RoutemasterIndexingMiddleware]
+        )
+        @routemaster = client.discover(discovery_url)
+        @routemaster_app = ::Routemaster::Drain::Caching.new
+      end
+
+      def retrieve(feature_name)
+        key = self.class.index_cache_key(feature_name)
+        feature_id = ::Routemaster::Config.cache_redis.get(key)
+        return unless feature_id
+
+        obj = @routemaster.feature.show(feature_id)
+
+        Feature.new(
+          name:          obj.body.name,
+          identifier:    obj.body.identifier,
+          bucket_type:   obj.body.bucket_type,
+          target_groups: obj.body.target_groups.map { |tg|
+            TargetGroup.new(
+              rollout: tg.rollout,
+              constraints: tg.constraints.to_hash
+            )
+          },
+          variants:      obj.body.variants.to_hash,
+          overrides:     obj.body.overrides.to_hash
+        )
+      rescue ::Routemaster::Errors::ResourceNotFound
+        nil
+      end
+
+      # Automatically configures the rails router to listen for Features with routemaster
+      #
+      # @param route_mapper [ActionDispatch::Routing::Mapper] The rails mapper, 'self' within the `routes.draw` block
+      def configure_rails_router(route_mapper)
+        route_mapper.mount routemaster_app, at: CALLBACK_PATH
+      end
+
+      def self.index_cache_key(feature_name)
+        "determinator_index:#{feature_name}"
+      end
+    end
+  end
+end

data/lib/determinator/retrieve/routemaster_indexing_middleware.rb

@@ -0,0 +1,28 @@
+module Determinator
+  module Retrieve
+    # Middleware which indexes features by their name, so we can look up a feature by name
+    # and find the details (which are only accessible by ID)
+    class RoutemasterIndexingMiddleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        content = JSON.parse(env.body)
+
+        if content_describes_feature?(content)
+          key = Routemaster.index_cache_key(content['name'])
+          ::Routemaster::Config.cache_redis.set(key, content['id'])
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def content_describes_feature?(content)
+        content['id'] && content['name'] && content['bucket_type']
+      end
+    end
+  end
+end

data/lib/determinator/target_group.rb

@@ -0,0 +1,28 @@
+module Determinator
+  class TargetGroup
+    attr_reader :rollout, :constraints
+
+    def initialize(rollout:, constraints: {})
+      @rollout = rollout
+      @constraints = constraints
+    end
+
+    def rollout_percent
+      # Rollout is out of 65536 because the highest rollout indicator
+      # (which is a 16 bit integer) can be is 65,535. 100% rollout
+      # needs to include the highest indicator, and 0% needs to not include
+      # the lowest indicator.
+      Rational(rollout, 65_536)
+    end
+
+    def inspect
+      pc = (rollout_percent * 100).to_f.round(1)
+      "<#{pc}% of those matching: #{constraints}>"
+    end
+
+    def ==(other)
+      return false unless other.is_a?(self.class)
+      other.rollout == rollout && other.constraints == constraints
+    end
+  end
+end

data/lib/determinator/version.rb

@@ -0,0 +1,3 @@
+module Determinator
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: determinator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JP Hastings-Spital
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: routemaster-drain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+description: 
+email:
+- jp@deliveroo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- determinator.gemspec
+- docs/img/determinator.jpg
+- examples/determinator-rails/.env
+- examples/determinator-rails/.gitignore
+- examples/determinator-rails/Gemfile
+- examples/determinator-rails/Gemfile.lock
+- examples/determinator-rails/Procfile
+- examples/determinator-rails/README.md
+- examples/determinator-rails/Rakefile
+- examples/determinator-rails/app/controllers/application_controller.rb
+- examples/determinator-rails/app/controllers/index_controller.rb
+- examples/determinator-rails/app/jobs/application_job.rb
+- examples/determinator-rails/bin/bundle
+- examples/determinator-rails/bin/rails
+- examples/determinator-rails/bin/rake
+- examples/determinator-rails/config.ru
+- examples/determinator-rails/config/application.rb
+- examples/determinator-rails/config/boot.rb
+- examples/determinator-rails/config/environment.rb
+- examples/determinator-rails/config/environments/development.rb
+- examples/determinator-rails/config/environments/production.rb
+- examples/determinator-rails/config/environments/test.rb
+- examples/determinator-rails/config/initializers/determinator.rb
+- examples/determinator-rails/config/initializers/filter_parameter_logging.rb
+- examples/determinator-rails/config/initializers/new_framework_defaults.rb
+- examples/determinator-rails/config/initializers/wrap_parameters.rb
+- examples/determinator-rails/config/puma.rb
+- examples/determinator-rails/config/routes.rb
+- examples/determinator-rails/config/secrets.yml
+- examples/determinator-rails/config/sidekiq.yml
+- examples/determinator-rails/public/favicon.ico
+- examples/determinator-rails/public/robots.txt
+- lib/determinator.rb
+- lib/determinator/actor_control.rb
+- lib/determinator/control.rb
+- lib/determinator/feature.rb
+- lib/determinator/retrieve/routemaster.rb
+- lib/determinator/retrieve/routemaster_indexing_middleware.rb
+- lib/determinator/target_group.rb
+- lib/determinator/version.rb
+homepage: https://github.com/deliveroo/determinator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Determine which experiments and features a specific actor should see.
+test_files: []