flipper-api 0.20.3 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddd925172819bb8de72eb02d85ee014bd170fb0bfd0b4e071eabeedb162911f
-  data.tar.gz: 6be5a9daf2461963d9b14b5c2f3edab6102e4c69f6952ca13168d53690701131
+  metadata.gz: c9e87d4217900f7ce0ff46ea9fa6c145ec1d01e226395529e7ec8ab782bf8119
+  data.tar.gz: 8473cf20629a95691441912a1a8b0ed623b59f84865c2f45410d600fb9a342c1
 SHA512:
-  metadata.gz: e749a826aae5fa8c9e9942e828f77eb738d62788a646637bb5c46723a85f8444cf760b8630bbcf562bed90121ca43f488d1b45f9575f67db3cac995ea96b3427
-  data.tar.gz: 978a81bbab7f4d5bb2dc1cb5004c0328e7d379f23f6dddd7a60762f5a7ee69b54c860aa70539271a2e66e219a16de55ac1173d0ba593a632d16570627b775a19
+  metadata.gz: d16c137e2541de6fa6d53f7e48296be6a17b98bed5c8393274af9766c041c1189bfa823934e694d46b3d041d34df4e132e3158f6a3f7cdba8a9ebc9e9b1b8b0a
+  data.tar.gz: 5979c36e18707e094941a0e12fae47a2203a6bd5b53218c574b63d100f9323109646bd7a429d8c89c4611e86e9a152642feefc74bdb8deea19ac07b6c9a306c2

data/lib/flipper/api.rb

@@ -9,14 +9,11 @@ module Flipper
 
     def self.app(flipper = nil, options = {})
       env_key = options.fetch(:env_key, 'flipper')
