flipper-api 0.26.2 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8804cea61a705f8f6ce27bcf54a2f83fb46c09117f8e0104f8bcf296c1b4d623
-  data.tar.gz: 59b804c299c5c15fd995e988d356f930044dfc9db967b42e7d0e749ec7712b13
+  metadata.gz: 16b7564999fb4df34d901a811d675e3d0ca30f1d8577016fdb5c76bd3a3ed609
+  data.tar.gz: 5338a67ba725ec6ddbb3f61b30ac727faf0a2aa6a6be74d92d6c29d6e3cd0a73
 SHA512:
-  metadata.gz: 9d140074d8035fc0214c85b7b1951528ace17a5fb9811ee050eefd95b985a0df46f4e622bebb93bc5ade0779f0f84b93d6c78fa9ba28a4d1d83983b785cc63fd
-  data.tar.gz: 8c974f5501a3dbfc4f114a6c338f0ea1b86df3dc766da37761670539a2a1521569c86d16210f4d3b8bc57e015af07fe361845a1cecb06f0018d7b0c366f18cf8
+  metadata.gz: 90087bf7b75e0dc5b98aa329e6350ba9c272b2e2d9b77987ede2d1edcc37ca74dcc7814dbf538ebef6d870924b1112dfdf508845945ad27a460f70244f5bc6bf
+  data.tar.gz: 1f76b37067421056664e19b6d74fa827d61980dc6dd16a8bedc80c16faec0fdbb62e08abee16e240f5fae54d5ad2cb0678076711ad079ba5bc704ec69219fbf5

data/lib/flipper/api/error_response.rb

@@ -24,10 +24,10 @@ module Flipper
       ERRORS = {
         feature_not_found: Error.new(1, 'Feature not found.', 404),
         group_not_registered: Error.new(2, 'Group not registered.', 404),
-        percentage_invalid:
-          Error.new(3, 'Percentage must be a positive number less than or equal to 100.', 422),
+        percentage_invalid: Error.new(3, 'Percentage must be a positive number less than or equal to 100.', 422),
         flipper_id_invalid: Error.new(4, 'Required parameter flipper_id is missing.', 422),
         name_invalid: Error.new(5, 'Required parameter name is missing.', 422),
+        import_invalid: Error.new(6, 'Import invalid.', 422),
       }.freeze
     end
   end

data/lib/flipper/api/middleware.rb

@@ -23,6 +23,7 @@ module Flipper
         @action_collection.add Api::V1::Actions::Actors
         @action_collection.add Api::V1::Actions::Feature
         @action_collection.add Api::V1::Actions::Features
+        @action_collection.add Api::V1::Actions::Import
       end
 
       def call(env)

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

@@ -11,6 +11,8 @@ module Flipper
           def get
             keys = params['keys']
             exclude_gates = params['exclude_gates']&.downcase == "true"
+            exclude_gate_names = params['exclude_gate_names']&.downcase == "true"
+
             features = if keys
               names = keys.split(',')
               if names.empty?
@@ -27,7 +29,10 @@ module Flipper
             end
 
             decorated_features = features.map do |feature|
-              Decorators::Feature.new(feature).as_json(exclude_gates: exclude_gates)
+              Decorators::Feature.new(feature).as_json(
+                exclude_gates: exclude_gates,
+                exclude_gate_names: exclude_gate_names
+              )
             end
 
             json_response(features: decorated_features)

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

@@ -0,0 +1,25 @@
+require 'flipper/exporters/json/export'
+require 'flipper/api/action'
+require 'flipper/api/v1/decorators/feature'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class Import < Api::Action
+          route %r{\A/import/?\Z}
+
+          def post
+            body = request.body.read
+            request.body.rewind
+            export = Flipper::Exporters::Json::Export.new(contents: body)
+            flipper.import(export)
+            json_response({}, 204)
+          rescue Flipper::Exporters::Json::InvalidError
+            json_error_response(:import_invalid)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Flipper
           alias_method :feature, :__getobj__
 
           # Public: Returns instance as hash that is ready to be json dumped.
-          def as_json(exclude_gates: false)
+          def as_json(exclude_gates: false, exclude_gate_names: false)
             result = {
               'key' => key,
               'state' => state.to_s,
@@ -19,7 +19,7 @@ module Flipper
             unless exclude_gates
               gate_values = feature.adapter.get(self)
               result['gates'] = gates.map do |gate|
-                Decorators::Gate.new(gate, gate_values[gate.key]).as_json
+                Decorators::Gate.new(gate, gate_values[gate.key]).as_json(exclude_name: exclude_gate_names)
               end
             end
 

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

@@ -14,12 +14,13 @@ module Flipper
             @value = value
           end
 
-          def as_json
-            {
+          def as_json(exclude_name: false)
+            as_json = {
               'key' => gate.key.to_s,
-              'name' => gate.name.to_s,
               'value' => value_as_json,
             }
+            as_json['name'] = gate.name.to_s unless exclude_name
+            as_json
           end
 
           private

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.26.2'.freeze
+  VERSION = '0.27.0'.freeze
 end

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

@@ -8,10 +8,11 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
       before do
         flipper[:my_feature].enable
         flipper[:my_feature].enable(admin)
-        get '/features'
       end
 
       it 'responds with correct attributes' do
+        get '/features'
+
         expected_response = {
           'features' => [
             {
@@ -50,6 +51,28 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
         expect(last_response.status).to eq(200)
         expect(json_response).to eq(expected_response)
       end
+
+      it 'responds without names when instructed by param' do
+        expected_response = {
+          'features' => [
+            {
+              'key' => 'my_feature',
+              'state' => 'on',
+              'gates' => [
+                { 'key' => 'boolean', 'value' => 'true'},
+                { 'key' => 'actors', 'value' => ['10']},
+                {'key' => 'percentage_of_actors', 'value' => nil},
+                { 'key' => 'percentage_of_time', 'value' => nil},
+                { 'key' => 'groups', 'value' => []},
+              ],
+            },
+          ],
+        }
+
+        get '/features', 'exclude_gate_names' => 'true'
+        expect(last_response.status).to eq(200)
+        expect(json_response).to eq(expected_response)
+      end
     end
 
     context 'with keys specified' do
@@ -103,13 +126,12 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
         post '/features', name: 'my_feature'
       end
 
-      it 'responds 200 ' do
+      it 'responds 200' do
         expect(last_response.status).to eq(200)
       end
 
       it 'returns decorated feature' do
         expected_response = {
-
           'key' => 'my_feature',
           'state' => 'off',
           'gates' => [

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

@@ -19,7 +19,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group enabled' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq(['admins'])
     end
   end
@@ -42,7 +42,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group enabled' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq(['admins'])
     end
   end
@@ -89,7 +89,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group disabled' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq([])
     end
   end
@@ -111,7 +111,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group disabled' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq([])
     end
   end
@@ -145,7 +145,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group in groups set' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq(['admins'])
     end
 
@@ -167,7 +167,7 @@ RSpec.describe Flipper::Api::V1::Actions::GroupsGate do
     end
 
     it 'returns decorated feature with group not in groups set' do
-      group_gate = json_response['gates'].find { |m| m['name'] == 'group' }
+      group_gate = json_response['gates'].find { |m| m['key'] == 'groups' }
       expect(group_gate['value']).to eq([])
     end
 

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

@@ -0,0 +1,69 @@
+RSpec.describe Flipper::Api::V1::Actions::Import do
+  let(:app) { build_api(flipper) }
+
+  describe 'post' do
+    context 'succesful request' do
+      before do
+        flipper.enable(:search)
+        flipper.disable(:adios)
+
+        source_flipper = build_flipper
+        source_flipper.disable(:search)
+        source_flipper.enable_actor(:google_analytics, Flipper::Actor.new("User;1"))
+
+        export = source_flipper.export
+
+        post '/import', export.contents, 'CONTENT_TYPE' => 'application/json'
+      end
+
+      it 'responds 204' do
+        expect(last_response.status).to eq(204)
+      end
+
+      it 'imports features' do
+        expect(flipper[:search].boolean_value).to be(false)
+        expect(flipper[:google_analytics].actors_value).to eq(Set["User;1"])
+        expect(flipper.features.map(&:key)).to eq(["search", "google_analytics"])
+      end
+    end
+
+    context 'empty request' do
+      before do
+        flipper.enable(:search)
+        flipper.disable(:adios)
+
+        source_flipper = build_flipper
+        export = source_flipper.export
+
+        post '/import', export.contents, 'CONTENT_TYPE' => 'application/json'
+      end
+
+      it 'responds 204' do
+        expect(last_response.status).to eq(204)
+      end
+
+      it 'removes all features' do
+        expect(flipper.features.map(&:key)).to eq([])
+      end
+    end
+
+    context 'bad request' do
+      before do
+        post '/import'
+      end
+
+      it 'returns correct status code' do
+        expect(last_response.status).to eq(422)
+      end
+
+      it 'returns formatted error' do
+        expected = {
+          'code' => 6,
+          'message' => 'Import invalid.',
+          'more_info' => api_error_code_reference_url,
+        }
+        expect(json_response).to eq(expected)
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
       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' }
+        gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_actors' }
         expect(gate['value']).to eq(percentage)
       end
     end
@@ -90,7 +90,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
     end
 
     it 'returns decorated feature with gate disabled' do
-      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_actors' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_actors' }
       expect(gate['value']).to eq('0')
     end
   end
@@ -104,7 +104,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
     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' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_actors' }
       expect(gate['value']).to eq('0')
     end
   end
@@ -120,7 +120,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfActorsGate do
 
     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' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_actors' }
       expect(gate['value']).to eq('0')
     end
   end

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

@@ -8,7 +8,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
       end
 
       it 'returns decorated feature with gate enabled for a percent of times' do
-        gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+        gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_time' }
         expect(gate['value']).to eq(percentage)
       end
     end
@@ -90,7 +90,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
     end
 
     it 'returns decorated feature with gate disabled' do
-      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_time' }
       expect(gate['value']).to eq('0')
     end
   end
@@ -105,7 +105,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
 
     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' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_time' }
       expect(gate['value']).to eq('0')
     end
   end
@@ -120,7 +120,7 @@ RSpec.describe Flipper::Api::V1::Actions::PercentageOfTimeGate do
     end
 
     it 'returns decorated feature with gate disabled' do
-      gate = json_response['gates'].find { |gate| gate['name'] == 'percentage_of_time' }
+      gate = json_response['gates'].find { |gate| gate['key'] == 'percentage_of_time' }
       expect(gate['value']).to eq('0')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.26.2
+  version: 0.27.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.2
+        version: 0.27.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.2
+        version: 0.27.0
 description:
 email:
 - nunemaker@gmail.com
@@ -67,6 +67,7 @@ files:
 - lib/flipper/api/v1/actions/feature.rb
 - lib/flipper/api/v1/actions/features.rb
 - lib/flipper/api/v1/actions/groups_gate.rb
+- lib/flipper/api/v1/actions/import.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
@@ -82,6 +83,7 @@ files:
 - spec/flipper/api/v1/actions/feature_spec.rb
 - spec/flipper/api/v1/actions/features_spec.rb
 - spec/flipper/api/v1/actions/groups_gate_spec.rb
+- spec/flipper/api/v1/actions/import_spec.rb
 - spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb
 - spec/flipper/api/v1/decorators/feature_spec.rb
@@ -120,6 +122,7 @@ test_files:
 - spec/flipper/api/v1/actions/feature_spec.rb
 - spec/flipper/api/v1/actions/features_spec.rb
 - spec/flipper/api/v1/actions/groups_gate_spec.rb
+- spec/flipper/api/v1/actions/import_spec.rb
 - spec/flipper/api/v1/actions/percentage_of_actors_gate_spec.rb
 - spec/flipper/api/v1/actions/percentage_of_time_gate_spec.rb
 - spec/flipper/api/v1/decorators/feature_spec.rb