flipper-api 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 197876b4a2596f886d53e8201fece30624ba53c0
+  data.tar.gz: ff6181dddff5fe04923d61d0e591650b95bc3654
+SHA512:
+  metadata.gz: 9b4827eee0a212add12f181b1d8d83fb4da8b00d243e4d70bbaa3199cc0de4a4e4a71ea904839f5221c3a8b582f1ae1213e22745718c94d0a2de1784f14a3079
+  data.tar.gz: 920d154ee0c38d1394c6e3c0274b0d7cd711e32456d6824488959c2cf95caf4fe929b27490f8228219e889931ec9af622a0ad5e0ad2a5882b65be863667283a6

data/flipper-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+
+flipper_api_files = lambda { |file|
+  file =~ /(flipper)[\/-]api/
+}
+
+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.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_api_files)
+  gem.name          = "flipper-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Flipper::VERSION
+
+  gem.add_dependency 'rack', '>= 1.4', '< 3'
+  gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+end

data/lib/flipper/api/action.rb

@@ -0,0 +1,116 @@
+module Flipper
+  module Api
+    class Action
+      extend Forwardable
+
+      # Public: Call this in subclasses so the action knows its route.
+      #
+      # regex - The Regexp that this action should run for.
+      #
+      # Returns nothing.
+      def self.route(regex)
+        @regex = regex
+      end
+
+      # Internal: Initializes and runs an action for a given request.
+      #
+      # flipper - The Flipper::DSL instance.
+      # request - The Rack::Request that was sent.
+      #
+      # Returns result of Action#run.
+      def self.run(flipper, request)
+        new(flipper, request).run
+      end
+
+      # Internal: The regex that matches which routes this action will work for.
+      def self.regex
+        @regex || raise("#{name}.route is not set")
+      end
+
+      # Public: The instance of the Flipper::DSL the middleware was
+      # initialized with.
+      attr_reader :flipper
+
+      # Public: The Rack::Request to provide a response for.
+      attr_reader :request
+
+      # Public: The params for the request.
+      def_delegator :@request, :params
+
+      def initialize(flipper, request)
+        @flipper, @request = flipper, request
+        @code = 200
+        @headers = {"Content-Type" => Api::CONTENT_TYPE }
+      end
+
+      # Public: Runs the request method for the provided request.
+      #
+      # Returns whatever the request method returns in the action.
+      def run
+        if 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}"
+        end
+      end
+
+      # Public: Runs another action from within the request method of a
+      # different action.
+      #
+      # action_class - The class of the other action to run.
+      #
+      # Examples
+      #
+      #   run_other_action Home
+      #   # => result of running Home action
+      #
+      # Returns result of other action.
+      def run_other_action(action_class)
+        action_class.new(flipper, request).run
+      end
+
+      # Public: Call this with a response to immediately stop the current action
+      # and respond however you want.
+      #
+      # response - The response you would like to return.
+      def halt(response)
+        throw :halt, response
+      end
+
+      def json_response(object, status = 200)
+        header 'Content-Type', Api::CONTENT_TYPE
+        status(status)
+        body = JSON.dump(object)
+        halt [@code, @headers, [body]]
+      end
+
+      # Public: Set the status code for the response.
+      #
+      # code - The Integer code you would like the response to return.
+      def status(code)
+        @code = code.to_i
+      end
+
+      # Public: Set a header.
+      #
+      # name - The String name of the header.
+      # value - The value of the header.
+      def header(name, value)
+        @headers[name] = value
+      end
+
+      private
+
+      # Private: Returns the request method converted to an action method.
+      def request_method_name
+        @request_method_name ||= @request.request_method.downcase
+      end
+
+      # Private: split request path by "/"
+      # Example: "api/v1/features/feature_name" => ['api', 'v1', 'features', 'feature_name']
+      def path_parts
+        @request.path.split("/")
+      end
+    end
+  end
+end

data/lib/flipper/api/action_collection.rb

@@ -0,0 +1,19 @@
+module Flipper
+  module Api
+    class ActionCollection
+      def initialize
+        @action_classes = []
+      end
+
+      def add(action_class)
+        @action_classes << action_class
+      end
+
+      def action_for_request(request)
+        @action_classes.detect { |action_class|
+          request.path_info =~ action_class.regex
+        }
+      end
+    end
+  end
+end

data/lib/flipper/api/error.rb

@@ -0,0 +1,10 @@
+module Flipper
+  module Api
+    # All flipper api errors inherit from this.
+    Error = Class.new(StandardError)
+
+    # Raised when a request method (get, post, etc.) is called for an action
+    # that does not know how to handle it.
+    RequestMethodNotSupported = Class.new(Error)
+  end
+end

data/lib/flipper/api/middleware.rb

@@ -0,0 +1,62 @@
+require 'rack'
+require 'flipper/api/action_collection'
+
+# Require all V1 actions automatically.
+Pathname(__FILE__).dirname.join('v1/actions').each_child(false) do |name|
+  require "flipper/api/v1/actions/#{name}"
+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)
+        @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::BooleanGate
+        @action_collection.add Api::V1::Actions::Feature
+      end
+
+      def flipper
+        @flipper ||= @flipper_block.call
+      end
+
+      def call(env)
+        dup.call!(env)
+      end
+
+      def call!(env)
+        request = Rack::Request.new(env)
+        action_class = @action_collection.action_for_request(request)
+        if action_class.nil?
+          @app.status = 404
+          @app.call(env)
+        else
+          action_class.run(flipper, request)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'flipper/api/action'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class BooleanGate < Api::Action
+          route %r{api/v1/features/[^/]*/(enable|disable)/?\Z}
+          
+          def put
+            feature_name = Rack::Utils.unescape(path_parts[-2])
+            feature = flipper[feature_name.to_sym]
+            action = Rack::Utils.unescape(path_parts.last)
+            feature.send(action)
+            json_response({}, 204)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'flipper/api/action'
+require 'flipper/api/v1/decorators/feature'
+
+module Flipper
+  module Api
+    module V1
+      module Actions
+        class Feature < Api::Action
+
+          route %r{api/v1/features/[^/]*/?\Z}
+
+          def get
+            if feature_names.include?(feature_name)
+              feature = Decorators::Feature.new(flipper[feature_name])
+              json_response(feature.as_json)
+            else
+              json_response({}, 404)
+            end
+          end
+
+          def delete
+            if feature_names.include?(feature_name)
+              flipper.remove(feature_name)
+
+              json_response({}, 204)
+            else
+              json_response({}, 404)
+            end
+          end
+
+          private
+
+          def feature_name
+            @feature_name ||= Rack::Utils.unescape(path_parts.last)
+          end
+
+          def feature_names
+            @feature_names ||= flipper.adapter.features
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+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__
+
+          # Public: Returns instance as hash that is ready to be json dumped.
+          def as_json
+            gate_values = feature.gate_values
+            {
+              'key' => key,
+              'state' => state.to_s,
+              'gates' => gates.map { |gate|
+                Decorators::Gate.new(gate, gate_values[gate.key]).as_json
+              },
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+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
+
+          def initialize(gate, value = nil)
+            super gate
+            @value = value
+          end
+
+          def as_json
+            {
+              'key' => gate.key.to_s,
+              'name' => gate.name.to_s,
+              'value' => value_as_json,
+            }
+          end
+
+          private
+
+          # json doesn't like sets
+          def value_as_json
+            data_type == :set ? value.to_a : value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flipper/api.rb

@@ -0,0 +1,42 @@
+require 'rack'
+require 'flipper'
+require 'flipper/api/middleware'
+
+module Flipper
+  module Api
+    CONTENT_TYPE = 'application/json'.freeze
+
+    def self.app(flipper)
+      app = App.new(200,{ 'Content-Type' => CONTENT_TYPE }, [''])
+      builder = Rack::Builder.new
+      yield builder if block_given?
+      builder.use Flipper::Api::Middleware, flipper
+      builder.run app
+      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

@@ -0,0 +1,3 @@
+module Flipper
+  VERSION = "0.8.0"
+end

data/lib/flipper-api.rb

@@ -0,0 +1 @@
+require 'flipper/api'

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

@@ -0,0 +1,39 @@
+require 'helper'
+
+RSpec.describe Flipper::Api::V1::Actions::BooleanGate do
+  let(:app) { build_api(flipper) }
+
+  describe 'enable' do
+    before do
+      flipper[:my_feature].disable
+      put '/api/v1/features/my_feature/enable'
+    end
+
+    it 'enables feature' do
+      expect(last_response.status).to eq(204)
+      expect(flipper[:my_feature].on?).to be_truthy
+    end
+  end
+
+  describe 'disable' do
+    before do
+      flipper[:my_feature].enable
+      put '/api/v1/features/my_feature/disable'
+    end
+
+    it 'disables feature' do
+      expect(last_response.status).to eq(204)
+      expect(flipper[:my_feature].off?).to be_truthy
+    end
+  end
+
+  describe 'invalid paremeter' do
+    before do
+      put '/api/v1/features/my_feature/invalid_param'
+    end
+
+    it 'responds with 404 when not sent enable or disable parameter' do
+      expect(last_response.status).to eq(404)
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+require 'helper'
+
+RSpec.describe Flipper::Api::V1::Actions::Feature do
+  let(:app) { build_api(flipper) }
+  let(:feature) { build_feature }
+  let(:gate) { feature.gate(:boolean) }
+
+  describe 'get' do
+    context 'enabled feature' do
+
+      before do
+        flipper[:my_feature].enable
+        get 'api/v1/features/my_feature'
+      end
+
+      it 'responds with correct attributes' do
+        response_body = {
+          'key' => 'my_feature',
+          'state' => 'on',
+          'gates' => [
+            {
+              'key' => 'boolean',
+              'name' => 'boolean',
+              'value' => true,
+            },
+            {
+              'key' => 'groups',
+              'name' => 'group',
+              'value' => [],
+            },
+            {
+              'key' => 'actors',
+              'name' => 'actor',
+              'value' => [],
+            },
+            {
+              'key' => 'percentage_of_actors',
+              'name' => 'percentage_of_actors',
+              'value' => 0,
+            },
+            {
+              'key' => 'percentage_of_time',
+              'name' => 'percentage_of_time',
+              'value' => 0,
+            }
+          ]
+        }
+
+        expect(last_response.status).to eq(200)
+        expect(json_response).to eq(response_body)
+      end
+    end
+
+    context 'disabled feature' do
+      before do
+        flipper[:my_feature].disable
+        get 'api/v1/features/my_feature'
+      end
+
+      it 'responds with correct attributes' do
+        response_body = {
+          'key' => 'my_feature',
+          'state' => 'off',
+          'gates' => [
+            {
+              'key' => 'boolean',
+              'name' => 'boolean',
+              'value' => false,
+            },
+            {
+              'key'=> 'groups',
+              'name'=> 'group',
+              'value'=> [],
+            },
+            {
+              'key' => 'actors',
+              'name' => 'actor',
+              'value' => [],
+            },
+            {
+              'key' => 'percentage_of_actors',
+              'name' => 'percentage_of_actors',
+              'value'=> 0,
+            },
+            {
+              'key' => 'percentage_of_time',
+              'name' => 'percentage_of_time',
+              'value' => 0,
+            }
+          ]
+        }
+
+        expect(last_response.status).to eq(200)
+        expect(json_response).to eq(response_body)
+      end
+    end
+
+    context 'feature does not exist' do
+      before do
+        get 'api/v1/features/not_a_feature'
+      end
+
+      it 'returns 404' do
+        expect(last_response.status).to eq(404)
+      end
+    end
+  end
+
+  describe 'delete' do
+    it 'deletes feature' do
+      flipper[:my_feature].enable
+      expect(flipper.features.map(&:key)).to include('my_feature')
+      delete 'api/v1/features/my_feature'
+      expect(last_response.status).to eq(204)
+      expect(flipper.features.map(&:key)).not_to include('my_feature')
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: flipper-api
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Rack middleware that provides an API for the flipper gem.
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- flipper-api.gemspec
+- lib/flipper-api.rb
+- lib/flipper/api.rb
+- lib/flipper/api/action.rb
+- lib/flipper/api/action_collection.rb
+- lib/flipper/api/error.rb
+- lib/flipper/api/middleware.rb
+- lib/flipper/api/v1/actions/boolean_gate.rb
+- lib/flipper/api/v1/actions/feature.rb
+- lib/flipper/api/v1/decorators/feature.rb
+- lib/flipper/api/v1/decorators/gate.rb
+- lib/flipper/version.rb
+- spec/flipper/api/v1/actions/boolean_gate_spec.rb
+- spec/flipper/api/v1/actions/feature_spec.rb
+homepage: https://github.com/jnunemaker/flipper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: API for the Flipper gem
+test_files:
+- spec/flipper/api/v1/actions/boolean_gate_spec.rb
+- spec/flipper/api/v1/actions/feature_spec.rb