flipper 0.22.0 → 0.28.0

data/docker-compose.yml

@@ -1,34 +1,37 @@
-# postgres:
-#   container_name: flipper_postgres
-#   image: postgres:9.4
-redis:
-  container_name: flipper_redis
-  image: redis:2.8
-mongo:
-  container_name: flipper_mongo
-  image: mongo:3.3
-memcached:
-  container_name: flipper_memcached
-  image: memcached:1.4.33
-app:
-  container_name: flipper_app
-  build: .
-  dockerfile: Dockerfile
-  volumes:
-    - .:/srv/app
-  volumes_from:
-    - bundle_cache
-  links:
-    # - postgres
-    - redis
-    - mongo
-    - memcached
-  environment:
-    - REDIS_URL=redis://redis:6379
-    - MONGODB_HOST=mongo
-    - MEMCACHED_URL=memcached:11211
-bundle_cache:
-  container_name: flipper_bundle_cache
-  image: busybox
-  volumes:
-    - /bundle_cache
+version: "2.4"
+services:
+  # postgres:
+  #   container_name: flipper_postgres
+  #   image: postgres:9.4
+  redis:
+    container_name: flipper_redis
+    image: redis:6.2.5
+  mongo:
+    container_name: flipper_mongo
+    image: mongo:4.4.8
+  memcached:
+    container_name: flipper_memcached
+    image: memcached:1.4.33
+  app:
+    container_name: flipper_app
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/srv/app
+    volumes_from:
+      - bundle_cache
+    links:
+      # - postgres
+      - redis
+      - mongo
+      - memcached
+    environment:
+      - REDIS_URL=redis://redis:6379
+      - MONGODB_HOST=mongo
+      - MEMCACHED_URL=memcached:11211
+  bundle_cache:
+    container_name: flipper_bundle_cache
+    image: busybox
+    volumes:
+      - /bundle_cache

data/docs/README.md

@@ -0,0 +1 @@
+See [flippercloud.io](https://flippercloud.io/docs) for extensive docs.

data/examples/api/basic.ru

@@ -1,19 +1,18 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/basic.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/basic.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/api"
 require "flipper/adapters/pstore"
 
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/custom_memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/custom_memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -31,6 +28,8 @@ ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
 # You can uncomment this to get some default data:
 # flipper[:logging].enable_percentage_of_time 5
 
+use Rack::Reloader
+
 run Flipper::Api.app(flipper) { |builder|
   builder.use Flipper::Middleware::SetupEnv, flipper
   builder.use Flipper::Middleware::Memoizer, preload: true

data/examples/api/memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -38,6 +35,8 @@ Flipper.register(:admins) { |actor|
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app { |builder|
   builder.use Flipper::Middleware::Memoizer, preload: true
 }

data/examples/dsl.rb

@@ -1,7 +1,7 @@
 require 'bundler/setup'
 require 'flipper'
 
-# create a thing with an identifier
+# create an actor with an identifier
 class Person < Struct.new(:id)
   include Flipper::Identifier
 end
@@ -58,8 +58,8 @@ responds_to_flipper_id = Struct.new(:flipper_id).new(10)
 puts Flipper.actor(responds_to_flipper_id).inspect
 
 # get an instance of an actor using an object
-thing = Struct.new(:flipper_id).new(22)
-puts Flipper.actor(thing).inspect
+actor = Struct.new(:flipper_id).new(22)
+puts Flipper.actor(actor).inspect
 
 # register a top level group
 admins = Flipper.register(:admins) { |actor|

data/examples/enabled_for_actor.rb

@@ -31,5 +31,7 @@ Flipper.enable_percentage_of_actors :pro_stats, 50
 Flipper.enable_group :tweets, :admins
 Flipper.enable_actor :posts, user2
 
-pp Flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name)
-pp Flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name)
+pp Flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?(user1, user2) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?([user2, user1]) }.map(&:name).sort

data/examples/instrumentation.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
 require 'securerandom'
+require 'active_support/isolated_execution_state'
 require 'active_support/notifications'
 
 class FlipperSubscriber

data/examples/instrumentation_last_accessed_at.rb

@@ -0,0 +1,38 @@
+# Quick example of how to keep track of when a feature was last checked.
+require 'bundler/setup'
+require 'securerandom'
+require 'active_support/isolated_execution_state'
+require 'active_support/notifications'
+require 'flipper'
+
+class FlipperSubscriber
+  def self.stats
+    @stats ||= {}
+  end
+
+  def call(name, start, finish, id, payload)
+    if payload[:operation] == :enabled?
+      feature_name = payload.fetch(:feature_name)
+      self.class.stats[feature_name] = Time.now
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe(/feature_operation.flipper/, new)
+end
+
+Flipper.configure do |config|
+  config.default {
+    Flipper.new(config.adapter, instrumenter: ActiveSupport::Notifications)
+  }
+end
+
+Flipper.enabled?(:search)
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:hooray)
+
+pp FlipperSubscriber.stats

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!
@@ -28,11 +27,12 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
   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'
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
   gem.metadata      = Flipper::METADATA
+
+  gem.add_dependency 'concurrent-ruby', '< 2'
 end

data/lib/flipper/actor.rb

@@ -12,5 +12,9 @@ module Flipper
       self.class.eql?(other.class) && @flipper_id == other.flipper_id
     end
     alias_method :==, :eql?
+
+    def hash
+      flipper_id.hash
+    end
   end
 end

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
@@ -20,6 +16,11 @@ module Flipper
           percentage_of_time: nil,
         }
       end
+
+      def from(source)
+        return source if source.is_a?(Flipper::Adapter)
+        source.adapter
+      end
     end
 
     # Public: Get all features and gate values in one call. Defaults to one call
@@ -43,9 +44,19 @@ 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.
@@ -54,3 +65,8 @@ module Flipper
     end
   end
 end
+
+require "set"
+require "flipper/exporter"
+require "flipper/feature"
+require "flipper/adapters/sync/synchronizer"

data/lib/flipper/adapters/dual_write.rb

@@ -4,7 +4,7 @@ module Flipper
       include ::Flipper::Adapter
 
       # Public: The name of the adapter.
-      attr_reader :name
+      attr_reader :name, :local, :remote
 
       # Public: Build a new sync instance.
       #
@@ -34,33 +34,27 @@ module Flipper
       end
 
       def add(feature)
-        result = @remote.add(feature)
-        @local.add(feature)
-        result
+        @remote.add(feature).tap { @local.add(feature) }
       end
 
       def remove(feature)
-        result = @remote.remove(feature)
-        @local.remove(feature)
-        result
+        @remote.remove(feature).tap { @local.remove(feature) }
       end
 
       def clear(feature)
-        result = @remote.clear(feature)
-        @local.clear(feature)
-        result
+        @remote.clear(feature).tap { @local.clear(feature) }
       end
 
       def enable(feature, gate, thing)
-        result = @remote.enable(feature, gate, thing)
-        @local.enable(feature, gate, thing)
-        result
+        @remote.enable(feature, gate, thing).tap do
+          @local.enable(feature, gate, thing)
+        end
       end
 
       def disable(feature, gate, thing)
-        result = @remote.disable(feature, gate, thing)
-        @local.disable(feature, gate, thing)
-        result
+        @remote.disable(feature, gate, thing).tap do
+          @local.disable(feature, gate, thing)
+        end
       end
     end
   end

data/lib/flipper/adapters/failover.rb

@@ -0,0 +1,83 @@
+module Flipper
+  module Adapters
+    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.
+      # secondary - The secondary flipper adapter which services reads when
+      #             the primary adapter is unavailable.
+      # options   - Hash of options:
+      #             :dual_write - Boolean, whether to update secondary when
+      #                           primary is updated
+      #             :errors - Array of exception types for which to failover
+
+      def initialize(primary, secondary, options = {})
+        @name = :failover
+        @primary = primary
+        @secondary = secondary
+
+        @dual_write = options.fetch(:dual_write, false)
+        @errors = options.fetch(:errors, [ StandardError ])
+      end
+
+      def features
+        @primary.features
+      rescue *@errors
+        @secondary.features
+      end
+
+      def get(feature)
+        @primary.get(feature)
+      rescue *@errors
+        @secondary.get(feature)
+      end
+
+      def get_multi(features)
+        @primary.get_multi(features)
+      rescue *@errors
+        @secondary.get_multi(features)
+      end
+
+      def get_all
+        @primary.get_all
+      rescue *@errors
+        @secondary.get_all
+      end
+
+      def add(feature)
+        @primary.add(feature).tap do
+          @secondary.add(feature) if @dual_write
+        end
+      end
+
+      def remove(feature)
+        @primary.remove(feature).tap do
+          @secondary.remove(feature) if @dual_write
+        end
+      end
+
+      def clear(feature)
+        @primary.clear(feature).tap do
+          @secondary.clear(feature) if @dual_write
+        end
+      end
+
+      def enable(feature, gate, thing)
+        @primary.enable(feature, gate, thing).tap do
+          @secondary.enable(feature, gate, thing) if @dual_write
+        end
+      end
+
+      def disable(feature, gate, thing)
+        @primary.disable(feature, gate, thing).tap do
+          @secondary.disable(feature, gate, thing) if @dual_write
+        end
+      end
+    end
+  end
+end

data/lib/flipper/adapters/failsafe.rb

@@ -0,0 +1,76 @@
+module Flipper
+  module Adapters
+    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.
+      # options   - Hash of options:
+      #             :errors - Array of exception types for which to fail safe
+
+      def initialize(adapter, options = {})
+        @adapter = adapter
+        @errors = options.fetch(:errors, [StandardError])
+        @name = :failsafe
+      end
+
+      def features
+        @adapter.features
+      rescue *@errors
+        Set.new
+      end
+
+      def add(feature)
+        @adapter.add(feature)
+      rescue *@errors
+        false
+      end
+
+      def remove(feature)
+        @adapter.remove(feature)
+      rescue *@errors
+        false
+      end
+
+      def clear(feature)
+        @adapter.clear(feature)
+      rescue *@errors
+        false
+      end
+
+      def get(feature)
+        @adapter.get(feature)
+      rescue *@errors
+        {}
+      end
+
+      def get_multi(features)
+        @adapter.get_multi(features)
+      rescue *@errors
+        {}
+      end
+
+      def get_all
+        @adapter.get_all
+      rescue *@errors
+        {}
+      end
+
+      def enable(feature, gate, thing)
+        @adapter.enable(feature, gate, thing)
+      rescue *@errors
+        false
+      end
+
+      def disable(feature, gate, thing)
+        @adapter.disable(feature, gate, thing)
+      rescue *@errors
+        false
+      end
+    end
+  end
+end

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

@@ -14,6 +14,10 @@ module Flipper
 
         HTTPS_SCHEME = "https".freeze
 
+        attr_reader :uri, :headers
+        attr_reader :basic_auth_username, :basic_auth_password
+        attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
+
         def initialize(options = {})
           @uri = URI(options.fetch(:url))
           @headers = DEFAULT_HEADERS.merge(options[:headers] || {})
@@ -22,6 +26,7 @@ module Flipper
           @read_timeout = options[:read_timeout]
           @open_timeout = options[:open_timeout]
           @write_timeout = options[:write_timeout]
+          @max_retries = options.key?(:max_retries) ? options[:max_retries] : 0
           @debug_output = options[:debug_output]
         end
 
@@ -58,7 +63,8 @@ module Flipper
           http = Net::HTTP.new(uri.host, uri.port)
           http.read_timeout = @read_timeout if @read_timeout
           http.open_timeout = @open_timeout if @open_timeout
-          apply_write_timeout(http)
+          http.max_retries = @max_retries if @max_retries
+          http.write_timeout = @write_timeout if @write_timeout
           http.set_debug_output(@debug_output) if @debug_output
 
           if uri.scheme == HTTPS_SCHEME
@@ -70,9 +76,19 @@ module Flipper
         end
 
         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,
+          }.merge(headers)
+
           body = options[:body]
           request = http_method.new(uri.request_uri)
-          request.initialize_http_header(headers) if headers
+          request.initialize_http_header(request_headers)
           request.body = body if body
 
           if @basic_auth_username && @basic_auth_password
@@ -81,16 +97,6 @@ module Flipper
 
           request
         end
-
-        def apply_write_timeout(http)
-          if @write_timeout
-            if RUBY_VERSION >= '2.6.0'
-              http.write_timeout = @write_timeout
-            else
-              Kernel.warn("Warning: option :write_timeout requires Ruby version 2.6.0 or later")
-            end
-          end
-        end
       end
     end
   end

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

@@ -1,3 +1,5 @@
+require "json"
+
 module Flipper
   module Adapters
     class Http
@@ -6,7 +8,23 @@ module Flipper
 
         def initialize(response)
           @response = response
-          super("Failed with status: #{response.code}")
+          message = "Failed with status: #{response.code}"
+
+          begin
+            data = JSON.parse(response.body)
+
+            if error_message = data["message"]
+              message << "\n\n#{data["message"]}"
+            end
+
+            if more_info = data["more_info"]
+              message << "\n#{data["more_info"]}"
+            end
+          rescue => exception
+            # welp we tried
+          end
+
+          super(message)
         end
       end
     end

data/lib/flipper/adapters/http.rb

@@ -10,7 +10,7 @@ module Flipper
     class Http
       include Flipper::Adapter
 
-      attr_reader :name
+      attr_reader :name, :client
 
       def initialize(options = {})
         @client = Client.new(url: options.fetch(:url),
@@ -19,6 +19,8 @@ module Flipper
                              basic_auth_password: options[:basic_auth_password],
                              read_timeout: options[:read_timeout],
                              open_timeout: options[:open_timeout],
+                             write_timeout: options[:write_timeout],
+                             max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
         @name = :http
       end
@@ -37,7 +39,7 @@ module Flipper
 
       def get_multi(features)
         csv_keys = features.map(&:key).join(',')
-        response = @client.get("/features?keys=#{csv_keys}")
+        response = @client.get("/features?keys=#{csv_keys}&exclude_gate_names=true")
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
         parsed_response = JSON.parse(response.body)
@@ -55,7 +57,7 @@ module Flipper
       end
 
       def get_all
-        response = @client.get("/features")
+        response = @client.get("/features?exclude_gate_names=true")
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
         parsed_response = JSON.parse(response.body)
@@ -74,7 +76,7 @@ module Flipper
       end
 
       def features
-        response = @client.get('/features')
+        response = @client.get('/features?exclude_gate_names=true')
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
         parsed_response = JSON.parse(response.body)
@@ -121,6 +123,14 @@ module Flipper
         true
       end
 
+      def import(source)
+        adapter = self.class.from(source)
+        export = adapter.export(format: :json, version: 1)
+        response = @client.post("/import", export.contents)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
+      end
+
       private
 
       def request_body_for_gate(gate, value)