flipper 0.26.0 → 1.1.0

data/examples/expressions.rb

@@ -0,0 +1,213 @@
+require 'bundler/setup'
+require 'flipper'
+
+def assert(value)
+  if value
+    p value
+  else
+    puts "Expected true but was #{value}. Please correct."
+    exit 1
+  end
+end
+
+def refute(value)
+  if value
+    puts "Expected false but was #{value}. Please correct."
+    exit 1
+  else
+    p value
+  end
+end
+
+def reset
+  Flipper.disable_expression :something
+end
+
+class User < Struct.new(:id, :flipper_properties)
+  include Flipper::Identifier
+end
+
+class Org < Struct.new(:id, :flipper_properties)
+  include Flipper::Identifier
+end
+
+NOW = Time.now.to_i
+DAY = 60 * 60 * 24
+
+org = Org.new(1, {
+  "type" => "Org",
+  "id" => 1,
+  "now" => NOW,
+})
+
+user = User.new(1, {
+  "type" => "User",
+  "id" => 1,
+  "plan" => "basic",
+  "age" => 39,
+  "team_user" => true,
+  "now" => NOW,
+})
+
+admin_user = User.new(2, {
+  "type" => "User",
+  "id" => 2,
+  "admin" => true,
+  "team_user" => true,
+  "now" => NOW,
+})
+
+other_user = User.new(3, {
+  "type" => "User",
+  "id" => 3,
+  "plan" => "plus",
+  "age" => 18,
+  "org_admin" => true,
+  "now" => NOW - DAY,
+})
+
+age_expression = Flipper.property(:age).gte(21)
+plan_expression = Flipper.property(:plan).eq("basic")
+admin_expression = Flipper.property(:admin).eq(true)
+
+puts "Single Expression"
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling single expression"
+Flipper.enable :something, plan_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling single expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nAny Expression"
+any_expression = Flipper.any(plan_expression, age_expression)
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling any expression"
+Flipper.enable :something, any_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling any expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nAll Expression"
+all_expression = Flipper.all(plan_expression, age_expression)
+refute Flipper.enabled?(:something, user)
+
+puts "Enabling all expression"
+Flipper.enable :something, all_expression
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling all expression"
+reset
+refute Flipper.enabled?(:something, user)
+
+puts "\n\nNested Expression"
+nested_expression = Flipper.any(admin_expression, all_expression)
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Enabling nested expression"
+Flipper.enable :something, nested_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "Disabling nested expression"
+reset
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nBoolean Expression"
+boolean_expression = Flipper.boolean(true)
+Flipper.enable :something, boolean_expression
+assert Flipper.enabled?(:something)
+assert Flipper.enabled?(:something, user)
+reset
+
+puts "\n\nSet of Actors Expression"
+set_of_actors_expression = Flipper.any(
+  Flipper.property(:flipper_id).eq("User;1"),
+  Flipper.property(:flipper_id).eq("User;3"),
+)
+Flipper.enable :something, set_of_actors_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, other_user)
+refute Flipper.enabled?(:something, admin_user)
+reset
+
+puts "\n\n% of Actors Expression"
+percentage_of_actors = Flipper.property(:flipper_id).percentage_of_actors(30)
+Flipper.enable :something, percentage_of_actors
+refute Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, other_user)
+assert Flipper.enabled?(:something, admin_user)
+reset
+
+puts "\n\n% of Actors Per Type Expression"
+percentage_of_actors_per_type = Flipper.any(
+  Flipper.all(
+    Flipper.property(:type).eq("User"),
+    Flipper.property(:flipper_id).percentage_of_actors(40),
+  ),
+  Flipper.all(
+    Flipper.property(:type).eq("Org"),
+    Flipper.property(:flipper_id).percentage_of_actors(10),
+  )
+)
+Flipper.enable :something, percentage_of_actors_per_type
+refute Flipper.enabled?(:something, user) # not in the 40% enabled for Users
+assert Flipper.enabled?(:something, other_user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, org) # not in the 10% of enabled for Orgs
+reset
+
+puts "\n\nPercentage of Time Expression"
+percentage_of_time_expression = Flipper.random(100).lt(50)
+Flipper.enable :something, percentage_of_time_expression
+results = (1..10000).map { |n| Flipper.enabled?(:something, user) }
+enabled, disabled = results.partition { |r| r }
+p enabled: enabled.size
+p disabled: disabled.size
+assert (4_700..5_200).include?(enabled.size)
+assert (4_700..5_200).include?(disabled.size)
+reset
+
+puts "\n\nChanging single expression to all expression"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).all.add(age_expression)
+assert Flipper.enabled?(:something, user)
+refute Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nChanging single expression to any expression"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).any.add(age_expression, admin_expression)
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nChanging single expression to any expression by adding to condition"
+Flipper.enable :something, plan_expression
+Flipper.enable :something, Flipper.expression(:something).add(admin_expression)
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)
+
+puts "\n\nEnabling based on time"
+scheduled_time_expression = Flipper.property(:now).gte(NOW)
+Flipper.enable :something, scheduled_time_expression
+assert Flipper.enabled?(:something, user)
+assert Flipper.enabled?(:something, admin_user)
+refute Flipper.enabled?(:something, other_user)

data/examples/mirroring.rb

@@ -0,0 +1,59 @@
+require 'bundler/setup'
+require_relative 'active_record/ar_setup'
+require 'flipper'
+require 'flipper/adapters/redis'
+require 'flipper/adapters/active_record'
+
+# Say you have production...
+production_adapter = Flipper::Adapters::Memory.new
+production = Flipper.new(production_adapter)
+
+# And production has some stuff enabled...
+production.enable(:search)
+production.enable_percentage_of_time(:verbose_logging, 5)
+production.enable_percentage_of_actors(:new_feature, 5)
+production.enable_actor(:issues, Flipper::Actor.new('1'))
+production.enable_actor(:issues, Flipper::Actor.new('2'))
+production.enable_group(:request_tracing, :staff)
+
+# And you would like to mirror production to staging...
+staging_adapter = Flipper::Adapters::Memory.new
+staging = Flipper.new(staging_adapter)
+staging_export = staging.export
+
+puts "Here is the state of the world for staging and production..."
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+
+# NOTE: This wipes active record clean and copies features/gates from redis into active record.
+puts "Mirroring production to staging..."
+staging.import(production.export)
+puts "Staging is now identical to Production."
+
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+
+puts "Restoring staging to original state..."
+staging.import(staging_export)
+puts "Staging restored."
+
+puts "Staging"
+staging.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end
+puts "Production"
+production.features.each do |feature|
+  pp feature: feature.key, values: feature.gate_values
+end

data/examples/strict.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'flipper'
+
+adapter = Flipper::Adapters::Strict.new(Flipper::Adapters::Memory.new)
+flipper = Flipper.new(adapter)
+
+begin
+  puts "Checking :unknown_feature, which should raise an error."
+  flipper.enabled?(:unknown_feature)
+  warn "An error was not raised, but should have been"
+  exit 1
+rescue Flipper::Adapters::Strict::NotFound => exception
+  puts "Ok, the exepcted error was raised: #{exception.message}"
+end
+
+puts "Flipper.add(:new_feature)"
+flipper.add(:new_feature)
+puts "Flipper.enabled?(:new_feature) => #{flipper.enabled?(:new_feature)}"

data/flipper-cloud.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+require File.expand_path('../lib/flipper/metadata', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['John Nunemaker']
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = '[DEPRECATED] This gem has been merged into the `flipper` gem'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://www.flippercloud.io'
+
+  gem.files         = [ 'lib/flipper-cloud.rb', 'lib/flipper/version.rb' ]
+  gem.name          = 'flipper-cloud'
+  gem.require_paths = ['lib']
+  gem.version       = Flipper::VERSION
+  gem.metadata      = Flipper::METADATA
+
+  gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+end

data/flipper.gemspec

@@ -13,7 +13,6 @@ end
 
 ignored_files = plugin_files
 ignored_files << Dir['script/*']
-ignored_files << '.travis.yml'
 ignored_files << '.gitignore'
 ignored_files << 'Guardfile'
 ignored_files.flatten!.uniq!
@@ -23,12 +22,11 @@ ignored_test_files.flatten!.uniq!
 
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
-  gem.email         = ['nunemaker@gmail.com']
-  gem.summary       = 'Feature flipper for ANYTHING'
-  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = 'Beautiful, performant feature flags for Ruby.'
+  gem.homepage      = 'https://www.flippercloud.io/docs'
   gem.license       = 'MIT'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files
   gem.name          = 'flipper'

data/lib/flipper/actor.rb

@@ -2,14 +2,17 @@
 # to Flipper::Feature#enabled?.
 module Flipper
   class Actor
-    attr_reader :flipper_id
+    attr_reader :flipper_id, :flipper_properties
 
-    def initialize(flipper_id)
+    def initialize(flipper_id, flipper_properties = {})
       @flipper_id = flipper_id
+      @flipper_properties = flipper_properties
     end
 
     def eql?(other)
-      self.class.eql?(other.class) && @flipper_id == other.flipper_id
+      self.class.eql?(other.class) &&
+        @flipper_id == other.flipper_id &&
+        @flipper_properties == other.flipper_properties
     end
     alias_method :==, :eql?
 

data/lib/flipper/adapter.rb

@@ -1,7 +1,3 @@
-require "set"
-require "flipper/feature"
-require "flipper/adapters/sync/synchronizer"
-
 module Flipper
   # Adding a module include so we have some hooks for stuff down the road
   module Adapter
@@ -16,10 +12,20 @@ module Flipper
           boolean: nil,
           groups: Set.new,
           actors: Set.new,
+          expression: nil,
           percentage_of_actors: nil,
           percentage_of_time: nil,
         }
       end
+
+      def from(source)
+        return source if source.is_a?(Flipper::Adapter)
+        source.adapter
+      end
+    end
+
+    def read_only?
+      false
     end
 
     # Public: Get all features and gate values in one call. Defaults to one call
@@ -43,14 +49,34 @@ module Flipper
 
     # Public: Ensure that adapter is in sync with source adapter provided.
     #
-    # Returns result of Synchronizer#call.
-    def import(source_adapter)
-      Adapters::Sync::Synchronizer.new(self, source_adapter, raise: true).call
+    # source - The source dsl, adapter or export to import.
+    #
+    # Returns true if successful.
+    def import(source)
+      Adapters::Sync::Synchronizer.new(self, self.class.from(source), raise: true).call
+      true
+    end
+
+    # Public: Exports the adapter in a given format for a given format version.
+    #
+    # Returns a Flipper::Export instance.
+    def export(format: :json, version: 1)
+      Flipper::Exporter.build(format: format, version: version).call(self)
     end
 
     # Public: Default config for a feature's gate values.
     def default_config
       self.class.default_config
     end
+
+    # Public: default name of the adapter
+    def name
+      @name ||= self.class.name.split('::').last.split(/(?=[A-Z])/).join('_').downcase.to_sym
+    end
   end
 end
+
+require "set"
+require "flipper/exporter"
+require "flipper/feature"
+require "flipper/adapters/sync/synchronizer"

data/lib/flipper/adapter_builder.rb

@@ -0,0 +1,44 @@
+module Flipper
+  # Builds an adapter from a stack of adapters.
+  #
+  #   adapter = Flipper::AdapterBuilder.new do
+  #     use Flipper::Adapters::Strict
+  #     use Flipper::Adapters::Memoizer
+  #     store Flipper::Adapters::Memory
+  #   end.to_adapter
+  #
+  class AdapterBuilder
+    def initialize(&block)
+      @stack = []
+
+      # Default to memory adapter
+      store Flipper::Adapters::Memory
+
+      block.arity == 0 ? instance_eval(&block) : block.call(self) if block
+    end
+
+    if RUBY_VERSION >= '3.0'
+      def use(klass, *args, **kwargs, &block)
+        @stack.push ->(adapter) { klass.new(adapter, *args, **kwargs, &block) }
+      end
+    else
+      def use(klass, *args, &block)
+        @stack.push ->(adapter) { klass.new(adapter, *args, &block) }
+      end
+    end
+
+    if RUBY_VERSION >= '3.0'
+      def store(adapter, *args, **kwargs, &block)
+        @store = adapter.respond_to?(:call) ? adapter : -> { adapter.new(*args, **kwargs, &block) }
+      end
+    else
+      def store(adapter, *args, &block)
+        @store = adapter.respond_to?(:call) ? adapter : -> { adapter.new(*args, &block) }
+      end
+    end
+
+    def to_adapter
+      @stack.reverse.inject(@store.call) { |adapter, wrapper| wrapper.call(adapter) }
+    end
+  end
+end

