flipper-api 0.24.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee54a1b8dbd6fbe6c8569970b9b2c25dfabef58f024ca0b2848717a703b17600
-  data.tar.gz: 63f01695a63096f006332632f8d6d6d982338a70bdd577c214b15b790074aea4
+  metadata.gz: 463722a6c76397e004716c02360817a52d22dafda409d5508ec93355783d2f87
+  data.tar.gz: c2b457498c463653f8ca0fcf0baf0e118d4c0941316294d0bcf12cc91b90d958
 SHA512:
-  metadata.gz: 760626f78c88eacc21d3d9e672f82449678bd57014c99f949539d3b4fae0202e7e774df0992118aa2b6d6d3d9bf79883c8558c872356ad1d08d7370d49e008b7
-  data.tar.gz: f386ad25a8911ce18b7560cd77aed907cc2bd50ae27d05b778058e013d8b3ab68cb6b38919a210baf0c1abd429fd9a57ed44a674c91079415ced685f1b064b43
+  metadata.gz: 7faf36080060780258a8a979fc206a9cdb9ae69df3b3231b30f9b156cb12130f6d7a7ae82fb7d965a578a66d4415bbd649a2b3e67f93073df089c15dcf2548a3
+  data.tar.gz: 24ea9e61bb8cda87d3efa602bfacfae9f9d63d9db7b75e7955d7ac8a5afed17a9694f4868c4dd9c7639c02b02928490dfdd67730e81a25fdc368e7eb17721ebc

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.24.0'.freeze
+  VERSION = '0.25.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.24.0
+  version: 0.25.1
 platform: ruby
 authors:
 - John Nunemaker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-17 00:00:00.000000000 Z
+date: 2022-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,15 +36,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.24.0
-description: 
+        version: 0.25.1
+description:
 email:
 - nunemaker@gmail.com
 executables: []
@@ -84,13 +84,14 @@ 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:
 - MIT
 metadata:
   changelog_uri: https://github.com/jnunemaker/flipper/blob/master/Changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +106,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: API for the Flipper gem
 test_files:
@@ -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