eight_ball 1.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e72251f479d9b7709d48d560535bb28b72692a7893e2de3d196967eb4915509
-  data.tar.gz: 72721d1bb8447908b7241fa1545fe4d59073e2a951982f231de1e32bf11c6d85
+  metadata.gz: 521486fba75fc1996224ec260d22ed00860955da71941256452cb910adb3539d
+  data.tar.gz: 2c905caa109755024226a5ae088c9731ee7349930e423bf76a5d96de057e2b2c
 SHA512:
-  metadata.gz: bc07aa302ce37b33da32b8943c4dfae7b7db392d4e028f148500ff95a667999c07cdf0fcd0bd09676e6349f9f20ebc1457d515b72e1dca27c72318e4fb1bc929
-  data.tar.gz: e34699163e898d44ad6d7d832470785b9208383b08a089f5badec06b16bd55929d5bc1410ec1748921852ed1c465b84ad60b175ba66a26014a6b13829deb6657
+  metadata.gz: b9265bc7abf5060158f14ba9b42e9945a618fc4fb94c6f97b946228927fa37f8638fc5e9f014340aa4e03698edf00df39d24f3ef58bd2087dda0f15162ea59a3
+  data.tar.gz: c55f4e5fc008e92bc1b70a6c5d02efe5af600c59834aa35bbf850ccab0fd2d89c427ee16ca1931bc781009e4cc57b0ed6ac358f8632d81f55520d0aac0dccddc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -3,11 +3,11 @@ language: ruby
 cache: bundler
 rvm:
 - 2.5.0
-before_install: gem install bundler -v 1.17.1
+before_install: gem install bundler -v 1.17.2
 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=
+    secure: fHXG5wBNcGRqpznLCCHfgwKEL1UXf0CNjou+HUdLJgLDwHaJro5TxM/c9z0Pnb9OJE0KIydVaIKh3iX0VtH1gS4m3ZztSpb5tnu4kkwAfdqG6QXVyubatxL/NQKTZSv6IzUjK/SC1eUePFMUu64Kx6voe8B1ZwoAGVf6L+atektcGb0PhZ24ogNFQaNUC3QJVPYyVKHLD8hZv6GVtxHE/xF6yiVhSZ4Mz2vqD4hDMQlkASnFzhhGvBk22aboc9Z0cBeYd2CRICJfyMyjUSmM2cFaeq1IsMJ6p2THoeeHYu8dIE7iiPMh2hMBD+ok+O+5f/8T3MpOdnpaLuq0u/ZkGBjg8oe4TCEQ67IZdIZnsRYEtwqJl//0Tkh9qW6ZZrq9ZHpd8VSXGbJv3eDutytlXNb0YdLXiRrBX72dGH9zheSQHIaBnc5gbSdaTcgqFacdeK3grx1L40SWTVrwBm+Dm88xvGGfPl+Y2sj0dBoPdeZqRfbrztSJivbbbR7XKosyOWQK9LqasPNP5EXjlnJRms6C/15m57RFs0oi/1p1TPAbaLqcp9Xvbwlft6HegCSram9xvd6R9alFgaizS1vLbESOJAQkADA9VN9ERApr38Eum8J6HF2xa/uXn4mHsLXzp5nkYqWb8LRqvxvzAnWL2p553upBTfP4m055jxPGwaM=
   gem: eight_ball
   on:
     tags: true

data/CHANGELOG.md

@@ -1,4 +1,30 @@
 # Changelog
 
+## [2.2.0]
+ - Add `==` to `Feature` and `Conditions`
+
+## [2.1.0]
+ - Add `features` parameter to `EightBall.marshall` to allow marshalling any Features, not just the ones
+   from the configured Provider.
+
+## [2.0.0]
+ - [BREAKING] `Parsers` have been replaced with `Marshallers`, allowing bi-directional conversions
+ - Added `EightBall.marshall` as a way to output the Feature list to an external format (e.g. to create a JSON file)
+ - Added `EightBall.features` as a shortcut to `EightBall.provider.features`
+ - Testing framework has been moved from Minitest to rspec
+ - Updated dev dependencies
+
+## [1.0.5]
+Security: Update rake to >= 12.3.3
+
+## [1.0.3]
+Update .travis.yml
+
+## [1.0.2]
+Update .travis.yml
+
+## [1.0.1]
+Security: Update yard 0.9.16 -> 0.9.20
+
 ## [1.0.0]
 Initial release!

data/Gemfile

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

data/Gemfile.lock

@@ -1,57 +1,64 @@
 PATH
   remote: .
   specs:
-    eight_ball (1.0.0)
+    eight_ball (2.2.0)
+      awrence (~> 1.1)
       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)
+    awrence (1.1.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.3)
+    docile (1.3.2)
     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)
+    method_source (1.0.0)
+    plissken (1.3.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.4.2)
+      simplecov-html (~> 0.11)
+    simplecov-console (0.7.2)
       ansi
-      hirb
       simplecov
-    simplecov-html (0.10.2)
+      terminal-table
+    simplecov-html (0.12.2)
     sparkr (0.4.1)
-    term-ansicolor (1.7.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
-    tins (1.20.2)
-    yard (0.9.16)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tins (1.25.0)
+      sync
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -60,13 +67,11 @@ 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)
+  rake (~> 13.0)
+  rspec (~> 3.9.0)
   simplecov (~> 0.16)
   simplecov-console (~> 0.4)
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -1,5 +1,5 @@
 # EightBall
-[![Build Status](https://travis-ci.com/rewindio/eight_ball.svg?token=2toDwh2UkVcJs8RE5coA&branch=dev)](https://travis-ci.com/rewindio/eight_ball)
+[![Build Status](https://travis-ci.org/rewindio/eight_ball.svg?branch=dev)](https://travis-ci.org/rewindio/eight_ball)
 
 EightBall is a feature toggle querying gem
 
@@ -42,8 +42,8 @@ json_input = %(
 )
 
 # Transform the JSON into a list of Features
-parser = EightBall::Parsers::Json.new
-features = parser.parse json_input
+marshaller = EightBall::Marshallers::Json.new
+features = marshaller.unmarshall json_input
 
 # Tell EightBall about these Features
 EightBall.provider = EightBall::Providers::Static.new features
@@ -76,7 +76,7 @@ A Condition must either be `true` or `false`. It describes when a Feature is ena
 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.
+- [HTTP](lib/eight_ball/providers/http.rb): Connect to a URL and use the given Marshaller 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
@@ -85,15 +85,15 @@ Some Providers are able to automatically "refresh" their list of Features using
 **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.
+### Marshallers
+A Marshaller converts Features to and from another format.
 
-**Supported Parsers**
-- [JSON](lib/eight_ball/parsers/json.rb)
+**Supported Marshaller**
+- [JSON](lib/eight_ball/marshallers/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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`.
 

data/Rakefile

@@ -1,10 +1,9 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
 end
 
-task :default => :test
+task default: :spec

data/eight_ball.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'eight_ball/version'
 
@@ -15,22 +15,24 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.5.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|.github|examples)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   ### DEPENDENCIES
+
+  spec.add_dependency 'awrence', '~> 1.1'
   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 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'simplecov-console', '~> 0.4'
 end

data/lib/eight_ball.rb

@@ -3,6 +3,8 @@
 require 'eight_ball/version'
 require 'eight_ball/feature'
 
+require 'eight_ball/configuration_error'
+
 require 'eight_ball/conditions/conditions'
 require 'eight_ball/conditions/base'
 
@@ -11,7 +13,7 @@ require 'eight_ball/conditions/list'
 require 'eight_ball/conditions/never'
 require 'eight_ball/conditions/range'
 
-require 'eight_ball/parsers/json'
+require 'eight_ball/marshallers/json'
 
 require 'eight_ball/providers/http'
 require 'eight_ball/providers/static'
@@ -33,6 +35,24 @@ module EightBall
     @provider = provider
   end
 
+  # Gets the {EightBall::Providers Provider} instance
+  # EightBall is configured to use
+  #
+  # @return {EightBall::Providers Provider}
+  def self.provider
+    @provider
+  end
+
+  # Serves as a shortcut to access the {EightBall::Feature Features} available
+  # on the configured {EightBall::Providers Provider}
+  #
+  # @return [Array<EightBall::Feature>]
+  def self.features
+    raise EightBall::ConfigurationError, 'No Provider has been configured; there can be no features. Please see "EightBall.provider="' unless provider
+
+    provider.features
+  end
+
   # "EightBall, is the feature named 'NewFeature' enabled?"
   #
   # @return whether or not the {EightBall::Feature} is enabled.
@@ -45,7 +65,7 @@ module EightBall
   # @example
   #   EightBall.enabled? 'feature1', account_id: 1
   def self.enabled?(name, parameters = {})
-    feature = @provider.features.find { |f| f.name == name }
+    feature = provider.features.find { |f| f.name == name }
     return false unless feature
 
     feature.enabled? parameters
@@ -69,7 +89,7 @@ module EightBall
   # 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
+  # @return [false] if no block is given
   #
   # @param name [String] The name of the {EightBall::Feature}.
   # @param parameters [Hash] The parameters the {EightBall::Conditions} of this
@@ -85,9 +105,28 @@ module EightBall
     yield if enabled? name, parameters
   end
 
+  # Marshalls the {EightBall::Feature Features}. This can be useful for
+  # converting the data to, e.g., a JSON file.
+  #
+  # If a {EightBall::Marshallers Marshaller} is provided, use it.
+  #
+  # If no {EightBall::Marshallers Marshaller} is provided, uses the same
+  # Marshaller that the Provider is configured with.
+  #
+  # If the {EightBall::Providers Provider} does not expose a
+  # {EightBall::Marshallers Marshaller}, this will default to the
+  # {EightBall::Marshallers::Json JSON Marshaller}.
+  def self.marshall(marshaller = nil, features = EightBall.features)
+    marshaller ||=
+      (provider.respond_to?(:marshaller) && provider.marshaller) ||
+      EightBall::Marshallers::Json.new
+
+    marshaller.marshall features
+  end
+
   def self.logger
     @logger ||= Logger.new(STDOUT).tap do |log|
-      log.progname = self.name
+      log.progname = name
     end
   end
 

data/lib/eight_ball/conditions/base.rb

@@ -4,7 +4,7 @@ module EightBall::Conditions
   class Base
     attr_reader :parameter
 
-    def initialize(options = [])
+    def initialize(_options = [])
       @parameter = nil
     end
 
@@ -12,11 +12,25 @@ module EightBall::Conditions
       raise 'You can never satisfy the Base condition'
     end
 
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+    alias eql? ==
+
+    def hash
+      state.hash
+    end
+
     protected
 
+    def state
+      [@parameter]
+    end
+
     def parameter=(parameter)
       return if parameter.nil?
-      @parameter = parameter.gsub(/(.)([A-Z])/,'\1_\2').downcase
+
+      @parameter = parameter.gsub(/(.)([A-Z])/, '\1_\2').downcase
     end
   end
 end

data/lib/eight_ball/conditions/list.rb

@@ -31,5 +31,11 @@ module EightBall::Conditions
     def satisfied?(value)
       values.include? value
     end
+
+    protected
+
+    def state
+      super + [@values.sort]
+    end
   end
 end

data/lib/eight_ball/conditions/range.rb

@@ -44,5 +44,11 @@ module EightBall::Conditions
     def satisfied?(value)
       value >= min && value <= max
     end
+
+    protected
+
+    def state
+      super + [@min, @max]
+    end
   end
 end

data/lib/eight_ball/configuration_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module EightBall
+  class ConfigurationError < StandardError
+    def initialize(msg = 'An invalid configuration was detected')
+      super
+    end
+  end
+end

data/lib/eight_ball/feature.rb

@@ -48,6 +48,15 @@ module EightBall
       any_satisfied?(@enabled_for, parameters) && !any_satisfied?(@disabled_for, parameters)
     end
 
+    def ==(other)
+      name == other.name &&
+        enabled_for.size == other.enabled_for.size &&
+        enabled_for.all? { |condition| other.enabled_for.any? { |other_condition| condition == other_condition } } &&
+        disabled_for.size == other.disabled_for.size &&
+        disabled_for.all? { |condition| other.disabled_for.any? { |other_condition| condition == other_condition } }
+    end
+    alias eql? ==
+
     private
 
     def any_satisfied?(conditions, parameters)

data/lib/eight_ball/marshallers/json.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'awrence'
+require 'json'
+require 'plissken'
+
+# A JSON marshaller can convert back and forth between JSON and a list of {EightBall::Feature Features}
+# The JSON produced will be pretty-printed, as it is assumed the output will be written to a file.
+#
+# When converting from JSON, the top-level JSON element must be an array and
+# its keys must use camel-case; this will be converted to snake-case by EightBall
+# in order to adhere to both JSON and Ruby standards.
+#
+# 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"
+#     }]
+#   }]
+module EightBall::Marshallers
+  class Json
+    # Convert the given {EightBall::Feature Features} into a JSON array.
+    #
+    # @param [Array<EightBall::Feature>] features The {EightBall::Feature Features} to convert.
+    # @return [String] The resulting JSON string.
+    #
+    # @example
+    #   json_string = <Read from somewhere>
+    #
+    #   marshaller = EightBall::Marshallers::Json.new
+    #   marshaller.marshall [Array<EightBall::Feature>] => json
+    def marshall(features)
+      JSON.generate(features.map { |feature| feature_to_hash(feature).to_camelback_keys })
+    end
+
+    # Convert the given JSON into a list of {EightBall::Feature Features}.
+    #
+    # @param [String] json The JSON string to convert.
+    # @return [Array<EightBall::Feature>] The parsed {EightBall::Feature Features}
+    #
+    # @example
+    #   json_string = <Read from somewhere>
+    #
+    #   marshaller = EightBall::Marshallers::Json.new
+    #   marshaller.unmarshall json_string => [Features]
+    def unmarshall(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_from_json feature[:enabled_for]
+        disabled_for = create_conditions_from_json 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 feature_to_hash(feature)
+      hash = {
+        name: feature.name
+      }
+
+      hash[:enabled_for] = feature.enabled_for.map { |condition| condition_to_hash(condition) } unless feature.enabled_for.empty?
+      hash[:disabled_for] = feature.disabled_for.map { |condition| condition_to_hash(condition) } unless feature.disabled_for.empty?
+
+      hash
+    end
+
+    def condition_to_hash(condition)
+      hash = {
+        type: condition.class.name.split('::').last.downcase
+      }
+      condition.instance_variables.each do |var|
+        next unless condition.instance_variable_get(var)
+
+        hash[var.to_s.delete('@')] = condition.instance_variable_get(var)
+      end
+
+      hash
+    end
+
+    def create_conditions_from_json(json_conditions)
+      return [] unless 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

@@ -1,22 +1,26 @@
 # frozen_string_literal: true
 
+require 'net/http'
+
 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}.
+  # given {EightBall::Marshallers Marshaller}.
   #
   # 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
 
+    attr_reader :marshaller
+
     # @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
+    # @option options [EightBall::Marshallers] :marshaller
+    #   The {EightBall::Marshallers Marshaller} used to convert the response to an array
     #   of {EightBall::Feature Features}. Defaults to an instance of
-    #   {EightBall::Parsers::Json}
+    #   {EightBall::Marshallers::Json}
     #
     # @option options [EightBall::Providers::RefreshPolicies] :refresh_policy
     #   The {EightBall::Providers::RefreshPolicies Policy} used to determine
@@ -34,7 +38,7 @@ module EightBall::Providers
 
       @uri = URI.parse uri
 
-      @parser = options[:parser] || EightBall::Parsers::Json.new
+      @marshaller = options[:marshaller] || EightBall::Marshallers::Json.new
       @policy = options[:refresh_policy] || EightBall::Providers::RefreshPolicies::Interval.new
     end
 
@@ -48,8 +52,8 @@ module EightBall::Providers
     private
 
     def fetch
-      @features = @parser.parse Net::HTTP.get(@uri)
-    rescue => e
+      @features = @marshaller.unmarshall Net::HTTP.get(@uri)
+    rescue StandardError => e
       EightBall.logger.error { "Failed to fetch data from #{@uri}: #{e.message}" }
       @features = []
     end

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

@@ -7,7 +7,7 @@ module EightBall::Providers::RefreshPolicies
   # 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.

data/lib/eight_ball/version.rb

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

metadata

@@ -1,127 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: eight_ball
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Rewind.io
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-06 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: plissken
+  name: awrence
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.1'
   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'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: plissken
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
+        version: '1.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -157,8 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -169,8 +155,6 @@ files:
 - 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
@@ -178,8 +162,9 @@ files:
 - lib/eight_ball/conditions/list.rb
 - lib/eight_ball/conditions/never.rb
 - lib/eight_ball/conditions/range.rb
+- lib/eight_ball/configuration_error.rb
 - lib/eight_ball/feature.rb
-- lib/eight_ball/parsers/json.rb
+- lib/eight_ball/marshallers/json.rb
 - lib/eight_ball/providers/http.rb
 - lib/eight_ball/providers/refresh_policies/interval.rb
 - lib/eight_ball/providers/static.rb
@@ -196,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -204,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: The most cost efficient way to flag features

data/.github/CODEOWNERS

@@ -1,7 +0,0 @@
-# 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/examples/http_provider.rb

@@ -1,8 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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/parsers/json.rb

@@ -1,72 +0,0 @@
-# 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