flipper-api 0.10.2 → 0.11.0.beta1

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

@@ -10,58 +10,88 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
       before do
         flipper[:my_feature].enable
         flipper[:my_feature].enable(admin)
-        get 'api/v1/features'
+        get '/features'
       end
 
       it 'responds with correct attributes' do
         expected_response = {
-          "features" => [
+          'features' => [
             {
-              "key" => "my_feature",
-              "state" => "on",
-              "gates" => [
+              'key' => 'my_feature',
+              'state' => 'on',
+              'gates' => [
                 {
-                  "key"=> "boolean",
-                  "name"=> "boolean",
-                  "value" => true
+                  'key' => 'boolean',
+                  'name' => 'boolean',
+                  'value' => 'true',
                 },
                 {
-                  "key" => "groups",
-                  "name" => "group",
-                  "value" => [],
+                  'key' => 'groups',
+                  'name' => 'group',
+                  'value' => [],
                 },
                 {
-                  "key" => "actors",
-                  "name" => "actor",
-                  "value" => ["10"],
+                  'key' => 'actors',
+                  'name' => 'actor',
+                  'value' => ['10'],
                 },
                 {
-                  "key" => "percentage_of_actors",
-                  "name" => "percentage_of_actors",
-                  "value" => 0,
+                  'key' => 'percentage_of_actors',
+                  'name' => 'percentage_of_actors',
+                  'value' => nil,
                 },
                 {
-                  "key"=> "percentage_of_time",
-                  "name"=> "percentage_of_time",
-                  "value"=> 0,
+                  'key' => 'percentage_of_time',
+                  'name' => 'percentage_of_time',
+                  'value' => nil,
                 },
               ],
             },
-          ]
+          ],
         }
         expect(last_response.status).to eq(200)
         expect(json_response).to eq(expected_response)
       end
     end
 
+    context 'with keys specified' do
+      before do
+        flipper[:audit_log].enable
+        flipper[:issues].enable
+        flipper[:search].enable
+        flipper[:stats].disable
+        get '/features', 'keys' => 'search,stats'
+      end
+
+      it 'responds with correct attributes' do
+        expect(last_response.status).to eq(200)
+        keys = json_response.fetch('features').map { |feature| feature.fetch('key') }.sort
+        expect(keys).to eq(%w(search stats))
+      end
+    end
+
+    context 'with keys that are not existing features' do
+      before do
+        flipper[:search].disable
+        flipper[:stats].disable
+        get '/features', 'keys' => 'search,stats,not_a_feature,another_feature_that_does_not_exist'
+      end
+
+      it 'only returns features that exist' do
+        expect(last_response.status).to eq(200)
+        keys = json_response.fetch('features').map { |feature| feature.fetch('key') }.sort
+        expect(keys).to eq(%w(search stats))
+      end
+    end
+
     context 'with no flipper features' do
       before do
-        get 'api/v1/features'
+        get '/features'
       end
 
       it 'returns empty array for features key' do
         expected_response = {
-          "features" => []
+          'features' => [],
         }
         expect(last_response.status).to eq(200)
         expect(json_response).to eq(expected_response)
@@ -72,7 +102,7 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
   describe 'post' do
     context 'succesful request' do
       before do
-        post 'api/v1/features', { name: 'my_feature' }
+        post '/features', name: 'my_feature'
       end
 
       it 'responds 200 ' do
@@ -82,33 +112,33 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
       it 'returns decorated feature' do
         expected_response = {
 
-          "key" => "my_feature",
-          "state" => "off",
-          "gates" => [
+          'key' => 'my_feature',
+          'state' => 'off',
+          'gates' => [
             {
-              "key"=> "boolean",
-              "name"=> "boolean",
-              "value" => false,
+              'key' => 'boolean',
+              'name' => 'boolean',
+              'value' => nil,
             },
             {
-              "key" => "groups",
-              "name" => "group",
-              "value" => [],
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
             },
             {
-              "key" => "actors",
-              "name" => "actor",
-              "value" => [],
+              'key' => 'actors',
+              'name' => 'actor',
+              'value' => [],
             },
             {
-              "key" => "percentage_of_actors",
-              "name" => "percentage_of_actors",
-              "value" => 0,
+              'key' => 'percentage_of_actors',
+              'name' => 'percentage_of_actors',
+              'value' => nil,
             },
             {
-              "key"=> "percentage_of_time",
-              "name"=> "percentage_of_time",
-              "value"=> 0,
+              'key' => 'percentage_of_time',
+              'name' => 'percentage_of_time',
+              'value' => nil,
             },
           ],
         }
@@ -126,7 +156,7 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
 
     context 'bad request' do
       before do
-        post 'api/v1/features'
+        post '/features'
       end
 
       it 'returns correct status code' do
@@ -134,7 +164,12 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
       end
 
       it 'returns formatted error' do
-        expect(json_response).to eq({ 'code' => 5, 'message' => 'Required parameter name is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+        expected = {
+          'code' => 5,
+          'message' => 'Required parameter name is missing.',
+          'more_info' => api_error_code_reference_url,
+        }
+        expect(json_response).to eq(expected)
       end
     end
   end

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

@@ -9,7 +9,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
       Flipper.register(:admins) do |actor|
         actor.respond_to?(:admin?) && actor.admin?
       end
-      post '/api/v1/features/my_feature/groups', { name: 'admins' }
+      post '/features/my_feature/groups', name: 'admins'
     end
 
     it 'enables feature for group' do
@@ -26,6 +26,29 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
   end
 
+  describe 'enable without name params' do
+    before do
+      flipper[:my_feature].disable
+      Flipper.register(:admins) do |actor|
+        actor.respond_to?(:admin?) && actor.admin?
+      end
+      post '/features/my_feature/groups'
+    end
+
+    it 'returns correct status code' do
+      expect(last_response.status).to eq(422)
+    end
+
+    it 'returns formatted error' do
+      expected = {
+        'code' => 5,
+        'message' => 'Required parameter name is missing.',
+        'more_info' => api_error_code_reference_url,
+      }
+      expect(json_response).to eq(expected)
+    end
+  end
+
   describe 'disable' do
     before do
       flipper[:my_feature].disable
@@ -33,7 +56,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
         actor.respond_to?(:admin?) && actor.admin?
       end
       flipper[:my_feature].enable_group(:admins)
-      delete '/api/v1/features/my_feature/groups', { name: 'admins' }
+      delete '/features/my_feature/groups', name: 'admins'
     end
 
     it 'disables feature for group' do
@@ -50,26 +73,85 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
   end
 
-  describe 'non-existent feature' do
+  describe 'disable for non-existent feature' do
     before do
-      delete '/api/v1/features/my_feature/groups', { name:  'admins' }
+      Flipper.register(:admins) do |actor|
+        actor.respond_to?(:admin?) && actor.admin?
+      end
+      delete '/features/my_feature/groups', name: 'admins'
     end
 
-    it  '404s with correct error response when feature does not exist' do
-      expect(last_response.status).to eq(404)
-      expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+    it 'disables 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_falsey
+    end
+
+    it 'returns decorated feature with group disabled' do
+      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      expect(group_gate['value']).to eq([])
     end
   end
 
-  describe 'group not registered' do
+  describe 'disable for group not registered' do
     before do
       flipper[:my_feature].disable
-      delete '/api/v1/features/my_feature/groups', { name: 'admins' }
+      delete '/features/my_feature/groups', name: 'admins'
     end
 
     it '404s with correct error response when group not registered' do
       expect(last_response.status).to eq(404)
-      expect(json_response).to eq({ 'code' => 2, 'message' => 'Group not registered.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expected = {
+        'code' => 2,
+        'message' => 'Group not registered.',
+        'more_info' => api_error_code_reference_url,
+      }
+      expect(json_response).to eq(expected)
+    end
+  end
+
+  describe 'enable for group not registered when allow_unregistered_groups is true' do
+    before do
+      Flipper.unregister_groups
+      flipper[:my_feature].disable
+      post '/features/my_feature/groups', name: 'admins', allow_unregistered_groups: 'true'
+    end
+
+    it 'responds successfully' do
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'returns decorated feature with group in groups set' do
+      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      expect(group_gate['value']).to eq(['admins'])
+    end
+
+    it 'enables group' do
+      expect(flipper[:my_feature].groups_value).to eq(Set["admins"])
+    end
+  end
+
+  describe 'disable for group not registered when allow_unregistered_groups is true' do
+    before do
+      Flipper.unregister_groups
+      flipper[:my_feature].disable
+      flipper[:my_feature].enable_group(:admins)
+      delete '/features/my_feature/groups', name: 'admins', allow_unregistered_groups: 'true'
+    end
+
+    it 'responds successfully' do
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'returns decorated feature with group not in groups set' do
+      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      expect(group_gate['value']).to eq([])
+    end
+
+    it 'disables group' do
+      expect(flipper[:my_feature].groups_value).to be_empty
     end
   end
 end

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

@@ -4,26 +4,45 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
   let(:app) { build_api(flipper) }
 
   describe 'enable' do
-    before do
-      flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_actors', { percentage: '10' }
+    context 'url-encoded request' 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
 
-    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)
+    context 'json request' do
+      before do
+        flipper[:my_feature].disable
+        post '/features/my_feature/percentage_of_actors',
+             JSON.generate(percentage: '10'),
+             'CONTENT_TYPE' => 'application/json'
+      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
-
   end
 
-  describe 'disable' do
+  describe 'disable without percentage' do
     before do
       flipper[:my_feature].enable_percentage_of_actors(10)
-      delete '/api/v1/features/my_feature/percentage_of_actors'
+      delete '/features/my_feature/percentage_of_actors'
     end
 
     it 'disables gate for feature' do
@@ -32,54 +51,73 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
 
     it 'returns decorated feature with gate disabled' do
       gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
-      expect(gate['value']).to eq(0)
+      expect(gate['value']).to eq('0')
+    end
+  end
+
+  describe 'disable with percentage' do
+    before do
+      flipper[:my_feature].enable_percentage_of_actors(10)
+      delete '/features/my_feature/percentage_of_actors',
+             JSON.generate(percentage: '5'),
+             'CONTENT_TYPE' => 'application/json'
+    end
+
+    it 'returns decorated feature with gate value set to 0 regardless of percentage requested' do
+      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
+      expect(gate['value']).to eq('0')
     end
   end
 
   describe 'non-existent feature' do
     before do
-      delete '/api/v1/features/my_feature/percentage_of_actors'
+      delete '/features/my_feature/percentage_of_actors'
+    end
+
+    it 'disables gate for feature' do
+      expect(flipper[:my_feature].enabled_gates).to be_empty
     end
 
-    it  '404s with correct error response when feature does not exist' do
-      expect(last_response.status).to eq(404)
-      expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+    it 'returns decorated feature with gate disabled' do
+      expect(last_response.status).to eq(200)
+      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
+      expect(gate['value']).to eq('0')
     end
   end
 
   describe 'out of range parameter percentage parameter' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_actors', { percentage: '300' }
+      post '/features/my_feature/percentage_of_actors', percentage: '300'
     end
 
     it '422s with correct error response when percentage parameter is invalid' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 
   describe 'percentage parameter not an integer' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_actors', { percentage: 'foo' }
+      post '/features/my_feature/percentage_of_actors', percentage: 'foo'
     end
 
     it '422s with correct error response when percentage parameter is invalid' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 
   describe 'missing percentage parameter' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_actors'
+      post '/features/my_feature/percentage_of_actors'
     end
 
     it '422s with correct error response when percentage parameter is missing' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 end

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

@@ -6,7 +6,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
   describe 'enable' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_time', { percentage: '10' }
+      post '/features/my_feature/percentage_of_time', percentage: '10'
     end
 
     it 'enables gate for feature' do
@@ -15,14 +15,14 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
 
     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)
+      expect(gate['value']).to eq('10')
     end
   end
 
-  describe 'disable' do
+  describe 'disable without percentage' do
     before do
       flipper[:my_feature].enable_percentage_of_time(10)
-      delete '/api/v1/features/my_feature/percentage_of_time'
+      delete '/features/my_feature/percentage_of_time'
     end
 
     it 'disables gate for feature' do
@@ -31,54 +31,73 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
 
     it 'returns decorated feature with gate disabled' do
       gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
-      expect(gate['value']).to eq(0)
+      expect(gate['value']).to eq('0')
+    end
+  end
+
+  describe 'disable with percentage' do
+    before do
+      flipper[:my_feature].enable_percentage_of_time(10)
+      delete '/features/my_feature/percentage_of_time',
+             JSON.generate(percentage: '5'),
+             'CONTENT_TYPE' => 'application/json'
+    end
+
+    it 'returns decorated feature with gate value set to 0 regardless of percentage requested' do
+      expect(last_response.status).to eq(200)
+      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+      expect(gate['value']).to eq('0')
     end
   end
 
   describe 'non-existent feature' do
     before do
-      delete '/api/v1/features/my_feature/percentage_of_time'
+      delete '/features/my_feature/percentage_of_time'
     end
 
-    it  '404s with correct error response when feature does not exist' do
-      expect(last_response.status).to eq(404)
-      expect(json_response).to eq({ 'code' => 1, 'message' => 'Feature not found.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+    it 'disables gate for feature' do
+      expect(flipper[:my_feature].enabled_gates).to be_empty
+    end
+
+    it 'returns decorated feature with gate disabled' do
+      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+      expect(gate['value']).to eq('0')
     end
   end
 
   describe 'out of range parameter percentage parameter' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_time', { percentage: '300' }
+      post '/features/my_feature/percentage_of_time', percentage: '300'
     end
 
     it '422s with correct error response when percentage parameter is invalid' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 
   describe 'percentage parameter not an integer' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_time', { percentage: 'foo' }
+      post '/features/my_feature/percentage_of_time', percentage: 'foo'
     end
 
     it '422s with correct error response when percentage parameter is invalid' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 
   describe 'missing percentage parameter' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/percentage_of_time'
+      post '/features/my_feature/percentage_of_time'
     end
 
     it '422s with correct error response when percentage parameter is missing' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 3, 'message' => 'Percentage must be a positive number less than or equal to 100.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_positive_percentage_error_response)
     end
   end
 end

data/spec/flipper/api_spec.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+RSpec.describe Flipper::Api do
+  context 'when initialized with flipper instance and flipper instance in env' do
+    let(:app) { build_api(flipper) }
+
+    it 'uses env instance over initialized instance' do
+      flipper[:built_a].enable
+      flipper[:built_b].disable
+
+      env_flipper = build_flipper
+      env_flipper[:env_a].enable
+      env_flipper[:env_b].disable
+
+      params = {}
+      env = {
+        'flipper' => env_flipper,
+      }
+      get '/features', params, env
+
+      expect(last_response.status).to eq(200)
+      feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
+      expect(feature_names).to eq(%w(env_a env_b))
+    end
+  end
+
+  context 'when initialized without flipper instance but flipper instance in env' do
+    let(:app) { described_class.app }
+
+    it 'uses env instance' do
+      flipper[:a].enable
+      flipper[:b].disable
+
+      params = {}
+      env = {
+        'flipper' => flipper,
+      }
+      get '/features', params, env
+
+      expect(last_response.status).to eq(200)
+      feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
+      expect(feature_names).to eq(%w(a b))
+    end
+  end
+
+  context "when request does not match any api routes" do
+    let(:app) { build_api(flipper) }
+
+    it "returns 404" do
+      get '/gibberish'
+      expect(last_response.status).to eq(404)
+      expect(json_response).to eq({})
+    end
+  end
+end