flipper-cloud 0.20.1 → 0.21.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35dc166068996854a78fc08810a942999539735d61f8f0215d6c10101a57d23d
-  data.tar.gz: bdccf48ff9d058fc20ded13e1c64d7f64964c2daad12fe0ccc11b8aafcd2d0ab
+  metadata.gz: 6c1f88aaef562296d69c7d601cde538b3494e5356664123e302d96cd951d1cab
+  data.tar.gz: 6be448c6a0c689aa38f831baf8f48cfcf1381c72f6a24541bb196da80ec7f962
 SHA512:
-  metadata.gz: a2f6190b1ff9a30ce518a0044323c55a9997db8cf3ec383c4d425ce5eb02121e99a355ca370928df1b9a23ea5add521133fb30a051b56a93b8ce088707d1f2a3
-  data.tar.gz: 132a9a42b22803fa362b85acfd1c741519ce7eff91d5443bf47b8d0d869cd29d6a161ded0e15ef80fa7a642d46b948a454a0c633a72ff5cbbc22949dd2459622
+  metadata.gz: f1c48a398d01d7b3efcb50329778520b6a241f06e9aec3ac6bd478148aafaad7a6a6808bef14d9094b1170992372aa4f3c641a1acc5dc37d1f6fd0f6af701b9b
+  data.tar.gz: 7c4b07f27b3daa727ddafe1bc2fa51581fd15fda3f677f1e322ddfe42ad0eed19101e40436906de49d684e2ec238b88d02daa1cbdf508c245813ba93126af788

data/examples/cloud/app.ru

@@ -1,14 +1,9 @@
 # Usage (from the repo root):
-#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec rackup examples/ui/basic.ru -p 9999
-#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec shotgun examples/ui/basic.ru -p 9999
+#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> bundle exec rackup examples/cloud/app.ru -p 9999
+#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> bundle exec shotgun examples/cloud/app.ru -p 9999
 #   http://localhost:9999/
-#   http://localhost:9999/webhooks
-
-require 'pathname'
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
 
+require 'bundler/setup'
 require 'flipper/cloud'
 Flipper.configure do |config|
   config.default { Flipper::Cloud.new }

data/examples/cloud/basic.rb

@@ -1,25 +1,19 @@
 # Usage (from the repo root):
-#   env TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
-require 'pathname'
-require 'logger'
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
+require 'bundler/setup'
 require 'flipper/cloud'
-flipper = Flipper::Cloud.new(ENV.fetch('TOKEN'))
 
-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/examples/cloud/import.rb

@@ -1,23 +1,15 @@
 # Usage (from the repo root):
-#   env TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
-require 'pathname'
-require 'logger'
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+#   env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/import.rb
+require 'bundler/setup'
 require 'flipper'
 require 'flipper/cloud'
 
-memory_adapter = Flipper::Adapters::Memory.new
-memory_flipper = Flipper.new(memory_adapter)
-
-memory_flipper.enable(:test)
-memory_flipper.enable(:search)
-memory_flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
-memory_flipper.enable_percentage_of_time(:logging, 5)
+Flipper.enable(:test)
+Flipper.enable(:search)
+Flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+Flipper.enable_percentage_of_time(:logging, 5)
 
-flipper = Flipper::Cloud.new(ENV.fetch('TOKEN'))
+cloud = Flipper::Cloud.new
 
-# wipes cloud clean and makes it identical to memory flipper
-flipper.import(memory_flipper)
+# makes cloud identical to memory flipper
+cloud.import(Flipper)

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

@@ -1,3 +1,4 @@
+require "socket"
 require "flipper/adapters/http"
 require "flipper/adapters/memory"
 require "flipper/adapters/dual_write"
@@ -12,6 +13,8 @@ module Flipper
         :webhook,
       ].freeze
 
+      DEFAULT_URL = "https://www.flippercloud.io/adapter".freeze
+
       # Public: The token corresponding to an environment on flippercloud.io.
       attr_accessor :token
 
@@ -56,10 +59,6 @@ module Flipper
       # the local in sync with cloud (default: 10).
       attr_accessor :sync_interval
 
-      # Public: The method to be used for synchronizing your local flipper
-      # adapter with cloud. (default: :poll, can also be :webhook).
-      attr_reader :sync_method
-
       # Public: The secret used to verify if syncs in the middleware should
       # occur or not.
       attr_accessor :sync_secret
@@ -68,9 +67,14 @@ 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"]
+          warn "FLIPPER_CLOUD_SYNC_METHOD is deprecated and has no effect."
+        end
+        self.sync_method = options[:sync_method] if options[:sync_method]
+
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
         @read_timeout = options.fetch(:read_timeout) { ENV.fetch("FLIPPER_CLOUD_READ_TIMEOUT", 5).to_f }
         @open_timeout = options.fetch(:open_timeout) { ENV.fetch("FLIPPER_CLOUD_OPEN_TIMEOUT", 5).to_f }
@@ -80,8 +84,7 @@ module Flipper
         @local_adapter = options.fetch(:local_adapter) { Adapters::Memory.new }
         @debug_output = options[:debug_output]
         @adapter_block = ->(adapter) { adapter }
-        self.sync_method = options.fetch(:sync_method) { ENV.fetch("FLIPPER_CLOUD_SYNC_METHOD", :poll).to_sym }
-        self.url = options.fetch(:url) { ENV.fetch("FLIPPER_CLOUD_URL", "https://www.flippercloud.io/adapter".freeze) }
+        self.url = options.fetch(:url) { ENV.fetch("FLIPPER_CLOUD_URL", DEFAULT_URL) }
       end
 
       # Public: Read or customize the http adapter. Calling without a block will
@@ -113,18 +116,14 @@ module Flipper
         }).call
       end
 
-      def sync_method=(new_sync_method)
-        new_sync_method = new_sync_method.to_sym
-
-        unless VALID_SYNC_METHODS.include?(new_sync_method)
-          raise ArgumentError, "Unsupported sync_method. Valid options are (#{VALID_SYNC_METHODS.to_a.join(', ')})"
-        end
-
-        if new_sync_method == :webhook && sync_secret.nil?
-          raise ArgumentError, "Flipper::Cloud sync_secret is missing. Please set FLIPPER_CLOUD_SYNC_SECRET or provide the sync_secret used to validate webhooks."
-        end
+      # Public: The method that will be used to synchronize local adapter with
+      # cloud. (default: :poll, will be :webhook if sync_secret is set).
+      def sync_method
+        sync_secret ? :webhook : :poll
+      end
 
-        @sync_method = new_sync_method
+      def sync_method=(_)
+        warn "Flipper::Cloud: sync_method is deprecated and has no effect."
       end
 
       private
@@ -153,6 +152,11 @@ module Flipper
           headers: {
             "Flipper-Cloud-Token" => @token,
             "Feature-Flipper-Token" => @token,
+            "Client-Lang" => "ruby",
+            "Client-Lang-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            "Client-Platform" => RUBY_PLATFORM,
+            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            "Client-Hostname" => Socket.gethostname,
           },
         })
       end

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/middleware.rb

@@ -7,6 +7,8 @@ module Flipper
     class Middleware
       # Internal: The path to match for webhook requests.
       WEBHOOK_PATH = %r{\A/webhooks\/?\Z}
+      # Internal: The root path to match for requests.
+      ROOT_PATH = %r{\A/\Z}
 
       def initialize(app, options = {})
         @app = app
@@ -19,7 +21,7 @@ module Flipper
 
       def call!(env)
         request = Rack::Request.new(env)
