flipper 0.28.2 → 1.0.0.pre

data/spec/flipper/dsl_spec.rb

@@ -123,18 +123,6 @@ RSpec.describe Flipper::DSL do
     end
   end
 
-  describe '#boolean' do
-    it_should_behave_like 'a DSL boolean method' do
-      let(:method_name) { :boolean }
-    end
-  end
-
-  describe '#bool' do
-    it_should_behave_like 'a DSL boolean method' do
-      let(:method_name) { :bool }
-    end
-  end
-
   describe '#group' do
     context 'for registered group' do
       before do
@@ -148,69 +136,6 @@ RSpec.describe Flipper::DSL do
     end
   end
 
-  describe '#actor' do
-    context 'for an actor' do
-      it 'returns actor instance' do
-        actor = Flipper::Actor.new(33)
-        flipper_actor = subject.actor(actor)
-        expect(flipper_actor).to be_instance_of(Flipper::Types::Actor)
-        expect(flipper_actor.value).to eq('33')
-      end
-    end
-
-    context 'for nil' do
-      it 'raises argument error' do
-        expect do
-          subject.actor(nil)
-        end.to raise_error(ArgumentError)
-      end
-    end
-
-    context 'for something that is not actor wrappable' do
-      it 'raises argument error' do
-        expect do
-          subject.actor(Object.new)
-        end.to raise_error(ArgumentError)
-      end
-    end
-  end
-
-  describe '#time' do
-    before do
-      @result = subject.time(5)
-    end
-
-    it 'returns percentage of time' do
-      expect(@result).to be_instance_of(Flipper::Types::PercentageOfTime)
-    end
-
-    it 'sets value' do
-      expect(@result.value).to eq(5)
-    end
-
-    it 'is aliased to percentage_of_time' do
-      expect(@result).to eq(subject.percentage_of_time(@result.value))
-    end
-  end
-
-  describe '#actors' do
-    before do
-      @result = subject.actors(17)
-    end
-
-    it 'returns percentage of actors' do
-      expect(@result).to be_instance_of(Flipper::Types::PercentageOfActors)
-    end
-
-    it 'sets value' do
-      expect(@result.value).to eq(17)
-    end
-
-    it 'is aliased to percentage_of_actors' do
-      expect(@result).to eq(subject.percentage_of_actors(@result.value))
-    end
-  end
-
   describe '#features' do
     context 'with no features enabled/disabled' do
       it 'defaults to empty set' do

data/spec/flipper/engine_spec.rb

@@ -0,0 +1,190 @@
+require 'rails'
+require 'flipper/engine'
+
+RSpec.describe Flipper::Engine do
+  let(:application) do
+    Class.new(Rails::Application) do
+      config.eager_load = false
+      config.logger = ActiveSupport::Logger.new($stdout)
+    end
+  end
+
+  before do
+    Rails.application = nil
+    ActiveSupport::Dependencies.autoload_paths = ActiveSupport::Dependencies.autoload_paths.dup
+    ActiveSupport::Dependencies.autoload_once_paths = ActiveSupport::Dependencies.autoload_once_paths.dup
+  end
+
+  let(:config) { application.config.flipper }
+
+  subject { application.initialize! }
+
+  context 'cloudless' do
+    it 'can set env_key from ENV' do
+      with_env 'FLIPPER_ENV_KEY' => 'flopper' do
+        subject
+        expect(config.env_key).to eq('flopper')
+      end
+    end
+
+    it 'can set memoize from ENV' do
+      with_env 'FLIPPER_MEMOIZE' => 'false' do
+        subject
+        expect(config.memoize).to eq(false)
+      end
+    end
+
+    it 'can set preload from ENV' do
+      with_env 'FLIPPER_PRELOAD' => 'false' do
+        subject
+        expect(config.preload).to eq(false)
+      end
+    end
+
+    it 'can set instrumenter from ENV' do
+      stub_const('My::Cool::Instrumenter', Class.new)
+      with_env 'FLIPPER_INSTRUMENTER' => 'My::Cool::Instrumenter' do
+        subject
+        expect(config.instrumenter).to eq(My::Cool::Instrumenter)
+      end
+    end
+
+    it 'can set log from ENV' do
+      with_env 'FLIPPER_LOG' => 'false' do
+        subject
+        expect(config.log).to eq(false)
+      end
+    end
+
+    it 'sets defaults' do
+      subject # initialize
+      expect(config.env_key).to eq("flipper")
+      expect(config.memoize).to be(true)
+      expect(config.preload).to be(true)
+    end
+
+    it "configures instrumentor on default instance" do
+      subject # initialize
+      expect(Flipper.instance.instrumenter).to eq(ActiveSupport::Notifications)
+    end
+
+    it 'uses Memoizer middleware if config.memoize = true' do
+      initializer { config.memoize = true }
+      expect(subject.middleware).to include(Flipper::Middleware::Memoizer)
+    end
+
+    it 'does not use Memoizer middleware if config.memoize = false' do
+      initializer { config.memoize = false }
+      expect(subject.middleware).not_to include(Flipper::Middleware::Memoizer)
+    end
+
+    it 'passes config to memoizer' do
+      initializer do
+        config.update(
+          env_key: 'my_flipper',
+          preload: [:stats, :search]
+        )
+      end
+
+      expect(subject.middleware).to include(Flipper::Middleware::Memoizer)
+      middleware = subject.middleware.detect { |m| m.klass == Flipper::Middleware::Memoizer }
+      expect(middleware.args[0]).to eq({
+        env_key: config.env_key,
+        preload: config.preload,
+        if: nil
+      })
+    end
+
+    it "defines #flipper_id on AR::Base" do
+      subject
+      require 'active_record'
+      expect(ActiveRecord::Base.ancestors).to include(Flipper::Identifier)
+    end
+  end
+
+  context 'with cloud' do
+    around do |example|
+      with_env "FLIPPER_CLOUD_TOKEN" => "test-token" do
+        example.run
+      end
+    end
+
+    # App for Rack::Test
+    let(:app) { application.routes }
+
+    it "initializes cloud configuration" do
+      stub_request(:get, /flippercloud\.io/).to_return(status: 200, body: "{}")
+
+      application.initialize!
+
+      expect(Flipper.instance).to be_a(Flipper::Cloud::DSL)
+      expect(Flipper.instance.instrumenter).to be(ActiveSupport::Notifications)
+    end
+
+    context "with CLOUD_SYNC_SECRET" do
+      around do |example|
+        with_env "FLIPPER_CLOUD_SYNC_SECRET" => "test-secret" do
+          example.run
+        end
+      end
+
+      let(:request_body) do
+        JSON.generate({
+          "environment_id" => 1,
+          "webhook_id" => 1,
+          "delivery_id" => SecureRandom.uuid,
+          "action" => "sync",
+        })
+      end
+      let(:timestamp) { Time.now }
+
+      let(:signature) {
+        Flipper::Cloud::MessageVerifier.new(secret: ENV["FLIPPER_CLOUD_SYNC_SECRET"]).generate(request_body, timestamp)
+      }
+      let(:signature_header_value) {
+        Flipper::Cloud::MessageVerifier.new(secret: "").header(signature, timestamp)
+      }
+
+      it "configures webhook app" do
+        application.initialize!
+
+        stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").with({
+          headers: { "Flipper-Cloud-Token" => ENV["FLIPPER_CLOUD_TOKEN"] },
+        }).to_return(status: 200, body: JSON.generate({ features: {} }), headers: {})
+
+        post "/_flipper", request_body, { "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value }
+
+        expect(last_response.status).to eq(200)
+        expect(stub).to have_been_requested
+      end
+    end
+
+    context "without CLOUD_SYNC_SECRET" do
+      it "does not configure webhook app" do
+        application.initialize!
+
+        post "/_flipper"
+        expect(last_response.status).to eq(404)
+      end
+    end
+
+    context "without FLIPPER_CLOUD_TOKEN" do
+      it "gracefully skips configuring webhook app" do
+        with_env "FLIPPER_CLOUD_TOKEN" => nil do
+          application.initialize!
+          expect(Flipper.instance).to be_a(Flipper::DSL)
+        end
+
+        post "/_flipper"
+        expect(last_response.status).to eq(404)
+      end
+    end
+  end
+
+  # Add app initializer in the same order as config/initializers/*
+  def initializer(&block)
+    application.initializer 'spec', before: :load_config_initializers do
+      block.call
+    end
+  end
+end

data/spec/flipper_integration_spec.rb

@@ -24,8 +24,8 @@ RSpec.describe Flipper do
   let(:pitt)        { Flipper::Actor.new(1) }
   let(:clooney)     { Flipper::Actor.new(10) }
 
-  let(:five_percent_of_actors) { flipper.actors(5) }
-  let(:five_percent_of_time) { flipper.time(5) }
+  let(:five_percent_of_actors) { Flipper::Types::PercentageOfActors.new(5) }
+  let(:five_percent_of_time) { Flipper::Types::PercentageOfTime.new(5) }
 
   before do
     described_class.register(:admins, &:admin?)
@@ -69,11 +69,11 @@ RSpec.describe Flipper do
       end
 
       it 'enables feature for flipper actor in group' do
-        expect(feature.enabled?(flipper.actor(admin_actor))).to eq(true)
+        expect(feature.enabled?(Flipper::Types::Actor.new(admin_actor))).to eq(true)
       end
 
       it 'does not enable for flipper actor not in group' do
-        expect(feature.enabled?(flipper.actor(dev_actor))).to eq(false)
+        expect(feature.enabled?(Flipper::Types::Actor.new(dev_actor))).to eq(false)
       end
 
       it 'does not enable feature for all' do
@@ -256,11 +256,11 @@ RSpec.describe Flipper do
       end
 
       it 'disables feature for flipper actor in group' do
-        expect(feature.enabled?(flipper.actor(admin_actor))).to eq(false)
+        expect(feature.enabled?(Flipper::Types::Actor.new(admin_actor))).to eq(false)
       end
 
       it 'does not disable feature for flipper actor in other groups' do
-        expect(feature.enabled?(flipper.actor(dev_actor))).to eq(true)
+        expect(feature.enabled?(Flipper::Types::Actor.new(dev_actor))).to eq(true)
       end
 
       it 'adds feature to set of features' do
@@ -294,7 +294,7 @@ RSpec.describe Flipper do
 
     context 'with a percentage of actors' do
       before do
-        @result = feature.disable(flipper.actors(0))
+        @result = feature.disable(Flipper::Types::PercentageOfActors.new(0))
       end
 
       it 'returns true' do
@@ -318,7 +318,7 @@ RSpec.describe Flipper do
     context 'with a percentage of time' do
       before do
         @gate = feature.gate(:percentage_of_time)
-        @result = feature.disable(flipper.time(0))
+        @result = feature.disable(Flipper::Types::PercentageOfTime.new(0))
       end
 
       it 'returns true' do
@@ -373,12 +373,12 @@ RSpec.describe Flipper do
       end
 
       it 'returns true' do
-        expect(feature.enabled?(flipper.actor(admin_actor))).to eq(true)
+        expect(feature.enabled?(Flipper::Types::Actor.new(admin_actor))).to eq(true)
         expect(feature.enabled?(admin_actor)).to eq(true)
       end
 
       it 'returns true for truthy block values' do
-        expect(feature.enabled?(flipper.actor(admin_truthy_actor))).to eq(true)
+        expect(feature.enabled?(Flipper::Types::Actor.new(admin_truthy_actor))).to eq(true)
       end
 
       it 'returns true if any actor is in enabled group' do
@@ -388,12 +388,12 @@ RSpec.describe Flipper do
 
     context 'for actor in disabled group' do
       it 'returns false' do
-        expect(feature.enabled?(flipper.actor(dev_actor))).to eq(false)
+        expect(feature.enabled?(Flipper::Types::Actor.new(dev_actor))).to eq(false)
         expect(feature.enabled?(dev_actor)).to eq(false)
       end
 
       it 'returns false for falsey block values' do
-        expect(feature.enabled?(flipper.actor(admin_falsey_actor))).to eq(false)
+        expect(feature.enabled?(Flipper::Types::Actor.new(admin_falsey_actor))).to eq(false)
       end
     end
 

data/spec/flipper_spec.rb

@@ -88,14 +88,6 @@ RSpec.describe Flipper do
       expect(described_class.instance.enabled?(:search)).to be(false)
     end
 
-    it 'delegates bool to instance' do
-      expect(described_class.bool).to eq(described_class.instance.bool)
-    end
-
-    it 'delegates boolean to instance' do
-      expect(described_class.boolean).to eq(described_class.instance.boolean)
-    end
-
     it 'delegates enable_actor to instance' do
       described_class.enable_actor(:search, actor)
       expect(described_class.instance.enabled?(:search, actor)).to be(true)
@@ -106,10 +98,6 @@ RSpec.describe Flipper do
       expect(described_class.instance.enabled?(:search, actor)).to be(false)
     end
 
-    it 'delegates actor to instance' do
-      expect(described_class.actor(actor)).to eq(described_class.instance.actor(actor))
-    end
-
     it 'delegates enable_group to instance' do
       described_class.enable_group(:search, group)
       expect(described_class.instance[:search].enabled_groups).to include(group)
@@ -130,15 +118,6 @@ RSpec.describe Flipper do
       expect(described_class.instance[:search].percentage_of_actors_value).to be(0)
     end
 
-    it 'delegates actors to instance' do
-      expect(described_class.actors(5)).to eq(described_class.instance.actors(5))
-    end
-
-    it 'delegates percentage_of_actors to instance' do
-      expected = described_class.instance.percentage_of_actors(5)
-      expect(described_class.percentage_of_actors(5)).to eq(expected)
-    end
-
     it 'delegates enable_percentage_of_time to instance' do
       described_class.enable_percentage_of_time(:search, 5)
       expect(described_class.instance[:search].percentage_of_time_value).to be(5)
@@ -149,15 +128,6 @@ RSpec.describe Flipper do
       expect(described_class.instance[:search].percentage_of_time_value).to be(0)
     end
 
-    it 'delegates time to instance' do
-      expect(described_class.time(56)).to eq(described_class.instance.time(56))
-    end
-
-    it 'delegates percentage_of_time to instance' do
-      expected = described_class.instance.percentage_of_time(56)
-      expect(described_class.percentage_of_time(56)).to eq(expected)
-    end
-
     it 'delegates features to instance' do
       described_class.instance.add(:search)
       expect(described_class.features).to eq(described_class.instance.features)

data/spec/spec_helper.rb

@@ -91,15 +91,3 @@ RSpec.shared_examples_for 'a DSL feature' do
     end.to raise_error(ArgumentError, /must be a String or Symbol/)
   end
 end
-
-RSpec.shared_examples_for 'a DSL boolean method' do
-  it 'returns boolean with value set' do
-    result = subject.send(method_name, true)
-    expect(result).to be_instance_of(Flipper::Types::Boolean)
-    expect(result.value).to be(true)
-
-    result = subject.send(method_name, false)
-    expect(result).to be_instance_of(Flipper::Types::Boolean)
-    expect(result.value).to be(false)
-  end
-end

data/spec/support/climate_control.rb

@@ -0,0 +1,7 @@
+require 'climate_control'
+
+RSpec.configure do |config|
+  def with_env(options = {}, &block)
+    ClimateControl.modify(options, &block)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.28.2
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,9 +24,22 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: brow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 description:
-email:
-- nunemaker@gmail.com
+email: support@flippercloud.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -53,10 +66,17 @@ files:
 - docs/DockerCompose.md
 - docs/README.md
 - docs/images/banner.jpg
+- docs/images/flipper_cloud.png
 - examples/api/basic.ru
 - examples/api/custom_memoized.ru
 - examples/api/memoized.ru
 - examples/basic.rb
+- examples/cloud/app.ru
+- examples/cloud/basic.rb
+- examples/cloud/cloud_setup.rb
+- examples/cloud/forked.rb
+- examples/cloud/import.rb
+- examples/cloud/threaded.rb
 - examples/configuring_default.rb
 - examples/dsl.rb
 - examples/enabled_for_actor.rb
@@ -73,6 +93,7 @@ files:
 - examples/percentage_of_actors_enabled_check.rb
 - examples/percentage_of_actors_group.rb
 - examples/percentage_of_time.rb
+- flipper-cloud.gemspec
 - flipper.gemspec
 - lib/flipper.rb
 - lib/flipper/actor.rb
@@ -95,8 +116,16 @@ files:
 - lib/flipper/adapters/sync/feature_synchronizer.rb
 - lib/flipper/adapters/sync/interval_synchronizer.rb
 - lib/flipper/adapters/sync/synchronizer.rb
+- lib/flipper/cloud.rb
+- lib/flipper/cloud/configuration.rb
+- lib/flipper/cloud/dsl.rb
+- lib/flipper/cloud/instrumenter.rb
+- lib/flipper/cloud/message_verifier.rb
+- lib/flipper/cloud/middleware.rb
+- lib/flipper/cloud/routes.rb
 - lib/flipper/configuration.rb
 - lib/flipper/dsl.rb
+- lib/flipper/engine.rb
 - lib/flipper/errors.rb
 - lib/flipper/export.rb
 - lib/flipper/exporter.rb
@@ -122,7 +151,6 @@ files:
 - lib/flipper/middleware/memoizer.rb
 - lib/flipper/middleware/setup_env.rb
 - lib/flipper/poller.rb
-- lib/flipper/railtie.rb
 - lib/flipper/registry.rb
 - lib/flipper/spec/shared_adapter_specs.rb
 - lib/flipper/test/shared_adapter_test.rb
@@ -153,8 +181,14 @@ files:
 - spec/flipper/adapters/sync/interval_synchronizer_spec.rb
 - spec/flipper/adapters/sync/synchronizer_spec.rb
 - spec/flipper/adapters/sync_spec.rb
+- spec/flipper/cloud/configuration_spec.rb
+- spec/flipper/cloud/dsl_spec.rb
+- spec/flipper/cloud/message_verifier_spec.rb
+- spec/flipper/cloud/middleware_spec.rb
+- spec/flipper/cloud_spec.rb
 - spec/flipper/configuration_spec.rb
 - spec/flipper/dsl_spec.rb
+- spec/flipper/engine_spec.rb
 - spec/flipper/export_spec.rb
 - spec/flipper/exporter_spec.rb
 - spec/flipper/exporters/json/export_spec.rb
@@ -176,7 +210,6 @@ files:
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
 - spec/flipper/poller_spec.rb
-- spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
 - spec/flipper/types/actor_spec.rb
@@ -188,6 +221,7 @@ files:
 - spec/flipper_integration_spec.rb
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
+- spec/support/climate_control.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb
@@ -196,10 +230,14 @@ files:
 - test/adapters/pstore_test.rb
 - test/test_helper.rb
 - test_rails/helper.rb
-homepage: https://github.com/jnunemaker/flipper
+homepage: https://www.flippercloud.io/docs
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://www.flippercloud.io/docs
+  homepage_uri: https://www.flippercloud.io
+  source_code_uri: https://github.com/jnunemaker/flipper
+  bug_tracker_uri: https://github.com/jnunemaker/flipper/issues
   changelog_uri: https://github.com/jnunemaker/flipper/blob/main/Changelog.md
 post_install_message:
 rdoc_options: []
@@ -212,9 +250,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key:
@@ -239,8 +277,14 @@ test_files:
 - spec/flipper/adapters/sync/interval_synchronizer_spec.rb
 - spec/flipper/adapters/sync/synchronizer_spec.rb
 - spec/flipper/adapters/sync_spec.rb
+- spec/flipper/cloud/configuration_spec.rb
+- spec/flipper/cloud/dsl_spec.rb
+- spec/flipper/cloud/message_verifier_spec.rb
+- spec/flipper/cloud/middleware_spec.rb
+- spec/flipper/cloud_spec.rb
 - spec/flipper/configuration_spec.rb
 - spec/flipper/dsl_spec.rb
+- spec/flipper/engine_spec.rb
 - spec/flipper/export_spec.rb
 - spec/flipper/exporter_spec.rb
 - spec/flipper/exporters/json/export_spec.rb
@@ -262,7 +306,6 @@ test_files:
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
 - spec/flipper/poller_spec.rb
-- spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
 - spec/flipper/types/actor_spec.rb
@@ -274,6 +317,7 @@ test_files:
 - spec/flipper_integration_spec.rb
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
+- spec/support/climate_control.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb