bandiera-client 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748f5858d09ce6aec023da7987c3f4ab0fc0fa75
-  data.tar.gz: e9cb4b7fa6ba2e12f04b24cb7bc8ca7505b5313a
+  metadata.gz: 170478dc6075aeda3c245c9ea8ef1f4fd357a556
+  data.tar.gz: a5bda6c22f5c52fceb82d665009a9c3323940948
 SHA512:
-  metadata.gz: 75bbcece7e445f4420c8d4e8bb8091372705e435d4e5d81625ce8cc6d1c02ac71fee56846ded50c5b59360c5c41f5a55aa5f62adc41510914b847e62751f1d60
-  data.tar.gz: e42c294b272343d9a495aa091c90dfcb72bfa7c7d1880f4a6645b8c08404c4befe0be8aeb2e3b4f3c5e26564ab01bdb6a6baddce4f1da8bdd74abdace2b4a6a6
+  metadata.gz: f274fff7ed02c4bcbc18324c7c1c0ea7eea83213b051f8c5ba859f89a1c21dbe25e6b310a95bd6448cd8b4aee0165dd0650b6a6a31d2e05fb4fa755866075034
+  data.tar.gz: 85585452a8af8119f8d12fd3d2a610ae0d4ecb10eaae61ccac7fd7782ac17a24744d641b0339e725053f03280a867e000d3d5567812cab8b48431655288ed72e

data/.hound.yml

@@ -34,3 +34,6 @@ Style/CollectionMethods:
 
 Style/DotPosition:
   EnforcedStyle: leading
+
+Style/DoubleNegation:
+  Enabled: false

data/.rubocop.yml

@@ -34,3 +34,6 @@ Style/CollectionMethods:
 
 Style/DotPosition:
   EnforcedStyle: leading
+
+Style/DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+cache: bundler
+language: ruby
+
+# Ruby build matrix
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby
+  - ruby-head
+  - jruby
+
+# Ensure we don't build for *every* commit (doesn't apply to PR builds)
+branches:
+  only:
+  - master
+
+script:
+- bundle exec rspec --format documentation

data/README.md

@@ -1,13 +1,13 @@
 # Bandiera::Client (Ruby)
 
-This is a client for talking to the [Bandiera][bandiera] feature flagging
-service from a Ruby application.
+This is a client for talking to the [Bandiera][bandiera] feature flagging service from a Ruby application.
 
 This client is compatible with the [v2 Bandiera API][bandiera-api].
 
-**Current Version:** 2.2.1
-**License:** [MIT][mit]
-**Build Status:** [![Build Status][travis-img]][travis]
+[![Gem version][shield-gem]][info-gem]
+[![Build status][shield-build]][info-build]
+[![Dependencies][shield-dependencies]][info-dependencies]
+[![MIT licensed][shield-license]][info-license]
 
 ## Ruby Support:
 
@@ -26,72 +26,76 @@ Then interact with a Bandiera server like so:
 ```ruby
 require 'bandiera/client'
 
-$bandiera = Bandiera::Client.new('http://bandiera.example.com')
+client = Bandiera::Client.new('http://bandiera-demo.herokuapp.com')
+params = {}
 
-if $bandiera.enabled?('pubserv', 'show-new-search')
+if client.enabled?('pubserv', 'show-new-search', params)
   # show the new experimental search function
 end
 ```
 
-The `$bandiera.enabled?` command takes two arguments - the 'feature group',
-and the 'feature name'.  This is because in Bandiera, features are organised
-in groups as it is intented as a service for multiple applications to use at
-the same time - this organisation allows separation of feature flags that are
-intended for different audiences.
+The `client.enabled?` command takes two main arguments - the 'feature group', and the 'feature name'.  This is because in Bandiera, features are organised into groups as it is intented as a service for multiple applications to use at the same time - this organisation allows separation of feature flags that are intended for different audiences.
 
-## Caching
+`client.enabled?` also takes an optional `params` hash, this is for use with some of the more advanced features in Bandiera - user group and percentage based flags.  It is in this params hash you pass in your `user_group` and `user_id`, i.e.:
 
