flipper-cloud 0.20.4 → 0.21.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a7975de45022ee964e72588441cebfcbb2381feb4657342c7423064a709d239
-  data.tar.gz: 0d707e5f5ecda9181a6673df0537696d9c8046fe3a01956bee5091e72c39e58f
+  metadata.gz: 9ba3c2db9aa7175de2301fb4fea82a25164e935b0f0fe5d7ce38911eee319cf9
+  data.tar.gz: e97f8ec07dcc20057d6934e1cf933be9517d53549317539900630e43a7ffd23e
 SHA512:
-  metadata.gz: 1833dab42fd2c96295317d99061a90b1e38b592bea66b4c7b672f013cd915cb09f476984545a244741cac62f37054a66e09e00eb1a0a287fd4b689153098baaa
-  data.tar.gz: 00a7ade548bf735d0cd9ca2fbca6a74e1beb6b15c4719a34b06923db6ff9a56b8a43387a6810ec5ee204fd32dab0a916cd5d3f245176473b658dad75a31eb4f9
+  metadata.gz: 62d4f0cc6817cfa654e1980156ca7e4d9ba81d1c0bb761f37651455b20f0b4732ceafe1adbf5a30ca09f8c1f8b80b8609c9d61ef969b82be48eedd183e4a5c15
+  data.tar.gz: 4540506c2b1c4eabe0140f3757e0414977ef876454755106bedfffd8159a880ffea37b6bca24bde30e9e6b79259ad86e30afb415219f7a22104c91bcd4edfbe8

data/examples/cloud/app.ru

@@ -1,13 +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/cloud/app.ru -p 9999
-#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec shotgun examples/cloud/app.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/
 
-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,11 +1,6 @@
 # Usage (from the repo root):
 # env FLIPPER_CLOUD_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)
-
+require 'bundler/setup'
 require 'flipper/cloud'
 flipper = Flipper::Cloud.new
 

data/examples/cloud/cached_in_memory.rb

@@ -1,6 +1,5 @@
 # env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/cached_in_memory.rb
-require File.expand_path('../../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'flipper/cloud'
 require 'flipper/adapters/active_support_cache_store'
 require 'active_support/cache'

data/examples/cloud/import.rb

@@ -1,23 +1,15 @@
 # Usage (from the repo root):
 #   env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/import.rb
-require 'pathname'
-require 'logger'
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+require 'bundler/setup'
 require 'flipper'
 require 'flipper/cloud'
 
-memory_adapter = Flipper::Adapters::Memory.new
-flipper = Flipper.new(memory_adapter)
-
-flipper.enable(:test)
-flipper.enable(:search)
-flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
-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)
 
 cloud = Flipper::Cloud.new
 
 # makes cloud identical to memory flipper
-cloud.import(flipper)
+cloud.import(Flipper)

data/examples/cloud/local_adapter.rb

@@ -6,8 +6,7 @@
 # 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 File.expand_path('../../example_setup', __FILE__)
-
+require 'bundler/setup'
 require 'logger'
 require 'flipper/cloud'
 require 'flipper/adapters/redis'

data/lib/flipper/cloud/configuration.rb

@@ -13,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
 
@@ -57,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
@@ -72,6 +70,11 @@ module Flipper
           raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token (e.g. Flipper::Cloud.new('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 }
@@ -81,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
@@ -114,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

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.4'.freeze
+  VERSION = '0.21.0.rc1'.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/middleware_spec.rb

@@ -9,7 +9,6 @@ RSpec.describe Flipper::Cloud::Middleware do
     Flipper::Cloud.new("regular") do |config|
       config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
       config.sync_secret = "regular_tasty"
-      config.sync_method = :webhook
     end
   }
 
@@ -17,7 +16,6 @@ RSpec.describe Flipper::Cloud::Middleware do
     Flipper::Cloud.new("env") do |config|
       config.local_adapter = Flipper::Adapters::OperationLogger.new(Flipper::Adapters::Memory.new)
       config.sync_secret = "env_tasty"
-      config.sync_method = :webhook
     end
   }
 
@@ -105,7 +103,7 @@ RSpec.describe Flipper::Cloud::Middleware do
 
       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
@@ -128,7 +126,7 @@ RSpec.describe Flipper::Cloud::Middleware do
 
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.20.4
+  version: 0.21.0.rc1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-05-01 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.4
+        version: 0.21.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.21.0.rc1
 description: 
 email:
 - nunemaker@gmail.com
@@ -66,9 +66,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: