flipper-api 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae54a392fa555bc9ee34b7783aff686a17bc9543
-  data.tar.gz: 21c6d2a34ed3789aaea62c84bb86a3558459716c
+  metadata.gz: 1fe848186acddf2d53ab3068d5f2ec2246ab688c
+  data.tar.gz: 20c08ae092d4b61c9a1412778a55f84ca9602c1b
 SHA512:
-  metadata.gz: 09ce98c6e834ac45e3b46c4d47936f1cefe5e45facb26ccc1e2e183f45748d32190c7ee75f9cccb37ca3a11b0872af36af9b7f8360c7fa5463f248883d97f6f3
-  data.tar.gz: 1c553a7e7f0acfd12e158f8211ae79b72941317093201e2d73dce235eaa4660e5cba4c108f661bb48c93d834880cdf6f15af4776de8ad1447d31486332296d85
+  metadata.gz: 8e7e1c899f4a5cd09ac3e129e8e83d0085a46b1ccb4bd05a6d849ad4ccc7a4a158313a08d22201d644f4d35820d70482b248e1a81283f5434ccfc93e70b88863
+  data.tar.gz: 4d367bab12c168329609aa4c9cac1b7098bd68d428d49d927c4c5ee22584864482877866a49d733c9a36fa4874d698b632277cff90ee027f800a0196343febbd

data/flipper-api.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
+require File.expand_path('../lib/flipper/metadata', __FILE__)
 
 flipper_api_files = lambda do |file|
   file =~ %r{(flipper)[\/-]api}
@@ -17,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'flipper-api'
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
+  gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'rack', '>= 1.4', '< 3'
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"

data/lib/flipper/api.rb

@@ -1,7 +1,5 @@
 require 'rack'
 require 'flipper'
-require 'flipper/middleware/setup_env'
-require 'flipper/middleware/memoizer'
 require 'flipper/api/middleware'
 require 'flipper/api/json_params'
 

data/lib/flipper/api/action.rb

@@ -6,6 +6,16 @@ require 'json'
 module Flipper
   module Api
     class Action
+      module FeatureNameFromRoute
+        def feature_name
+          @feature_name ||= begin
+            match = request.path_info.match(self.class.route_regex)
+            match ? match[:feature_name] : nil
+          end
+        end
+        private :feature_name
+      end
+
       extend Forwardable
 
       VALID_REQUEST_METHOD_NAMES = Set.new([
@@ -21,7 +31,17 @@ module Flipper
       #
       # Returns nothing.
       def self.route(regex)
-        @regex = regex
+        @route_regex = regex
+      end
+
+      # Internal: Does this action's route match the path.
+      def self.route_match?(path)
+        path.match(route_regex)
+      end
+
+      # Internal: The regex that matches which routes this action will work for.
+      def self.route_regex
+        @route_regex || raise("#{name}.route is not set")
       end
 
       # Internal: Initializes and runs an action for a given request.
@@ -34,11 +54,6 @@ module Flipper
         new(flipper, request).run
       end
 
-      # Internal: The regex that matches which routes this action will work for.
-      def self.regex
-        @regex || raise("#{name}.route is not set")
-      end
-
       # Public: The instance of the Flipper::DSL the middleware was
       # initialized with.
       attr_reader :flipper

data/lib/flipper/api/action_collection.rb

@@ -1,5 +1,6 @@
 module Flipper
   module Api
+    # Internal: Used to detect the action that should be used in the middleware.
     class ActionCollection
       def initialize
         @action_classes = []
@@ -11,7 +12,7 @@ module Flipper
 
       def action_for_request(request)
         @action_classes.detect do |action_class|
-          request.path_info =~ action_class.regex
+          action_class.route_match?(request.path_info)
         end
       end
     end

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

@@ -6,7 +6,9 @@ module Flipper
     module V1
       module Actions
         class ActorsGate < Api::Action
-          route %r{features/[^/]*/actors/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/actors/?\Z}
 
           def post
             ensure_valid_params
@@ -32,10 +34,6 @@ module Flipper
             json_error_response(:flipper_id_invalid) if flipper_id.nil?
           end
 
-          def feature_name
-            @feature_name ||= Rack::Utils.unescape(path_parts[-2])
-          end
-
           def flipper_id
             @flipper_id ||= params['flipper_id']
           end

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

@@ -6,10 +6,11 @@ module Flipper
     module V1
       module Actions
         class BooleanGate < Api::Action
-          route %r{features/[^/]*/boolean/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/boolean/?\Z}
 
           def post
-            feature_name = Rack::Utils.unescape(path_parts[-2])
             feature = flipper[feature_name]
             feature.enable
             decorated_feature = Decorators::Feature.new(feature)
@@ -17,7 +18,6 @@ module Flipper
           end
 
           def delete
-            feature_name = Rack::Utils.unescape(path_parts[-2])
             feature = flipper[feature_name.to_sym]
             feature.disable
             decorated_feature = Decorators::Feature.new(feature)

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

@@ -6,10 +6,11 @@ module Flipper
     module V1
       module Actions
         class ClearFeature < Api::Action
-          route %r{features/[^/]*/clear/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/clear/?\Z}
 
           def delete
-            feature_name = Rack::Utils.unescape(path_parts[-2])
             feature = flipper[feature_name]
             feature.clear
             json_response({}, 204)

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

@@ -6,7 +6,9 @@ module Flipper
     module V1
       module Actions
         class Feature < Api::Action
-          route %r{features/[^/]*/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/?\Z}
 
           def get
             return json_error_response(:feature_not_found) unless feature_exists?(feature_name)
@@ -21,10 +23,6 @@ module Flipper
 
           private
 
-          def feature_name
-            @feature_name ||= Rack::Utils.unescape(path_parts.last)
-          end
-
           def feature_exists?(feature_name)
             flipper.features.map(&:key).include?(feature_name)
           end

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

@@ -6,7 +6,7 @@ module Flipper
     module V1
       module Actions
         class Features < Api::Action
-          route(/features\Z/)
+          route %r{\A/features/?\Z}
 
           def get
             keys = params['keys']

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

@@ -6,7 +6,9 @@ module Flipper
     module V1
       module Actions
         class GroupsGate < Api::Action
-          route %r{features/[^/]*/groups/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/groups/?\Z}
 
           def post
             ensure_valid_params
@@ -46,10 +48,6 @@ module Flipper
             !allow_unregistered_groups?
           end
 
-          def feature_name
-            @feature_name ||= Rack::Utils.unescape(path_parts[-2])
-          end
-
           def group_name
             @group_name ||= params['name']
           end

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

@@ -6,7 +6,9 @@ module Flipper
     module V1
       module Actions
         class PercentageOfActorsGate < Api::Action
-          route %r{features/[^/]*/percentage_of_actors/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/percentage_of_actors/?\Z}
 
           def post
             if percentage < 0 || percentage > 100
@@ -28,10 +30,6 @@ module Flipper
 
           private
 
-          def feature_name
-            @feature_name ||= Rack::Utils.unescape(path_parts[-2])
-          end
-
           def percentage
             @percentage ||= begin
               Integer(params['percentage'])

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

@@ -6,7 +6,9 @@ module Flipper
     module V1
       module Actions
         class PercentageOfTimeGate < Api::Action
-          route %r{features/[^/]*/percentage_of_time/?\Z}
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/percentage_of_time/?\Z}
 
           def post
             if percentage < 0 || percentage > 100
@@ -29,10 +31,6 @@ module Flipper
 
           private
 
-          def feature_name
-            @feature_name ||= Rack::Utils.unescape(path_parts[-2])
-          end
-
           def percentage
             @percentage ||= begin
               Integer(params['percentage'])

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.15.0'.freeze
+  VERSION = '0.16.0'.freeze
 end

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

@@ -42,6 +42,24 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
     end
   end
 
+  describe 'enable feature with slash in name' do
+    before do
+      flipper[:my_feature].disable_actor(actor)
+      post '/features/my/feature/actors', flipper_id: actor.flipper_id
+    end
+
+    it 'enables feature for actor' do
+      expect(last_response.status).to eq(200)
+      expect(flipper["my/feature"].enabled?(actor)).to be_truthy
+      expect(flipper["my/feature"].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/boolean_gate_spec.rb

@@ -20,6 +20,23 @@ RSpec.describe Flipper::Api::V1::Actions::BooleanGate do
     end
   end
 
+  describe 'enable feature with slash in name' do
+    before do
+      flipper["my/feature"].disable
+      post '/features/my/feature/boolean'
+    end
+
+    it 'enables feature' do
+      expect(last_response.status).to eq(200)
+      expect(flipper["my/feature"].on?).to be_truthy
+    end
+
+    it 'returns decorated feature with boolean gate enabled' do
+      boolean_gate = json_response['gates'].find { |gate| gate['key'] == 'boolean' }
+      expect(boolean_gate['value']).to be_truthy
+    end
+  end
+
   describe 'disable' do
     before do
       flipper[:my_feature].enable

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

@@ -23,4 +23,25 @@ RSpec.describe Flipper::Api::V1::Actions::ClearFeature do
       expect(flipper[:my_feature].off?).to be_truthy
     end
   end
+
+  describe 'clear feature with slash in name' do
+    before do
+      Flipper.register(:admins) {}
+      actor22 = Flipper::Actor.new('22')
+
+      feature = flipper["my/feature"]
+      feature.enable flipper.boolean
+      feature.enable flipper.group(:admins)
+      feature.enable flipper.actor(actor22)
+      feature.enable flipper.actors(25)
+      feature.enable flipper.time(45)
+
+      delete '/features/my/feature/clear'
+    end
+
+    it 'clears feature' do
+      expect(last_response.status).to eq(204)
+      expect(flipper["my/feature"].off?).to be_truthy
+    end
+  end
 end

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

@@ -22,11 +22,6 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => 'true',
             },
-            {
-              'key' => 'groups',
-              'name' => 'group',
-              'value' => [],
-            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -42,6 +37,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'percentage_of_time',
               'value' => nil,
             },
+            {
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
+            },
           ],
         }
 
@@ -66,11 +66,6 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => nil,
             },
-            {
-              'key' => 'groups',
-              'name' => 'group',
-              'value' => [],
-            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -86,6 +81,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'percentage_of_time',
               'value' => nil,
             },
+            {
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
+            },
           ],
         }
 
@@ -126,11 +126,50 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => 'true',
             },
+            {
+              'key' => 'actors',
+              'name' => 'actor',
+              'value' => [],
+            },
+            {
+              'key' => 'percentage_of_actors',
+              'name' => 'percentage_of_actors',
+              'value' => nil,
+            },
+            {
+              'key' => 'percentage_of_time',
+              'name' => 'percentage_of_time',
+              'value' => nil,
+            },
             {
               'key' => 'groups',
               'name' => 'group',
               'value' => [],
             },
+          ],
+        }
+
+        expect(last_response.status).to eq(200)
+        expect(json_response).to eq(response_body)
+      end
+    end
+
+    context 'feature with name that has slash' do
+      before do
+        flipper["my/feature"].enable
+        get '/features/my/feature'
+      end
+
+      it 'responds with correct attributes' do
+        response_body = {
+          'key' => 'my/feature',
+          'state' => 'on',
+          'gates' => [
+            {
+              'key' => 'boolean',
+              'name' => 'boolean',
+              'value' => 'true',
+            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -146,6 +185,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'percentage_of_time',
               'value' => nil,
             },
+            {
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
+            },
           ],
         }
 

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

@@ -25,11 +25,6 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
                   'name' => 'boolean',
                   'value' => 'true',
                 },
-                {
-                  'key' => 'groups',
-                  'name' => 'group',
-                  'value' => [],
-                },
                 {
                   'key' => 'actors',
                   'name' => 'actor',
@@ -45,6 +40,11 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
                   'name' => 'percentage_of_time',
                   'value' => nil,
                 },
+                {
+                  'key' => 'groups',
+                  'name' => 'group',
+                  'value' => [],
+                },
               ],
             },
           ],
@@ -120,11 +120,6 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
               'name' => 'boolean',
               'value' => nil,
             },
-            {
-              'key' => 'groups',
-              'name' => 'group',
-              'value' => [],
-            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -140,6 +135,11 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
               'name' => 'percentage_of_time',
               'value' => nil,
             },
+            {
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
+            },
           ],
         }
         expect(json_response).to eq(expected_response)

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

@@ -26,6 +26,29 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
   end
 
+  describe 'enable feature with slash in name' do
+    before do
+      flipper["my/feature"].disable
+      Flipper.register(:admins) do |actor|
+        actor.respond_to?(:admin?) && actor.admin?
+      end
+      post '/features/my/feature/groups', name: 'admins'
+    end
+
+    it 'enables feature for group' do
+      person = double
+      allow(person).to receive(:flipper_id).and_return(1)
+      allow(person).to receive(:admin?).and_return(true)
+      expect(last_response.status).to eq(200)
+      expect(flipper["my/feature"].enabled?(person)).to be_truthy
+    end
+
+    it 'returns decorated feature with group enabled' do
+      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      expect(group_gate['value']).to eq(['admins'])
+    end
+  end
+
   describe 'enable without name params' do
     before do
       flipper[:my_feature].disable

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

@@ -4,6 +4,22 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
   let(:app) { build_api(flipper) }
 
   describe 'enable' do
+    context 'for feature with slash in name' do
+      before do
+        flipper["my/feature"].disable
+        post '/features/my/feature/percentage_of_actors', percentage: '10'
+      end
+
+      it 'enables gate for feature' do
+        expect(flipper["my/feature"].enabled_gate_names).to include(:percentage_of_actors)
+      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')
+      end
+    end
+
     context 'url-encoded request' do
       before do
         flipper[:my_feature].disable

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

@@ -19,6 +19,22 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
     end
   end
 
+  describe 'enable for feature with slash in name' do
+    before do
+      flipper["my/feature"].disable
+      post '/features/my/feature/percentage_of_time', percentage: '10'
+    end
+
+    it 'enables gate for feature' do
+      expect(flipper["my/feature"].enabled_gate_names).to include(:percentage_of_time)
+    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
+
   describe 'disable without percentage' do
     before do
       flipper[:my_feature].enable_percentage_of_time(10)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-12 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 description: Rack middleware that provides an API for the flipper gem.
 email:
 - nunemaker@gmail.com
@@ -85,7 +85,8 @@ files:
 homepage: https://github.com/jnunemaker/flipper
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/jnunemaker/flipper/blob/master/Changelog.md
 post_install_message: 
 rdoc_options: []
 require_paths: