flipper-api 0.23.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 416150892b81d4ee93b5e524ae179386f7d6b6de297f199f8e9ae9a1195ff864
-  data.tar.gz: 5a8eb77ca19843457f681305d1c444bce7d782687d26faeec563a23292a4c995
+  metadata.gz: a6fc51e82446b1d30b12dc8efe5441742d845b0aefc6c04bf0a69a21752b7485
+  data.tar.gz: 39099982047dd1b9ec6459f42dddbece3661981b81259612e3ca8028d79859e2
 SHA512:
-  metadata.gz: 8b359d5d6fb420cd21037ecd5c776ec4b415daeddd70f5af01f5443fa2a75e707415638ea85e5b3cd624182ff12214383b00101bdd10d4d221285515e4697d98
-  data.tar.gz: 868cfc5fd0d80fc4f9d3a790e414c15ce083e6025747e30731a8267f161aa1f0d761ebbc241530da088dc9115d409b224b57e598ac4b45c421b90f38d0c369b0
+  metadata.gz: a95a27f7794f22b0fbd26007b043a7b31b488b4e50d915074c7ce470e32605c7e6ae6f4928f0ffb9a45b81b78fb354e5ed4d6c11bfc4458bd4dbd57221ed623a
+  data.tar.gz: 64df3f4d179fb84efa94e2f9ba1936204a4a6e3cf03c8c23d72912bcd02ad36d1820ff22b7f7d4d9d9fb10343af86c427a380dc519ed8cec00ba8257d52f802f

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

@@ -12,8 +12,9 @@ module Flipper
 
           def get
             return json_error_response(:feature_not_found) unless feature_exists?(feature_name)
+            exclude_gates = params['exclude_gates']&.downcase == "true"
             feature = Decorators::Feature.new(flipper[feature_name])
-            json_response(feature.as_json)
+            json_response(feature.as_json(exclude_gates: exclude_gates))
           end
 
           def delete

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

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

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

@@ -10,17 +10,20 @@ module Flipper
           alias_method :feature, :__getobj__
 
           # 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
-
-            {
+          def as_json(exclude_gates: false)
+            result = {
               'key' => key,
               'state' => state.to_s,
-              'gates' => gates_json,
             }
+
+            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
+              end
+            end
+
+            result
           end
         end
       end

data/lib/flipper/api.rb

@@ -17,8 +17,9 @@ module Flipper
       builder.use Flipper::Api::Middleware, env_key: env_key
       builder.run app
       klass = self
-      builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
-      builder
+      app = builder.to_app
+      app.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
+      app
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.23.1'.freeze
+  VERSION = '0.25.0'.freeze
 end

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

@@ -0,0 +1,27 @@
+RSpec.describe Flipper::Api::V1::Decorators::Feature do
+  describe "#as_json" do
+    context "with exclude_gates set to true" do
+      subject { described_class.new(flipper[:my_feature]).as_json(exclude_gates: true) }
+
+      it "returns json WITHOUT feature gate data" do
+        expect(subject.keys).to_not include("gates")
+      end
+    end
+
+    context "with exclude_gates set to false" do
+      subject { described_class.new(flipper[:my_feature]).as_json(exclude_gates: false) }
+
+      it "returns json WITH feature gate data" do
+        expect(subject.keys).to include("gates")
+      end
+    end
+
+    context "without exclude_gates set" do
+      subject { described_class.new(flipper[:my_feature]).as_json }
+
+      it "returns json WITH feature gate data" do
+        expect(subject.keys).to include("gates")
+      end
+    end
+  end
+end

data/spec/flipper/api_spec.rb

@@ -107,7 +107,7 @@ RSpec.describe Flipper::Api do
 
   describe 'Inspecting the built Rack app' do
     it 'returns a String' do
-      expect(build_api(flipper).inspect).to be_a(String)
+      expect(build_api(flipper).inspect).to eq("Flipper::Api")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.25.0
 description: 
 email:
 - nunemaker@gmail.com
@@ -84,6 +84,7 @@ files:
 - spec/flipper/api/v1/actions/groups_gate_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
 - spec/flipper/api_spec.rb
 homepage: https://github.com/jnunemaker/flipper
 licenses:
@@ -121,4 +122,5 @@ test_files:
 - spec/flipper/api/v1/actions/groups_gate_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
 - spec/flipper/api_spec.rb