flipper-api 0.10.2 → 0.11.0.beta1

data/spec/flipper/api/action_spec.rb

@@ -1,68 +1,66 @@
 require 'helper'
 
 RSpec.describe Flipper::Api::Action do
-  let(:action_subclass) {
+  let(:action_subclass) do
     Class.new(described_class) do
       def noooope
-        raise "should never run this"
+        raise 'should never run this'
       end
 
       def get
-        [200, {}, "get"]
+        [200, {}, 'get']
       end
 
       def post
-        [200, {}, "post"]
+        [200, {}, 'post']
       end
 
       def put
-        [200, {}, "put"]
+        [200, {}, 'put']
       end
 
       def delete
-        [200, {}, "delete"]
+        [200, {}, 'delete']
       end
     end
-  }
+  end
 
   describe 'https verbs' do
-
     it "won't run method that isn't whitelisted" do
-      fake_request = Struct.new(:request_method, :env, :session).new("NOOOOPE", {}, {})
+      fake_request = Struct.new(:request_method, :env, :session).new('NOOOOPE', {}, {})
       action = action_subclass.new(flipper, fake_request)
-      expect {
+      expect do
         action.run
-      }.to raise_error(Flipper::Api::RequestMethodNotSupported)
+      end.to raise_error(Flipper::Api::RequestMethodNotSupported)
     end
 
-    it "will run get" do
-      fake_request = Struct.new(:request_method, :env, :session).new("GET", {}, {})
+    it 'will run get' do
+      fake_request = Struct.new(:request_method, :env, :session).new('GET', {}, {})
       action = action_subclass.new(flipper, fake_request)
-      expect(action.run).to eq([200, {}, "get"])
+      expect(action.run).to eq([200, {}, 'get'])
     end
 
-    it "will run post" do
-      fake_request = Struct.new(:request_method, :env, :session).new("POST", {}, {})
+    it 'will run post' do
+      fake_request = Struct.new(:request_method, :env, :session).new('POST', {}, {})
       action = action_subclass.new(flipper, fake_request)
-      expect(action.run).to eq([200, {}, "post"])
+      expect(action.run).to eq([200, {}, 'post'])
     end
 
-    it "will run put" do
-      fake_request = Struct.new(:request_method, :env, :session).new("PUT", {}, {})
+    it 'will run put' do
+      fake_request = Struct.new(:request_method, :env, :session).new('PUT', {}, {})
       action = action_subclass.new(flipper, fake_request)
-      expect(action.run).to eq([200, {}, "put"])
+      expect(action.run).to eq([200, {}, 'put'])
     end
 
-    it "will run delete" do
-      fake_request = Struct.new(:request_method, :env, :session).new("DELETE", {}, {})
+    it 'will run delete' do
+      fake_request = Struct.new(:request_method, :env, :session).new('DELETE', {}, {})
       action = action_subclass.new(flipper, fake_request)
-      expect(action.run).to eq([200, {}, "delete"])
+      expect(action.run).to eq([200, {}, 'delete'])
     end
   end
 
   describe '#json_error_response' do
-    describe ":feature_not_found" do
-
+    describe ':feature_not_found' do
       it 'locates and serializes error correctly' do
         action = action_subclass.new({}, {})
         response = catch(:halt) do
@@ -71,15 +69,12 @@ RSpec.describe Flipper::Api::Action do
         status, headers, body = response
         parsed_body = JSON.parse(body[0])
 
-        expect(headers["Content-Type"]).to eq("application/json")
-        expect(parsed_body["code"]).to eq(1)
-        expect(parsed_body["message"]).to eq("Feature not found.")
-        expect(parsed_body["more_info"]).to eq("https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference")
+        expect(headers['Content-Type']).to eq('application/json')
+        expect(parsed_body).to eql(api_not_found_response)
       end
     end
 
     describe ':group_not_registered' do
-
       it 'locates and serializes error correctly' do
         action = action_subclass.new({}, {})
         response = catch(:halt) do
@@ -88,19 +83,18 @@ RSpec.describe Flipper::Api::Action do
         status, headers, body = response
         parsed_body = JSON.parse(body[0])
 
-        expect(headers["Content-Type"]).to eq("application/json")
-        expect(parsed_body["code"]).to eq(2)
-        expect(parsed_body["message"]).to eq("Group not registered.")
-        expect(parsed_body["more_info"]).to eq("https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference")
+        expect(headers['Content-Type']).to eq('application/json')
+        expect(parsed_body['code']).to eq(2)
+        expect(parsed_body['message']).to eq('Group not registered.')
+        expect(parsed_body['more_info']).to eq(api_error_code_reference_url)
       end
     end
 
     describe 'invalid error key' do
-
       it 'raises descriptive error' do
         action = action_subclass.new({}, {})
         catch(:halt) do
-          expect{ action.json_error_response(:invalid_error_key) }.to raise_error(KeyError)
+          expect { action.json_error_response(:invalid_error_key) }.to raise_error(KeyError)
         end
       end
     end

data/spec/flipper/api/json_params_spec.rb

@@ -0,0 +1,81 @@
+require 'helper'
+
+RSpec.describe Flipper::Api::JsonParams do
+  let(:app) do
+    app = lambda do |env|
+      request = Rack::Request.new(env)
+      [200, { 'Content-Type' => 'application/json' }, [JSON.generate(request.params)]]
+    end
+    builder = Rack::Builder.new
+    builder.use described_class
+    builder.run app
+    builder
+  end
+
+  describe 'json post request' do
+    it 'adds request body to params' do
+      response = post '/',
+                      JSON.generate(flipper_id: 'user:2'),
+                      'CONTENT_TYPE' => 'application/json'
+
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2')
+    end
+
+    it 'handles request bodies with multiple params' do
+      response = post '/',
+                      JSON.generate(flipper_id: 'user:2', language: 'ruby'),
+                      'CONTENT_TYPE' => 'application/json'
+
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+    end
+
+    it 'handles request bodies and single query string params' do
+      response = post '/?language=ruby',
+                      JSON.generate(flipper_id: 'user:2'),
+                      'CONTENT_TYPE' => 'application/json'
+
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+    end
+
+    it 'handles request bodies and multiple query string params' do
+      response = post '/?language=ruby&framework=rails',
+                      JSON.generate(flipper_id: 'user:2'),
+                      'CONTENT_TYPE' => 'application/json'
+
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby', 'framework' => 'rails')
+    end
+
+    it 'favors request body params' do
+      response = post '/?language=javascript',
+                      JSON.generate(flipper_id: 'user:2', language: 'ruby'),
+                      'CONTENT_TYPE' => 'application/json'
+
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+    end
+  end
+
+  describe 'url-encoded request' do
+    it 'handles params the same as a json request' do
+      response = post '/', flipper_id: 'user:2'
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2')
+    end
+
+    it 'handles single query string params' do
+      response = post '/?language=ruby', flipper_id: 'user:2'
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+    end
+
+    it 'handles multiple query string params' do
+      response = post '/?language=ruby&framework=rails', flipper_id: 'user:2'
+      params = JSON.parse(response.body)
+      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby', 'framework' => 'rails')
+    end
+  end
+end

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

@@ -2,13 +2,12 @@ require 'helper'
 
 RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
   let(:app) { build_api(flipper) }
+  let(:actor) { Flipper::Api::Actor.new('1') }
 
   describe 'enable' do
-    let(:actor) { Flipper::Api::Actor.new("1") }
-
     before do
       flipper[:my_feature].disable_actor(actor)
-      post '/api/v1/features/my_feature/actors', { flipper_id: actor.flipper_id }
+      post '/features/my_feature/actors', flipper_id: actor.flipper_id
     end
 
     it 'enables feature for actor' do
@@ -19,16 +18,16 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
 
     it 'returns decorated feature with actor enabled' do
       gate = json_response['gates'].find { |gate| gate['key'] == 'actors' }
-      expect(gate['value']).to eq(["1"])
+      expect(gate['value']).to eq(['1'])
     end
   end
 
   describe 'disable' do
-    let(:actor) { Flipper::Api::Actor.new("1") }
+    let(:actor) { Flipper::Api::Actor.new('1') }
 
     before do
       flipper[:my_feature].enable_actor(actor)
-      delete '/api/v1/features/my_feature/actors', { flipper_id: actor.flipper_id }
+      delete '/features/my_feature/actors', flipper_id: actor.flipper_id
     end
 
     it 'disables feature' do
@@ -46,70 +45,82 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
   describe 'enable missing flipper_id parameter' do
     before do
       flipper[:my_feature].enable
-      post '/api/v1/features/my_feature/actors'
+      post '/features/my_feature/actors'
     end
 
     it 'returns correct error response' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_flipper_id_is_missing_response)
     end
   end
 
   describe 'disable missing flipper_id parameter' do
     before do
       flipper[:my_feature].enable
-      delete '/api/v1/features/my_feature/actors'
+      delete '/features/my_feature/actors'
     end
 
     it 'returns correct error response' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_flipper_id_is_missing_response)
     end
   end
 
   describe 'enable nil flipper_id parameter' do
     before do
       flipper[:my_feature].enable
-      post '/api/v1/features/my_feature/actors', { flipper_id: nil }
+      post '/features/my_feature/actors', flipper_id: nil
     end
 
     it 'returns correct error response' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_flipper_id_is_missing_response)
     end
   end
 
   describe 'disable nil flipper_id parameter' do
     before do
       flipper[:my_feature].enable
-      delete '/api/v1/features/my_feature/actors', { flipper_id: nil }
+      delete '/features/my_feature/actors', flipper_id: nil
     end
 
     it 'returns correct error response' do
       expect(last_response.status).to eq(422)
-      expect(json_response).to eq({ 'code' => 4, 'message' => 'Required parameter flipper_id is missing.', 'more_info' => 'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference' })
+      expect(json_response).to eq(api_flipper_id_is_missing_response)
     end
   end
 
   describe 'enable missing feature' do
     before do
