flipper-api 1.0.0.pre → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd719f6606e1372006f530832e5e1c696b4e1ddc206109d164bbc4982fa57f7b
-  data.tar.gz: 12344ed08ee934dd1040191650a19e4b5994a314c1181ff59afb2d6701fdefe3
+  metadata.gz: b25c0b97a02c78eb7c67cf2f4a2471f0c1ca3d6ac07fb1199f4e9b00fce15f82
+  data.tar.gz: 2c00025cbdb9d13b9b38e99b8ddc79786bc2c6f540d100d7ab5c8b3bfdc68234
 SHA512:
-  metadata.gz: 3ea2eb129be53a8a4af88a756707c7158c920ec961f9738278b5154846cfe6670d5faa858f15ad91040796193fdd3a121021262bd8d80471abb3412a8585a07e
-  data.tar.gz: 9c5e18723f54022a48168da92f76e80ef1582da000787e9605676a3ca6afd77247ad75ca456a83aa3fc310df4a92819efef3514fa6aa8eed2dc4dc0ea7f20c6e
+  metadata.gz: a2a0ab2da9e51ce266b5b25e782163891b3b3be0428642391cb1b32d81b707097c9a869583c630d737633a004b4d23fdc9e5a616202d1507bb0c1c47f3f95917
+  data.tar.gz: 57f01b47c7e7ca94a70222a35062e6ff58b1e0ebcc1b03f344bb8092431140feb0b7a4e106626be516f5538894b74b852ed85407f0263160a0d9bbe59aa2cc4e

data/lib/flipper/api/action.rb

@@ -19,6 +19,7 @@ module Flipper
       extend Forwardable
 
       VALID_REQUEST_METHOD_NAMES = Set.new([
+                                             'head'.freeze,
                                              'get'.freeze,
                                              'post'.freeze,
                                              'put'.freeze,
@@ -115,7 +116,7 @@ module Flipper
       def json_response(object, status = 200)
         header 'content-type', Api::CONTENT_TYPE
         status(status)
-        body = JSON.dump(object)
+        body = Typecast.to_json(object)
         halt [@code, @headers, [body]]
       end
 
@@ -147,8 +148,12 @@ module Flipper
       private
 
       # Private: Returns the request method converted to an action method.
+      # Converts head to get.
       def request_method_name
-        @request_method_name ||= @request.request_method.downcase
+        @request_method_name ||= begin
+          name = @request.request_method.downcase
+          name == "head" ? "get" : name
+        end
       end
 
       # Private: split request path by "/"

data/lib/flipper/api/error_response.rb

@@ -28,6 +28,7 @@ module Flipper
         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),
+        expression_invalid: Error.new(7, 'The provided expression was not valid.', 422),
       }.freeze
     end
   end

data/lib/flipper/api/json_params.rb

@@ -34,7 +34,8 @@ module Flipper
       # This method accomplishes similar functionality
       def update_params(env, data)
         return if data.empty?
-        parsed_request_body = JSON.parse(data)
+        parsed_request_body = Typecast.from_json(data)
+        env["parsed_request_body".freeze] = parsed_request_body
         parsed_query_string = parse_query(env[QUERY_STRING])
         parsed_query_string.merge!(parsed_request_body)
         parameters = build_query(parsed_query_string)

data/lib/flipper/api/middleware.rb

@@ -14,6 +14,7 @@ module Flipper
         @env_key = options.fetch(:env_key, 'flipper')
 
         @action_collection = ActionCollection.new
+        @action_collection.add Api::V1::Actions::ExpressionGate
         @action_collection.add Api::V1::Actions::PercentageOfTimeGate
         @action_collection.add Api::V1::Actions::PercentageOfActorsGate
         @action_collection.add Api::V1::Actions::ActorsGate

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

@@ -0,0 +1,43 @@
+require 'flipper/api/action'
+require 'flipper/api/v1/decorators/feature'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class ExpressionGate < Api::Action
+          include FeatureNameFromRoute
+
+          route %r{\A/features/(?<feature_name>.*)/expression/?\Z}
+
+          def post
+            feature = flipper[feature_name]
+
+            begin
+              expression = Flipper::Expression.build(expression_hash)
+              feature.enable_expression expression
+              decorated_feature = Decorators::Feature.new(feature)
+              json_response(decorated_feature.as_json, 200)
+            rescue NameError, ArgumentError => exception
+              json_error_response(:expression_invalid)
+            end
+          end
+
+          def delete
+            feature = flipper[feature_name]
+            feature.disable_expression
+
+            decorated_feature = Decorators::Feature.new(feature)
+            json_response(decorated_feature.as_json, 200)
+          end
+
+          private
+
+          def expression_hash
+            @expression_hash ||= request.env["parsed_request_body".freeze] || {}.freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,9 +25,12 @@ module Flipper
 
           private
 
+          # Set of types that should be represented as Array in JSON.
+          JSON_ARRAY_TYPES = Set[:set].freeze
+
           # json doesn't like sets
           def value_as_json
-            data_type == :set ? value.to_a : value
+            JSON_ARRAY_TYPES.include?(data_type) ? value.to_a : value
           end
         end
       end

data/lib/flipper/api.rb

@@ -12,6 +12,7 @@ module Flipper
       app = ->(_) { [404, { 'content-type'.freeze => CONTENT_TYPE }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
+      builder.use Rack::Head
       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,3 +1,3 @@
 module Flipper
-  VERSION = '1.0.0.pre'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/flipper/api/action_spec.rb

@@ -9,6 +9,10 @@ RSpec.describe Flipper::Api::Action do
         [200, {}, 'get']
       end
 
+      def head
+        [200, {}, 'head']
+      end
+
       def post
         [200, {}, 'post']
       end
@@ -38,6 +42,12 @@ RSpec.describe Flipper::Api::Action do
       expect(action.run).to eq([200, {}, 'get'])
     end
 
+    it 'will run head' do
+      fake_request = Struct.new(:request_method, :env, :session).new('HEAD', {}, {})
+      action = action_subclass.new(flipper, fake_request)
+      expect(action.run).to eq([200, {}, 'get'])
+    end
+
     it 'will run post' do
       fake_request = Struct.new(:request_method, :env, :session).new('POST', {}, {})
       action = action_subclass.new(flipper, fake_request)

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

@@ -0,0 +1,157 @@
+RSpec.describe Flipper::Api::V1::Actions::ExpressionGate do
+  let(:app) { build_api(flipper) }
+  let(:actor) {
+    Flipper::Actor.new('1', {
+      "plan" => "basic",
+      "age" => 21,
+    })
+  }
+  let(:expression) { Flipper.property(:plan).eq("basic") }
+
+  describe 'enable' do
+    before do
+      flipper[:my_feature].disable_expression
+      post '/features/my_feature/expression', JSON.dump(expression.value),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'enables feature for expression' do
+      expect(last_response.status).to eq(200)
+      expect(flipper[:my_feature].enabled?(actor)).to be_truthy
+      expect(flipper[:my_feature].enabled_gate_names).to eq([:expression])
+    end
+
+    it 'returns decorated feature with expression enabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to eq(expression.value)
+    end
+  end
+
+  describe 'disable' do
+    before do
+      flipper[:my_feature].enable_expression(expression)
+      delete '/features/my_feature/expression', JSON.dump({}),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'disables expression for feature' do
+      expect(last_response.status).to eq(200)
+      expect(flipper[:my_feature].enabled?(actor)).to be_falsy
+      expect(flipper[:my_feature].enabled_gate_names).to be_empty
+    end
+
+    it 'returns decorated feature with expression gate disabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to be(nil)
+    end
+  end
+
+  describe 'enable feature with slash in name' do
+    before do
+      flipper["my/feature"].disable_expression
+      post '/features/my/feature/expression', JSON.dump(expression.value),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'enables feature for expression' do
+      expect(last_response.status).to eq(200)
+      expect(flipper["my/feature"].enabled?(actor)).to be_truthy
+      expect(flipper["my/feature"].enabled_gate_names).to eq([:expression])
+    end
+
+    it 'returns decorated feature with expression enabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to eq(expression.value)
+    end
+  end
+
+  describe 'enable feature with space in name' do
+    before do
+      flipper["sp ace"].disable_expression
+      post '/features/sp%20ace/expression', JSON.dump(expression.value),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'enables feature for expression' do
+      expect(last_response.status).to eq(200)
+      expect(flipper["sp ace"].enabled?(actor)).to be_truthy
+      expect(flipper["sp ace"].enabled_gate_names).to eq([:expression])
+    end
+
+    it 'returns decorated feature with expression enabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to eq(expression.value)
+    end
+  end
+
+  describe 'enable with no data' do
+    before do
+      post '/features/my_feature/expression', "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'returns correct error response' do
+      expect(last_response.status).to eq(422)
+      expect(json_response).to eq(api_expression_invalid_response)
+    end
+  end
+
+  describe 'enable with empty object' do
+    before do
+      data = {}
+      post '/features/my_feature/expression', JSON.dump(data),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'returns correct error response' do
+      expect(last_response.status).to eq(422)
+      expect(json_response).to eq(api_expression_invalid_response)
+    end
+  end
+
+  describe 'enable with invalid data' do
+    before do
+      data = {"blah" => "blah"}
+      post '/features/my_feature/expression', JSON.dump(data),
+        "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'returns correct error response' do
+      expect(last_response.status).to eq(422)
+      expect(json_response).to eq(api_expression_invalid_response)
+    end
+  end
+
+  describe 'enable missing feature' do
+    before do
+      post '/features/my_feature/expression', JSON.dump(expression.value), "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'enables expression for feature' do
+      expect(last_response.status).to eq(200)
+      expect(flipper[:my_feature].enabled?(actor)).to be_truthy
+      expect(flipper[:my_feature].enabled_gate_names).to eq([:expression])
+    end
+
+    it 'returns decorated feature with expression enabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to eq(expression.value)
+    end
+  end
+
+  describe 'disable missing feature' do
+    before do
+      delete '/features/my_feature/expression', "CONTENT_TYPE" => "application/json"
+    end
+
+    it 'disables expression for feature' do
+      expect(last_response.status).to eq(200)
+      expect(flipper[:my_feature].enabled?(actor)).to be_falsy
+      expect(flipper[:my_feature].enabled_gate_names).to be_empty
+    end
+
+    it 'returns decorated feature with expression gate disabled' do
+      gate = json_response['gates'].find { |gate| gate['key'] == 'expression' }
+      expect(gate['value']).to be(nil)
+    end
+  end
+end

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

@@ -20,6 +20,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => 'true',
             },
+            {
+              'key' => 'expression',
+              'name' => 'expression',
+              'value' => nil,
+            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -64,6 +69,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => nil,
             },
+            {
+              'key' => 'expression',
+              'name' => 'expression',
+              'value' => nil,
+            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -124,6 +134,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => 'true',
             },
+            {
+              'key' => 'expression',
+              'name' => 'expression',
+              'value' => nil,
+            },
             {
               'key' => 'actors',
               'name' => 'actor',
@@ -168,6 +183,11 @@ RSpec.describe Flipper::Api::V1::Actions::Feature do
               'name' => 'boolean',
               'value' => 'true',
             },
+            {
+              'key' => 'expression',
+              'name' => 'expression',
+              'value' => nil,
+            },
             {
               'key' => 'actors',
               'name' => 'actor',

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

@@ -24,6 +24,11 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
                   'name' => 'boolean',
                   'value' => 'true',
                 },
+                {
+                  'key' => 'expression',
+                  'name' => 'expression',
+                  'value' => nil,
+                },
                 {
                   'key' => 'actors',
                   'name' => 'actor',
@@ -60,6 +65,7 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
               'state' => 'on',
               'gates' => [
                 { 'key' => 'boolean', 'value' => 'true'},
+                {"key" => "expression", "value" => nil},
                 { 'key' => 'actors', 'value' => ['10']},
                 {'key' => 'percentage_of_actors', 'value' => nil},
                 { 'key' => 'percentage_of_time', 'value' => nil},
@@ -140,6 +146,11 @@ RSpec.describe Flipper::Api::V1::Actions::Features do
               'name' => 'boolean',
               'value' => nil,
             },
+            {
+              'key' => 'expression',
+              'name' => 'expression',
+              'value' => nil,
+            },
             {
               'key' => 'actors',
               'name' => 'actor',

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

@@ -2,6 +2,8 @@ RSpec.describe Flipper::Api::V1::Actions::Import do
   let(:app) { build_api(flipper) }
 
   describe 'post' do
+    let(:expression) { Flipper.property(:plan).eq("basic") }
+
     context 'succesful request' do
       before do
         flipper.enable(:search)
@@ -10,6 +12,7 @@ RSpec.describe Flipper::Api::V1::Actions::Import do
         source_flipper = build_flipper
         source_flipper.disable(:search)
         source_flipper.enable_actor(:google_analytics, Flipper::Actor.new("User;1"))
+        source_flipper.enable(:analytics, expression)
 
         export = source_flipper.export
 
@@ -23,7 +26,8 @@ RSpec.describe Flipper::Api::V1::Actions::Import do
       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"])
+        expect(flipper[:analytics].expression_value).to eq(expression.value)
+        expect(flipper.features.map(&:key)).to eq(["search", "google_analytics", "analytics"])
       end
     end
 

data/spec/flipper/api_spec.rb

@@ -14,6 +14,20 @@ RSpec.describe Flipper::Api do
     end
   end
 
+  describe "Head requests" do
+    let(:app) { build_api(flipper) }
+
+    it "are allowed but perform get and return no body" do
+      flipper.enable :a
+      flipper.disable :b
+
+      head '/features'
+
+      expect(last_response.status).to be(200)
+      expect(last_response.body).to be_empty
+    end
+  end
+
   describe 'Initializing middleware lazily with a block' do
     let(:app) { build_api(-> { flipper }) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.1.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre
+        version: 1.1.0
 description:
 email: support@flippercloud.io
 executables: []
@@ -63,6 +63,7 @@ files:
 - lib/flipper/api/v1/actions/actors_gate.rb
 - lib/flipper/api/v1/actions/boolean_gate.rb
 - lib/flipper/api/v1/actions/clear_feature.rb
+- lib/flipper/api/v1/actions/expression_gate.rb
 - lib/flipper/api/v1/actions/feature.rb
 - lib/flipper/api/v1/actions/features.rb
 - lib/flipper/api/v1/actions/groups_gate.rb
@@ -79,6 +80,7 @@ files:
 - spec/flipper/api/v1/actions/actors_spec.rb
 - spec/flipper/api/v1/actions/boolean_gate_spec.rb
 - spec/flipper/api/v1/actions/clear_feature_spec.rb
+- spec/flipper/api/v1/actions/expression_gate_spec.rb
 - 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
@@ -93,9 +95,9 @@ licenses:
 metadata:
   documentation_uri: https://www.flippercloud.io/docs
   homepage_uri: https://www.flippercloud.io
-  source_code_uri: https://github.com/jnunemaker/flipper
-  bug_tracker_uri: https://github.com/jnunemaker/flipper/issues
-  changelog_uri: https://github.com/jnunemaker/flipper/blob/main/Changelog.md
+  source_code_uri: https://github.com/flippercloud/flipper
+  bug_tracker_uri: https://github.com/flippercloud/flipper/issues
+  changelog_uri: https://github.com/flippercloud/flipper/blob/main/Changelog.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -107,11 +109,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: API for the Flipper gem
@@ -122,6 +124,7 @@ test_files:
 - spec/flipper/api/v1/actions/actors_spec.rb
 - spec/flipper/api/v1/actions/boolean_gate_spec.rb
 - spec/flipper/api/v1/actions/clear_feature_spec.rb
+- spec/flipper/api/v1/actions/expression_gate_spec.rb
 - 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