flipper-api 0.11.0.beta4 → 0.11.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a26853ebf5075f4787bbfdb68ff46ed0802ad87
-  data.tar.gz: 94a1fa6c3c6751a0754392f0e4680aa61bb2cbf3
+  metadata.gz: 5f47344a8b6c5e5aa22f885dca16202c8335bf7f
+  data.tar.gz: 38dcc1ca7f51ac4c0301ef80ddc08a610adf7dd8
 SHA512:
-  metadata.gz: 8959693ec26ebb91565a56407dc83c55a818592ffaa24f8bf3d41681b245cc1d86dfd868b19bbdfeed85147262ddc802c4872b9740707f9d35bae40e33213eb5
-  data.tar.gz: e9d707690cfacf6f370e313404ad7e0da9de8de70af5e46bd201ff7d1eff5e9e74525515eebec09a11d7447508ae45364d4275d0e81038d3114eb9eeb311236d
+  metadata.gz: 67c8a531a6ca084ad8e25a238f58e50f1f8db3db7233ac46bdf1affb53ca8e88e8546f138642bdbf426cec23c2e564fad51b1f867e30b4b8414280682b00318f
+  data.tar.gz: 05e52fd77c85f8bee42ec27985e8f926ae65565e6e9b5a3b3bbfcbf01c54acedcd2ecddf26ebe536d17617db35e496f8a23d012390d437c1e86a0af4126e411f

data/lib/flipper/api.rb

