this_feature-adapters-flipper 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4a261fc36bd82e31aecd8f83fc399e50eca40fdf1b639b10ce3c5d819f6aa9
-  data.tar.gz: 6053c41648e337f13a9817d0f5c6134755ecb7b8b4f3364d9b11ef761ef4aabf
+  metadata.gz: 4de6acf45dc7581500f737401158c90b6e2da6b6193c33a19c6e7c15378d8f8a
+  data.tar.gz: 4bf56af16928ae0d03a827e3039b404cc03e94f3ceb0d32a0f3790981381feab
 SHA512:
-  metadata.gz: 24ad8ced3e7e4f13f878943f49cd4f2bba8db2a6e543805b9eb29d8e7bd4d6736d9fd73525c1bcfdc4c20e617b5156f5d6d9561f38fc6ba5add72d7d09367e28
-  data.tar.gz: 4d75aa7090b18b05b0ced212f315c92bce510793959fd79c83107507dc285199f31db6c4e0481c62e4c797548de5ae165fa2c46b02fd8bb9535822744f83dd04
+  metadata.gz: 52d87427a549c8f8e1c51c1df420fc9df37c2c929b62f1644a13ee0dd8e5ee7c4d19c759d58962589853f473e3e88ef087c4544d4f8b98527abd048d49a82504
+  data.tar.gz: c64ce30d84f15a31f09241d66fa8a053056e1f12ffa730a10d1cd9f54d943786424fb0ddbaaff4afe3c3a4a95200e99435d349193a273d5ac327a88d437b40b9

data/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 
 gemspec name: "this_feature"
 gemspec name: "this_feature-adapters-flipper"
+gemspec name: "this_feature-adapters-split_io"

data/Gemfile.lock

@@ -1,10 +1,14 @@
 PATH
   remote: .
   specs:
-    this_feature (0.3.0)
-    this_feature-adapters-flipper (0.3.0)
+    this_feature (0.5.0)
+    this_feature-adapters-flipper (0.5.0)
       flipper (~> 0.16)
       flipper-active_record (~> 0.16)
+      this_feature
+    this_feature-adapters-split_io (0.5.0)
+      splitclient-rb
+      this_feature
 
 GEM
   remote: https://rubygems.org/
@@ -23,20 +27,30 @@ GEM
     byebug (11.1.2)
     coderay (1.1.2)
     concurrent-ruby (1.1.6)
+    connection_pool (2.2.3)
     database_cleaner (1.8.4)
     database_cleaner-active_record (1.8.0)
       activerecord
       database_cleaner (~> 1.8.0)
     diff-lcs (1.3)
-    flipper (0.18.0)
-    flipper-active_record (0.18.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    flipper (0.19.0)
+    flipper-active_record (0.19.0)
       activerecord (>= 5.0, < 7)
-      flipper (~> 0.18.0)
+      flipper (~> 0.19.0)
     gem-release (2.1.1)
+    hitimes (1.3.1)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    jwt (2.2.2)
+    lru_redux (1.1.0)
     method_source (1.0.0)
     minitest (5.14.1)
+    multipart-post (2.1.1)
+    net-http-persistent (4.0.0)
+      connection_pool (~> 2.2)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -44,6 +58,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rake (13.0.1)
+    redis (4.2.2)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -57,6 +72,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    socketry (0.5.1)
+      hitimes (~> 1.2)
+    splitclient-rb (7.1.3)
+      concurrent-ruby (~> 1.0)
+      faraday (>= 0.8)
+      json (>= 1.8)
+      jwt (>= 2.2.1)
+      lru_redux
+      net-http-persistent (>= 2.9)
+      redis (>= 3.2)
+      socketry (~> 0.5.1)
+      thread_safe (>= 0.3)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
@@ -76,6 +103,7 @@ DEPENDENCIES
   sqlite3
   this_feature!
   this_feature-adapters-flipper!
+  this_feature-adapters-split_io!
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,59 +1,69 @@
 # ThisFeature
 
-The purpose of ThisFeature is to have one way to use feature flags
+**A common interface to interact with many feature flag providers.**
 
-## Installation
+Can be used to more easily migrate among providers.
+
+If your code uses ThisFeature,
+then you can just swap out the adapter without having to do a bunch of find-and-replace.
 
-Add this line to your application's `Gemfile`:
+## Installation
 
 ```ruby
 gem 'this_feature'
 ```
 
-And then execute:
+## Configuration
 
-```sh
-bundle
+```ruby
+# config/initializers/this_feature.rb
+require 'this_feature'
+require 'this_feature/adapters/memory'
+
+ThisFeature.configure do |config|
+  adapter = ThisFeature::Adapters::Memory.new
+  config.adapters = [adapter]
+  config.default_adapter = adapter
+end
 ```
 
-Or install it yourself as:
-
-```sh
-gem install feature
-```
+**NOTE**: When searching for the presence of a flag, adapters are queried in order. The default adapter is the fallback adapter used when a flag isn't present in any of the adapters.
 
 ## Usage
 
-### Currently
-
-Currently, the only available adapter is `Flipper`.
-We will update this document when more are added.
-
-To set it up, put this in an initializer file:
+### Flags
 
 ```ruby
-ThisFeature.set_adapters([ThisFeature::Adapters::FlipperAdapter])
+ThisFeature.flag('flag_name').on?      # is the flag is turned on?
+ThisFeature.flag('flag_name').off?     # is the flag is turned off?
+ThisFeature.flag('flag_name').control? # is the adapter is using the control?
+ThisFeature.flag('flag_name').present? # is the flag set at all?
+ThisFeature.default_adapter            # access the default adapter directly if needed
 ```
 
-This `set_adapters` will internally call the `.setup` method on the `FlipperAdapter`, which performs the Flipper initialization.
+### Context
 
-Then you can call `ThisFeature.enabled?("flag name")`.
+You can also pass a context to the flag, many feature flagging systems support this.
 
-It will iterate through the adapters until one of them returns `true`/`false`.
+```ruby
+ThisFeature.flag('flag_name', context: current_user).on?
+```
 
-A context (`User` or `Org`) can be passed in the arguments to `enabled?` as well. `ThisFeature.enabled?(:flag_name, Current.user)`
+### Data
 
-### Planned
+In case context is not sufficient, you can also pass a data hash.
 
-Create an initializer file in your Rails app:
+```ruby
+ThisFeature.flag('flag_name', context: context, data: { org_id: 1 }).on?
+```
 
-`/config/initializers/this_feature.rb`
+## Available Adapters
 
-And set your list of adapters, _ordered by priority_. For example:
+These adapters do behave slightly differently, so make sure to read the following docs:
 
-```ruby
-ThisFeature.adapters = [SplitIO Flipper]
-```
+- [Flipper adapter](./docs/flipper.md)
+- [Split.io adapter](./docs/splitio.md)
+- [Memory adapter](./docs/memory.md) - **designed for use in tests**
 
 ## Development
 
@@ -64,6 +74,11 @@ You can run the tests with these commands in your Terminal:
 bundle install && bundle exec rspec
 ```
 
+To write a new adapter, check the [Guide](./docs/writing_an_adapter.md).
+
 ## License
 
 ThisFeature is released under the [MIT License](https://choosealicense.com/licenses/mit).
+
+
+

data/lib/this_feature.rb

@@ -13,19 +13,19 @@ class ThisFeature
 
   def self.adapter_for(flag_name, context: nil, data: {})
     matching_adapter = adapters.find do |adapter|
-      adapter.present?(flag_name, context: context, data: data)
+      adapter.present?(flag_name)
     end
 
     matching_adapter || configuration.default_adapter
   end
 
-  # Configuration
-
   def self.configuration
     @configuration ||= Configuration.new
   end
 
   def self.configure
+    @configuration = Configuration.new
+
     yield(configuration)
 
     configuration.init
@@ -35,4 +35,7 @@ class ThisFeature
     configuration.adapters
   end
 
+  def self.test_adapter
+    configuration.test_adapter
+  end
 end

data/lib/this_feature/adapters/base.rb

@@ -1,34 +1,21 @@
 class ThisFeature
   module Adapters
     class Base
-
-      def self.setup
-        raise UnimplementedError.new(self, __method__)
-      end
-
-      def self.present?(flag_name)
-        raise UnimplementedError.new(self, __method__)
-      end
-
-      def self.on?(flag_name, context: nil, data: {})
-        raise UnimplementedError.new(self, __method__)
-      end
-
-      def self.off?(flag_name, context: nil, data: {})
+      def present?(flag_name)
         raise UnimplementedError.new(self, __method__)
       end
 
-      def self.on!(flag_name, context: nil, data: {})
+      def on?(flag_name, context: nil, data: {})
         raise UnimplementedError.new(self, __method__)
       end
 
-      def self.off!(flag_name, context: nil, data: {})
+      def off?(flag_name, context: nil, data: {})
         raise UnimplementedError.new(self, __method__)
       end
 
       # OPTIONAL method
       # check to see if a control is being used
-      def self.control?(flag_name, context: nil, data: {})
+      def control?(flag_name, context: nil, data: {})
         false
       end
     end

data/lib/this_feature/adapters/flipper.rb

@@ -4,48 +4,38 @@ require "flipper/adapters/active_record"
 class ThisFeature
   module Adapters
     class Flipper < Base
+      attr_reader :client
 
-      def self.setup(flipper = nil)
-        return @flipper = flipper unless flipper.nil?
-
-        @flipper = ::Flipper
-
-        ::Flipper.configure do |config|
-          config.default do
-            adapter = ::Flipper::Adapters::ActiveRecord.new
-            ::Flipper.new(adapter)
-          end
-        end
+      def initialize(client: nil)
+        @client = client || default_flipper_adapter
       end
 
-      def self.present?(flag_name)
-        flipper[flag_name].exist?
+      def present?(flag_name)
+        client[flag_name].exist?
       end
 
-      def self.on?(flag_name, context: nil, data: {})
-        return unless present?(flag_name)
-
-        flipper[flag_name].enabled?(*[context].compact)
+      def control?(flag_name, **kwargs)
+        !present?(flag_name)
       end
 
-      def self.off?(flag_name, context: nil, data: {})
-        on_result = on?(flag_name, context: context)
-
-        return if on_result.nil?
-
-        !on_result
+      def on?(flag_name, context: nil, data: {})
+        client[flag_name].enabled?(*[context].compact)
       end
 
-      def self.on!(flag_name, context: nil, data: {})
-        flipper[flag_name].enable(*[context].compact)
+      def off?(flag_name, context: nil, data: {})
+        !on?(flag_name, context: context)
       end
 
-      def self.off!(flag_name, context: nil, data: {})
-        flipper[flag_name].disable(*[context].compact)
-      end
+      private
 
-      def self.flipper
-        @flipper
+      def default_flipper_adapter
+        ::Flipper.configure do |config|
+          config.default do
+            adapter = ::Flipper::Adapters::ActiveRecord.new
+            ::Flipper.new(adapter)
+          end
+        end
+        ::Flipper
       end
     end
   end

data/lib/this_feature/adapters/memory.rb

@@ -2,20 +2,19 @@ class ThisFeature
   module Adapters
     class Memory < Base
 
-      def self.setup(context_id_method: :id)
-        @context_id_method = context_id_method
+      def initialize(context_key_method: nil)
+        @context_key_method = context_key_method
       end
 
-      def self.clear
+      def clear
         storage.clear
       end
 
-      def self.present?(flag_name)
+      def present?(flag_name)
         !storage[flag_name].nil?
       end
 
-      def self.on?(flag_name, context: nil, data: {})
-        # binding.pry
+      def on?(flag_name, context: nil, data: {})
         return unless present?(flag_name)
 
         flag_data = storage[flag_name]
@@ -25,10 +24,10 @@ class ThisFeature
 
         flag_data[:contexts] ||= {}
 
-        !!flag_data[:contexts][context.send(@context_id_method)]
+        !!flag_data[:contexts][context_key(context)]
       end
 
-      def self.off?(flag_name, context: nil, data: {})
+      def off?(flag_name, context: nil, data: {})
         on_result = on?(flag_name, context: context)
 
         return if on_result.nil?
@@ -36,27 +35,37 @@ class ThisFeature
         !on_result
       end
 
-      def self.on!(flag_name, context: nil, data: {})
+      def on!(flag_name, context: nil, data: {})
         storage[flag_name] ||= {}
 
         return storage[flag_name][:global] = true if context.nil?
 
         storage[flag_name][:contexts] ||= {}
-        storage[flag_name][:contexts][context.send(@context_id_method)] = true
+        storage[flag_name][:contexts][context_key(context)] = true
       end
 
-      def self.off!(flag_name, context: nil, data: {})
+      def off!(flag_name, context: nil, data: {})
         storage[flag_name] ||= {}
 
         return storage[flag_name][:global] = false if context.nil?
 
         storage[flag_name][:contexts] ||= {}
-        storage[flag_name][:contexts][context.send(@context_id_method)] = false
+        storage[flag_name][:contexts][context_key(context)] = false
       end
 
-      def self.storage
+      def storage
         @storage ||= {}
       end
+
+      private
+
+      attr_reader :context_key_method
+
+      def context_key(context)
+        return context if context_key_method.nil?
+
+        context.send(context_key_method)
+      end
     end
   end
 end

data/lib/this_feature/adapters/split_io.rb

@@ -0,0 +1,52 @@
+require 'splitclient-rb'
+
+class ThisFeature
+  module Adapters
+    class SplitIo < Base
+      # used as treatment key when none is given, it's required by split
+      UNDEFINED_KEY = 'undefined_key'
+
+      def initialize(client: nil)
+        @client = client || default_split_client
+
+        @client.block_until_ready
+      end
+
+      def present?(flag_name)
+        !control?(flag_name)
+      end
+
+      def control?(flag_name, context: UNDEFINED_KEY, data: {})
+        treatment(flag_name, context: context, data: data).include?('control')
+      end
+
+      def on?(flag_name, context: UNDEFINED_KEY, data: {})
+        treatment(flag_name, context: context, data: data).eql?('on')
+      end
+
+      def off?(flag_name, context: UNDEFINED_KEY, data: {})
+        treatment(flag_name, context: context, data: data).eql?('off')
+      end
+
+      private
+
+      attr_reader :client
+
+      def treatment(flag_name, context: UNDEFINED_KEY, data: {})
+        key = if context.nil?
+          UNDEFINED_KEY
+        elsif context.respond_to?(:to_s)
+          context.to_s
+        else
+          context
+        end
+
+        client.get_treatment(key, flag_name, data)
+      end
+
+      def default_split_client
+        SplitIoClient::SplitFactory.new(ENV.fetch('SPLIT_IO_AUTH_KEY')).client
+      end
+    end
+  end
+end

data/lib/this_feature/configuration.rb

@@ -1,17 +1,16 @@
-
 class ThisFeature
   class Configuration
-    attr_writer :adapters, :default_adapter
+    attr_writer :adapters, :default_adapter, :test_adapter
 
     def init
       validate_adapters!
-
-      adapters.each(&:setup)
     end
 
     def validate_adapters!
+      raise(NoAdaptersError.new) unless adapters.any?
+
       adapters.each do |adapter|
-        raise BadAdapterError.new(adapter) unless adapter < Adapters::Base
+        raise BadAdapterError.new(adapter) unless adapter.class < Adapters::Base
       end
     end
 
@@ -22,5 +21,9 @@ class ThisFeature
     def default_adapter
       @default_adapter ||= adapters.first
     end
+
+    def test_adapter
+      @test_adapter ||= Adapters::Memory.new
+    end
   end
 end

data/lib/this_feature/errors.rb

@@ -3,20 +3,20 @@ class ThisFeature
   class Error < StandardError; end
 
   class UnimplementedError < Error
-    def initialize(klass, fn_name)
-      super("class #{klass.name} doesnt implement method .#{fn_name}")
+    def initialize(adapter_instance, fn_name)
+      super("class #{adapter_instance.class.name} doesnt implement method .#{fn_name}")
     end
   end
 
   class BadAdapterError < Error
-    def initialize(adapter)
-      super("adapter #{adapter.name} doesn't inherit from ThisFeature::Adapters::Base")
+    def initialize(adapter_instance)
+      super("adapter #{adapter_instance.class.name} doesn't inherit from #{ThisFeature::Adapters::Base.name}")
     end
   end
 
-  class NoWriteAdapter < Error
+  class NoAdaptersError < Error
     def initialize
-      super("Use the `ThisFeature.write_adapter=` setter before calling #enable or #disable")
+      super("No adapters configured.")
     end
   end
 

data/lib/this_feature/flag.rb

@@ -20,13 +20,5 @@ class ThisFeature
     def control?
       adapter.control?(flag_name, context: context, data: data)
     end
-
-    def on!
-      adapter.on!(flag_name, context: context, data: data)
-    end
-
-    def off!
-      adapter.off!(flag_name, context: context, data: data)
-    end
   end
 end

data/lib/this_feature/version.rb

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = "0.3.0"
+  VERSION = "0.5.2"
 end

data/this_feature-adapters-flipper.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.platform      = Gem::Platform::RUBY
   s.require_paths = ['lib']
 
+  s.add_runtime_dependency "this_feature"
   s.add_runtime_dependency "flipper", "~> 0.16"
   s.add_runtime_dependency "flipper-active_record", "~> 0.16"
 end

data/this_feature-adapters-split_io.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'this_feature/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'this_feature-adapters-split_io'
+  s.version       = ThisFeature::VERSION
+  s.authors       = ['Max Pleaner', 'Matt Fong']
+  s.email         = ['maxpleaner@gmail.com', 'matthewjf@gmail.com']
+  s.homepage      = 'http://hover.to'
+  s.licenses      = ['MIT']
+  s.summary       = '[summary]'
+  s.description   = '[description]'
+
+  s.files         = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
+  s.platform      = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency "this_feature"
+  s.add_runtime_dependency "splitclient-rb"
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: this_feature-adapters-flipper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Max Pleaner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: this_feature
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: flipper
   requirement: !ruby/object:Gem::Requirement
@@ -58,18 +72,20 @@ files:
 - lib/this_feature/adapters/base.rb
 - lib/this_feature/adapters/flipper.rb
 - lib/this_feature/adapters/memory.rb
+- lib/this_feature/adapters/split_io.rb
 - lib/this_feature/configuration.rb
 - lib/this_feature/errors.rb
 - lib/this_feature/flag.rb
 - lib/this_feature/version.rb
 - memory
 - this_feature-adapters-flipper.gemspec
+- this_feature-adapters-split_io.gemspec
 - this_feature.gemspec
 homepage: http://hover.to
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: "[summary]"
 test_files: []