flipper-cloud 0.21.0.rc1 → 0.21.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba3c2db9aa7175de2301fb4fea82a25164e935b0f0fe5d7ce38911eee319cf9
-  data.tar.gz: e97f8ec07dcc20057d6934e1cf933be9517d53549317539900630e43a7ffd23e
+  metadata.gz: 6c1f88aaef562296d69c7d601cde538b3494e5356664123e302d96cd951d1cab
+  data.tar.gz: 6be448c6a0c689aa38f831baf8f48cfcf1381c72f6a24541bb196da80ec7f962
 SHA512:
-  metadata.gz: 62d4f0cc6817cfa654e1980156ca7e4d9ba81d1c0bb761f37651455b20f0b4732ceafe1adbf5a30ca09f8c1f8b80b8609c9d61ef969b82be48eedd183e4a5c15
-  data.tar.gz: 4540506c2b1c4eabe0140f3757e0414977ef876454755106bedfffd8159a880ffea37b6bca24bde30e9e6b79259ad86e30afb415219f7a22104c91bcd4edfbe8
+  metadata.gz: f1c48a398d01d7b3efcb50329778520b6a241f06e9aec3ac6bd478148aafaad7a6a6808bef14d9094b1170992372aa4f3c641a1acc5dc37d1f6fd0f6af701b9b
+  data.tar.gz: 7c4b07f27b3daa727ddafe1bc2fa51581fd15fda3f677f1e322ddfe42ad0eed19101e40436906de49d684e2ec238b88d02daa1cbdf508c245813ba93126af788

data/examples/cloud/basic.rb

@@ -2,19 +2,18 @@
 # env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
 require 'bundler/setup'
 require 'flipper/cloud'
-flipper = Flipper::Cloud.new
 
-flipper[:stats].enable
+Flipper[:stats].enable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts 'Enabled!'
 else
   puts 'Disabled!'
 end
 
-flipper[:stats].disable
+Flipper[:stats].disable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts 'Enabled!'
 else
   puts 'Disabled!'

data/lib/flipper/cloud.rb

@@ -4,6 +4,7 @@ require "flipper/middleware/memoizer"
 require "flipper/cloud/configuration"
 require "flipper/cloud/dsl"
 require "flipper/cloud/middleware"
+require "flipper/cloud/engine" if defined?(Rails::Engine)
 
 module Flipper
   module Cloud
@@ -14,8 +15,14 @@ module Flipper
     # options - The Hash of options. See Flipper::Cloud::Configuration.
     # block - The block that configuration will be yielded to allowing you to
     #         customize this cloud instance and its adapter.
-    def self.new(token = nil, options = {})
-      options = options.merge(token: token) if token
+    def self.new(options = {}, deprecated_options = {})
+      if options.is_a?(String)
+        warn "`Flipper::Cloud.new(token)` is deprecated. Use `Flipper::Cloud.new(token: token)` " +
+          "or set the `FLIPPER_CLOUD_TOKEN` environment variable.\n" +
+          caller[0]
+        options = deprecated_options.merge(token: options)
+      end
+
       configuration = Configuration.new(options)
       yield configuration if block_given?
       DSL.new(configuration)
@@ -36,5 +43,21 @@ module Flipper
       builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
       builder
     end
+
+    # Private: Configure Flipper to use Cloud by default
+    def self.set_default
+      Flipper.configure do |config|
+        config.default do
+          if ENV["FLIPPER_CLOUD_TOKEN"]
+            self.new(local_adapter: config.adapter)
+          else
+            warn "Missing FLIPPER_CLOUD_TOKEN environment variable. Disabling Flipper::Cloud."
+            Flipper.new(config.adapter)
+          end
+        end
+      end
+    end
   end
 end
+
+Flipper::Cloud.set_default

data/lib/flipper/cloud/configuration.rb

@@ -67,7 +67,7 @@ module Flipper
         @token = options.fetch(:token) { ENV["FLIPPER_CLOUD_TOKEN"] }
 
         if @token.nil?
-          raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token (e.g. Flipper::Cloud.new('token'))."
+          raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token (e.g. Flipper::Cloud.new(token: 'token'))."
         end
 
         if ENV["FLIPPER_CLOUD_SYNC_METHOD"]

data/lib/flipper/cloud/engine.rb

@@ -0,0 +1,29 @@
+require "flipper/railtie"
+
+module Flipper
+  module Cloud
+    class Engine < Rails::Engine
+      paths["config/routes.rb"] = ["lib/flipper/cloud/routes.rb"]
+
+      config.before_configuration do
+        config.flipper.cloud_path = "_flipper"
+      end
+
+      initializer "flipper.cloud.default", before: :load_config_initializers do |app|
+        Flipper.configure do |config|
+          config.default do
+            if ENV["FLIPPER_CLOUD_TOKEN"]
+              Flipper::Cloud.new(
+                local_adapter: config.adapter,
+                instrumenter: app.config.flipper.instrumenter
+              )
+            else
+              warn "Missing FLIPPER_CLOUD_TOKEN environment variable. Disabling Flipper::Cloud."
+              Flipper.new(config.adapter)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flipper/cloud/routes.rb

@@ -0,0 +1,13 @@
+# Default routes loaded by Flipper::Cloud::Engine
+Rails.application.routes.draw do
+  if ENV["FLIPPER_CLOUD_TOKEN"] && ENV["FLIPPER_CLOUD_SYNC_SECRET"]
+    config = Rails.application.config.flipper
+
+    cloud_app = Flipper::Cloud.app(nil,
+      env_key: config.env_key,
+      memoizer_options: { preload: config.preload }
+    )
+
+    mount cloud_app, at: config.cloud_path
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.21.0.rc1'.freeze
+  VERSION = '0.21.0.rc2'.freeze
 end

data/spec/flipper/cloud/engine_spec.rb

@@ -0,0 +1,98 @@
+require 'helper'
+require 'rails'
+require 'flipper/cloud'
+
+RSpec.describe Flipper::Cloud::Engine do
+  let(:env) do
+    { "FLIPPER_CLOUD_TOKEN" => "test-token" }
+  end
+
+  let(:application) do
+    Class.new(Rails::Application) do
+      config.eager_load = false
+      config.logger = ActiveSupport::Logger.new($stdout)
+    end
+  end
+
+  # App for Rack::Test
+  let(:app) { application.routes }
+
+  before do
+    Rails.application = nil
+
+    # Force loading of flipper to configure itself
+    load 'flipper/cloud.rb'
+  end
+
+  it "initializes cloud configuration" do
+    stub_request(:get, /flippercloud\.io/).to_return(status: 200, body: "{}")
+
+    with_modified_env env do
+      application.initialize!
+
+      expect(Flipper.instance).to be_a(Flipper::Cloud::DSL)
+      expect(Flipper.instance.instrumenter).to be(ActiveSupport::Notifications)
+    end
+  end
+
+  context "with CLOUD_SYNC_SECRET" do
+    before do
+      env.update "FLIPPER_CLOUD_SYNC_SECRET" => "test-secret"
+    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
+      with_modified_env env do
+        application.initialize!
+
+        stub = stub_request(:get, "https://www.flippercloud.io/adapter/features").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
+  end
+
+  context "without CLOUD_SYNC_SECRET" do
+    it "does not configure webhook app" do
+      with_modified_env env do
+        application.initialize!
+
+        post "/_flipper"
+        expect(last_response.status).to eq(404)
+      end
+    end
+  end
+
+  context "without FLIPPER_CLOUD_TOKEN" do
+    it "gracefully skips configuring webhook app" do
+      with_modified_env "FLIPPER_CLOUD_TOKEN" => nil do
+        application.initialize!
+        expect(silence { Flipper.instance }).to match(/Missing FLIPPER_CLOUD_TOKEN/)
+        expect(Flipper.instance).to be_a(Flipper::DSL)
+
+        post "/_flipper"
+        expect(last_response.status).to eq(404)
+      end
+    end
+  end
+end

data/spec/flipper/cloud/middleware_spec.rb

