flipper-cloud 0.11.0.beta7 → 0.11.0.beta8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d71445392a31df17844e8669b6de0106a45f43b
-  data.tar.gz: f42bca34d957a4e840ddf5a29fd8de4402f16e59
+  metadata.gz: 3a3c2f7161eea7fbe9301cb071628fdba2701762
+  data.tar.gz: 21cb58e7ccb42782a6e27c30041921e133d4ece4
 SHA512:
-  metadata.gz: f206e6fed86360fedc07a038f8b25cd5d0b5cd3c2670c26d94ab890a0e8ab843e47b373cf7585c21cc8cedd22280d64388d73497b497296857b43cc73e47d65d
-  data.tar.gz: 77bfadf0ccbbf6666dc98642e87f793a492f7c13242bc60b43480f9790768977f6749861e36cac12abe902324b4636fb57c9465fa12a60aae7d4aa690975d792
+  metadata.gz: 2e1c85a80adbdf9ce82f0e2a7734a5529502256e3c81a8774a635ea62e88f538bbe6c7e74721422953f9dd70563148f296fdd0d05300deed81727fa22a493ad1
+  data.tar.gz: 41ef7a54f326005f4c88c1d08a54ca7a40a724d0741246b64a3a97e50f6e87f47e67c68d63e1107466ce95eb3ebdeca67ee486bc6215fad560a3a1e415df5b38

data/examples/cloud/cached_in_memory.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../../example_setup', __FILE__)
+
+require 'flipper/cloud'
+require 'flipper/adapters/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::CacheStore.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/lib/flipper/cloud/configuration.rb

@@ -0,0 +1,85 @@
+require "flipper/adapters/http"
+require "flipper/instrumenters/noop"
+
+module Flipper
+  module Cloud
+    class Configuration
+      # The default url should be the one, the only, the website.
+      DEFAULT_URL = "https://www.featureflipper.com/adapter".freeze
+
+      # Public: The token corresponding to an environment on featureflipper.com.
+      attr_accessor :token
+
+      # Public: The url for http adapter (default: Flipper::Cloud::DEFAULT_URL).
+      #         Really should only be customized for development work. Feel free
+      #         to forget you ever saw this.
+      attr_reader :url
+
+      # Public: net/http read timeout for all http requests (default: 5).
+      attr_accessor :read_timeout
+
+      # Public: net/http open timeout for all http requests (default: 5).
+      attr_accessor :open_timeout
+
+      # Public: IO stream to send debug output too. Off by default.
+      #
+      #  # for example, this would send all http request information to STDOUT
+      #  configuration = Flipper::Cloud::Configuration.new
+      #  configuration.debug_output = STDOUT
+      attr_accessor :debug_output
+
+      # Public: Instrumenter to use for the Flipper instance returned by
+      #         Flipper::Cloud.new (default: Flipper::Instrumenters::Noop).
+      #
+      #  # for example, to use active support notifications you could do:
+      #  configuration = Flipper::Cloud::Configuration.new
+      #  configuration.instrumenter = ActiveSupport::Notifications
+      attr_accessor :instrumenter
+
+      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)
+        @debug_output = options[:debug_output]
+        @adapter_block = ->(adapter) { adapter }
+
+        self.url = options.fetch(:url, DEFAULT_URL)
+      end
+
+      # Public: Read or customize the http adapter. Calling without a block will
+      # perform a read. Calling with a block yields the http_adapter
+      # for customization.
+      #
+      #   # for example, to instrument the http calls, you can wrap the http
+      #   # adapter with the intsrumented adapter
+      #   configuration = Flipper::Cloud::Configuration.new
+      #   configuration.adapter do |adapter|
+      #     Flipper::Adapters::Instrumented.new(adapter)
+      #   end
+      #
+      def adapter(&block)
+        if block_given?
+          @adapter_block = block
+        else
+          @adapter_block.call(http_adapter)
+        end
+      end
+
+      # Public: Set url and uri for the http adapter.
+      attr_writer :url
+
+      private
+
+      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,
+                                    })
+      end
+    end
+  end
+end

data/lib/flipper/cloud.rb

@@ -1,45 +1,18 @@
-require "flipper/adapters/http"
-require "flipper/instrumenters/noop"
+require "flipper/cloud/configuration"
 
 module Flipper
   module Cloud
-    # The default adapter wrapper which doesn't wrap at all.
-    DEFAULT_ADAPTER_WRAPPER_BLOCK = ->(adapter) { adapter }
-
-    # The default url should be the one, the only, the website.
-    DEFAULT_URL = "https://www.featureflipper.com/adapter".freeze
-
     # Public: Returns a new Flipper instance with an http adapter correctly
     # configured for flipper cloud.
     #
     # token - The String token for the environment from the website.
-    # options - The Hash of options.
-    #           # :url - The url to point at (defaults to DEFAULT_URL).
-    #           # :adapter_wrapper - The adapter wrapper block. Block should
-    #                                receive an adapter and return an adapter.
-    #                                Allows you to wrap the http adapter with
-    #                                other adapters to make instrumentation and
-    #                                caching easy.
-    #           # :instrumenter - The optional instrumenter to use for the
-    #                             Flipper::DSL instance (defaults to Noop).
+    # 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, options = {})
-      url = options.fetch(:url, DEFAULT_URL)
-      http_options = {
-        uri: URI(url),
-        headers: {
-          "Feature-Flipper-Token" => token,
-        },
-        read_timeout: options[:read_timeout],
-        open_timeout: options[:open_timeout],
-        debug_output: options[:debug_output],
-      }
-      adapter = Flipper::Adapters::Http.new(http_options)
-
-      adapter_wrapper = options.fetch(:adapter_wrapper, DEFAULT_ADAPTER_WRAPPER_BLOCK)
-      adapter = adapter_wrapper.call(adapter)
-
-      instrumenter = options.fetch(:instrumenter, Flipper::Instrumenters::Noop)
-      Flipper.new(adapter, instrumenter: instrumenter)
+      configuration = Configuration.new(options.merge(token: token))
+      yield configuration if block_given?
+      Flipper.new(configuration.adapter, instrumenter: configuration.instrumenter)
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0.beta7'.freeze
+  VERSION = '0.11.0.beta8'.freeze
 end

data/spec/flipper/cloud/configuration_spec.rb

@@ -0,0 +1,58 @@
+require 'helper'
+require 'flipper/cloud/configuration'
+require 'flipper/adapters/instrumented'
+
+RSpec.describe Flipper::Cloud::Configuration do
+  let(:required_options) do
+    { token: "asdf" }
+  end
+
+  it "can set token" do
+    instance = described_class.new(required_options)
+    expect(instance.token).to eq(required_options[:token])
+  end
+
+  it "can set instrumenter" do
+    instrumenter = Object.new
+    instance = described_class.new(required_options.merge(instrumenter: instrumenter))
+    expect(instance.instrumenter).to be(instrumenter)
+  end
+
+  it "can set read_timeout" do
+    instance = described_class.new(required_options.merge(read_timeout: 5))
+    expect(instance.read_timeout).to eq(5)
+  end
+
+  it "can set open_timeout" do
+    instance = described_class.new(required_options.merge(open_timeout: 5))
+    expect(instance.open_timeout).to eq(5)
+  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
+    instance = described_class.new(required_options)
+    expect(instance.adapter).to be_instance_of(Flipper::Adapters::Http)
+  end
+
+  it "can override adapter block" do
+    instance = described_class.new(required_options)
+    instance.adapter do |adapter|
+      Flipper::Adapters::Instrumented.new(adapter)
+    end
+    expect(instance.adapter).to be_instance_of(Flipper::Adapters::Instrumented)
+  end
+
+  it "can override url" do
+    options = required_options.merge(url: "http://localhost:5000/adapter")
+    instance = described_class.new(options)
+    expect(instance.url).to eq("http://localhost:5000/adapter")
+
+    instance = described_class.new(required_options)
+    instance.url = "http://localhost:5000/adapter"
+    expect(instance.url).to eq("http://localhost:5000/adapter")
+  end
+end

data/spec/flipper/cloud_spec.rb

@@ -61,10 +61,11 @@ RSpec.describe Flipper::Cloud do
   end
 
   it 'allows wrapping adapter with another adapter like the instrumenter' do
-    adapter_wrapper = lambda do |adapter|
-      Flipper::Adapters::Instrumented.new(adapter)
+    instance = described_class.new('asdf') do |config|
+      config.adapter do |adapter|
+        Flipper::Adapters::Instrumented.new(adapter)
+      end
     end
-    instance = described_class.new('asdf', adapter_wrapper: adapter_wrapper)
     # instance.adapter is memoizable adapter instance
     expect(instance.adapter.adapter).to be_instance_of(Flipper::Adapters::Instrumented)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta7
+  version: 0.11.0.beta8
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta7
+        version: 0.11.0.beta8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta7
+        version: 0.11.0.beta8
 description: FeatureFlipper.com adapter for Flipper
 email:
 - nunemaker@gmail.com
@@ -32,10 +32,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - examples/cloud/basic.rb
+- examples/cloud/cached_in_memory.rb
 - flipper-cloud.gemspec
 - lib/flipper-cloud.rb
 - lib/flipper/cloud.rb
+- lib/flipper/cloud/configuration.rb
 - lib/flipper/version.rb
+- spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud_spec.rb
 homepage: https://github.com/jnunemaker/flipper
 licenses:
@@ -62,4 +65,5 @@ signing_key:
 specification_version: 4
 summary: FeatureFlipper.com adapter for Flipper
 test_files:
+- spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud_spec.rb