eight_ball 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e72251f479d9b7709d48d560535bb28b72692a7893e2de3d196967eb4915509
+  data.tar.gz: 72721d1bb8447908b7241fa1545fe4d59073e2a951982f231de1e32bf11c6d85
+SHA512:
+  metadata.gz: bc07aa302ce37b33da32b8943c4dfae7b7db392d4e028f148500ff95a667999c07cdf0fcd0bd09676e6349f9f20ebc1457d515b72e1dca27c72318e4fb1bc929
+  data.tar.gz: e34699163e898d44ad6d7d832470785b9208383b08a089f5badec06b16bd55929d5bc1410ec1748921852ed1c465b84ad60b175ba66a26014a6b13829deb6657

data/.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence, members of
+# @rewindio/codeowners will be requested for review when someone
+# opens a pull request.
+*       @MarcMorinville-Rewind @jhuff078 @smandegar

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.5.0
+before_install: gem install bundler -v 1.17.1
+deploy:
+  provider: rubygems
+  api_key:
+    secure: t7jNoz9Ct19jfGikW2lxK39aNPbvbFTwkhvVQ4ZlSAn+0iUWSmcTDFnh6MiSJFi9PEGvH3AUIrs6s7p6vhWUB8ll3S1UpC+34izUQZjUUHssJ+tf+A9q27OtX/O9PUsoOkHiq8/3F8SRT1OqyKb9+DR6i/M9MpHgWKLVEmXq3MXnGin1TeNJ70Hy2hakwbH/LdprrfT0LUohLZYzVFEodBPXRWeplJSAnJlyTrSIfIZV9e716L0F3HbXYY6pE5PJkFUSWwzAyO0Z73PJVV5+VsHt10AbHIJzPqf/qsLtC4K4SICWO7Xtnyuu9erg0HjG+y2D3AHbMklP/vJk4y1J2m6aJEzJ4VUVYfbVbkomPV0ol6alPmd6rCth8FQSZ5IFulwfp3qcsvSxS1BDhKl1yDC1di6n5MH9YNndy6puy6VTuuz4lqCya4WA1aBeummb9WsH2CNIws+rLneoH7PsMz6DCx9YhxbfZkh8h0WXRUgl86Ir1RbKbhR4+b3P1MFart55ipJ/tWMtyWOdJvjgakEyR/QMUEkWFMCOHuQd+Iv3PGT5God9YV6L01X/26BIfiHcTZTi2f5RDSyy6vIaOMROLKKU+heK3CGWvemA24uuJbyH9b3QujypCrR7wLRYvfGHeHunFbFH4HHZj+aedvtxzyJ004kNsia2y1TSw6c=
+  gem: eight_ball
+  on:
+    tags: true
+    repo: rewindio/eight_ball

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## [1.0.0]
+Initial release!

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in eight_ball.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    eight_ball (1.0.0)
+      plissken (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    docile (1.3.1)
+    hirb (0.7.3)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    json (2.1.0)
+    metaclass (0.0.4)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.7.0)
+      metaclass (~> 0.0.1)
+    plissken (1.2.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    sparkr (0.4.1)
+    term-ansicolor (1.7.0)
+      tins (~> 1.0)
+    tins (1.20.2)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  eight_ball!
+  inch (~> 0.8)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  mocha (~> 1.7)
+  pry-byebug (~> 3.6)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+  simplecov-console (~> 0.4)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Third Blink Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# EightBall
+[![Build Status](https://travis-ci.com/rewindio/eight_ball.svg?token=2toDwh2UkVcJs8RE5coA&branch=dev)](https://travis-ci.com/rewindio/eight_ball)
+
+EightBall is a feature toggle querying gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eight_ball'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eight_ball
+
+## Example Usage
+```
+require 'eight_ball'
+
+# This could be read from the filesystem or be the response from an external service, etc.
+json_input = %(
+  [{
+    "name": "Feature1",
+    "enabledFor": [{
+      "type": "range",
+      "parameter": "accountId",
+      "min": 1,
+      "max": 10
+    }],
+    "disabledFor": [{
+      "type": "list",
+      "parameter": "accountId",
+      "values": [2, 3]
+    }]
+  }]
+)
+
+# Transform the JSON into a list of Features
+parser = EightBall::Parsers::Json.new
+features = parser.parse json_input
+
+# Tell EightBall about these Features
+EightBall.provider = EightBall::Providers::Static.new features
+
+# Away you go
+EightBall.enabled? "Feature1", { accountId: 4 } # true
+EightBall.enabled? "Feature1", { accountId: 2 } # false
+```
+
+More examples [here](examples)
+
+## Concepts
+
+### Feature
+A Feature is a part of your application that can be enabled or disabled based on various conditions. It has the following attributes:
+- `name`: The unique name of the Feature.
+- `enabledFor`: An array of Conditions for which the Feature is enabled.
+- `disabledFor`: An array of Conditions for which the Feature is disabled.
+
+### Condition
+A Condition must either be `true` or `false`. It describes when a Feature is enabled or disabled.
+
+**Supported Conditions**
+- [Always](lib/eight_ball/conditions/always.rb):  This condition is always satisfied.
+- [List](lib/eight_ball/conditions/list.rb): This condition is satisfied if the given value belongs to its list of accepted values.
+- [Never](lib/eight_ball/conditions/never.rb): This condition is never satisfied.
+- [Range](lib/eight_ball/conditions/range.rb): This condition is satisfied if the given value is within the specified range (inclusive).
+
+### Provider
+A Provider is able to give EightBall the list of Features it needs to answer queries.
+
+**Supported Providers**
+- [HTTP](lib/eight_ball/providers/http.rb): Connect to a URL and use the given Parser to convert the response into a list of Features.
+- [Static](lib/eight_ball/providers/static.rb): Once initialized with a list of Features, always provides that same list of Features.
+
+#### RefreshPolicies
+Some Providers are able to automatically "refresh" their list of Features using a RefreshPolicy.
+
+**Supported RefreshPolicies**
+- [Interval](lib/eight_ball/providers/refresh_policies/interval.rb): The data is considered fresh for a given number of seconds, after which it is considered stale and should be refreshed.
+
+### Parser
+A Parser converts the given input to an array of Features.
+
+**Supported Parsers**
+- [JSON](lib/eight_ball/parsers/json.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Documenting
+Documentation is written using [yard](https://yardoc.org/) syntax. You can view the generated docs by running `yard server` and going to `http://127.0.0.1:8808/docs/EightBall`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rewindio/eight_ball.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'eight_ball'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry-byebug'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eight_ball.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eight_ball/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eight_ball'
+  spec.version       = EightBall::VERSION
+  spec.authors       = ['Rewind.io']
+  spec.email         = ['team@rewind.io']
+
+  spec.summary       = 'The most cost efficient way to flag features'
+  spec.description   = 'Ask questions about flagged features'
+  spec.homepage      = 'https://github.com/rewindio/eight_ball'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  ### DEPENDENCIES
+  spec.add_dependency 'plissken', '~> 1.2'
+
+  # Development
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'inch', '~> 0.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3'
+  spec.add_development_dependency 'mocha', '~> 1.7'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4'
+end

data/examples/http_provider.rb

@@ -0,0 +1,8 @@
+require 'eight_ball'
+
+# Tell EightBall about the Features
+EightBall.provider = EightBall::Providers::Http.new '<YOUR URL HERE>'
+
+# Away you go
+EightBall.enabled? 'Feature1', account_id: 4 # true
+EightBall.enabled? 'Feature1', account_id: 2 # false

data/examples/static_provider.rb

@@ -0,0 +1,13 @@
+require 'eight_ball'
+
+# Create a Feature programatically
+enabled_for = EightBall::Conditions::Range.new min: 1, max: 10, parameter: 'account_id'
+disabled_for = EightBall::Conditions::List.new values: [2, 3]
+feature = EightBall::Feature.new 'Feature1', enabled_for, disabled_for
+
+# Tell EightBall about the Features
+EightBall.provider = EightBall::Providers::Static.new feature
+
+# Away you go
+EightBall.enabled? 'Feature1', account_id: 4 # true
+EightBall.enabled? 'Feature1', account_id: 2 # false

data/lib/eight_ball/conditions/always.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  # The Always Condition is always satisfied
+  class Always < Base
+    def satisfied?
+      true
+    end
+  end
+end

data/lib/eight_ball/conditions/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  class Base
+    attr_reader :parameter
+
+    def initialize(options = [])
+      @parameter = nil
+    end
+
+    def satisfied?
+      raise 'You can never satisfy the Base condition'
+    end
+
+    protected
+
+    def parameter=(parameter)
+      return if parameter.nil?
+      @parameter = parameter.gsub(/(.)([A-Z])/,'\1_\2').downcase
+    end
+  end
+end

data/lib/eight_ball/conditions/conditions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  # Finds the Condition class based on its name
+  # @param [String] name The case insensitive name to find the Condition for
+  # @return [EightBall::Conditions] the Condition class represented by the given name
+  def self.by_name(name)
+    mappings = {
+      always: EightBall::Conditions::Always,
+      list: EightBall::Conditions::List,
+      never: EightBall::Conditions::Never,
+      range: EightBall::Conditions::Range
+    }
+    mappings[name.downcase.to_sym]
+  end
+end

data/lib/eight_ball/conditions/list.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  # The List Condition describes a list of acceptable values.
+  # These can be strings, integers, etc.
+  class List < Base
+    attr_reader :values
+
+    # Creates a new instance of a List Condition.
+    #
+    # @param [Hash] options
+    #
+    # @option options [Array<String>, String] :values
+    #   The list of acceptable values
+    # @option options [String] :parameter
+    #   The name of the parameter this Condition was created for (eg. "account_id").
+    #   This value is only used by calling classes as a way to know what to pass
+    #   into {satisfied?}.
+    def initialize(options = {})
+      options ||= {}
+
+      @values = Array(options[:values])
+      self.parameter = options[:parameter]
+    end
+
+    # @example
+    #   condition = new EightBall::Conditions::List.new [1, 'a']
+    #   condition.satisfied? 1 => true
+    #   condition.satisfied? 2 => false
+    #   condition.satisfied? 'a' => true
+    def satisfied?(value)
+      values.include? value
+    end
+  end
+end

data/lib/eight_ball/conditions/never.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  # The Never Condition is never satisfied
+  class Never < Base
+    def satisfied?
+      false
+    end
+  end
+end

data/lib/eight_ball/conditions/range.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module EightBall::Conditions
+  # The Range Condition describes a range of acceptable values by specifying
+  # a minimum and a maximum. These can be strings, integers, etc. but mixing
+  # data types will probably give you unexpected results.
+  class Range < Base
+    attr_reader :min, :max
+
+    # Creates a new instance of a Range Condition.
+    #
+    # @param [Hash] options
+    #
+    # @option options :min The minimum acceptable value (inclusive).
+    # @option options :max The maximum acceptable value (inclusive).
+    # @option options [String] :parameter
+    #   The name of the parameter this Condition was created for (eg. "account_id").
+    #   This value is only used by calling classes as a way to know what to pass
+    #   into {satisfied?}.
+    def initialize(options = {})
+      options ||= {}
+
+      raise ArgumentError, 'Missing value for min' if options[:min].nil?
+      raise ArgumentError, 'Missing value for max' if options[:max].nil?
+
+      @min = options[:min]
+
+      raise ArgumentError, 'Max must be greater or equal to min' if options[:max] < min
+
+      @max = options[:max]
+
+      self.parameter = options[:parameter]
+    end
+
+    # @example Using integers
+    #   condition = new EightBall::Conditions::List.new min: 1, max: 300
+    #   condition.satisfied? 1 => true
+    #   condition.satisfied? 301 => false
+    #
+    # @example Using strings
+    #   condition = new EightBall::Conditions::List.new min: 'a', max: 'm'
+    #   condition.satisfied? 'a' => true
+    #   condition.satisfied? 'z' => false
+    def satisfied?(value)
+      value >= min && value <= max
+    end
+  end
+end

data/lib/eight_ball/feature.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module EightBall
+  # A Feature is an element of your application that can be enabled or disabled
+  # based on various {EightBall::Conditions}.
+  class Feature
+    attr_reader :name, :enabled_for, :disabled_for
+
+    # Creates a new instance of an Interval RefreshPolicy.
+    #
+    # @param name [String] The name of the Feature.
+    # @param enabled_for [Array<EightBall::Conditions>, EightBall::Conditions]
+    #   The Condition(s) that need to be satisfied for the Feature to be enabled.
+    # @param disabled_for [Array<EightBall::Conditions>, EightBall::Conditions]
+    #   The Condition(s) that need to be satisfied for the Feature to be disabled.
+    #
+    # @example A Feature which is always enabled
+    #   feature = EightBall::Feature.new 'feature1', EightBall::Conditions::Always
+    def initialize(name, enabled_for = [], disabled_for = [])
+      @name = name
+      @enabled_for = Array enabled_for
+      @disabled_for = Array disabled_for
+    end
+
+    # "EightBall, is this Feature enabled?"
+    #
+    # @param parameters [Hash] The parameters the {EightBall::Conditions}
+    #   of this Feature are concerned with.
+    #
+    # @return [true] if no {EightBall::Conditions} are set on the Feature.
+    #   This is equivalent to the {EightBall::Conditions::Always Always} condition.
+    # @return [true] if ANY of the {enabled_for} {EightBall::Conditions} are satisfied
+    #   and NONE of the {disabled_for} {EightBall::Conditions} are satisfied.
+    # @return [false ] if ANY of the {disabled_for} {EightBall::Conditions} are satisfied
+    #
+    # @raise [ArgumentError] if no value is provided for a parameter required
+    #   by one of the Feature's {EightBall::Conditions}
+    #
+    # @example The Feature's {EightBall::Conditions} do not require any parameters
+    #   feature.enabled?
+    #
+    # @example The Feature's {EightBall::Conditions} require an account ID
+    #   feature.enabled? account_id: 123
+    def enabled?(parameters = {})
+      return true if @enabled_for.empty? && @disabled_for.empty?
+      return true if @enabled_for.empty? && !any_satisfied?(@disabled_for, parameters)
+
+      any_satisfied?(@enabled_for, parameters) && !any_satisfied?(@disabled_for, parameters)
+    end
+
+    private
+
+    def any_satisfied?(conditions, parameters)
+      conditions.any? do |condition|
+        return condition.satisfied? if condition.parameter.nil?
+
+        value = parameters[condition.parameter.to_sym]
+        raise ArgumentError, "Missing parameter #{condition.parameter}" if value.nil?
+
+        condition.satisfied? value
+      end
+    end
+  end
+end

data/lib/eight_ball/parsers/json.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'plissken'
+
+module EightBall::Parsers
+  # A JSON parser will parse JSON into a list of {EightBall::Feature Features}.
+  # The top-level JSON element must be an array and must use camel-case;
+  # this will be converted to snake-case by EightBall.
+  #
+  # Below are some examples of valid JSON:
+  #
+  # @example A single {EightBall::Feature} is enabled for accounts 1-5 as well as region Europe
+  #   [{
+  #     "name": "Feature1",
+  #     "enabledFor": [{
+  #       "type": "range",
+  #       "parameter": "accountId",
+  #       "min": 1,
+  #       "max": 5
+  #     }, {
+  #       "type": "list",
+  #       "parameter": "regionName",
+  #       "values": ["Europe"]
+  #     }]
+  #   }]
+  #
+  # @example A single {EightBall::Feature} is disabled completely using the {EightBall::Conditions::Always Always} condition
+  #   [{
+  #     "name": "Feature1",
+  #     "disabledFor": [{
+  #       "type": "always"
+  #     }]
+  #   }]
+  class Json
+    # Convert the JSON into a list of {EightBall::Feature Features}.
+    #
+    # @param [String] json The JSON string to parse.
+    # @return [Array<EightBall::Feature>] The parsed {EightBall::Feature Features}
+    #
+    # @example
+    #   json_string = <Read from somewhere>
+    #
+    #   parser = EightBall::Parsers::Json.new
+    #   parser.parse json_string => [Features]
+    def parse(json)
+      parsed = JSON.parse(json, :symbolize_names => true).to_snake_keys
+      
+      raise ArgumentError, 'JSON input was not an array' unless parsed.is_a? Array
+
+      parsed.map do |feature|
+        enabled_for = create_conditions feature[:enabled_for]
+        disabled_for = create_conditions feature[:disabled_for]
+
+        EightBall::Feature.new feature[:name], enabled_for, disabled_for
+      end
+    rescue JSON::ParserError => e
+      EightBall.logger.error { "Failed to parse JSON: #{e.message}" }
+      []
+    end
+
+    private
+
+    def create_conditions(json_conditions)
+      return [] unless json_conditions && json_conditions.is_a?(Array)
+
+      json_conditions.map do |condition|
+        condition_class = EightBall::Conditions.by_name condition[:type]
+        condition_class.new condition
+      end
+    end
+  end
+end

data/lib/eight_ball/providers/http.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module EightBall::Providers
+  # An HTTP Provider will make a GET request to a given URI, and convert
+  # the response into an array of {EightBall::Feature Features} using the
+  # given {EightBall::Parsers Parser}.
+  #
+  # The {EightBall::Feature Features} will be automatically kept up to date
+  # according to the given {EightBall::Providers::RefreshPolicies RefreshPolicy}.
+  class Http
+    SUPPORTED_SCHEMES = %w[http https].freeze
+
+    # @param uri [String] The URI to GET the {EightBall::Feature Features} from.
+    # @param options [Hash] The options to create the Provider with.
+    #
+    # @option options [EightBall::Parsers] :parser
+    #   The {EightBall::Parsers Parser} used to convert the response to an array
+    #   of {EightBall::Feature Features}. Defaults to an instance of
+    #   {EightBall::Parsers::Json}
+    #
+    # @option options [EightBall::Providers::RefreshPolicies] :refresh_policy
+    #   The {EightBall::Providers::RefreshPolicies Policy} used to determine
+    #   when the {EightBall::Feature Features} have gone stale and need to be
+    #   refreshed. Defaults to an instance of
+    #   {EightBall::Providers::RefreshPolicies::Interval}
+    #
+    # @example
+    #   provider = EightBall::Providers::Http.new(
+    #     'http://www.rewind.io',
+    #     refresh_policy: EightBall::Providers::RefreshPolicies::Interval.new 120
+    #   )
+    def initialize(uri, options = {})
+      raise ArgumentError, 'Invalid HTTP/HTTPS URI provided' unless uri =~ URI.regexp(SUPPORTED_SCHEMES)
+
+      @uri = URI.parse uri
+
+      @parser = options[:parser] || EightBall::Parsers::Json.new
+      @policy = options[:refresh_policy] || EightBall::Providers::RefreshPolicies::Interval.new
+    end
+
+    # Returns the current {EightBall::Feature Features}.
+    # @return [Array<{EightBall::Feature}>]
+    def features
+      @policy.refresh { fetch }
+      @features
+    end
+
+    private
+
+    def fetch
+      @features = @parser.parse Net::HTTP.get(@uri)
+    rescue => e
+      EightBall.logger.error { "Failed to fetch data from #{@uri}: #{e.message}" }
+      @features = []
+    end
+  end
+end

data/lib/eight_ball/providers/refresh_policies/interval.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module EightBall::Providers::RefreshPolicies
+  # An Interval RefreshPolicy states that data is considered fresh for a certain
+  # amount of time, after which it is considered stale and should be refreshed.
+  class Interval
+    SECONDS_IN_A_DAY = 86_400
+    
+    # Creates a new instance of an Interval RefreshPolicy.
+    #
+    # @param seconds [Integer] The number of seconds the data is considered fresh.
+    #
+    # @example New data stays fresh for 2 minutes
+    #   EightBall::Providers::RefreshPolicies::Interval.new 120
+    def initialize(seconds = 60)
+      @interval = seconds
+      @fresh_until = nil
+    end
+
+    # Yields if the current data is stale, in order to refresh it.
+    # Resets the interval once the data is refreshed.
+    #
+    # @example Load new data if current data is stale
+    #   policy.refresh { load_new_data }
+    def refresh
+      return unless block_given? && stale?
+
+      yield
+      @fresh_until = DateTime.now + Rational(@interval, SECONDS_IN_A_DAY)
+    end
+
+    protected
+
+    def stale?
+      @fresh_until.nil? || DateTime.now > @fresh_until
+    end
+  end
+end

data/lib/eight_ball/providers/static.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EightBall::Providers
+  # A Static provider will always provide the exact list of {EightBall::Features}
+  # that were passed in at construction time.
+  class Static
+    attr_reader :features
+
+    # Creates a new instance of a Static Provider.
+    #
+    # @param features [Array<EightBall::Feature>, EightBall::Feature]
+    #   The {EightBall::Feature Feature(s)} that this provider will return.
+    #
+    # @example
+    #   provider = EightBall::Providers::Static.new([
+    #     EightBall::Feature.new 'feature1',
+    #     EightBall::Feature.new 'feature2'
+    #   ])
+    def initialize(features = [])
+      @features = Array features
+    end
+  end
+end

data/lib/eight_ball/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EightBall
+  VERSION = '1.0.0'
+end

data/lib/eight_ball.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'eight_ball/version'
+require 'eight_ball/feature'
+
+require 'eight_ball/conditions/conditions'
+require 'eight_ball/conditions/base'
+
+require 'eight_ball/conditions/always'
+require 'eight_ball/conditions/list'
+require 'eight_ball/conditions/never'
+require 'eight_ball/conditions/range'
+
+require 'eight_ball/parsers/json'
+
+require 'eight_ball/providers/http'
+require 'eight_ball/providers/static'
+
+require 'eight_ball/providers/refresh_policies/interval'
+
+require 'logger'
+
+# For all your feature querying needs.
+module EightBall
+  # Sets the {EightBall::Providers Provider} instance EightBall
+  # will use to obtain your list of {EightBall::Feature Features}.
+  #
+  # @return [nil]
+  #
+  # @example
+  #   EightBall.provider = EightBall::Providers::Http.new 'http://www.rewind.io'
+  def self.provider=(provider)
+    @provider = provider
+  end
+
+  # "EightBall, is the feature named 'NewFeature' enabled?"
+  #
+  # @return whether or not the {EightBall::Feature} is enabled.
+  # @return [false] if {EightBall::Feature} does not exist.
+  #
+  # @param name [String] The name of the {EightBall::Feature}.
+  # @param parameters [Hash] The parameters the {EightBall::Conditions} of this
+  #   {EightBall::Feature} are concerned with.
+  #
+  # @example
+  #   EightBall.enabled? 'feature1', account_id: 1
+  def self.enabled?(name, parameters = {})
+    feature = @provider.features.find { |f| f.name == name }
+    return false unless feature
+
+    feature.enabled? parameters
+  end
+
+  # "EightBall, is the feature named 'NewFeature' disabled?"
+  #
+  # @return whether or not the {EightBall::Feature} is disabled.
+  # @return [true] if {EightBall::Feature} does not exist.
+  #
+  # @param name [String] The name of the {EightBall::Feature}.
+  # @param parameters [Hash] The parameters the {EightBall::Conditions} of this
+  #   {EightBall::Feature} are concerned with.
+  #
+  # @example
+  #   EightBall.disabled? 'feature1', account_id: 1
+  def self.disabled?(name, parameters = {})
+    !enabled? name, parameters
+  end
+
+  # Yields to the given block of code if the {EightBall::Feature} is enabled.
+  #
+  # @return [nil] if block is yielded to
+  # @return [false] if {EightBall::Feature} is disabled
+  #
+  # @param name [String] The name of the {EightBall::Feature}.
+  # @param parameters [Hash] The parameters the {EightBall::Conditions} of this
+  #   {EightBall::Feature} are concerned with.
+  #
+  # @example
+  #   EightBall.with 'feature1', account_id: 1 do
+  #     puts 'Feature is enabled!'
+  #   end
+  def self.with(name, parameters = {})
+    return false unless block_given?
+
+    yield if enabled? name, parameters
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT).tap do |log|
+      log.progname = self.name
+    end
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: eight_ball
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rewind.io
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Ask questions about flagged features
+email:
+- team@rewind.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eight_ball.gemspec
+- examples/http_provider.rb
+- examples/static_provider.rb
+- lib/eight_ball.rb
+- lib/eight_ball/conditions/always.rb
+- lib/eight_ball/conditions/base.rb
+- lib/eight_ball/conditions/conditions.rb
+- lib/eight_ball/conditions/list.rb
+- lib/eight_ball/conditions/never.rb
+- lib/eight_ball/conditions/range.rb
+- lib/eight_ball/feature.rb
+- lib/eight_ball/parsers/json.rb
+- lib/eight_ball/providers/http.rb
+- lib/eight_ball/providers/refresh_policies/interval.rb
+- lib/eight_ball/providers/static.rb
+- lib/eight_ball/version.rb
+homepage: https://github.com/rewindio/eight_ball
+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.7.8
+signing_key: 
+specification_version: 4
+summary: The most cost efficient way to flag features
+test_files: []