-        if request.post? && request.path_info.match(WEBHOOK_PATH)
+        if request.post? && (request.path_info.match(ROOT_PATH) || request.path_info.match(WEBHOOK_PATH))
           status = 200
           headers = {
             "Content-Type" => "application/json",

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.20.1'.freeze
+  VERSION = '0.21.0.rc2'.freeze
 end

data/spec/flipper/cloud/configuration_spec.rb

@@ -127,53 +127,30 @@ RSpec.describe Flipper::Cloud::Configuration do
     end
   end
 
-  it "defaults to sync_method to poll" do
-    memory_adapter = Flipper::Adapters::Memory.new
+  it "defaults sync_method to :poll" do
     instance = described_class.new(required_options)
 
     expect(instance.sync_method).to eq(:poll)
   end
 
-  it "can use webhook for sync_method" do
-    memory_adapter = Flipper::Adapters::Memory.new
+  it "sets sync_method to :webhook if sync_secret provided" do
     instance = described_class.new(required_options.merge({
       sync_secret: "secret",
-      sync_method: :webhook,
-      local_adapter: memory_adapter,
     }))
 
     expect(instance.sync_method).to eq(:webhook)
     expect(instance.adapter).to be_instance_of(Flipper::Adapters::DualWrite)
   end
 
-  it "raises ArgumentError for invalid sync_method" do
-    expect {
-      described_class.new(required_options.merge(sync_method: :foo))
-    }.to raise_error(ArgumentError, "Unsupported sync_method. Valid options are (poll, webhook)")
-  end
-
-  it "can use ENV var for sync_method" do
-    with_modified_env "FLIPPER_CLOUD_SYNC_METHOD" => "webhook" do
-      instance = described_class.new(required_options.merge({
-        sync_secret: "secret",
-      }))
+  it "sets sync_method to :webhook if FLIPPER_CLOUD_SYNC_SECRET set" do
+    with_modified_env "FLIPPER_CLOUD_SYNC_SECRET" => "abc" do
+      instance = described_class.new(required_options)
 
       expect(instance.sync_method).to eq(:webhook)
+      expect(instance.adapter).to be_instance_of(Flipper::Adapters::DualWrite)
     end
   end
 
-  it "can use string sync_method instead of symbol" do
-    memory_adapter = Flipper::Adapters::Memory.new
-    instance = described_class.new(required_options.merge({
-      sync_secret: "secret",
-      sync_method: "webhook",
-      local_adapter: memory_adapter,
-    }))
-
-    expect(instance.sync_method).to eq(:webhook)
-    expect(instance.adapter).to be_instance_of(Flipper::Adapters::DualWrite)
-  end
-
   it "can set sync_secret" do
     instance = described_class.new(required_options.merge(sync_secret: "from_config"))
       expect(instance.sync_secret).to eq("from_config")

data/spec/flipper/cloud/dsl_spec.rb

@@ -9,7 +9,6 @@ RSpec.describe Flipper::Cloud::DSL do
     cloud_configuration = Flipper::Cloud::Configuration.new({
       token: "asdf",
       sync_secret: "tasty",
-      sync_method: :webhook,
     })
     dsl = described_class.new(cloud_configuration)
     expect(dsl.features).to eq(Set.new)
@@ -26,7 +25,6 @@ RSpec.describe Flipper::Cloud::DSL do
     cloud_configuration = Flipper::Cloud::Configuration.new({
       token: "asdf",
       sync_secret: "tasty",
-      sync_method: :webhook,
     })
     dsl = described_class.new(cloud_configuration)
     dsl.sync
@@ -37,7 +35,6 @@ RSpec.describe Flipper::Cloud::DSL do
     cloud_configuration = Flipper::Cloud::Configuration.new({
       token: "asdf",
       sync_secret: "tasty",
-      sync_method: :webhook,
     })
     dsl = described_class.new(cloud_configuration)
     expect(dsl.sync_secret).to eq("tasty")
@@ -52,7 +49,6 @@ RSpec.describe Flipper::Cloud::DSL do
       cloud_configuration = Flipper::Cloud::Configuration.new({
         token: "asdf",
         sync_secret: "tasty",
-        sync_method: :webhook,
         local_adapter: local_adapter
       })
     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,18 +6,16 @@ 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"
-      config.sync_method = :webhook
     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"
-      config.sync_method = :webhook
     end
   }
 