@@ -6,14 +6,14 @@ require 'flipper/adapters/operation_logger'
 
 RSpec.describe Flipper::Cloud::Middleware do
   let(:flipper) {
-    Flipper::Cloud.new("regular") do |config|
+    Flipper::Cloud.new(token: "regular") do |config|
       config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
       config.sync_secret = "regular_tasty"
     end
   }
 
   let(:env_flipper) {
-    Flipper::Cloud.new("env") do |config|
+    Flipper::Cloud.new(token: "env") do |config|
       config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
       config.sync_secret = "env_tasty"
     end

data/spec/flipper/cloud_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Flipper::Cloud do
     let(:token) { 'asdf' }
 
     before do
-      @instance = described_class.new(token)
+      @instance = described_class.new(token: token)
       memoized_adapter = @instance.adapter
       sync_adapter = memoized_adapter.adapter
       @http_adapter = sync_adapter.instance_variable_get('@remote')
@@ -52,7 +52,7 @@ RSpec.describe Flipper::Cloud do
     before do
       stub_request(:get, /fakeflipper\.com/).to_return(status: 200, body: "{}")
 
-      @instance = described_class.new('asdf', url: 'https://www.fakeflipper.com/sadpanda')
+      @instance = described_class.new(token: 'asdf', url: 'https://www.fakeflipper.com/sadpanda')
       memoized_adapter = @instance.adapter
       sync_adapter = memoized_adapter.adapter
       @http_adapter = sync_adapter.instance_variable_get('@remote')
@@ -75,12 +75,12 @@ RSpec.describe Flipper::Cloud do
 
   it 'can set instrumenter' do
     instrumenter = Flipper::Instrumenters::Memory.new
-    instance = described_class.new('asdf', instrumenter: instrumenter)
+    instance = described_class.new(token: 'asdf', instrumenter: instrumenter)
     expect(instance.instrumenter).to be(instrumenter)
   end
 
   it 'allows wrapping adapter with another adapter like the instrumenter' do
-    instance = described_class.new('asdf') do |config|
+    instance = described_class.new(token: 'asdf') do |config|
       config.adapter do |adapter|
         Flipper::Adapters::Instrumented.new(adapter)
       end
@@ -92,26 +92,26 @@ RSpec.describe Flipper::Cloud do
   it 'can set debug_output' do
     expect(Flipper::Adapters::Http::Client).to receive(:new)
       .with(hash_including(debug_output: STDOUT))
-    described_class.new('asdf', debug_output: STDOUT)
+    described_class.new(token: 'asdf', debug_output: STDOUT)
   end
 
   it 'can set read_timeout' do
     expect(Flipper::Adapters::Http::Client).to receive(:new)
       .with(hash_including(read_timeout: 1))
-    described_class.new('asdf', read_timeout: 1)
+    described_class.new(token: 'asdf', read_timeout: 1)
   end
 
   it 'can set open_timeout' do
     expect(Flipper::Adapters::Http::Client).to receive(:new)
       .with(hash_including(open_timeout: 1))
-    described_class.new('asdf', open_timeout: 1)
+    described_class.new(token: 'asdf', open_timeout: 1)
   end
 
   if RUBY_VERSION >= '2.6.0'
     it 'can set write_timeout' do
       expect(Flipper::Adapters::Http::Client).to receive(:new)
         .with(hash_including(open_timeout: 1))
-      described_class.new('asdf', open_timeout: 1)
+      described_class.new(token: 'asdf', open_timeout: 1)
     end
   end
 
@@ -129,7 +129,7 @@ RSpec.describe Flipper::Cloud do
     flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
     flipper.enable_percentage_of_time(:logging, 5)
 
-    cloud_flipper = Flipper::Cloud.new("asdf")
+    cloud_flipper = Flipper::Cloud.new(token: "asdf")
 
     get_all = {
       "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},
@@ -158,7 +158,7 @@ RSpec.describe Flipper::Cloud do
     flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
     flipper.enable_percentage_of_time(:logging, 5)
 
-    cloud_flipper = Flipper::Cloud.new("asdf")
+    cloud_flipper = Flipper::Cloud.new(token: "asdf")
 
     get_all = {
       "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},
@@ -186,7 +186,7 @@ RSpec.describe Flipper::Cloud do
     flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
     flipper.enable_percentage_of_time(:logging, 5)
 
-    cloud_flipper = Flipper::Cloud.new("asdf")
+    cloud_flipper = Flipper::Cloud.new(token: "asdf")
 
     get_all = {
       "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.21.0.rc1
+  version: 0.21.0.rc2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0.rc1
+        version: 0.21.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0.rc1
+        version: 0.21.0.rc2
 description: 
 email:
 - nunemaker@gmail.com
@@ -34,19 +34,20 @@ files:
 - docs/images/flipper_cloud.png
 - examples/cloud/app.ru
 - examples/cloud/basic.rb
-- examples/cloud/cached_in_memory.rb
 - examples/cloud/import.rb
-- examples/cloud/local_adapter.rb
 - flipper-cloud.gemspec
 - lib/flipper-cloud.rb
 - lib/flipper/cloud.rb
 - lib/flipper/cloud/configuration.rb
 - lib/flipper/cloud/dsl.rb
+- lib/flipper/cloud/engine.rb
 - lib/flipper/cloud/message_verifier.rb
 - lib/flipper/cloud/middleware.rb
+- lib/flipper/cloud/routes.rb
 - lib/flipper/version.rb
 - spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud/dsl_spec.rb
+- spec/flipper/cloud/engine_spec.rb
 - spec/flipper/cloud/message_verifier_spec.rb
 - spec/flipper/cloud/middleware_spec.rb
 - spec/flipper/cloud_spec.rb
@@ -77,6 +78,7 @@ summary: FeatureFlipper.com adapter for Flipper
 test_files:
 - spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud/dsl_spec.rb
+- spec/flipper/cloud/engine_spec.rb
 - spec/flipper/cloud/message_verifier_spec.rb
 - spec/flipper/cloud/middleware_spec.rb
 - spec/flipper/cloud_spec.rb

data/examples/cloud/cached_in_memory.rb

@@ -1,28 +0,0 @@
-# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/cached_in_memory.rb
-require 'bundler/setup'
-require 'flipper/cloud'
-require 'flipper/adapters/active_support_cache_store'
-require 'active_support/cache'
-require 'active_support/cache/memory_store'
-
-feature_name = ENV.fetch("FEATURE") { "testing" }.to_sym
-
-Flipper.configure do |config|
-  config.default do
-    Flipper::Cloud.new do |cloud|
-      cloud.debug_output = STDOUT
-      cloud.adapter do |adapter|
-        Flipper::Adapters::ActiveSupportCacheStore.new(adapter,
-          ActiveSupport::Cache::MemoryStore.new, {expires_in: 5.seconds})
-      end
-    end
-  end
-end
-
-loop do
-  # Should only print out http call every 5 seconds
-  p Flipper.enabled?(feature_name)
-  puts "\n\n"
-
-  sleep 1
-end

data/examples/cloud/local_adapter.rb

@@ -1,35 +0,0 @@
-# This is an example of using cloud with a local adapter. All cloud feature
-# changes are synced to the local adapter on an interval. All feature reads are
-# directed to the local adapter, which means reads are fast and not dependent on
-# cloud being available. You can turn internet on/off and more and this should
-# never raise. You could get a slow request every now and then if cloud is
-# unavailable, but we are hoping to fix that soon by doing the cloud update in a
-# background thread.
-# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/local_adapter.rb
-require 'bundler/setup'
-require 'logger'
-require 'flipper/cloud'
-require 'flipper/adapters/redis'
-
-feature_name = ENV.fetch("FEATURE") { "testing" }.to_sym
-
-redis = Redis.new(logger: Logger.new(STDOUT))
-redis.flushdb
-
-Flipper.configure do |config|
-  config.default do
-    Flipper::Cloud.new do |cloud|
-      cloud.debug_output = STDOUT
-      cloud.local_adapter = Flipper::Adapters::Redis.new(redis)
-      cloud.sync_interval = 10
-    end
-  end
-end
-
-loop do
-  # Should only print out http call every 10 seconds
-  p Flipper.enabled?(feature_name)
-  puts "\n\n"
-
-  sleep 1
-end