@@ -4,20 +4,20 @@ 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 = nil)
+    def self.app(flipper = nil, options = {})
+      env_key = options.fetch(:env_key, 'flipper')
       app = ->(_) { [404, { 'Content-Type'.freeze => CONTENT_TYPE }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
-      builder.use Flipper::Middleware::SetupEnv, flipper
-      builder.use Flipper::Middleware::Memoizer
       builder.use Flipper::Api::JsonParams
-      builder.use Flipper::Api::Middleware
+      builder.use Flipper::Middleware::SetupEnv, flipper, env_key: env_key
+      builder.use Flipper::Middleware::Memoizer, env_key: env_key
+      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

data/lib/flipper/api/middleware.rb

@@ -9,8 +9,9 @@ end
 module Flipper
   module Api
     class Middleware
-      def initialize(app)
+      def initialize(app, options = {})
         @app = app
+        @env_key = options.fetch(:env_key, 'flipper')
 
         @action_collection = ActionCollection.new
         @action_collection.add Api::V1::Actions::PercentageOfTimeGate
@@ -33,7 +34,7 @@ module Flipper
         if action_class.nil?
           @app.call(env)
         else
-          flipper = env.fetch('flipper')
+          flipper = env.fetch(@env_key)
           action_class.run(flipper, request)
         end
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.11.0.beta4'.freeze
+  VERSION = '0.11.0.beta5'.freeze
 end

data/spec/flipper/api/json_params_spec.rb

@@ -15,67 +15,67 @@ RSpec.describe Flipper::Api::JsonParams do
   describe 'json post request' do
     it 'adds request body to params' do
       response = post '/',
-                      JSON.generate(flipper_id: 'user:2'),
+                      JSON.generate(flipper_id: 'User;2'),
                       'CONTENT_TYPE' => 'application/json'
 
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2')
+      expect(params).to eq('flipper_id' => 'User;2')
     end
 
     it 'handles request bodies with multiple params' do
       response = post '/',
-                      JSON.generate(flipper_id: 'user:2', language: 'ruby'),
+                      JSON.generate(flipper_id: 'User;2', language: 'ruby'),
                       'CONTENT_TYPE' => 'application/json'
 
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby')
     end
 
     it 'handles request bodies and single query string params' do
       response = post '/?language=ruby',
-                      JSON.generate(flipper_id: 'user:2'),
+                      JSON.generate(flipper_id: 'User;2'),
                       'CONTENT_TYPE' => 'application/json'
 
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby')
     end
 
     it 'handles request bodies and multiple query string params' do
       response = post '/?language=ruby&framework=rails',
-                      JSON.generate(flipper_id: 'user:2'),
+                      JSON.generate(flipper_id: 'User;2'),
                       'CONTENT_TYPE' => 'application/json'
 
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby', 'framework' => 'rails')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby', 'framework' => 'rails')
     end
 
     it 'favors request body params' do
       response = post '/?language=javascript',
-                      JSON.generate(flipper_id: 'user:2', language: 'ruby'),
+                      JSON.generate(flipper_id: 'User;2', language: 'ruby'),
                       'CONTENT_TYPE' => 'application/json'
 
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby')
     end
   end
 
   describe 'url-encoded request' do
     it 'handles params the same as a json request' do
-      response = post '/', flipper_id: 'user:2'
+      response = post '/', flipper_id: 'User;2'
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2')
+      expect(params).to eq('flipper_id' => 'User;2')
     end
 
     it 'handles single query string params' do
-      response = post '/?language=ruby', flipper_id: 'user:2'
+      response = post '/?language=ruby', flipper_id: 'User;2'
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby')
     end
 
     it 'handles multiple query string params' do
-      response = post '/?language=ruby&framework=rails', flipper_id: 'user:2'
+      response = post '/?language=ruby&framework=rails', flipper_id: 'User;2'
       params = JSON.parse(response.body)
-      expect(params).to eq('flipper_id' => 'user:2', 'language' => 'ruby', 'framework' => 'rails')
+      expect(params).to eq('flipper_id' => 'User;2', 'language' => 'ruby', 'framework' => 'rails')
     end
   end
 end

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

@@ -2,7 +2,7 @@ require 'helper'
 
 RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
   let(:app) { build_api(flipper) }
-  let(:actor) { Flipper::Api::Actor.new('1') }
+  let(:actor) { Flipper::Actor.new('1') }
 
   describe 'enable' do
     before do
@@ -23,7 +23,7 @@ RSpec.describe Flipper::Api::V1::Actions::ActorsGate do
   end
 
   describe 'disable' do
-    let(:actor) { Flipper::Api::Actor.new('1') }
+    let(:actor) { Flipper::Actor.new('1') }
 
     before do
       flipper[:my_feature].enable_actor(actor)

data/spec/flipper/api_spec.rb

@@ -43,6 +43,30 @@ RSpec.describe Flipper::Api do
     end
   end
 
+  context 'when initialized with env_key' do
+    let(:app) { build_api(flipper, env_key: 'flipper_api') }
+
+    it 'uses provided env key instead of default' do
+      flipper[:a].enable
+      flipper[:b].disable
+
+      default_env_flipper = build_flipper
+      default_env_flipper[:env_a].enable
+      default_env_flipper[:env_b].disable
+
+      params = {}
+      env = {
+        'flipper' => default_env_flipper,
+        'flipper_api' => flipper,
+      }
+      get '/features', params, env
+
+      expect(last_response.status).to eq(200)
+      feature_names = json_response.fetch('features').map { |feature| feature.fetch('key') }
+      expect(feature_names).to eq(%w(a b))
+    end
+  end
+
   context "when request does not match any api routes" do
     let(:app) { build_api(flipper) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-api
 version: !ruby/object:Gem::Version
-  version: 0.11.0.beta4
+  version: 0.11.0.beta5
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta4
+        version: 0.11.0.beta5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0.beta4
+        version: 0.11.0.beta5
 description: Rack middleware that provides an API for the flipper gem.
 email:
 - nunemaker@gmail.com
@@ -56,7 +56,6 @@ files:
 - lib/flipper/api.rb
 - lib/flipper/api/action.rb
 - lib/flipper/api/action_collection.rb
-- lib/flipper/api/actor.rb
 - lib/flipper/api/error.rb
 - lib/flipper/api/error_response.rb
 - lib/flipper/api/json_params.rb

data/lib/flipper/api/actor.rb

@@ -1,13 +0,0 @@
-module Flipper
-  module Api
-    # Internal: Shim for turning a string flipper id into something that responds to
-    # flipper_id for Flipper::Types::Actor.
-    class Actor
-      attr_reader :flipper_id
-
-      def initialize(flipper_id)
-        @flipper_id = flipper_id
-      end
-    end
-  end
-end