data/lib/flipper/adapters/dual_write.rb

@@ -3,8 +3,7 @@ module Flipper
     class DualWrite
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name, :local, :remote
+      attr_reader :local, :remote
 
       # Public: Build a new sync instance.
       #
@@ -12,7 +11,6 @@ module Flipper
       # remote - The remote flipper adapter that writes should go to first (in
       #          addition to the local adapter).
       def initialize(local, remote, options = {})
-        @name = :dual_write
         @local = local
         @remote = remote
       end

data/lib/flipper/adapters/failover.rb

@@ -3,9 +3,6 @@ module Flipper
     class Failover
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new failover instance.
       #
       # primary   - The primary flipper adapter.
@@ -17,7 +14,6 @@ module Flipper
       #             :errors - Array of exception types for which to failover
 
       def initialize(primary, secondary, options = {})
-        @name = :failover
         @primary = primary
         @secondary = secondary
 

data/lib/flipper/adapters/failsafe.rb

@@ -3,9 +3,6 @@ module Flipper
     class Failsafe
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new Failsafe instance.
       #
       # adapter   - Flipper adapter to guard.
@@ -15,7 +12,6 @@ module Flipper
       def initialize(adapter, options = {})
         @adapter = adapter
         @errors = options.fetch(:errors, [StandardError])
-        @name = :failsafe
       end
 
       def features

data/lib/flipper/adapters/http/client.rb

@@ -14,6 +14,12 @@ module Flipper
 
         HTTPS_SCHEME = "https".freeze
 
+        CLIENT_FRAMEWORKS = {
+          rails: -> { Rails.version if defined?(Rails) },
+          sinatra: -> { Sinatra::VERSION if defined?(Sinatra) },
+          hanami: -> { Hanami::VERSION if defined?(Hanami) },
+        }
+
         attr_reader :uri, :headers
         attr_reader :basic_auth_username, :basic_auth_password
         attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
@@ -30,6 +36,10 @@ module Flipper
           @debug_output = options[:debug_output]
         end
 
+        def add_header(key, value)
+          @headers[key] = value
+        end
+
         def get(path)
           perform Net::HTTP::Get, path, @headers
         end
@@ -77,18 +87,23 @@ module Flipper
 
         def build_request(http_method, uri, headers, options)
           request_headers = {
-            "Client-Language" => "ruby",
-            "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
-            "Client-Platform" => RUBY_PLATFORM,
-            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
-            "Client-Pid" => Process.pid.to_s,
-            "Client-Thread" => Thread.current.object_id.to_s,
-            "Client-Hostname" => Socket.gethostname,
+            client_language: "ruby",
+            client_language_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            client_platform: RUBY_PLATFORM,
+            client_engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            client_pid: Process.pid.to_s,
+            client_thread: Thread.current.object_id.to_s,
+            client_hostname: Socket.gethostname,
           }.merge(headers)
 
           body = options[:body]
           request = http_method.new(uri.request_uri)
           request.initialize_http_header(request_headers)
+
+          client_frameworks.each do |framework, version|
+            request.add_field("Client-Framework", [framework, version].join("="))
+          end
+
           request.body = body if body
 
           if @basic_auth_username && @basic_auth_password
@@ -97,6 +112,10 @@ module Flipper
 
           request
         end
+
+        def client_frameworks
+          CLIENT_FRAMEWORKS.transform_values { |detect| detect.call rescue nil }.compact
+        end
       end
     end
   end

data/lib/flipper/adapters/http/error.rb

@@ -11,7 +11,7 @@ module Flipper
           message = "Failed with status: #{response.code}"
 
           begin
-            data = JSON.parse(response.body)
+            data = Typecast.from_json(response.body)
 
             if error_message = data["message"]
               message << "\n\n#{data["message"]}"