-      post '/api/v1/features/my_feature/actors'
+      post '/features/my_feature/actors', flipper_id: actor.flipper_id
     end
 
-    it 'returns correct error response' 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 '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 'disable missing feature' do
     before do
-      delete '/api/v1/features/my_feature/actors'
+      delete '/features/my_feature/actors', flipper_id: actor.flipper_id
     end
 
-    it 'returns correct error response' 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' do
+      expect(last_response.status).to eq(200)
+      expect(flipper[:my_feature].enabled?(actor)).to be_falsy
+      expect(flipper[:my_feature].enabled_gate_names).to be_empty
+    end
+
+    it 'returns decorated feature with boolean gate disabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'actors' }
+      expect(gate['value']).to be_empty
     end
   end
 end

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

@@ -6,7 +6,7 @@ RSpec.describe Flipper::Api::V1::Actions::BooleanGate do
   describe 'enable' do
     before do
       flipper[:my_feature].disable
-      post '/api/v1/features/my_feature/boolean'
+      post '/features/my_feature/boolean'
     end
 
     it 'enables feature' do
@@ -23,7 +23,7 @@ RSpec.describe Flipper::Api::V1::Actions::BooleanGate do
   describe 'disable' do
     before do
       flipper[:my_feature].enable
-      delete '/api/v1/features/my_feature/boolean'
+      delete '/features/my_feature/boolean'
     end
 
     it 'disables feature' do

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

@@ -0,0 +1,27 @@
+require 'helper'
+
+RSpec.describe Flipper::Api::V1::Actions::ClearFeature do
+  let(:app) { build_api(flipper) }
+
+  describe 'clear' do
+    before do
+      Flipper.register(:admins) {}
+      actor_class = Struct.new(:flipper_id)
+      actor22 = actor_class.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

@@ -7,10 +7,9 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
 
   describe 'get' do
     context 'enabled feature' do
-
       before do
         flipper[:my_feature].enable
-        get 'api/v1/features/my_feature'
+        get '/features/my_feature'
       end
 
       it 'responds with correct attributes' do
@@ -21,7 +20,7 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
             {
               'key' => 'boolean',
               'name' => 'boolean',
-              'value' => true,
+              'value' => 'true',
             },
             {
               'key' => 'groups',
@@ -36,14 +35,14 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
             {
               'key' => 'percentage_of_actors',
               'name' => 'percentage_of_actors',
-              'value' => 0,
+              'value' => nil,
             },
             {
               'key' => 'percentage_of_time',
               'name' => 'percentage_of_time',
-              'value' => 0,
-            }
-          ]
+              'value' => nil,
+            },
+          ],
         }
 
         expect(last_response.status).to eq(200)
@@ -54,7 +53,7 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
     context 'disabled feature' do
       before do
         flipper[:my_feature].disable
-        get 'api/v1/features/my_feature'
+        get '/features/my_feature'
       end
 
       it 'responds with correct attributes' do
@@ -65,12 +64,12 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
             {
               'key' => 'boolean',
               'name' => 'boolean',
-              'value' => false,
+              'value' => nil,
             },
             {
-              'key'=> 'groups',
-              'name'=> 'group',
-              'value'=> [],
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
             },
             {
               'key' => 'actors',
@@ -80,14 +79,14 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
             {
               'key' => 'percentage_of_actors',
               'name' => 'percentage_of_actors',
-              'value'=> 0,
+              'value' => nil,
             },
             {
               'key' => 'percentage_of_time',
               'name' => 'percentage_of_time',
-              'value' => 0,
-            }
-          ]
+              'value' => nil,
+            },
+          ],
         }
 
         expect(last_response.status).to eq(200)
@@ -97,15 +96,17 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
 
     context 'feature does not exist' do
       before do
-        get 'api/v1/features/not_a_feature'
+        get '/features/not_a_feature'
       end
 
-      it 'returns 404' do
+      it '404s' do
         expect(last_response.status).to eq(404)
-      end
-
-      it 'returns formatted error response body' do
-        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" })
+        expected = {
+          'code' => 1,
+          'message' => 'Feature not found.',
+          'more_info' => api_error_code_reference_url,
+        }
+        expect(json_response).to eq(expected)
       end
     end
   end
@@ -115,7 +116,7 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
       it 'deletes feature' do
         flipper[:my_feature].enable
         expect(flipper.features.map(&:key)).to include('my_feature')
-        delete 'api/v1/features/my_feature'
+        delete '/features/my_feature'
         expect(last_response.status).to eq(204)
         expect(flipper.features.map(&:key)).not_to include('my_feature')
       end
@@ -123,15 +124,12 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
 
     context 'feature not found' do
       before do
-        delete 'api/v1/features/my_feature'
+        delete '/features/my_feature'
       end
 
-      it 'returns 404' do
-        expect(last_response.status).to eq(404)
-      end
-
-      it 'returns formatted error response body' do
-        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 'responds with 204' do
+        expect(last_response.status).to eq(204)
+        expect(flipper.features.map(&:key)).not_to include('my_feature')
       end
     end
   end