flipper 0.10.2 → 0.11.0.beta1

data/lib/flipper/typecast.rb

@@ -3,8 +3,8 @@ module Flipper
     TruthMap = {
       true    => true,
       1       => true,
-      "true"  => true,
-      "1"     => true,
+      'true'  => true,
+      '1'     => true,
     }.freeze
 
     # Internal: Convert value to a boolean.

data/lib/flipper/types/actor.rb

@@ -9,12 +9,10 @@ module Flipper
       attr_reader :thing
 
       def initialize(thing)
-        if thing.nil?
-          raise ArgumentError.new("thing cannot be nil")
-        end
+        raise ArgumentError, 'thing cannot be nil' if thing.nil?
 
         unless thing.respond_to?(:flipper_id)
-          raise ArgumentError.new("#{thing.inspect} must respond to flipper_id, but does not")
+          raise ArgumentError, "#{thing.inspect} must respond to flipper_id, but does not"
         end
 
         @thing = thing

data/lib/flipper/types/group.rb

@@ -16,7 +16,7 @@ module Flipper
           @block = block
           @single_argument = @block.arity == 1
         else
-          @block = lambda { |thing, context| false }
+          @block = ->(_thing, _context) { false }
           @single_argument = false
         end
       end

data/lib/flipper/types/percentage.rb

@@ -5,7 +5,8 @@ module Flipper
         value = Typecast.to_integer(value)
 
         if value < 0 || value > 100
-          raise ArgumentError, "value must be a positive number less than or equal to 100, but was #{value}"
+          raise ArgumentError,
+                "value must be a positive number less than or equal to 100, but was #{value}"
         end
 
         @value = value

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.10.2".freeze
+  VERSION = '0.11.0.beta1'.freeze
 end

data/spec/fixtures/feature.json

@@ -0,0 +1,31 @@
+{
+  "key": "my_feature",
+  "state": "on",
+  "gates": [
+    {
+      "key": "boolean",
+      "name": "boolean",
+      "value": "true"
+    },
+    {
+      "key": "groups",
+      "name": "group",
+      "value": []
+    },
+    {
+      "key": "actors",
+      "name": "actor",
+      "value": []
+    },
+    {
+      "key": "percentage_of_actors",
+      "name": "percentage_of_actors",
+      "value": null
+    },
+    {
+      "key": "percentage_of_time",
+      "name": "percentage_of_time",
+      "value": null
+    }
+  ]
+}

data/spec/flipper/adapters/http_spec.rb

