flipper-cloud 0.12.2 → 0.13.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c16c266053c1d551d7c1bb269dd905d1645a6dd
-  data.tar.gz: 8482911ea237a5b25dc683fa45586addb9ceaea0
+  metadata.gz: 50eb398f4f63e0cbd275e6d07aa287704ecfdcd3
+  data.tar.gz: 6f3f4f0715b503a3289849669a95a429f645d2f7
 SHA512:
-  metadata.gz: 90feb00b50804cbace1f6f42b2896b0f501349d5ff2d4b2bbfa86483d1976a9b4c05cbbb6f4d42154c45d7476dcb35e8017773b3cdac68b871a1d6aad7493f7b
-  data.tar.gz: 93d224f2254a8fd19f65854da1969ab0f1b99b5fab625dd383fc8bb73b861807d65e5c59779f4abb04f2646b0499506a29f01efd0d8f8a692fbda1b38e0d1bfc
+  metadata.gz: 4fc94db45b534f16013632befc7a65ae1cae65d0c0e88b008da6879fd7077c6e96f7313062c1afc6813361b42ab4623d5c4fcfba144e0c788bf7709749017f5a
+  data.tar.gz: 1937f6db0ee4e4446c6147f7bc848aa42c893b59365386b67545c1743f113f3fb99d88ba6959f91d43d62e4bc57d35365e8ff321cf2f81f012fd47b85201b3dc

data/examples/cloud/local_adapter.rb

@@ -0,0 +1,36 @@
+# 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_000
+    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

data/lib/flipper/cloud/configuration.rb

@@ -1,4 +1,6 @@
 require "flipper/adapters/http"
+require "flipper/adapters/memory"
+require "flipper/adapters/sync"
 require "flipper/instrumenters/noop"
 
 module Flipper
@@ -36,11 +38,26 @@ module Flipper
       #  configuration.instrumenter = ActiveSupport::Notifications
       attr_accessor :instrumenter
 
+      # Public: Local adapter that all reads should go to in order to ensure
+      # latency is low and resiliency is high. This adapter is automatically
+      # kept in sync with cloud.
+      #
+      #  # for example, to use active record you could do:
+      #  configuration = Flipper::Cloud::Configuration.new
+      #  configuration.local_adapter = Flipper::Adapters::ActiveRecord.new
+      attr_accessor :local_adapter
+
+      # Public: Number of milliseconds between attempts to bring the local in
+      # sync with cloud (default: 10_000 aka 10 seconds).
+      attr_accessor :sync_interval
+
       def initialize(options = {})
         @token = options.fetch(:token)
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
         @read_timeout = options.fetch(:read_timeout, 5)
         @open_timeout = options.fetch(:open_timeout, 5)
+        @sync_interval = options.fetch(:sync_interval, 10_000)
+        @local_adapter = options.fetch(:local_adapter) { Adapters::Memory.new }
         @debug_output = options[:debug_output]
         @adapter_block = ->(adapter) { adapter }
 
@@ -48,7 +65,7 @@ module Flipper
       end
 
       # Public: Read or customize the http adapter. Calling without a block will
-      # perform a read. Calling with a block yields the http_adapter
+      # perform a read. Calling with a block yields the cloud adapter
       # for customization.
       #
       #   # for example, to instrument the http calls, you can wrap the http
@@ -62,23 +79,34 @@ module Flipper
         if block_given?
           @adapter_block = block
         else
-          @adapter_block.call(http_adapter)
+          @adapter_block.call sync_adapter
         end
       end
 
-      # Public: Set url and uri for the http adapter.
+      # Public: Set url for the http adapter.
       attr_writer :url
 
       private
 
+      def sync_adapter
+        sync_options = {
+          instrumenter: instrumenter,
+          interval: sync_interval,
+        }
+        Flipper::Adapters::Sync.new(local_adapter, http_adapter, sync_options)
+      end
+
       def http_adapter
-        Flipper::Adapters::Http.new(url: @url,
-                                    read_timeout: @read_timeout,
-                                    open_timeout: @open_timeout,
-                                    debug_output: @debug_output,
-                                    headers: {
-                                      "Feature-Flipper-Token" => @token,
-                                    })
+        http_options = {
+          url: @url,
+          read_timeout: @read_timeout,
+          open_timeout: @open_timeout,
+          debug_output: @debug_output,
+          headers: {
+            "Feature-Flipper-Token" => @token,
+          },
+        }
+        Flipper::Adapters::Http.new(http_options)
       end
     end
   end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.12.2'.freeze