-      memoizer_options = options.fetch(:memoizer_options, {})
-
       app = ->(_) { [404, { 'Content-Type'.freeze => CONTENT_TYPE }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
       builder.use Flipper::Api::JsonParams
       builder.use Flipper::Middleware::SetupEnv, flipper, env_key: env_key
-      builder.use Flipper::Middleware::Memoizer, memoizer_options.merge(env_key: env_key)
       builder.use Flipper::Api::Middleware, env_key: env_key
       builder.run app
       klass = self

data/lib/flipper/api/middleware.rb

@@ -32,10 +32,11 @@ module Flipper
       def call!(env)
         request = Rack::Request.new(env)
         action_class = @action_collection.action_for_request(request)
+
         if action_class.nil?
           @app.call(env)
         else
-          flipper = env.fetch(@env_key)
+          flipper = env.fetch(@env_key) { Flipper }
           action_class.run(flipper, request)
         end
       end

data/lib/flipper/api/v1/actions/percentage_of_actors_gate.rb

@@ -30,9 +30,17 @@ module Flipper
 
           private
 
+          def percentage_param
+            @percentage_param ||= params['percentage'].to_s
+          end
+
           def percentage
             @percentage ||= begin
-              Integer(params['percentage'])
+              unless percentage_param.match(/\d/)
+                raise ArgumentError, "invalid numeric value: #{percentage_param}"
+              end
+
+              Flipper::Types::Percentage.new(percentage_param).value
             rescue ArgumentError, TypeError
               -1
             end

data/lib/flipper/api/v1/actions/percentage_of_time_gate.rb

@@ -31,9 +31,17 @@ module Flipper
 
           private
 
+          def percentage_param
+            @percentage_param ||= params['percentage'].to_s
+          end
+
           def percentage
             @percentage ||= begin
-              Integer(params['percentage'])
+              unless percentage_param.match(/\d/)
+                raise ArgumentError, "invalid numeric value: #{percentage_param}"
+              end
+
+              Flipper::Types::Percentage.new(percentage_param).value
             rescue ArgumentError, TypeError
               -1
             end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.3'.freeze
+  VERSION = '0.22.0'.freeze
 end

data/spec/flipper/api/v1/actions/actors_gate_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
 
   describe 'enable feature with slash in name' do
     before do
-      flipper[:my_feature].disable_actor(actor)
+      flipper["my/feature"].disable_actor(actor)
       post '/features/my/feature/actors', flipper_id: actor.flipper_id
     end
 
@@ -60,6 +60,24 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
     end
   end
 
+  describe 'enable feature with space in name' do
+    before do
+      flipper["sp ace"].disable_actor(actor)
+      post '/features/sp%20ace/actors', flipper_id: actor.flipper_id
+    end
+
+    it 'enables feature for actor' do
+      expect(last_response.status).to eq(200)
+      expect(flipper["sp ace"].enabled?(actor)).to be_truthy
+      expect(flipper["sp ace"].enabled_gate_names).to eq([:actor])
+    end
+
+    it 'returns decorated feature with actor enabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'actors' }
+      expect(gate['value']).to eq(['1'])
+    end
+  end
+
   describe 'enable missing flipper_id parameter' do
     before do
       flipper[:my_feature].enable

data/spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb

@@ -4,53 +4,79 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
   let(:app) { build_api(flipper) }
 
   describe 'enable' do
+    shared_examples 'gates with percentage' do
+      it 'enables gate for feature' do
+        expect(flipper[path].enabled_gate_names).to include(:percentage_of_actors)
+      end
+
+      it 'returns decorated feature with gate enabled for a percent of actors' do
+        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
+        expect(gate['value']).to eq(percentage)
+      end
+    end
+
     context 'for feature with slash in name' do
+      let(:path) { 'my/feature' }
+
       before do
-        flipper["my/feature"].disable
-        post '/features/my/feature/percentage_of_actors', percentage: '10'
+        flipper[path].disable
+        post "/features/#{path}/percentage_of_actors", percentage: percentage
       end
 
-      it 'enables gate for feature' do
-        expect(flipper["my/feature"].enabled_gate_names).to include(:percentage_of_actors)
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
       end
 
-      it 'returns decorated feature with gate enabled for 10 percent of actors' do
-        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
-        expect(gate['value']).to eq('10')
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
       end
     end
 
     context 'url-encoded request' do
+      let(:path) { :my_feature }
+
       before do
         flipper[:my_feature].disable
-        post '/features/my_feature/percentage_of_actors', percentage: '10'
+        post "/features/#{path}/percentage_of_actors", percentage: percentage
       end
 
-      it 'enables gate for feature' do
-        expect(flipper[:my_feature].enabled_gate_names).to include(:percentage_of_actors)
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
       end
 
-      it 'returns decorated feature with gate enabled for 10 percent of actors' do
-        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
-        expect(gate['value']).to eq('10')
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
       end
     end
 
     context 'json request' do
+      let(:path) { :my_feature }
+
       before do
         flipper[:my_feature].disable
-        post '/features/my_feature/percentage_of_actors',
-             JSON.generate(percentage: '10'),
+        post "/features/#{path}/percentage_of_actors",
+             JSON.generate(percentage: percentage),
              'CONTENT_TYPE' => 'application/json'
       end
 
-      it 'enables gate for feature' do
-        expect(flipper[:my_feature].enabled_gate_names).to include(:percentage_of_actors)
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
       end
 
-      it 'returns decorated feature with gate enabled for 10 percent of actors' do
-        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
-        expect(gate['value']).to eq('10')
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
       end
     end
   end
@@ -113,7 +139,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
     end
   end
 
-  describe 'percentage parameter not an integer' do
+  describe 'percentage parameter not a number' do
     before do
       flipper[:my_feature].disable
       post '/features/my_feature/percentage_of_actors', percentage: 'foo'

data/spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb

@@ -4,34 +4,80 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
   let(:app) { build_api(flipper) }
 
   describe 'enable' do
-    before do
-      flipper[:my_feature].disable
-      post '/features/my_feature/percentage_of_time', percentage: '10'
-    end
+    shared_examples 'gates with percentage' do
+      it 'enables gate for feature' do
+        expect(flipper[path].enabled_gate_names).to include(:percentage_of_time)
+      end
 
-    it 'enables gate for feature' do
-      expect(flipper[:my_feature].enabled_gate_names).to include(:percentage_of_time)
+      it 'returns decorated feature with gate enabled for a percent of times' do
+        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+        expect(gate['value']).to eq(percentage)
+      end
     end
 
-    it 'returns decorated feature with gate enabled for 5% of time' do
-      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
-      expect(gate['value']).to eq('10')
-    end
-  end
+    context 'for feature with slash in name' do
+      let(:path) { 'my/feature' }
 
-  describe 'enable for feature with slash in name' do
-    before do
-      flipper["my/feature"].disable
-      post '/features/my/feature/percentage_of_time', percentage: '10'
+      before do
+        flipper[path].disable
+        post "/features/#{path}/percentage_of_time", percentage: percentage
+      end
+
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
+      end
+
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
+      end
     end
 
-    it 'enables gate for feature' do
-      expect(flipper["my/feature"].enabled_gate_names).to include(:percentage_of_time)
+    context 'url-encoded request' do
+      let(:path) { :my_feature }
+
+      before do
+        flipper[:my_feature].disable
+        post "/features/#{path}/percentage_of_time", percentage: percentage
+      end
+
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
+      end
+
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
+      end
     end
 
-    it 'returns decorated feature with gate enabled for 5% of time' do
-      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
-      expect(gate['value']).to eq('10')
+    context 'json request' do
+      let(:path) { :my_feature }
+
+      before do
+        flipper[:my_feature].disable
+        post "/features/#{path}/percentage_of_time",
+             JSON.generate(percentage: percentage),
+             'CONTENT_TYPE' => 'application/json'
+      end
+
+      context 'with integer percentage' do
+        let(:percentage) { '10' }
+
+        it_behaves_like 'gates with percentage'
+      end
+
+      context 'with decimal percentage' do
+        let(:percentage) { '0.05' }
+
+        it_behaves_like 'gates with percentage'
+      end
     end
   end
 
@@ -93,7 +139,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
     end
   end
 
-  describe 'percentage parameter not an integer' do
+  describe 'percentage parameter not an number' do
     before do
       flipper[:my_feature].disable
       post '/features/my_feature/percentage_of_time', percentage: 'foo'

data/spec/flipper/api_spec.rb

@@ -1,6 +1,36 @@
 require 'helper'
 
 RSpec.describe Flipper::Api do
+  describe 'Initializing middleware with flipper instance' do
+    let(:app) { build_api(flipper) }
+
+    it 'works' do
+      flipper.enable :a
+      flipper.disable :b
+
+      get '/features'
+
+      expect(last_response.status).to be(200)
+      feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
+      expect(feature_names).to eq(%w(a b))
+    end
+  end
+
+  describe 'Initializing middleware lazily with a block' do
+    let(:app) { build_api(-> { flipper }) }
+
+    it 'works' do
+      flipper.enable :a
+      flipper.disable :b
+
+      get '/features'
+
+      expect(last_response.status).to be(200)
+      feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
+      expect(feature_names).to eq(%w(a b))
+    end
+  end
+
   context 'when initialized with flipper instance and flipper instance in env' do
     let(:app) { build_api(flipper) }
 
@@ -76,4 +106,10 @@ RSpec.describe Flipper::Api do
       expect(json_response).to eq({})
     end
   end
+
+  describe 'Inspecting the built Rack app' do
+    it 'returns a String' do
+      expect(build_api(flipper).inspect).to be_a(String)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.20.3
+  version: 0.22.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 0.22.0
 description: 
 email:
 - nunemaker@gmail.com