@@ -0,0 +1,148 @@
+require 'helper'
+require 'flipper/adapters/http'
+require 'flipper/adapters/pstore'
+require 'flipper/spec/shared_adapter_specs'
+require 'rack/handler/webrick'
+
+FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
+
+RSpec.describe Flipper::Adapters::Http do
+  context 'adapter' do
+    subject do
+      described_class.new(uri: URI("http://localhost:#{FLIPPER_SPEC_API_PORT}"))
+    end
+
+    before :all do
+      dir = FlipperRoot.join('tmp').tap(&:mkpath)
+      log_path = dir.join('flipper_adapters_http_spec.log')
+      @pstore_file = dir.join('flipper.pstore')
+      @pstore_file.unlink if @pstore_file.exist?
+
+      api_adapter = Flipper::Adapters::PStore.new(@pstore_file)
+      flipper_api = Flipper.new(api_adapter)
+      app = Flipper::Api.app(flipper_api)
+      server_options = {
+        Port: FLIPPER_SPEC_API_PORT,
+        StartCallback: -> { @started = true },
+        Logger: WEBrick::Log.new(log_path.to_s, WEBrick::Log::INFO),
+        AccessLog: [
+          [log_path.open('w'), WEBrick::AccessLog::COMBINED_LOG_FORMAT],
+        ],
+      }
+      @server = WEBrick::HTTPServer.new(server_options)
+      @server.mount '/', Rack::Handler::WEBrick, app
+
+      Thread.new { @server.start }
+      Timeout.timeout(1) { :wait until @started }
+    end
+
+    after :all do
+      @server.shutdown if @server
+    end
+
+    before(:each) do
+      @pstore_file.unlink if @pstore_file.exist?
+    end
+
+    it_should_behave_like 'a flipper adapter'
+
+    it "can enable and disable unregistered group" do
+      flipper = Flipper.new(subject)
+      expect(flipper[:search].enable_group(:some_made_up_group)).to be(true)
+      expect(flipper[:search].groups_value).to eq(Set["some_made_up_group"])
+
+      expect(flipper[:search].disable_group(:some_made_up_group)).to be(true)
+      expect(flipper[:search].groups_value).to eq(Set.new)
+    end
+  end
+
+  it "sends default headers" do
+    headers = {
+      'Accept' => 'application/json',
+      'Content-Type' => 'application/json',
+      'User-Agent' => 'Flipper HTTP Adapter v0.10.2',
+    }
+    stub_request(:get, "http://app.com/flipper/features/feature_panel")
+      .with(headers: headers)
+      .to_return(status: 404, body: "", headers: {})
+
+    adapter = described_class.new(uri: URI('http://app.com/flipper'))
+    adapter.get(flipper[:feature_panel])
+  end
+
+  describe "#get" do
+    it "raises error when not successful response" do
+      stub_request(:get, "http://app.com/flipper/features/feature_panel")
+        .to_return(status: 503, body: "", headers: {})
+
+      adapter = described_class.new(uri: URI('http://app.com/flipper'))
+      expect do
+        adapter.get(flipper[:feature_panel])
+      end.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#get_multi" do
+    it "raises error when not successful response" do
+      stub_request(:get, "http://app.com/flipper/features?keys=feature_panel")
+        .to_return(status: 503, body: "", headers: {})
+
+      adapter = described_class.new(uri: URI('http://app.com/flipper'))
+      expect do
+        adapter.get_multi([flipper[:feature_panel]])
+      end.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#features" do
+    it "raises error when not successful response" do
+      stub_request(:get, "http://app.com/flipper/features")
+        .to_return(status: 503, body: "", headers: {})
+
+      adapter = described_class.new(uri: URI('http://app.com/flipper'))
+      expect do
+        adapter.features
+      end.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe 'configuration' do
+    let(:options) do
+      {
+        uri: URI('http://app.com/mount-point'),
+        headers: { 'X-Custom-Header' => 'foo' },
+        basic_auth_username: 'username',
+        basic_auth_password: 'password',
+        read_timeout: 100,
+        open_timeout: 40,
+      }
+    end
+    subject { described_class.new(options) }
+    let(:feature) { flipper[:feature_panel] }
+
+    before do
+      stub_request(:get, %r{\Ahttp://app.com*}).to_return(body: fixture_file('feature.json'))
+    end
+
+    it 'allows client to set request headers' do
+      subject.get(feature)
+      expect(
+        a_request(:get, 'http://app.com/mount-point/features/feature_panel')
+        .with(headers: { 'X-Custom-Header' => 'foo' })
+      ).to have_been_made.once
+    end
+
+    it 'allows client to set basic auth' do
+      subject.get(feature)
+      expect(
+        a_request(:get, 'http://app.com/mount-point/features/feature_panel')
+        .with(basic_auth: %w(username password))
+      ).to have_been_made.once
+    end
+  end
+
+  def fixture_file(name)
+    fixtures_path = File.expand_path('../../../fixtures', __FILE__)
+    File.new(fixtures_path + '/' + name)
+  end
+end

data/spec/flipper/adapters/instrumented_spec.rb

@@ -13,13 +13,13 @@ RSpec.describe Flipper::Adapters::Instrumented do
   let(:gate) { feature.gate(:percentage_of_actors) }
   let(:thing) { flipper.actors(22) }
 
-  subject {
-    described_class.new(adapter, :instrumenter => instrumenter)
-  }
+  subject do
+    described_class.new(adapter, instrumenter: instrumenter)
+  end
 
   it_should_behave_like 'a flipper adapter'
 
-  it "forwards missing methods to underlying adapter" do
+  it 'forwards missing methods to underlying adapter' do
     adapter = Class.new do
       def foo
         :foo
@@ -29,14 +29,14 @@ RSpec.describe Flipper::Adapters::Instrumented do
     expect(instrumented.foo).to eq(:foo)
   end
 
-  describe "#name" do
-    it "is instrumented" do
+  describe '#name' do
+    it 'is instrumented' do
       expect(subject.name).to be(:instrumented)
     end
   end
 
-  describe "#get" do
-    it "records instrumentation" do
+  describe '#get' do
+    it 'records instrumentation' do
       result = subject.get(feature)
 
       event = instrumenter.events.last
@@ -49,8 +49,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#enable" do
-    it "records instrumentation" do
+  describe '#enable' do
+    it 'records instrumentation' do
       result = subject.enable(feature, gate, thing)
 
       event = instrumenter.events.last
@@ -64,8 +64,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#disable" do
-    it "records instrumentation" do
+  describe '#disable' do
+    it 'records instrumentation' do
       result = subject.disable(feature, gate, thing)
 
       event = instrumenter.events.last
@@ -79,8 +79,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#add" do
-    it "records instrumentation" do
+  describe '#add' do
+    it 'records instrumentation' do
       result = subject.add(feature)
 
       event = instrumenter.events.last
@@ -93,8 +93,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#remove" do
-    it "records instrumentation" do
+  describe '#remove' do
+    it 'records instrumentation' do
       result = subject.remove(feature)
 
       event = instrumenter.events.last
@@ -107,8 +107,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#clear" do
-    it "records instrumentation" do
+  describe '#clear' do
+    it 'records instrumentation' do
       result = subject.clear(feature)
 
       event = instrumenter.events.last
@@ -121,8 +121,8 @@ RSpec.describe Flipper::Adapters::Instrumented do
     end
   end
 
-  describe "#features" do
-    it "records instrumentation" do
+  describe '#features' do
+    it 'records instrumentation' do
       result = subject.features
 
       event = instrumenter.events.last

data/spec/flipper/adapters/memoizable_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Flipper::Adapters::Memoizable do
 
   it_should_behave_like 'a flipper adapter'
 
-  it "forwards missing methods to underlying adapter" do
+  it 'forwards missing methods to underlying adapter' do
     adapter = Class.new do
       def foo
         :foo
@@ -23,14 +23,14 @@ RSpec.describe Flipper::Adapters::Memoizable do
     expect(memoizable.foo).to eq(:foo)
   end
 
-  describe "#name" do
-    it "is instrumented" do
+  describe '#name' do
+    it 'is instrumented' do
       expect(subject.name).to be(:memoizable)
     end
   end
 
-  describe "#memoize=" do
-    it "sets value" do
+  describe '#memoize=' do
+    it 'sets value' do
       subject.memoize = true
       expect(subject.memoizing?).to eq(true)
 
@@ -38,44 +38,44 @@ RSpec.describe Flipper::Adapters::Memoizable do
       expect(subject.memoizing?).to eq(false)
     end
 
-    it "clears the local cache" do
+    it 'clears the local cache' do
       subject.cache['some'] = 'thing'
       subject.memoize = true
       expect(subject.cache).to be_empty
     end
   end
 
-  describe "#memoizing?" do
-    it "returns true if enabled" do
+  describe '#memoizing?' do
+    it 'returns true if enabled' do
       subject.memoize = true
       expect(subject.memoizing?).to eq(true)
     end
 
-    it "returns false if disabled" do
+    it 'returns false if disabled' do
       subject.memoize = false
       expect(subject.memoizing?).to eq(false)
     end
   end
 
-  describe "#get" do
-    context "with memoization enabled" do
+  describe '#get' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "memoizes feature" do
+      it 'memoizes feature' do
         feature = flipper[:stats]
         result = subject.get(feature)
         expect(cache[feature.key]).to be(result)
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         feature = flipper[:stats]
         result = subject.get(feature)
         adapter_result = adapter.get(feature)
@@ -84,30 +84,30 @@ RSpec.describe Flipper::Adapters::Memoizable do
     end
   end
 
-  describe "#get_multi" do
-    context "with memoization enabled" do
+  describe '#get_multi' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "memoizes feature" do
-        names = %i{stats shiny}
+      it 'memoizes feature' do
+        names = %i(stats shiny)
         features = names.map { |name| flipper[name] }
         results = subject.get_multi(features)
         features.each do |feature|
-          expect(cache[feature.key]).to_not be(nil)
+          expect(cache[feature.key]).not_to be(nil)
           expect(cache[feature.key]).to be(results[feature.key])
         end
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
-        names = %i{stats shiny}
+      it 'returns result' do
+        names = %i(stats shiny)
         features = names.map { |name| flipper[name] }
         result = subject.get_multi(features)
         adapter_result = adapter.get_multi(features)
@@ -116,27 +116,27 @@ RSpec.describe Flipper::Adapters::Memoizable do
     end
   end
 
-  describe "#enable" do
-    context "with memoization enabled" do
+  describe '#enable' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "unmemoizes feature" do
+      it 'unmemoizes feature' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
-        cache[feature.key] = {:some => 'thing'}
+        cache[feature.key] = { some: 'thing' }
         subject.enable(feature, gate, flipper.bool)
         expect(cache[feature.key]).to be_nil
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
         result = subject.enable(feature, gate, flipper.bool)
@@ -146,27 +146,27 @@ RSpec.describe Flipper::Adapters::Memoizable do
     end
   end
 
-  describe "#disable" do
-    context "with memoization enabled" do
+  describe '#disable' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "unmemoizes feature" do
+      it 'unmemoizes feature' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
-        cache[feature.key] = {:some => 'thing'}
+        cache[feature.key] = { some: 'thing' }
         subject.disable(feature, gate, flipper.bool)
         expect(cache[feature.key]).to be_nil
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         feature = flipper[:stats]
         gate = feature.gate(:boolean)
         result = subject.disable(feature, gate, flipper.bool)
@@ -176,13 +176,13 @@ RSpec.describe Flipper::Adapters::Memoizable do
     end
   end
 
-  describe "#features" do
-    context "with memoization enabled" do
+  describe '#features' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "memoizes features" do
+      it 'memoizes features' do
         flipper[:stats].enable
         flipper[:search].disable
         result = subject.features
@@ -190,92 +190,92 @@ RSpec.describe Flipper::Adapters::Memoizable do
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         expect(subject.features).to eq(adapter.features)
       end
     end
   end
 
-  describe "#add" do
-    context "with memoization enabled" do
+  describe '#add' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "unmemoizes the known features" do
-        cache[features_key] = {:some => 'thing'}
+      it 'unmemoizes the known features' do
+        cache[features_key] = { some: 'thing' }
         subject.add(flipper[:stats])
         expect(cache).to be_empty
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         expect(subject.add(flipper[:stats])).to eq(adapter.add(flipper[:stats]))
       end
     end
   end
 
-  describe "#remove" do
-    context "with memoization enabled" do
+  describe '#remove' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "unmemoizes the known features" do
-        cache[features_key] = {:some => 'thing'}
+      it 'unmemoizes the known features' do
+        cache[features_key] = { some: 'thing' }
         subject.remove(flipper[:stats])
         expect(cache).to be_empty
       end
 
-      it "unmemoizes the feature" do
+      it 'unmemoizes the feature' do
         feature = flipper[:stats]
-        cache[feature.key] = {:some => 'thing'}
+        cache[feature.key] = { some: 'thing' }
         subject.remove(feature)
         expect(cache[feature.key]).to be_nil
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         expect(subject.remove(flipper[:stats])).to eq(adapter.remove(flipper[:stats]))
       end
     end
   end
 
-  describe "#clear" do
-    context "with memoization enabled" do
+  describe '#clear' do
+    context 'with memoization enabled' do
       before do
         subject.memoize = true
       end
 
-      it "unmemoizes feature" do
+      it 'unmemoizes feature' do
         feature = flipper[:stats]
-        cache[feature.key] = {:some => 'thing'}
+        cache[feature.key] = { some: 'thing' }
         subject.clear(feature)
         expect(cache[feature.key]).to be_nil
       end
     end
 
-    context "with memoization disabled" do
+    context 'with memoization disabled' do
       before do
         subject.memoize = false
       end
 
-      it "returns result" do
+      it 'returns result' do
         feature = flipper[:stats]
         expect(subject.clear(feature)).to eq(adapter.clear(feature))
       end