flipper-api 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05240b6a191849388e613ed9bfdb792eb2b61a0a45bdd4479dfc5bfad0969d2e
-  data.tar.gz: 245d149acf46f28f00a784d6f0426be07ae1f37210d701c5f9988d244df2a42f
+  metadata.gz: d014ef4a99c27600bb19bd9231a005a3a5477e4efb283e74fbe62284d5fdcc63
+  data.tar.gz: ffa42821a2aa597813120a860af7a30c5e6635295d90b0d55305787a37bfc813
 SHA512:
-  metadata.gz: 42be6c946efeb2824240035f9a6bb4c19f577cf37d291cfd2e5a2fb9605de6bc2edb15e07a0fa00b74c4680022682f2bd0686b98e52b55b440a4b2b2c32a5ad1
-  data.tar.gz: c7918dbf6548e111095b1a812e57743a7e72bd4d8ac1ceeae0109c90d0c23db5ae73059dc2871fc752343d3c7f9bae1e52107e3703a19f84348c30f20ae12b3a
+  metadata.gz: 6d668398310b33bf227a0094017ec02e05c153f3de6f9e2d4ceb586a4c35c5ab5a414a9514b5e62b98eddad2694afb321e7bd76e956c24c132c382f17254cb6c
+  data.tar.gz: 52cfa115308d2fe0ab014136897b2bc40900416fd089f900ecae0650467187ba0b14bbf05b21906dd4565e9ec1e4365b7192d171922c27bc794fa8972a5827c3

data/lib/flipper/api/json_params.rb

@@ -12,6 +12,7 @@ module Flipper
       CONTENT_TYPE = 'CONTENT_TYPE'.freeze
       QUERY_STRING = 'QUERY_STRING'.freeze
       REQUEST_BODY = 'rack.input'.freeze
+      REWIND_BODY = Gem::Version.new(Rack.release) < Gem::Version.new('3.0.0')
 
       # Public: Merge request body params with query string params
       # This way can access all params with Rack::Request#params
@@ -21,7 +22,7 @@ module Flipper
       def call(env)
         if env[CONTENT_TYPE] == 'application/json'
           body = env[REQUEST_BODY].read
-          env[REQUEST_BODY].rewind
+          env[REQUEST_BODY].rewind if REWIND_BODY
           update_params(env, body)
         end
         @app.call(env)

data/lib/flipper/api/middleware.rb

@@ -34,6 +34,8 @@ module Flipper
       def call!(env)
         request = Rack::Request.new(env)
         action_class = @action_collection.action_for_request(request)
+        env["flipper.action_class"] = action_class
+        env["flipper.action_method"] = request.request_method.downcase
 
         if action_class.nil?
           @app.call(env)

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

@@ -10,8 +10,11 @@ module Flipper
           route %r{\A/import/?\Z}
 
           def post
+            # Rack 3 changed the requirement to rewind the body, so we can't assume it is rewound,
+            # so rewind before under Rack 3+ and after under Rack 2.
+            request.body.rewind if Gem::Version.new(Rack.release) >= Gem::Version.new('3.0.0')
             body = request.body.read
-            request.body.rewind
+            request.body.rewind if Gem::Version.new(Rack.release) < Gem::Version.new('3.0.0')
             export = Flipper::Exporters::Json::Export.new(contents: body)
             flipper.import(export)
             json_response({}, 204)

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

@@ -1,3 +1,5 @@
+require 'delegate'
+
 module Flipper
   module Api
     module V1

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

@@ -1,24 +1,24 @@
-require 'delegate'
 require 'flipper/api/v1/decorators/gate'
 
 module Flipper
   module Api
     module V1
       module Decorators
-        class Feature < SimpleDelegator
-          # Public: The feature being decorated.
-          alias_method :feature, :__getobj__
+        class Feature
+          def initialize(feature)
+            @feature = feature
+          end
 
           # Public: Returns instance as hash that is ready to be json dumped.
           def as_json(exclude_gates: false, exclude_gate_names: false)
             result = {
-              'key' => key,
-              'state' => state.to_s,
+              'key' => @feature.key,
+              'state' => @feature.state.to_s,
             }
 
             unless exclude_gates
-              gate_values = feature.adapter.get(self)
-              result['gates'] = gates.map do |gate|
+              gate_values = @feature.adapter.get(@feature)
+              result['gates'] = @feature.gates.map do |gate|
                 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

@@ -2,24 +2,18 @@ module Flipper
   module Api
     module V1
       module Decorators
-        class Gate < SimpleDelegator
-          # Public the gate being decorated
-          alias_method :gate, :__getobj__
-
-          # Public: the value for the gate from the adapter.
-          attr_reader :value
-
+        class Gate
           def initialize(gate, value = nil)
-            super gate
+            @gate = gate
             @value = value
           end
 
           def as_json(exclude_name: false)
             as_json = {
-              'key' => gate.key.to_s,
+              'key' => @gate.key.to_s,
               'value' => value_as_json,
             }
-            as_json['name'] = gate.name.to_s unless exclude_name
+            as_json['name'] = @gate.name.to_s unless exclude_name
             as_json
           end
 
@@ -30,7 +24,7 @@ module Flipper
 
           # json doesn't like sets
           def value_as_json
-            JSON_ARRAY_TYPES.include?(data_type) ? value.to_a : value
+            JSON_ARRAY_TYPES.include?(@gate.data_type) ? @value.to_a : @value
           end
         end
       end

data/lib/flipper/api.rb

@@ -9,11 +9,15 @@ module Flipper
 
     def self.app(flipper = nil, options = {})
       env_key = options.fetch(:env_key, 'flipper')
+      use_rewindable_middleware = options.fetch(:use_rewindable_middleware) {
+        Gem::Version.new(Rack.release) >= Gem::Version.new('3.0.0')
+      }
       app = ->(_) { [404, { Rack::CONTENT_TYPE => CONTENT_TYPE }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
       builder.use Rack::Head
       builder.use Rack::Deflater
+      builder.use Rack::RewindableInput::Middleware if use_rewindable_middleware
       builder.use Flipper::Api::JsonParams
       builder.use Flipper::Middleware::SetupEnv, flipper, env_key: env_key
       builder.use Flipper::Api::Middleware, env_key: env_key

data/lib/flipper/version.rb

@@ -1,5 +1,5 @@
 module Flipper
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.3.0'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/spec/flipper/api_spec.rb

@@ -8,6 +8,9 @@ RSpec.describe Flipper::Api do
 
       get '/features'
 
+      expect(last_request.env["flipper.action_class"]).to eq(Flipper::Api::V1::Actions::Features)
+      expect(last_request.env["flipper.action_method"]).to eq("get")
+
       expect(last_response.status).to be(200)
       feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
       expect(feature_names).to eq(%w(a b))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
 description:
 email: support@flippercloud.io
 executables: []
@@ -97,7 +97,7 @@ metadata:
   homepage_uri: https://www.flippercloud.io
   source_code_uri: https://github.com/flippercloud/flipper
   bug_tracker_uri: https://github.com/flippercloud/flipper/issues
-  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.2.2
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.0
 post_install_message:
 rdoc_options: []
 require_paths: