flipper-api 0.10.2 → 0.11.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2930a9c3ee15cd28f92ef28ecb97c05e104d1721
-  data.tar.gz: 5495a6703ebc072e1f246c69fe9d9b11c811e93d
+  metadata.gz: c14f137259ca4f58e82fa3ed35b32dd1f0375cb3
+  data.tar.gz: 6ed6d5173f602c198cc7b41e7cc2ac72c9fac096
 SHA512:
-  metadata.gz: fd8d1afb98c55d9a52b3bc640092234ca70c4531afad457701ea2d6c7702c88d61f2d71c4af35481a238d1d9ee990f39b6e23d47bbe02aeb6a26d368b3c1c4cf
-  data.tar.gz: fbfbd9c149177299f004516ce65f6775891c266d7effb923c07af8a660604da1912720af3b39e0103818d65173b79d8fbeccd6ce636bef70c733b410fadee902
+  metadata.gz: ffaf1fefc28654784568f600a17f0506a4d0833e4de153aedf89ced7b06613d6a9b7468d400afbdeabf762fd26ca50128140301abeb0e06df1c25c5ed3ef1b0e
+  data.tar.gz: 419c2e26875d8973e7c37d8e1258f1fed26809b1d8798cb692d468f79b5de51599ef57205b4309401198e8bd211d891ddaeb6ed244ecdeae6997883c1d4880e0

data/flipper-api.gemspec

@@ -1,21 +1,21 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
 
-flipper_api_files = lambda { |file|
-  file =~ /(flipper)[\/-]api/
-}
+flipper_api_files = lambda do |file|
+  file =~ %r{(flipper)[\/-]api}
+end
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["John Nunemaker"]
-  gem.email         = ["nunemaker@gmail.com"]
-  gem.summary       = "API for the Flipper gem"
-  gem.description   = "Rack middleware that provides an API for the flipper gem."
-  gem.license       = "MIT"
-  gem.homepage      = "https://github.com/jnunemaker/flipper"
-  gem.files         = `git ls-files`.split("\n").select(&flipper_api_files) + ["lib/flipper/version.rb"]
+  gem.authors       = ['John Nunemaker']
+  gem.email         = ['nunemaker@gmail.com']
+  gem.summary       = 'API for the Flipper gem'
+  gem.description   = 'Rack middleware that provides an API for the flipper gem.'
+  gem.license       = 'MIT'
+  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+  gem.files         = `git ls-files`.split("\n").select(&flipper_api_files) + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_api_files)
-  gem.name          = "flipper-api"
-  gem.require_paths = ["lib"]
+  gem.name          = 'flipper-api'
+  gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
 
   gem.add_dependency 'rack', '>= 1.4', '< 3'

data/lib/flipper/api/action.rb

@@ -9,11 +9,11 @@ module Flipper
       extend Forwardable
 
       VALID_REQUEST_METHOD_NAMES = Set.new([
-        "get".freeze,
-        "post".freeze,
-        "put".freeze,
-        "delete".freeze,
-      ]).freeze
+                                             'get'.freeze,
+                                             'post'.freeze,
+                                             'put'.freeze,
+                                             'delete'.freeze,
+                                           ]).freeze
 
       # Public: Call this in subclasses so the action knows its route.
       #
@@ -50,9 +50,10 @@ module Flipper
       def_delegator :@request, :params
 
       def initialize(flipper, request)
-        @flipper, @request = flipper, request
+        @flipper = flipper
+        @request = request
         @code = 200
-        @headers = {"Content-Type" => Api::CONTENT_TYPE }
+        @headers = { 'Content-Type' => Api::CONTENT_TYPE }
       end
 
       # Public: Runs the request method for the provided request.
@@ -62,7 +63,8 @@ module Flipper
         if valid_request_method? && respond_to?(request_method_name)
           catch(:halt) { send(request_method_name) }
         else
-          raise Api::RequestMethodNotSupported, "#{self.class} does not support request method #{request_method_name.inspect}"
+          raise Api::RequestMethodNotSupported,
+                "#{self.class} does not support request method #{request_method_name.inspect}"
         end
       end
 
@@ -135,9 +137,9 @@ module Flipper
       end
 
       # Private: split request path by "/"
-      # Example: "api/v1/features/feature_name" => ['api', 'v1', 'features', 'feature_name']
+      # Example: "features/feature_name" => ['features', 'feature_name']
       def path_parts
-        @request.path.split("/")
+        @request.path.split('/')
       end
 
       def valid_request_method?

data/lib/flipper/api/action_collection.rb

@@ -10,9 +10,9 @@ module Flipper
       end
 
       def action_for_request(request)
-        @action_classes.detect { |action_class|
+        @action_classes.detect do |action_class|
           request.path_info =~ action_class.regex
-        }
+        end
       end
     end
   end

data/lib/flipper/api/error_response.rb

@@ -7,7 +7,8 @@ module Flipper
         def initialize(code, message, http_status)
           @code = code
           @message = message
-          @more_info = "https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference"
+          @more_info =
+            'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference'
           @http_status = http_status
         end
 
@@ -21,13 +22,13 @@ module Flipper
       end
 
       ERRORS = {
-        feature_not_found: Error.new(1, "Feature not found.", 404),
-        group_not_registered: Error.new(2, "Group not registered.", 404),
-        percentage_invalid: Error.new(3, "Percentage must be a positive number less than or equal to 100.", 422),
-        flipper_id_invalid: Error.new(4, "Required parameter flipper_id is missing.", 422),
-        name_invalid: Error.new(5, "Required parameter name is missing.", 422),
-      }
-
+        feature_not_found: Error.new(1, 'Feature not found.', 404),
+        group_not_registered: Error.new(2, 'Group not registered.', 404),
+        percentage_invalid:
+          Error.new(3, 'Percentage must be a positive number less than or equal to 100.', 422),
+        flipper_id_invalid: Error.new(4, 'Required parameter flipper_id is missing.', 422),
+        name_invalid: Error.new(5, 'Required parameter name is missing.', 422),
+      }.freeze
     end
   end
 end

data/lib/flipper/api/json_params.rb

@@ -0,0 +1,45 @@
+require 'rack/utils'
+
+module Flipper
+  module Api
+    class JsonParams
+      include Rack::Utils
+
+      def initialize(app)
+        @app = app
+      end
+
+      CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+      QUERY_STRING = 'QUERY_STRING'.freeze
+      REQUEST_BODY = 'rack.input'.freeze
+
+      # Public: Merge request body params with query string params
+      # This way can access all params with Rack::Request#params
+      # Rack does not add application/json params to Rack::Request#params
+      # Allows app to handle x-www-url-form-encoded / application/json request
+      # parameters the same way
+      def call(env)
+        if env[CONTENT_TYPE] == 'application/json'
+          body = env[REQUEST_BODY].read
+          env[REQUEST_BODY].rewind
+          update_params(env, body)
+        end
+        @app.call(env)
+      end
+
+      private
+
+      # Rails 3.2.2.1 Rack version does not have Rack::Request#update_param
+      # Rack 1.5.0 adds update_param
+      # This method accomplishes similar functionality
+      def update_params(env, data)
+        return if data.empty?
+        parsed_request_body = JSON.parse(data)
+        parsed_query_string = parse_query(env[QUERY_STRING])
+        parsed_query_string.merge!(parsed_request_body)
+        parameters = build_query(parsed_query_string)
+        env[QUERY_STRING] = parameters
+      end
+    end
+  end
+end

data/lib/flipper/api/middleware.rb

@@ -9,45 +9,20 @@ end
 module Flipper
   module Api
     class Middleware
-      # Public: Initializes an instance of the API middleware.
-      #
-      # app - The app this middleware is included in.
-      # flipper_or_block - The Flipper::DSL instance or a block that yields a
-      #                    Flipper::DSL instance to use for all operations.
-      #
-      # Examples
-      #
-      #   flipper = Flipper.new(...)
-      #
-      #   # using with a normal flipper instance
-      #   use Flipper::Api::Middleware, flipper
-      #
-      #   # using with a block that yields a flipper instance
-      #   use Flipper::Api::Middleware, lambda { Flipper.new(...) }
-      #
-      def initialize(app, flipper_or_block)
+      def initialize(app)
         @app = app
 
-        if flipper_or_block.respond_to?(:call)
-          @flipper_block = flipper_or_block
-        else
-          @flipper = flipper_or_block
-        end
-
         @action_collection = ActionCollection.new
         @action_collection.add Api::V1::Actions::PercentageOfTimeGate
         @action_collection.add Api::V1::Actions::PercentageOfActorsGate
         @action_collection.add Api::V1::Actions::ActorsGate
         @action_collection.add Api::V1::Actions::GroupsGate
         @action_collection.add Api::V1::Actions::BooleanGate
+        @action_collection.add Api::V1::Actions::ClearFeature
         @action_collection.add Api::V1::Actions::Feature
         @action_collection.add Api::V1::Actions::Features
       end
 
-      def flipper
-        @flipper ||= @flipper_block.call
-      end
-
       def call(env)
         dup.call!(env)
       end
@@ -56,9 +31,9 @@ module Flipper
         request = Rack::Request.new(env)
         action_class = @action_collection.action_for_request(request)
         if action_class.nil?
-          @app.status = 404
           @app.call(env)
         else
+          flipper = env.fetch('flipper')
           action_class.run(flipper, request)
         end
       end

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

@@ -6,7 +6,7 @@ module Flipper
     module V1
       module Actions
         class ActorsGate < Api::Action
-          route %r{api/v1/features/[^/]*/actors/?\Z}
+          route %r{features/[^/]*/actors/?\Z}
 
           def post
             ensure_valid_params
@@ -29,10 +29,6 @@ module Flipper
           private
 
           def ensure_valid_params
-            unless feature_names.include?(feature_name)
-              json_error_response(:feature_not_found)
-            end
-
             json_error_response(:flipper_id_invalid) if flipper_id.nil?
           end
 
@@ -43,10 +39,6 @@ module Flipper
           def flipper_id
             @flipper_id ||= params['flipper_id']
           end
-
-          def feature_names
-            @feature_names ||= flipper.adapter.features
-          end
         end
       end
     end

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

@@ -6,7 +6,7 @@ module Flipper
     module V1
       module Actions
         class BooleanGate < Api::Action
-          route %r{api/v1/features/[^/]*/boolean/?\Z}
+          route %r{features/[^/]*/boolean/?\Z}
 
           def post
             feature_name = Rack::Utils.unescape(path_parts[-2])

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

@@ -0,0 +1,21 @@
+require 'flipper/api/action'
+require 'flipper/api/v1/decorators/feature'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class ClearFeature < Api::Action
+          route %r{features/[^/]*/clear/?\Z}
+
+          def delete
+            feature_name = Rack::Utils.unescape(path_parts[-2])
+            feature = flipper[feature_name]
+            flipper.adapter.clear(feature)
+            json_response({}, 204)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,25 +6,17 @@ module Flipper
     module V1
       module Actions
         class Feature < Api::Action
-
-          route %r{api/v1/features/[^/]*/?\Z}
+          route %r{features/[^/]*/?\Z}
 
           def get
-            if feature_names.include?(feature_name)
-              feature = Decorators::Feature.new(flipper[feature_name])
-              json_response(feature.as_json)
-            else
-              json_error_response(:feature_not_found)
-            end
+            return json_error_response(:feature_not_found) unless feature_exists?(feature_name)
+            feature = Decorators::Feature.new(flipper[feature_name])
+            json_response(feature.as_json)
           end
 
           def delete
-            if feature_names.include?(feature_name)
-              flipper.remove(feature_name)
-              json_response({}, 204)
-            else
-              json_error_response(:feature_not_found)
-            end
+            flipper.remove(feature_name)
+            json_response({}, 204)
           end
 
           private
@@ -33,8 +25,8 @@ module Flipper
             @feature_name ||= Rack::Utils.unescape(path_parts.last)
           end
 
-          def feature_names
-            @feature_names ||= flipper.adapter.features
+          def feature_exists?(feature_name)
+            flipper.features.map(&:key).include?(feature_name)
           end
         end
       end

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

@@ -1,23 +1,35 @@
 require 'flipper/api/action'
 require 'flipper/api/v1/decorators/feature'
-require 'json'
 
 module Flipper
   module Api
     module V1
       module Actions
         class Features < Api::Action
-
-          route %r{api/v1/features\Z}
+          route(/features\Z/)
 
           def get
-            features = flipper.features.map { |feature|
+            keys = params['keys']
+            features = if keys
+                         names = keys.split(',')
+                         if names.empty?
+                           []
+                         else
+                           existing_feature_names = names.keep_if do |feature_name|
+                             feature_exists?(feature_name)
+                           end
+
+                           flipper.preload(existing_feature_names)
+                         end
+                       else
+                         flipper.features
+                       end
+
+            decorated_features = features.map do |feature|
               Decorators::Feature.new(feature).as_json
-            }
+            end
 
-            json_response({
-              features: features
-            })
+            json_response(features: decorated_features)
           end
 
           def post
@@ -27,6 +39,12 @@ module Flipper
             decorated_feature = Decorators::Feature.new(feature)
             json_response(decorated_feature.as_json, 200)
           end
+
+          private
+
+          def feature_exists?(feature_name)
+            flipper.features.map(&:key).include?(feature_name)
+          end
         end
       end
     end

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

@@ -6,7 +6,7 @@ module Flipper
     module V1
       module Actions
         class GroupsGate < Api::Action
-          route %r{api/v1/features/[^/]*/groups/?\Z}
+          route %r{features/[^/]*/groups/?\Z}
 
           def post
             ensure_valid_params
@@ -27,8 +27,23 @@ module Flipper
           private
 
           def ensure_valid_params
-            json_error_response(:feature_not_found) unless feature_names.include?(feature_name)
-            json_error_response(:group_not_registered) unless Flipper.group_exists?(group_name)
+            if group_name.nil? || group_name.empty?
+              json_error_response(:name_invalid)
+            end
+
+            return if allow_unregistered_groups?
+            return if Flipper.group_exists?(group_name)
+
+            json_error_response(:group_not_registered)
+          end
+
+          def allow_unregistered_groups?
+            allow_unregistered_groups = params['allow_unregistered_groups']
+            allow_unregistered_groups && allow_unregistered_groups == 'true'
+          end
+
+          def disallow_unregistered_groups?
+            !allow_unregistered_groups?
           end
 
           def feature_name
@@ -38,10 +53,6 @@ module Flipper
           def group_name
             @group_name ||= params['name']
           end
-
-          def feature_names
-            @feature_names ||= flipper.adapter.features
-          end
         end
       end
     end

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

@@ -6,10 +6,13 @@ module Flipper
     module V1
       module Actions
         class PercentageOfActorsGate < Api::Action
-          route %r{api/v1/features/[^/]*/percentage_of_actors/?\Z}
+          route %r{features/[^/]*/percentage_of_actors/?\Z}
 
           def post
-            ensure_valid_enable_params
+            if percentage < 0 || percentage > 100
+              json_error_response(:percentage_invalid)
+            end
+
             feature = flipper[feature_name]
             feature.enable_percentage_of_actors(percentage)
             decorated_feature = Decorators::Feature.new(feature)
@@ -17,7 +20,6 @@ module Flipper
           end
 
           def delete
-            ensure_valid_disable_params
             feature = flipper[feature_name]
             feature.disable_percentage_of_actors
             decorated_feature = Decorators::Feature.new(feature)
@@ -26,22 +28,6 @@ module Flipper
 
           private
 
-          def ensure_valid_enable_params
-            unless feature_names.include?(feature_name)
-              json_error_response(:feature_not_found)
-            end
-
-            if percentage < 0 || percentage > 100
-              json_error_response(:percentage_invalid)
-            end
-          end
-
-          def ensure_valid_disable_params
-            unless feature_names.include?(feature_name)
-              json_error_response(:feature_not_found)
-            end
-          end
-
           def feature_name
             @feature_name ||= Rack::Utils.unescape(path_parts[-2])
           end
@@ -53,12 +39,8 @@ module Flipper
               -1
             end
           end
-
-            def feature_names
-              @feature_names ||= flipper.adapter.features
-            end
-          end
         end
       end
     end
   end
+end

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

@@ -6,10 +6,13 @@ module Flipper
     module V1
       module Actions
         class PercentageOfTimeGate < Api::Action
-          route %r{api/v1/features/[^/]*/percentage_of_time/?\Z}
+          route %r{features/[^/]*/percentage_of_time/?\Z}
 
           def post
-            ensure_valid_enable_params
+            if percentage < 0 || percentage > 100
+              json_error_response(:percentage_invalid)
+            end
+
             feature = flipper[feature_name]
             feature.enable_percentage_of_time(percentage)
             decorated_feature = Decorators::Feature.new(feature)
@@ -17,31 +20,15 @@ module Flipper
           end
 
           def delete
-            ensure_valid_disable_params
             feature = flipper[feature_name]
             feature.disable_percentage_of_time
+
             decorated_feature = Decorators::Feature.new(feature)
             json_response(decorated_feature.as_json, 200)
           end
 
           private
 
-          def ensure_valid_enable_params
-            unless feature_names.include?(feature_name)
-              json_error_response(:feature_not_found)
-            end
-
-            if percentage < 0 || percentage > 100
-              json_error_response(:percentage_invalid)
-            end
-          end
-
-          def ensure_valid_disable_params
-            unless feature_names.include?(feature_name)
-              json_error_response(:feature_not_found)
-            end
-          end
-
           def feature_name
             @feature_name ||= Rack::Utils.unescape(path_parts[-2])
           end
@@ -53,10 +40,6 @@ module Flipper
               -1
             end
           end
-
-          def feature_names
-            @feature_names ||= flipper.adapter.features
-          end
         end
       end
     end

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

@@ -6,19 +6,18 @@ module Flipper
     module V1
       module Decorators
         class Feature < SimpleDelegator
-
           # Public: The feature being decorated.
           alias_method :feature, :__getobj__
 
           # Public: Returns instance as hash that is ready to be json dumped.
           def as_json
-            gate_values = feature.gate_values
+            gate_values = feature.adapter.get(self)
             {
               'key' => key,
               'state' => state.to_s,
-              'gates' => gates.map { |gate|
+              'gates' => gates.map do |gate|
                 Decorators::Gate.new(gate, gate_values[gate.key]).as_json
-              },
+              end,
             }
           end
         end

data/lib/flipper/api.rb

@@ -1,43 +1,27 @@
 require 'rack'
 require 'flipper'
+require 'flipper/middleware/setup_env'
+require 'flipper/middleware/memoizer'
 require 'flipper/api/middleware'
+require 'flipper/api/json_params'
 require 'flipper/api/actor'
 
 module Flipper
   module Api
     CONTENT_TYPE = 'application/json'.freeze
 
-    def self.app(flipper)
-      app = App.new(200,{ 'Content-Type' => CONTENT_TYPE }, [''])
+    def self.app(flipper = nil)
+      app = ->(_) { [404, { 'Content-Type'.freeze => CONTENT_TYPE }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
-      builder.use Flipper::Api::Middleware, flipper
+      builder.use Flipper::Middleware::SetupEnv, flipper
+      builder.use Flipper::Middleware::Memoizer
+      builder.use Flipper::Api::JsonParams
+      builder.use Flipper::Api::Middleware
       builder.run app
+      klass = self
+      builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
       builder
     end
-
-    class App
-      # Public: HTTP response code
-      # Use this method to update status code before responding
-      attr_writer :status
-
-      def initialize(status, headers, body)
-        @status = status
-        @headers = headers
-        @body = body
-      end
-
-      # Public : Rack expects object that responds to call
-      # env - environment hash
-      def call(env)
-        response
-      end
-
-      private
-
-      def response
-        [@status, @headers, @body]
-      end
-    end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = "0.10.2".freeze
+  VERSION = '0.11.0.beta1'.freeze
 end