flipper-api 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fe848186acddf2d53ab3068d5f2ec2246ab688c
-  data.tar.gz: 20c08ae092d4b61c9a1412778a55f84ca9602c1b
+SHA256:
+  metadata.gz: 5786d14f2e90d02edd5861dd886113570984be4e6172473c86480e1b19706a78
+  data.tar.gz: d5b3d7996165c36a8223218a413ed7b9e1ee061228e12459ed91e739fcd241a4
 SHA512:
-  metadata.gz: 8e7e1c899f4a5cd09ac3e129e8e83d0085a46b1ccb4bd05a6d849ad4ccc7a4a158313a08d22201d644f4d35820d70482b248e1a81283f5434ccfc93e70b88863
-  data.tar.gz: 4d367bab12c168329609aa4c9cac1b7098bd68d428d49d927c4c5ee22584864482877866a49d733c9a36fa4874d698b632277cff90ee027f800a0196343febbd
+  metadata.gz: 78dd2b0565031689b1984c8d5bde1da3db5f96850e527916621fd8dc11956e443643ff536703560acec8c452f384bb94f348b022d7fd614756e6bc5ab6263e5a
+  data.tar.gz: ff989c5a4498f16895eba22b137cd441ce14cce3fdc595d5f96f2c8ac9b66d4504c4f6293ed4001d648f84d33b9f34c86db08370a0ed9ee5dbea7c05c11a5e59

data/flipper-api.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'API for the Flipper gem'
-  gem.description   = 'Rack middleware that provides an API for the flipper gem.'
   gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
   gem.files         = `git ls-files`.split("\n").select(&flipper_api_files) + ['lib/flipper/version.rb']

data/lib/flipper/api/action.rb

@@ -10,7 +10,7 @@ module Flipper
         def feature_name
           @feature_name ||= begin
             match = request.path_info.match(self.class.route_regex)
-            match ? match[:feature_name] : nil
+            match ? Rack::Utils.unescape(match[:feature_name]) : nil
           end
         end
         private :feature_name

data/lib/flipper/api/middleware.rb

@@ -20,6 +20,7 @@ module Flipper
         @action_collection.add Api::V1::Actions::GroupsGate
         @action_collection.add Api::V1::Actions::BooleanGate
         @action_collection.add Api::V1::Actions::ClearFeature
+        @action_collection.add Api::V1::Actions::Actors
         @action_collection.add Api::V1::Actions::Feature
         @action_collection.add Api::V1::Actions::Features
       end

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

@@ -0,0 +1,39 @@
+require 'flipper/api/action'
+require 'flipper/api/v1/decorators/actor'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class Actors < Api::Action
+          route %r{\A/actors/(?<flipper_id>.*)/?\Z}
+
+          def get
+            keys = params['keys']
+            features = if keys
+                         names = keys.split(',')
+                         if names.empty?
+                           []
+                         else
+                           flipper.preload(names)
+                         end
+                       else
+                         flipper.features
+                       end
+
+            actor = Flipper::Actor.new(flipper_id)
+            decorated_actor = Decorators::Actor.new(actor, features)
+            json_response(decorated_actor.as_json)
+          end
+
+          private
+
+          def flipper_id
+            match = request.path_info.match(self.class.route_regex)
+            match ? match[:flipper_id] : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flipper/api/v1/decorators/actor.rb

@@ -0,0 +1,35 @@
+module Flipper
+  module Api
+    module V1
+      module Decorators
+        class Actor < SimpleDelegator
+          # Public: the actor and features.
+          attr_reader :actor, :features
+
+          def initialize(actor, features)
+            @actor = actor
+            @features = features
+          end
+
+          def as_json
+            {
+              'flipper_id' => actor.flipper_id,
+              'features' => features_data,
+            }
+          end
+
+          private
+
+          def features_data
+            features.each_with_object({}) do |feature, features_hash|
+              features_hash[feature.name] = {
+                'enabled' => feature.enabled?(actor),
+              }
+              features_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,12 +12,14 @@ module Flipper
           # Public: Returns instance as hash that is ready to be json dumped.
           def as_json
             gate_values = feature.adapter.get(self)
+            gates_json = gates.map do |gate|
+              Decorators::Gate.new(gate, gate_values[gate.key]).as_json
+            end
+
             {
               'key' => key,
               'state' => state.to_s,
-              'gates' => gates.map do |gate|
-                Decorators::Gate.new(gate, gate_values[gate.key]).as_json
-              end,
+              'gates' => gates_json,
             }
           end
         end

data/lib/flipper/version.rb

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

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

@@ -0,0 +1,105 @@
+require 'helper'
+
+RSpec.describe Flipper::Api::V1::Actions::Actors do
+  let(:app) { build_api(flipper) }
+  let(:actor) { Flipper::Actor.new('User123') }
+
+  describe 'GET /actors/:flipper_id' do
+    before do
+      flipper[:my_feature_1].enable
+      flipper[:my_feature_2].disable
+      flipper[:my_feature_3].enable_actor(actor)
+    end
+
+    context 'when no feature is specified' do
+      before do
+        get "/actors/#{actor.flipper_id}"
+      end
+
+      it 'responds with success' do
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'returns all features' do
+        expected_response = {
+          'flipper_id' => 'User123',
+          'features' => {
+            'my_feature_1' => {
+              'enabled' => true,
+            },
+            'my_feature_2' => {
+              'enabled' => false,
+            },
+            'my_feature_3' => {
+              'enabled' => true,
+            },
+          },
+        }
+
+        expect(json_response).to eq(expected_response)
+      end
+    end
+
+    context 'when features are specified' do
+      before do
+        get "/actors/#{actor.flipper_id}", keys: "my_feature_2,my_feature_3"
+      end
+
+      it 'responds with success' do
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'returns all specified features' do
+        expected_response = {
+          'flipper_id' => 'User123',
+          'features' => {
+            'my_feature_2' => {
+              'enabled' => false,
+            },
+            'my_feature_3' => {
+              'enabled' => true,
+            },
+          },
+        }
+
+        expect(json_response).to eq(expected_response)
+      end
+    end
+
+    context 'when non-existent features are specified' do
+      before do
+        get "/actors/#{actor.flipper_id}", keys: "my_feature_3,not_a_feature"
+      end
+
+      it 'responds with success' do
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'returns false for a non-existent feature' do
+        expected_response = {
+          'flipper_id' => 'User123',
+          'features' => {
+            'my_feature_3' => {
+              'enabled' => true,
+            },
+            'not_a_feature' => {
+              'enabled' => false,
+            },
+          },
+        }
+
+        expect(json_response).to eq(expected_response)
+      end
+    end
+
+    context 'when flipper id is missing' do
+      before do
+        get "/actors"
+      end
+
+      it 'responds with a 404' do
+        expect(last_response.status).to eq(404)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,15 +36,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
-description: Rack middleware that provides an API for the flipper gem.
+        version: 0.18.0
+description: 
 email:
 - nunemaker@gmail.com
 executables: []
@@ -60,6 +60,7 @@ files:
 - lib/flipper/api/error_response.rb
 - lib/flipper/api/json_params.rb
 - lib/flipper/api/middleware.rb
+- lib/flipper/api/v1/actions/actors.rb
 - lib/flipper/api/v1/actions/actors_gate.rb
 - lib/flipper/api/v1/actions/boolean_gate.rb
 - lib/flipper/api/v1/actions/clear_feature.rb
@@ -68,12 +69,14 @@ files:
 - lib/flipper/api/v1/actions/groups_gate.rb
 - lib/flipper/api/v1/actions/percentage_of_actors_gate.rb
 - lib/flipper/api/v1/actions/percentage_of_time_gate.rb
+- lib/flipper/api/v1/decorators/actor.rb
 - lib/flipper/api/v1/decorators/feature.rb
 - lib/flipper/api/v1/decorators/gate.rb
 - lib/flipper/version.rb
 - spec/flipper/api/action_spec.rb
 - spec/flipper/api/json_params_spec.rb
 - spec/flipper/api/v1/actions/actors_gate_spec.rb
+- spec/flipper/api/v1/actions/actors_spec.rb
 - spec/flipper/api/v1/actions/boolean_gate_spec.rb
 - spec/flipper/api/v1/actions/clear_feature_spec.rb
 - spec/flipper/api/v1/actions/feature_spec.rb
@@ -102,8 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API for the Flipper gem
@@ -111,6 +113,7 @@ test_files:
 - spec/flipper/api/action_spec.rb
 - spec/flipper/api/json_params_spec.rb
 - spec/flipper/api/v1/actions/actors_gate_spec.rb
+- spec/flipper/api/v1/actions/actors_spec.rb
 - spec/flipper/api/v1/actions/boolean_gate_spec.rb
 - spec/flipper/api/v1/actions/clear_feature_spec.rb
 - spec/flipper/api/v1/actions/feature_spec.rb