+  VERSION = '0.13.0.beta1'.freeze
 end

data/spec/flipper/cloud/configuration_spec.rb

@@ -28,17 +28,36 @@ RSpec.describe Flipper::Cloud::Configuration do
     expect(instance.open_timeout).to eq(5)
   end
 
+  it "can set sync_interval" do
+    instance = described_class.new(required_options.merge(sync_interval: 1_000))
+    expect(instance.sync_interval).to eq(1_000)
+  end
+
+  it "passes sync_interval into sync adapter" do
+    # The initial sync of http to local invokes this web request.
+    stub_request(:get, /featureflipper\.com/).to_return(status: 200, body: "{}")
+
+    instance = described_class.new(required_options.merge(sync_interval: 1_000))
+    expect(instance.adapter.synchronizer.interval).to be(1_000)
+  end
+
   it "can set debug_output" do
     instance = described_class.new(required_options.merge(debug_output: STDOUT))
     expect(instance.debug_output).to eq(STDOUT)
   end
 
   it "defaults adapter block" do
+    # The initial sync of http to local invokes this web request.
+    stub_request(:get, /featureflipper\.com/).to_return(status: 200, body: "{}")
+
     instance = described_class.new(required_options)
-    expect(instance.adapter).to be_instance_of(Flipper::Adapters::Http)
+    expect(instance.adapter).to be_instance_of(Flipper::Adapters::Sync)
   end
 
   it "can override adapter block" do
+    # The initial sync of http to local invokes this web request.
+    stub_request(:get, /featureflipper\.com/).to_return(status: 200, body: "{}")
+
     instance = described_class.new(required_options)
     instance.adapter do |adapter|
       Flipper::Adapters::Instrumented.new(adapter)

data/spec/flipper/cloud_spec.rb

@@ -1,15 +1,21 @@
 require 'helper'
 require 'flipper/cloud'
 require 'flipper/adapters/instrumented'
+require 'flipper/instrumenters/memory'
 
 RSpec.describe Flipper::Cloud do
+  before do
+    stub_request(:get, /featureflipper\.com/).to_return(status: 200, body: "{}")
+  end
+
   context "initialize with token" do
     let(:token) { 'asdf' }
 
     before do
       @instance = described_class.new(token)
       memoized_adapter = @instance.adapter
-      @http_adapter = memoized_adapter.adapter
+      sync_adapter = memoized_adapter.adapter
+      @http_adapter = sync_adapter.instance_variable_get('@remote')
       @http_client = @http_adapter.instance_variable_get('@client')
     end
 
@@ -40,9 +46,12 @@ RSpec.describe Flipper::Cloud do
 
   context 'initialize with token and options' do
     before do
+      stub_request(:get, /fakeflipper\.com/).to_return(status: 200, body: "{}")
+
       @instance = described_class.new('asdf', url: 'https://www.fakeflipper.com/sadpanda')
       memoized_adapter = @instance.adapter
-      @http_adapter = memoized_adapter.adapter
+      sync_adapter = memoized_adapter.adapter
+      @http_adapter = sync_adapter.instance_variable_get('@remote')
       @http_client = @http_adapter.instance_variable_get('@client')
     end
 
@@ -55,7 +64,7 @@ RSpec.describe Flipper::Cloud do
   end
 
   it 'can set instrumenter' do
-    instrumenter = Object.new
+    instrumenter = Flipper::Instrumenters::Memory.new
     instance = described_class.new('asdf', instrumenter: instrumenter)
     expect(instance.instrumenter).to be(instrumenter)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0.beta1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.0.beta1
 description: FeatureFlipper.com adapter for Flipper
 email:
 - nunemaker@gmail.com
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - examples/cloud/basic.rb
 - examples/cloud/cached_in_memory.rb
+- examples/cloud/local_adapter.rb
 - flipper-cloud.gemspec
 - lib/flipper-cloud.rb
 - lib/flipper/cloud.rb
@@ -55,12 +56,12 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: FeatureFlipper.com adapter for Flipper