macmillan-utils 1.0.32 → 1.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 771b5d2922350be347edf3c922bdf1dc4d69d8f1
-  data.tar.gz: 726f17ce0e1aa15812d5889b9141c4e40fc65fc5
+  metadata.gz: 082720f53c08e7a389f791d4859adf4ff408ee1d
+  data.tar.gz: 686bbcdebb11405d314be7fc2eaceca800070539
 SHA512:
-  metadata.gz: 0a65ec3c1bceff1f615e802091960560875657253eff61145a827c3f45add52ceb50fa07159c8d69c96f3d7caee1c596ec6e4f9161f9531bd1fb735c0d528d1c
-  data.tar.gz: 07271ff5cf2cbaa72ddac0536b465862d88e647827a8cdb5fb37aacabacc81fc391ade27553cf8116dbe841ff820459edbf9659cbf9eaa5931cfeb170dc2ea1e
+  metadata.gz: 72fe89d06f184fb910a157b96330231438767a830b91c702741d7751f65a82ed7baa3e3b80b1eade25c42e671d50b80211ccbd4280d498a8e308596bb42e1d5b
+  data.tar.gz: 893e33789d9f0b892ce93d0dc9c7333f595374d1b2143c1affb4708dfc920064224f51c3aea2f3ab07f7d2076b87aa416b8fd8ee3fb197798a1720dfd95f0bb0

data/.rubocop.yml

@@ -2,6 +2,11 @@ Metrics/LineLength:
   Description: 'Limit lines to 120 characters.'
   Max: 120
 
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+
 Style/Documentation:
   Enabled: false
 
@@ -26,6 +31,25 @@ Style/AlignParameters:
 Style/StringLiterals:
   EnforcedStyle: single_quotes
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%I': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
 Style/CollectionMethods:
   PreferredMethods:
     collect: 'map'

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

@@ -0,0 +1,71 @@
+require 'rack/request'
+require 'rack/response'
+require 'uri'
+
+module Macmillan
+  module Utils
+    module Middleware
+      class CookieMessage
+        YEAR = 31_536_000
+        COOKIE = 'euCookieNotice'.freeze
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          request = Rack::Request.new(env)
+
+          if cookies_accepted?(request)
+            redirect_back(request)
+          else
+            @app.call(env)
+          end
+        end
+
+        private
+
+        def cookies_accepted?(request)
+          request.post? &&
+            request.cookies[COOKIE] != 'accepted' &&
+            request.params['cookies'] == 'accepted'
+        end
+
+        def redirect_back(request)
+          response = Rack::Response.new
+          location = build_location(request)
+
+          response.redirect(location)
+          response.set_cookie(COOKIE, cookie_options(request))
+
+          response.to_a
+        end
+
+        def cookie_options(request)
+          {
+            value:   'accepted',
+            domain:  request.host_with_port,
+            path:    '/',
+            expires: Time.now.getutc + YEAR
+          }
+        end
+
+        def build_location(request)
+          begin
+            uri = URI.parse(request.referrer.to_s)
+          rescue URI::InvalidURIError
+            uri = URI.parse(request.url)
+          end
+
+          # Check that the redirect is an internal one for security reasons:
+          # https://webmasters.googleblog.com/2009/01/open-redirect-urls-is-your-site-being.html
+          internal_redirect?(request, uri) ? uri.to_s : request.url
+        end
+
+        def internal_redirect?(request, uri)
+          request.host == uri.host && request.port == uri.port
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/middleware.rb

@@ -1,8 +1,9 @@
 module Macmillan
   module Utils
     module Middleware
-      autoload :WeakEtags, 'macmillan/utils/middleware/weak_etags'
-      autoload :Uuid,      'macmillan/utils/middleware/uuid'
+      autoload :CookieMessage, 'macmillan/utils/middleware/cookie_message'
+      autoload :WeakEtags,     'macmillan/utils/middleware/weak_etags'
+      autoload :Uuid,          'macmillan/utils/middleware/uuid'
     end
   end
 end

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

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+RSpec.describe Macmillan::Utils::Middleware::CookieMessage do
+  let(:app) { ->(_) { [200, {}, %w[body]] } }
+  let(:env) { env_for(url, request_headers) }
+  let(:request_headers) { default_headers.merge(extra_headers) }
+  let(:default_headers) { { 'REQUEST_METHOD' => request_method } }
+  let(:extra_headers) { {} }
+
+  subject { described_class.new(app) }
+
+  let(:response) { subject.call(env) }
+  let(:status) { response[0] }
+  let(:headers) { response[1] }
+  let(:body) { response[2] }
+  let(:cookie) { headers['Set-Cookie'] }
+  let(:location) { headers['Location'] }
+
+  context 'when request params contains cookies=accepted' do
+    let(:url) { 'http://www.nature.com/?cookies=accepted' }
+
+    context 'and the request method is GET' do
+      let(:request_method) { 'GET' }
+
+      it 'calls the app' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+      end
+    end
+
+    context 'and the request method is POST' do
+      let(:request_method) { 'POST' }
+
+      context 'and the euNoticeCookie is not set' do
+        before do
+          allow(Time).to receive(:now).and_return(Time.utc(2017, 1, 31))
+          expect(app).not_to receive(:call)
+        end
+
+        it 'redirects' do
+          expect(status).to eq(302)
+        end
+
+        it 'sets the cookie' do
+          expect(cookie).to match(/euCookieNotice=accepted;/)
+          expect(cookie).to match(/domain=www\.nature\.com:80;/)
+          expect(cookie).to match(/path=\/;/)
+          expect(cookie).to match(/expires=Wed, 31 Jan 2018 00:00:00 -0000/)
+        end
+
+        it 'redirects back to the original url' do
+          expect(location).to eq('http://www.nature.com/?cookies=accepted')
+        end
+
+        context 'and the referrer is set' do
+          let(:extra_headers) { { 'HTTP_REFERER' => 'http://www.nature.com/articles/ncomms7169' } }
+
+          it 'redirects back to the referrer' do
+            expect(location).to eq('http://www.nature.com/articles/ncomms7169')
+          end
+        end
+      end
+
+      context 'and the euNoticeCookie is set' do
+        let(:extra_headers) { { 'HTTP_COOKIE' => 'euCookieNotice=accepted' } }
+
+        it 'calls the app' do
+          expect(app).to receive(:call).with(env).and_call_original
+          expect(response).to eq([200, {}, %w[body]])
+        end
+      end
+    end
+  end
+
+  context 'when request params does not cookies=accepted' do
+    let(:url) { 'http://www.nature.com/' }
+
+    context 'and the request method is GET' do
+      let(:request_method) { 'GET' }
+
+      it 'calls the app' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+      end
+    end
+
+    context 'and the request method is POST' do
+      let(:request_method) { 'POST' }
+
+      it 'calls the app' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macmillan-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.32
+  version: 1.0.33
 platform: ruby
 authors:
 - Springer Nature
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2017-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -232,6 +232,7 @@ files:
 - lib/macmillan/utils/logger/factory.rb
 - lib/macmillan/utils/logger/formatter.rb
 - lib/macmillan/utils/middleware.rb
+- lib/macmillan/utils/middleware/cookie_message.rb
 - lib/macmillan/utils/middleware/uuid.rb
 - lib/macmillan/utils/middleware/weak_etags.rb
 - lib/macmillan/utils/rails/statsd_instrumentation.rb
@@ -257,6 +258,7 @@ files:
 - spec/lib/macmillan/utils/helper/string_conversion_helper_spec.rb
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
+- spec/lib/macmillan/utils/middleware/cookie_message_spec.rb
 - spec/lib/macmillan/utils/middleware/uuid_spec.rb
 - spec/lib/macmillan/utils/middleware/weak_etags_spec.rb
 - spec/lib/macmillan/utils/settings/lookup_spec.rb
@@ -295,6 +297,7 @@ test_files:
 - spec/lib/macmillan/utils/helper/string_conversion_helper_spec.rb
 - spec/lib/macmillan/utils/logger/factory_spec.rb
 - spec/lib/macmillan/utils/logger/formatter_spec.rb
+- spec/lib/macmillan/utils/middleware/cookie_message_spec.rb
 - spec/lib/macmillan/utils/middleware/uuid_spec.rb
 - spec/lib/macmillan/utils/middleware/weak_etags_spec.rb
 - spec/lib/macmillan/utils/settings/lookup_spec.rb