macmillan-utils 1.0.15 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f21b8489a845791b540628d4bd8c83f8b8bb8c0a
-  data.tar.gz: 10b5379ccfb3179f6aaebabdbae667b72bdfd4df
+  metadata.gz: a55ad2739730efad268195c547a7e32778b01a24
+  data.tar.gz: 7fdcb527d586d86710b39f37109fbeb43f9d6714
 SHA512:
-  metadata.gz: 70e07de17d2025f9c9852461e937913413107382ac979cc624bd7561a6a8f1e8fcc5711a36ba21420ee14b008a12c4ce9be33654e3273c686461081c3c42170e
-  data.tar.gz: 303455c3d6ca9cffc2188efdb8c1aa6f65a5948ba4b8f2ab78d23ac5945db13b64595449c70cbcbb8d6a25b6c1a8679f8c7605398b8130f0dfa1fe1318e346e8
+  metadata.gz: 7610595d1d34f5302efc6c0eda3005addc1ec698d490c872b0ac85a04c1f8a69646ee650ed373d0afacd7ca94c91ee2cd70d438c2d082b838fac01a65b25cdbc
+  data.tar.gz: 01578efea5492224685f7ddfddcaf25efcd262f24f7f6f45b9c2f8dd4287ffb2f8aef1f9ec8c1b9a2647082d1f03100a970e8f460318f65b78857f6abb781ecb

data/.travis.yml

@@ -11,5 +11,6 @@ rvm:
   - 2.1.5
   - 2.2.0
   - jruby-19mode
+  - rbx-2
 env:
   - USE_SIMPLECOV=true CODECLIMATE_REPO_TOKEN=2175628fb41494d45b50b6938600a53c130e1f7ac3b81b072bb71e91073a5e4a

data/lib/macmillan/utils/middleware.rb

@@ -2,6 +2,7 @@ module Macmillan
   module Utils
     module Middleware
       autoload :WeakEtags, 'macmillan/utils/middleware/weak_etags'
+      autoload :Uuid,      'macmillan/utils/middleware/uuid'
     end
   end
 end

data/lib/macmillan/utils/middleware/uuid.rb

@@ -0,0 +1,89 @@
+module Macmillan
+  module Utils
+    module Middleware
+      ##
+      # Rack Middleware for uniquley identifying a user.
+      #
+      # If the user is logged in, their UUID will be based upon their user_id, otherwise
+      # it will be randomly generated.  This UUID will be stored in the rack env, and
+      # persisted in a cookie.
+      #
+      # This middleware expects a user object to be stored in the rack env.
+      #
+      class Uuid
+        def self.env_key
+          'user.uuid'
+        end
+
+        def initialize(app, opts={})
+          @app            = app
+          @user_env_key   = opts[:user_env_key] || 'current_user'
+          @user_id_method = opts[:user_id_method] || 'user_id'
+        end
+
+        class CallHandler
+          attr_reader :app, :request, :user_env_key, :user_id_method, :cookie_key
+
+          def initialize(env, app, user_env_key, user_id_method, cookie_key)
+            @app            = app
+            @request        = Rack::Request.new(env)
+            @user_env_key   = user_env_key
+            @user_id_method = user_id_method
+            @cookie_key     = cookie_key
+
+            env[cookie_key] = user_uuid
+          end
+
+          def response
+            @response ||= begin
+                            status, headers, body = app.call(request.env)
+                            Rack::Response.new(body, status, headers)
+                          end
+          end
+
+          def finish
+            save_cookie if store_cookie?
+            response.finish
+          end
+
+          def user
+            request.env[user_env_key]
+          end
+
+          def user_uuid
+            @user_uuid ||= begin
+                             if user
+                               Digest::SHA1.hexdigest(user.public_send(user_id_method).to_s)
+                             elsif cookie_uuid
+                               cookie_uuid
+                             else
+                               SecureRandom.uuid
+                             end
+                           end
+          end
+
+          def cookie_uuid
+            request.cookies[cookie_key]
+          end
+
+          def store_cookie?
+            user_uuid != cookie_uuid
+          end
+
+          def save_cookie
+            response.set_cookie(cookie_key, { value: user_uuid, path: '/', expires: DateTime.now.next_year.to_time })
+          end
+        end
+
+        def call(env)
+          dup.process(env)
+        end
+
+        def process(env)
+          handler = CallHandler.new(env, @app, @user_env_key, @user_id_method, self.class.env_key)
+          handler.finish
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/middleware/weak_etags.rb

@@ -24,8 +24,7 @@ module Macmillan
             env['HTTP_IF_NONE_MATCH'] = etag.gsub(/^W\//, '')
           end
 
-          status, headers, body = @app.call(env)
-          [status, headers, body]
+          @app.call(env)
         end
       end
     end

data/spec/lib/macmillan/utils/middleware/uuid_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+RSpec.describe Macmillan::Utils::Middleware::Uuid do
+  let(:app)             { ->(env) { [200, env, 'app'] } }
+  let(:request)         { req_for('http://example.com') }
+  let(:user)            { double(email: 'bob.flemming@cough.com', user_id: '12345') }
+  let(:user_uuid)       { Digest::SHA1.hexdigest(user.user_id.to_s) }
+
+  subject { Macmillan::Utils::Middleware::Uuid.new(app) }
+
+  context 'when we have a logged in user' do
+    before do
+      request.env['current_user'] = user
+    end
+
+    context 'who has not visited before' do
+      it 'sets the user_uuid cookie' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['Set-Cookie']).to include(user_uuid)
+      end
+
+      it 'stores the user_uuid in the env' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['user.uuid']).to eq(user_uuid)
+      end
+    end
+
+    context 'who also has a randomly assigned user_uuid cookie (from a previous non-authenticated session)' do
+      before do
+        request.cookies['user.uuid'] = 'qwerty'
+      end
+
+      it 'replaces this cookie with one based on the users user_id' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['Set-Cookie']).to include("user.uuid=#{user_uuid}")
+      end
+    end
+  end
+
+  context 'when we have a non-logged in user' do
+    before do
+      request.env['current_user'] = nil
+      allow(SecureRandom).to receive(:uuid).and_return('wibble')
+    end
+
+    context 'who has not visited before' do
+      it 'stores the auto-generated UUID in the env' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['user.uuid']).to eq('wibble')
+      end
+
+      it 'sets the user_uuid cookie' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['Set-Cookie']).to include('user.uuid=wibble')
+      end
+    end
+
+    context 'who has visited before and has a user_uuid cookie' do
+      before do
+        request.cookies['user.uuid'] = 'qwerty'
+      end
+
+      it 'stores the user_uuid (from the cookie) in the env' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['user.uuid']).to eq('qwerty')
+      end
+
+      it 'does not try to replace the cookie' do
+        _status, headers, _body = subject.call(request.env)
+        expect(headers['Set-Cookie']).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macmillan-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.16
 platform: ruby
 authors:
 - Macmillan Science and Education (New Publsihing Platforms)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -230,6 +230,7 @@ files:
 - lib/macmillan/utils/logger/factory.rb
 - lib/macmillan/utils/logger/formatter.rb
 - lib/macmillan/utils/middleware.rb
+- lib/macmillan/utils/middleware/uuid.rb
 - lib/macmillan/utils/middleware/weak_etags.rb
 - lib/macmillan/utils/rails/statsd_instrumentation.rb
 - lib/macmillan/utils/rspec/rack_test_helper.rb
@@ -252,6 +253,7 @@ files:
 - spec/fixtures/config/application.yml
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
+- spec/lib/macmillan/utils/middleware/uuid_spec.rb
 - spec/lib/macmillan/utils/middleware/weak_etags_spec.rb
 - spec/lib/macmillan/utils/settings_spec.rb
 - spec/lib/macmillan/utils/statsd_controller_helper_spec.rb
@@ -287,6 +289,7 @@ test_files:
 - spec/fixtures/config/application.yml
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
+- spec/lib/macmillan/utils/middleware/uuid_spec.rb
 - spec/lib/macmillan/utils/middleware/weak_etags_spec.rb
 - spec/lib/macmillan/utils/settings_spec.rb
 - spec/lib/macmillan/utils/statsd_controller_helper_spec.rb