flipper-api 0.23.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88c8fcf2cad7d28ac9a1c968cb4afa798006f34aef33ee0fbf4c47da64275e8
-  data.tar.gz: 5395ef9526ad46564c569d2fdc0f0f58376f5a4956fdb2929c9454b6e3e4d26e
+  metadata.gz: 498a3561809183d8cfdc15aa77c221e80578e220de9b97365df9645ad61e47dc
+  data.tar.gz: f4755ea4711c5f4220203d67eaa0518e6f2365a069dc9302cfaac2c48ed5b927
 SHA512:
-  metadata.gz: d5eb1d1990347809c8383465585ba4926bb622c600870bd382bab3341028202e372311f63fd39f18b506172913e5b3ca7a93f456bfe9438e001da67efe9c5f36
-  data.tar.gz: 31316d4c9e04cf706ace8290733102c313053e571c497a4eac5a9bddbb32367dc60ca9a75d6e25245604ce6b7c983b84c9e00bc1fda9219031b1749b7e2561c8
+  metadata.gz: dcc285c9297786310f91250503b37e521accb20c67cdab671326824bcad5ea870fc0e89b6828e57adfb9a7189be592908cb70e20aed014d4d2862fa5e8e31962
+  data.tar.gz: 4721e66c96afb93ace4361cc4955b731ab246d7d37a2432ef7d392a8ac738202950f60ca9dd25e3cd1b14d2ffd4ea5f44524ac2e1877e3000d0957d3ee9d7cdc

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.0'.freeze
+  VERSION = '0.24.1'.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.0
+  version: 0.24.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-04-13 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.0
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.1
 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