-Bandiera::Client has a small layer of caching built into it in order to:
+```ruby
+client.enabled?('pubserv', 'show-new-search',
+  { user_id: '1234567', user_group: 'Administrators' })
+```
 
-1. Reduce the amount of HTTP requests made to the Bandiera server
-2. Make things faster
+For more information on these advanced features, please see the Bandiera wiki:
 
-### Strategies
+https://github.com/nature/bandiera/wiki/How-Feature-Flags-Work#feature-flags-in-bandiera
 
-There are three request/caching strategies you can use with Bandiera::Client.
+# Performance
 
-**:single_feature**
+Using the `client.enabled?` method all over your codebase isn't the most efficient way of working with Bandiera as every time you call `enabled?` you will make a HTTP request to the Bandiera server.
 
-This strategy calls the Bandiera API for each new .enabled? request, and stores
-the response in it's local cache. Subsequent `.enabled?` requests (using the
-same arguments) will read from the cache until it has expired.  This is the
-**least** efficient strategy in terms of reducing HTTP requests and speed.
+One way of working more efficiently is using the [Direct API Access](#direct-api-access) methods, to fetch all the feature flags for a given group (or even **all** of the feature flags in the Bandiera server) in one request. You can then hold these as you please in your application and call on the values when needed.
 
-**:group**
+Another approach is to use the Bandiera::Middleware class supplied in this gem.  This can be used in conjunction with other middlewares for identifying your currently logged in user and assigning them a UUID to enable all of the most advanced features in Bandiera very simply.
 
-This strategy calls the Bandiera API **once** for each feature flag group
-requested, and then stores the resulting feature flag values in the cache.
-This means that all subsequent calls to `.enabled?` for the same group will not
-perform a HTTP request and instead read from the cache until it has expired.
-This is a good compromise in terms of speed and number of HTTP requests, **and
-is the default caching strategy**.
+[See the blog post on cruft.io for more information on how Bandiera::Client is used at Nature.](http://cruft.io)
 
-**:all**
+<a name="direct-api-access"></a># Direct API Access
 
-This strategy calls the Bandiera API **once** and fetches/caches all feature
-flag values locally. All subsequent calls to `.enabled?` read from the cache
-until it has expired. This strategy is obviously the most efficient in terms of
-the number of HTTP requests if you are requesting flags from across multiple
-groups, but might not be the fastest if there are **lots** of flags in your
-Bandiera instance.
+If you'd prefer not to use the `enabled?` method for featching feature flag values, the following methods are available...
 
-#### Changing the Cache Strategy
+Get features for all groups:
 
 ```ruby
-$bandiera = Bandiera::Client.new('http://bandiera.example.com')
-$bandiera.cache_strategy = :all
+client.get_all(params)
+  # gives:
+  # {
+  #   'group1' => {
+  #     'feature1' => true,
+  #     'feature2' => false
+  #   },
+  #   'group2' => {
+  #     'feature1' => false
+  #   },
+  # }
 ```
 
-### Cache Expiration
+Get features for a group:
+
+```ruby
+client.get_features_for_group('pubserv', params)
+  # gives:
+  # {
+  #   'feature1' => true,
+  #   'feature2' => false
+  # }
+```
 
-The default cache lifetime is 5 seconds.  If you would like to alter this you
-can do so as follows:
+Get an individual feature:
 
 ```ruby
-$bandiera = Bandiera::Client.new('http://bandiera.example.com')
-$bandiera.cache_ttl = 10 # 10 seconds
+client.get_feature('pubserv', 'show-article-metrics', params)
+  # gives: true/false
 ```
 
+As with the `enabled?` method the `params` hash is for passing in your `user_group` and `user_id` values if you are using some of the more advanced features in Bandiera.
 
 # Development
 
@@ -107,5 +111,11 @@ Bandiera::Client (Ruby) is licensed under the [MIT License][mit].
 [mit]: http://opensource.org/licenses/mit-license.php
 [bandiera]: https://github.com/nature/bandiera
 [bandiera-api]: https://github.com/nature/bandiera/wiki/API-Documentation
-[travis]: https://travis-ci.org/nature/bandiera-client-ruby
-[travis-img]: https://travis-ci.org/nature/bandiera-client-ruby.svg?branch=master
+[info-dependencies]: https://gemnasium.com/nature/bandiera-client-ruby
+[info-license]: LICENSE
+[info-gem]: https://rubygems.org/gems/bandiera-client
+[info-build]: https://travis-ci.org/nature/bandiera-client-ruby
+[shield-dependencies]: https://img.shields.io/gemnasium/nature/bandiera-client-ruby.svg
+[shield-license]: https://img.shields.io/badge/license-MIT-blue.svg
+[shield-gem]: https://img.shields.io/gem/v/bandiera-client.svg
+[shield-build]: https://img.shields.io/travis/nature/bandiera-client-ruby/master.svg

data/bandiera-client.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Bandiera is a simple, stand-alone feature flagging service that is not tied to any existing web framework or language. This is a client for talking to the web service.'
   spec.summary       = 'Simple feature flagging API client.'
   spec.homepage      = 'https://github.com/nature/bandiera-client-ruby'
-  spec.license       = 'GPL-3'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.test_files    = Dir.glob('spec/*_spec.rb')
@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'
 
   spec.add_dependency 'rest-client'
-  spec.add_dependency 'moneta'
   spec.add_dependency 'macmillan-utils'
 end

data/lib/bandiera/client/version.rb

@@ -1,5 +1,5 @@
 module Bandiera
   class Client
-    VERSION = '2.2.2'
+    VERSION = '3.0.0'
   end
 end

data/lib/bandiera/client.rb

@@ -1,49 +1,54 @@
 require 'rest_client'
 require 'json'
 require 'logger'
-require 'moneta'
 
 module Bandiera
+  ##
+  # Client class for communicating with a Bandiera server.
+  #
+  # @since 1.0.0
+  # @attr [Float] timeout The HTTP timeout value (seconds) for requests
+  # @attr [String] client_name The client name passed along with HTTP requests
+  # @attr_reader [Logger] logger The logger object in use
+  #
   class Client
     autoload :VERSION, 'bandiera/client/version'
 
-    CACHE_STRATEGIES = [:single_feature, :group, :all]
-
-    attr_accessor :timeout, :client_name, :cache_ttl
-    attr_reader :logger, :cache, :cache_strategy
+    attr_accessor :timeout, :client_name
+    attr_reader :logger
 
+    ##
+    # Builds a new instance of Bandiera::Client
+    #
+    # @param [String] base_uri The URI of the Bandiera server
+    # @param [Logger] logger A logger object
+    # @param [String] client_name A client name to pass through along with the HTTP requests
+    #
     def initialize(base_uri = 'http://localhost', logger = Logger.new($stdout), client_name = nil)
       @base_uri       = base_uri
       @base_uri       << '/api' unless @base_uri.match(/\/api$/)
       @logger         = logger
       @timeout        = 0.2 # 0.4s (0.2 + 0.2) default timeout
       @client_name    = client_name
-      @cache          = Moneta.new(:LRUHash, expires: true)
-      @cache_ttl      = 5 # 5 seconds
-      @cache_strategy = :group
     end
 
-    def cache_strategy=(strategy)
-      unless CACHE_STRATEGIES.include?(strategy)
-        raise ArgumentError, "cache_strategy can only be #{CACHE_STRATEGIES}"
-      end
-      @cache_strategy = strategy
-    end
-
-    def enabled?(group, feature, params = {}, http_opts = {})
-      cache_key = build_cache_key(group, feature, params)
-
-      unless cache.key?(cache_key)
-        case cache_strategy
-        when :single_feature then get_feature(group, feature, params, http_opts)
-        when :group          then get_features_for_group(group, params, http_opts)
-        when :all            then get_all
-        end
-      end
-
-      cache.fetch(cache_key)
+    # @deprecated This functionality was deprecated/removed in 3.0.0
+    def cache_strategy=(_)
+      warn 'The caching features in Bandiera::Client have been removed as of v3.0.0, please consider using using ' \
+           'the Bandiera::Middleware class shipped as part of the "bandiera-client" gem.'
     end
 
+    ##
+    # Get the active/inactive state for a single feature flag
+    #
+    # @param [String] group The group of feature flags we're interested in
+    # @param [String] feature The feature flag we want to retrieve
+    # @param [Hash] params Additional parameters to pass through to the Bandiera request
+    # @option params [String] :user_id A unique user identifier, or UUID (for use with percentage based feature flags)
+    # @option params [String] :user_group A group to assign the identify the user with (for use with group based feature flags)
+    #
+    # @return [Boolean] True/False - depending on if the feature is on or off
+    #
     def get_feature(group, feature, params = {}, http_opts = {})
       path             = "/v2/groups/#{group}/features/#{feature}"
       default_response = false
@@ -51,11 +56,21 @@ module Bandiera
 
       logger.debug "[Bandiera::Client#get_feature] calling #{path} with params: #{params}"
 
-      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix) do |value|
-        store_value_in_cache(group, feature, params, value)
-      end
+      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix)
     end
 
+    alias_method :enabled?, :get_feature
+
+    ##
+    # Get the active/inactive state for all feature flags in a group
+    #
+    # @param [String] group The group of feature flags we're interested in
+    # @param [Hash] params Additional parameters to pass through to the Bandiera request
+    # @option params [String] :user_id A unique user identifier, or UUID (for use with percentage based feature flags)
+    # @option params [String] :user_group A group to assign the identify the user with (for use with group based feature flags)
+    #
+    # @return [Hash] A hash of feature flag pairs. Keys are the feature flag names, values are the active/inactive states.
+    #
     def get_features_for_group(group, params = {}, http_opts = {})
       path             = "/v2/groups/#{group}/features"
       default_response = {}
@@ -63,11 +78,17 @@ module Bandiera
 
       logger.debug "[Bandiera::Client#get_features_for_group] calling #{path} with params: #{params}"
 
-      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix) do |feature_hash|
-        store_feature_hash_in_cache(group, params, feature_hash)
-      end
+      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix)
     end
 
+    ##
+    # Get the active/inactive state for all feature flags known on the Bandiera server
+    #
+    # @param [Hash] params Additional parameters to pass through to the Bandiera request
+    # @option params [String] :user_id A unique user identifier, or UUID (for use with percentage based feature flags)
+    # @option params [String] :user_group A group to assign the identify the user with (for use with group based feature flags)
+    #
+    # @return [Hash] A hash of hashes containing the feature flag active/inactive states grouped by 'group'
     def get_all(params = {}, http_opts = {})
       path             = '/v2/all'
       default_response = {}
@@ -75,30 +96,11 @@ module Bandiera
 
       logger.debug "[Bandiera::Client#get_all] calling #{path} with params: #{params}"
 
-      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix) do |group_hash|
-        group_hash.each do |group, feature_hash|
-          store_feature_hash_in_cache(group, params, feature_hash)
-        end
-      end
+      get_and_handle_exceptions(path, params, http_opts, default_response, error_msg_prefix)
     end
 
     private
 
-    def store_feature_hash_in_cache(group, params, feature_hash)
-      feature_hash.each do |feature, value|
-        store_value_in_cache(group, feature, params, value)
-      end
-    end
-
-    def store_value_in_cache(group, feature, params, value)
-      cache_key = build_cache_key(group, feature, params)
-      cache.store(cache_key, value, expires: cache_ttl)
-    end
-
-    def build_cache_key(group, feature, params)
-      "#{group} / #{feature} / #{params}"
-    end
-
     def headers
       headers = { 'User-Agent' => "Bandiera Ruby Client / #{Bandiera::Client::VERSION}" }
       headers.merge!('Bandiera-Client' => client_name) unless client_name.nil?

data/lib/bandiera/middleware.rb

@@ -0,0 +1,66 @@
+require 'macmillan/utils'
+
+module Bandiera
+  ##
+  # Rack middleware for talking to a Bandiera feature flagging service.
+  #
+  # The benefit of using this middleware is two-fold when working with a Bandiera server:
+  #
+  # 1. Performance - Using this middleware, you will only call the Bandiera server once per-request (in contrast to using the `enabled?` method where you will make one request per-use).
+  # 2. Better Quality Code - If you use the more advanced features in Bandiera (user groups and percentages) you will no longer need to pass around user objects and UUIDs in your code.  This does assume the use of other middlewares to supply user objects and UUIDs though.
+  #
+  # This middleware can be used in conjunction with the {Macmillan::Utils::Middleware::Uuid} (or one of your own design) to automatically generate UUIDs for your users. See https://github.com/nature/bandiera/wiki for more information on this approach.
+  #
+  # @since 3.0.0
+  #
+  class Middleware
+    ##
+    # Builds a new instance of Bandiera::Middleware
+    #
+    # @param app The rack application
+    # @param [Hash] opts Additional options for the middleware
+    # @option opts [Bandiera::Client] :client The Bandiera::Client class to use
+    # @option opts [Array] :groups ([]) The feature flag groups to request and store in the rack env
+    # @option opts [String] :uuid_env_key (Macmillan::Utils::Middleware::Uuid.env_key) The rack env key containing a UUID for your current user (to pass to `user_id` in Bandiera)
+    # @option opts [String] :user_env_key ('current_user') The rack env key containing your currently logged in user
+    # @option opts [Symbol] :user_group_method (:email) The method to call on the current user to pass to `user_group` in Bandiera
+    #
+    # @see Bandiera::Client
+    # @see Macmillan::Utils::Middleware::Uuid
+    #
+    def initialize(app, opts = {})
+      @app               = app
+      @client            = opts[:client]
+      @groups            = opts[:groups] || []
+      @uuid_env_key      = opts[:uuid_env_key] || Macmillan::Utils::Middleware::Uuid.env_key
+      @user_env_key      = opts[:user_env_key] || 'current_user'
+      @user_group_method = opts[:user_group_method] || :email
+
+      fail ArgumentError, 'You must supply a Bandiera::Client' unless @client
+    end
+
+    def call(env)
+      dup.process(env)
+    end
+
+    def process(env)
+      request = Rack::Request.new(env)
+
+      user       = request.env[@user_env_key]
+      user_group = user ? user.public_send(@user_group_method) : nil
+      uuid       = request.env[@uuid_env_key]
+
+      if @groups.empty?
+        @client.get_all(user_group: user_group, user_id: uuid).each do |group, flags|
+          request.env["bandiera.#{group}"] = flags
+        end
+      else
+        @groups.each do |group|
+          request.env["bandiera.#{group}"] = @client.get_features_for_group(group, user_group: user_group, user_id: uuid)
+        end
+      end
+
+      @app.call(request.env)
+    end
+  end
+end

data/spec/lib/bandiera/client_spec.rb

@@ -9,10 +9,10 @@ describe Bandiera::Client do
   context 'when a client name is provided' do
     let(:group)   { 'pubserv' }
     let(:feature) { 'log-stats' }
-    let(:url)     { "#{api_uri}/v2/groups/#{group}/features" }
+    let(:url)     { "#{api_uri}/v2/groups/#{group}/features/#{feature}" }
 
     it 'sends it as part of the headers' do
-      stub = stub_api_request(url, { 'response' => {} }, { 'Bandiera-Client' => 'asdf' })
+      stub   = stub_api_request(url, { 'response' => {} }, { 'Bandiera-Client' => 'asdf' })
       client = Bandiera::Client.new(api_uri, logger, 'asdf')
       client.enabled?(group, feature)
       expect(stub).to have_been_requested
@@ -36,83 +36,6 @@ describe Bandiera::Client do
     end
   end
 
-  describe '#enabled?' do
-    context 'with cache strategy :single_feature' do
-      before do
-        subject.cache_strategy = :single_feature
-      end
-
-      context 'and an empty cache' do
-        it 'calls #get_feature' do
-          expect(subject).to receive(:get_feature).once
-          subject.enabled?('foo', 'bar')
-        end
-      end
-
-      context 'and a primed cache' do
-        before do
-          cache_key = subject.send(:build_cache_key, 'foo', 'bar', {})
-          subject.cache.store(cache_key, false)
-        end
-
-        it 'does not call #get_feature' do
-          expect(subject).to_not receive(:get_feature)
-          subject.enabled?('foo', 'bar')
-        end
-      end
-    end
-
-    context 'with cache strategy :group' do
-      before do
-        subject.cache_strategy = :group
-      end
-
-      context 'and an empty cache' do
-        it 'calls #get_features_for_group' do
-          expect(subject).to receive(:get_features_for_group).once
-          subject.enabled?('foo', 'bar')
-        end
-      end
-
-      context 'and a primed cache' do
-        before do
-          cache_key = subject.send(:build_cache_key, 'foo', 'bar', {})
-          subject.cache.store(cache_key, false)
-        end
-
-        it 'does not call #get_features_for_group' do
-          expect(subject).to_not receive(:get_features_for_group)
-          subject.enabled?('foo', 'bar')
-        end
-      end
-    end
-
-    context 'with cache strategy :all' do
-      before do
-        subject.cache_strategy = :all
-      end
-
-      context 'and an empty cache' do
-        it 'calls #get_all' do
-          expect(subject).to receive(:get_all).once
-          subject.enabled?('foo', 'bar')
-        end
-      end
-
-      context 'and a primed cache' do
-        before do
-          cache_key = subject.send(:build_cache_key, 'foo', 'bar', {})
-          subject.cache.store(cache_key, false)
-        end
-
-        it 'does not call #get_all' do
-          expect(subject).to_not receive(:get_all)
-          subject.enabled?('foo', 'bar')
-        end
-      end
-    end
-  end
-
   describe '#get_feature' do
     let(:group)   { 'pubserv' }
     let(:feature) { 'log-stats' }
@@ -127,14 +50,6 @@ describe Bandiera::Client do
         expect(stub).to have_been_requested
       end
 
-      it 'stores the feature value in the cache' do
-        stub_api_request(url, 'response' => true)
-        cache_key = subject.send(:build_cache_key, group, feature, {})
-
-        subject.get_feature(group, feature)
-        expect(subject.cache.key?(cache_key)).to be true
-      end
-
       context 'and the user has passed through some extra params' do
         it 'passes them through to the API' do
           stub = stub_request(:get, url)
@@ -174,14 +89,6 @@ describe Bandiera::Client do
 
         expect(response).to be false
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: [0, ''])
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_feature(group, feature)
-      end
     end
 
     context 'bandiera is having some problems' do
@@ -194,14 +101,6 @@ describe Bandiera::Client do
 
         expect(response).to be false
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: 500, body: '')
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_feature(group, feature)
-      end
     end
 
     context 'bandiera times out' do
@@ -214,14 +113,6 @@ describe Bandiera::Client do
 
         expect(response).to be false
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_timeout
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_feature(group, feature)
-      end
     end
   end
 
@@ -239,19 +130,6 @@ describe Bandiera::Client do
         expect(stub).to have_been_requested
       end
 
-      it 'stores the feature values in the cache' do
-        feature_hash = { 'show-stuff' => true, 'show-other-stuff' => false }
-        stub_api_request(url, 'response' => feature_hash)
-
-        subject.get_features_for_group(group)
-
-        cache_key = subject.send(:build_cache_key, group, 'show-stuff', {})
-        expect(subject.cache.key?(cache_key)).to be true
-
-        cache_key = subject.send(:build_cache_key, group, 'show-other-stuff', {})
-        expect(subject.cache.key?(cache_key)).to be true
-      end
-
       context 'and the user has passed through some extra params' do
         it 'passes them through to the API' do
           stub = stub_request(:get, url)
@@ -291,14 +169,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: [0, ''])
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_features_for_group(group)
-      end
     end
 
     context 'bandiera is having some problems' do
@@ -311,14 +181,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: 500, body: '')
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_features_for_group(group)
-      end
     end
 
     context 'bandiera times out' do
@@ -331,14 +193,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_timeout
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_features_for_group(group)
-      end
     end
   end
 
@@ -355,19 +209,6 @@ describe Bandiera::Client do
         expect(stub).to have_been_requested
       end
 
-      it 'stores the feature values in the cache' do
-        feature_hash = { 'pubserv' => { 'show-stuff' => true, 'show-other-stuff' => false } }
-        stub_api_request(url, 'response' => feature_hash)
-
-        subject.get_all
-
-        cache_key = subject.send(:build_cache_key, 'pubserv', 'show-stuff', {})
-        expect(subject.cache.key?(cache_key)).to be true
-
-        cache_key = subject.send(:build_cache_key, 'pubserv', 'show-other-stuff', {})
-        expect(subject.cache.key?(cache_key)).to be true
-      end
-
       context 'and the user has passed through some extra params' do
         it 'passes them through to the API' do
           stub = stub_request(:get, url)
@@ -407,14 +248,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: [0, ''])
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_all
-      end
     end
 
     context 'bandiera is having some problems' do
@@ -427,14 +260,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_return(status: 500, body: '')
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_all
-      end
     end
 
     context 'bandiera times out' do
@@ -447,14 +272,6 @@ describe Bandiera::Client do
 
         expect(response).to be {}
       end
-
-      it 'does not store anything in the cache' do
-        stub_request(:get, url).to_timeout
-
-        expect(subject.cache).to_not receive(:store)
-
-        subject.get_all
-      end
     end
   end
 

data/spec/lib/bandiera/middleware_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+require 'macmillan/utils/rspec/rack_test_helper'
+
+describe Bandiera::Middleware do
+  let(:app)             { ->(env) { [200, env, 'app'] } }
+  let(:request)         { req_for('http://example.com') }
+  let(:bandiera_client) { double(:bandiera_client) }
+  let(:bandiera_groups) { [] }
+  let(:user)            { double(:user, email: 'bob.flemming@cough.com') }
+  let(:user_uuid)       { '12345-12345-12345' }
+
+  subject { described_class.new(app, client: bandiera_client, groups: bandiera_groups) }
+
+  context 'when a bandiera client has NOT been passed' do
+    it 'raises an error' do
+      expect { described_class.new(app) }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'feature flag "groups"' do
+    context 'when NO feature flag "groups" have been defined' do
+      it 'calls #get_all on the bandiera_client' do
+        expect(bandiera_client).to receive(:get_all).and_return({})
+
+        subject.call(request.env)
+      end
+
+      it 'stores the returned flags in the env' do
+        pubserv_flags     = { 'show-stuff' => true }
+        search_flags      = { 'show-search' => false }
+        bandiera_response = { 'pubserv' => pubserv_flags, 'search' => search_flags }
+
+        expect(bandiera_client).to receive(:get_all).and_return(bandiera_response)
+
+        _status, headers, _body = subject.call(request.env)
+
+        expect(headers['bandiera.pubserv']).to eq(pubserv_flags)
+        expect(headers['bandiera.search']).to eq(search_flags)
+      end
+    end
+
+    context 'when SOME feature flag "groups" have been defined' do
+      let(:bandiera_groups) { ['search'] }
+
+      it 'calls #get_features_for_group on the bandiera_client' do
+        expect(bandiera_client).to receive(:get_features_for_group).and_return([])
+
+        subject.call(request.env)
+      end
+
+      it 'stores the returned flags in the env' do
+        bandiera_response = { 'show-search' => false }
+
+        expect(bandiera_client).to receive(:get_features_for_group).and_return(bandiera_response)
+
+        _status, headers, _body = subject.call(request.env)
+
+        expect(headers['bandiera.search']).to eq(bandiera_response)
+      end
+    end
+  end
+
+  context '"uuid_env_key"' do
+    before do
+      request.env[Macmillan::Utils::Middleware::Uuid.env_key] = user_uuid
+    end
+
+    context 'HAS NOT been set' do
+      it 'uses the default key from Macmillan::Utils' do
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_id: user_uuid)).and_return({})
+
+        subject.call(request.env)
+      end
+
+      context "and the nothing has set the #{Macmillan::Utils::Middleware::Uuid.env_key} value" do
+        it 'passes nil to the #user_id param' do
+          request.env.delete(Macmillan::Utils::Middleware::Uuid.env_key)
+
+          expect(bandiera_client).to receive(:get_all).with(hash_including(user_id: nil)).and_return({})
+
+          subject.call(request.env)
+        end
+      end
+    end
+
+    context 'HAS been set' do
+      let(:uuid_env_key) { 'wibble' }
+      let(:uuid)         { 'qwerty' }
+
+      subject { described_class.new(app, client: bandiera_client, groups: bandiera_groups, uuid_env_key: uuid_env_key) }
+
+      it 'uses the key passed into it' do
+        request.env[uuid_env_key] = uuid
+
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_id: uuid)).and_return({})
+
+        subject.call(request.env)
+      end
+    end
+  end
+
+  context '"user_env_key"' do
+    before do
+      request.env['current_user'] = user
+    end
+
+    context 'when there is no current user' do
+      it 'does not cause errors' do
+        expect do
+          request.env['current_user'] = nil
+
+          expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: nil)).and_return({})
+
+          subject.call(request.env)
+        end.to_not raise_error
+      end
+    end
+
+    context 'HAS NOT been set' do
+      it 'uses the default key - "current_user"' do
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: user.email)).and_return({})
+
+        subject.call(request.env)
+      end
+    end
+
+    context 'HAS been set' do
+      let(:user_env_key) { 'wibble' }
+      let(:user)         { double(:user, email: 'robert.paulson@example.com') }
+
+      subject { described_class.new(app, client: bandiera_client, groups: bandiera_groups, user_env_key: user_env_key) }
+
+      it 'uses the key passed to it' do
+        request.env[user_env_key] = user
+
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: user.email)).and_return({})
+
+        subject.call(request.env)
+      end
+    end
+  end
+
+  context '"user_group_method"' do
+    before do
+      request.env['current_user'] = user
+    end
+
+    context 'when there is no current user' do
+      it 'does not cause errors' do
+        expect do
+          request.env['current_user'] = nil
+
+          expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: nil)).and_return({})
+
+          subject.call(request.env)
+        end.to_not raise_error
+      end
+    end
+
+    context 'HAS NOT been set' do
+      it 'uses the default method - "email"' do
+        email = 'ron.manager@football.com'
+
+        expect(user).to receive(:public_send).with(:email).once.and_return(email)
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: email)).and_return({})
+
+        subject.call(request.env)
+      end
+    end
+
+    context 'HAS been set' do
+      subject { described_class.new(app, client: bandiera_client, groups: bandiera_groups, user_group_method: :role) }
+
+      it 'uses the method passed to it' do
+        role = 'Administrator'
+
+        expect(user).to receive(:public_send).with(:role).once.and_return(role)
+        expect(bandiera_client).to receive(:get_all).with(hash_including(user_group: role)).and_return({})
+
+        subject.call(request.env)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -12,3 +12,4 @@ require 'macmillan/utils/test_helpers/simplecov_helper'
 require 'pry'
 
 require 'bandiera/client'
+require 'bandiera/middleware'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandiera-client
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Macmillan Science and Education (New Publsihing Platforms)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,13 +81,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: moneta
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -135,6 +135,7 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - HISTORY
 - LICENSE.txt
@@ -143,11 +144,13 @@ files:
 - bandiera-client.gemspec
 - lib/bandiera/client.rb
 - lib/bandiera/client/version.rb
+- lib/bandiera/middleware.rb
 - spec/lib/bandiera/client_spec.rb
+- spec/lib/bandiera/middleware_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/nature/bandiera-client-ruby
 licenses:
-- GPL-3
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -165,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple feature flagging API client.