@@ -53,7 +51,7 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(JSON.parse(last_response.body)).to eq({
@@ -80,7 +78,7 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(400)
       expect(stub).not_to have_been_requested
@@ -101,11 +99,11 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(402)
       expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
-      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("Failed with status: 402")
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to include("Failed with status: 402")
       expect(stub).to have_been_requested
     end
   end
@@ -124,11 +122,11 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(500)
       expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
-      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("Failed with status: 503")
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to include("Failed with status: 503")
       expect(stub).to have_been_requested
     end
   end
@@ -147,7 +145,7 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(500)
       expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Net::OpenTimeout")
@@ -168,7 +166,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
         'flipper' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -187,7 +185,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
         'flipper' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -207,7 +205,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         'flipper' => flipper,
         'flipper_cloud' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -218,6 +216,27 @@ RSpec.describe Flipper::Cloud::Middleware do
     let(:app) { Flipper::Cloud.app(-> { flipper }) }
 
     it 'works' do
+      stub = stub_request_for_token('regular')
+      env = {
+        "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
+      }
+      post '/', request_body, env
+
+      expect(last_response.status).to eq(200)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context 'when using older /webhooks path' do
+    let(:app) { Flipper::Cloud.app(flipper) }
+
+    it 'uses instance to sync' do
+      Flipper.register(:admins) { |*args| false }
+      Flipper.register(:staff) { |*args| false }
+      Flipper.register(:basic) { |*args| false }
+      Flipper.register(:plus) { |*args| false }
+      Flipper.register(:premium) { |*args| false }
+
       stub = stub_request_for_token('regular')
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
@@ -225,13 +244,22 @@ RSpec.describe Flipper::Cloud::Middleware do
       post '/webhooks', request_body, env
 
       expect(last_response.status).to eq(200)
+      expect(JSON.parse(last_response.body)).to eq({
+        "groups" => [
+          {"name" => "admins"},
+          {"name" => "staff"},
+          {"name" => "basic"},
+          {"name" => "plus"},
+          {"name" => "premium"},
+        ],
+      })
       expect(stub).to have_been_requested
     end
   end
 
   describe 'Request method unsupported' do
     it 'skips middleware' do
-      get '/webhooks'
+      get '/'
       expect(last_response.status).to eq(404)
       expect(last_response.content_type).to eq("application/json")
       expect(last_response.body).to eq("{}")

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,111 @@ 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
+
+  it 'can import' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_return(status: 200, body: "{}", headers: {})
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    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"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    cloud_flipper.import(flipper)
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect(cloud_flipper.adapter.get_all).to eq(get_all)
+  end
+
+  it 'raises error for failure while importing' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_return(status: 500, body: "{}")
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    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"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect { cloud_flipper.import(flipper) }.to raise_error(Flipper::Adapters::Http::Error)
+    expect(flipper.adapter.get_all).to eq(get_all)
+  end
+
+  it 'raises error for timeout while importing' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_timeout
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    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"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect { cloud_flipper.import(flipper) }.to raise_error(Net::OpenTimeout)
+    expect(flipper.adapter.get_all).to eq(get_all)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0.rc2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-31 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.20.1
+        version: 0.21.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.1
+        version: 0.21.0.rc2
 description: 
 email:
 - nunemaker@gmail.com
@@ -31,21 +31,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 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
@@ -65,9 +67,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.0.3
 signing_key: 
@@ -76,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,29 +0,0 @@
-require File.expand_path('../../example_setup', __FILE__)
-
-require 'flipper/cloud'
-require 'flipper/adapters/active_support_cache_store'
-require 'active_support/cache'
-require 'active_support/cache/memory_store'
-
-token = ENV.fetch("TOKEN") { abort "TOKEN environment variable not set." }
-feature_name = ENV.fetch("FEATURE") { "testing" }.to_sym
-
-Flipper.configure do |config|
-  config.default do
-    Flipper::Cloud.new(token) 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,36 +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.
-require File.expand_path('../../example_setup', __FILE__)
-
-require 'logger'
-require 'flipper/cloud'
-require 'flipper/adapters/redis'
-
-token = ENV.fetch("TOKEN") { abort "TOKEN environment variable not set." }
-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(token) 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