macmillan-utils 1.0.40 → 1.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035e98cbc71c2bebdd28ae144cbcd2f67d4b4271
-  data.tar.gz: 74d77b9604b18e7e0587c5b369197d9cb9273fc0
+  metadata.gz: 184123073d6983e967bbbce0a6b3c6fb931ecc75
+  data.tar.gz: d8c366efb96ee5dbc76d03fe7aeb61785cf5bbed
 SHA512:
-  metadata.gz: c2787195fab5f2524f0d886f488580ea2f0b791d0f01e9f96fe2d4429d793d89be50003e97200c86c2a694c21553aef4b2498698e3d47ce16239fa0e4fb313ec
-  data.tar.gz: b06b8e063a31ca8044e10fc8e9ab12b15e53011da44b4307dca0388185f93eb12adb8d6ebdae17200fa6569de7f5f642ff520189166d7686ceb4eafbea95bc0b
+  metadata.gz: 2aa234ff620d8a062eaf900be3b9d7d16dfba5b5c235fc305a6da172788425395e82d0fb15e28389f13c881fb8ef3deab29935aa56142f902609cbc16ffe9740
+  data.tar.gz: 7c291922805eaff74cc650b2591fbb64dc14d4f3395d85596c40a811cab66b80672caece13748fe08c098a26217273aa9f6a5db07fbccd669db114435a848cf1

data/.rubocop.yml

@@ -7,6 +7,13 @@ Metrics/BlockLength:
     - describe
     - context
 
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 40
+
 Style/Documentation:
   Enabled: false
 
@@ -16,6 +23,15 @@ Style/SpaceBeforeFirstArg:
 Style/BracesAroundHashParameters:
   Enabled: false
 
+Style/CaseEquality:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
 Style/IndentHash:
   EnforcedStyle: consistent
 

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

@@ -1,6 +1,7 @@
 require 'rack/request'
 require 'rack/response'
 require 'uri'
+require 'active_support/tagged_logging'
 
 module Macmillan
   module Utils
@@ -9,8 +10,17 @@ module Macmillan
         YEAR = 31_536_000
         COOKIE = 'euCookieNotice'.freeze
 
-        def initialize(app)
+        def initialize(app, options = {})
           @app = app
+          @log_level = options[:log_level]
+
+          if (logger = options[:logger])
+            if logger.respond_to?(:tagged)
+              @logger = logger
+            else
+              @logger = ActiveSupport::TaggedLogging.new(logger)
+            end
+          end
         end
 
         def call(env)
@@ -26,41 +36,54 @@ module Macmillan
         private
 
         def cookies_accepted?(request)
-
-          debug_log("request.post? IS #{request.post?.inspect}")
-          debug_log("request.cookies[#{COOKIE}] IS #{request.cookies[COOKIE].inspect}")
-          debug_log("request.params['cookies'] IS #{request.params['cookies'].inspect}")
-          debug_log("request.cookies IS #{request.cookies.inspect}")
+          debug("request.post? IS #{request.post?.inspect}")
+          debug("request.cookies[#{COOKIE}] IS #{request.cookies[COOKIE].inspect}")
+          debug("request.params['cookies'] IS #{request.params['cookies'].inspect}")
+          debug("request.cookies IS #{request.cookies.inspect}")
 
           unless request.post?
-            debug_log("request.post? (#{request.post?.inspect}) means passthru")
+            debug("request.post? (#{request.post?.inspect}) means passthru")
             return false
           end
+
           unless request.cookies[COOKIE] != 'accepted'
-            debug_log("request.cookies['#{COOKIE}'] (#{request.cookies[COOKIE].inspect}) means passthru")
+            debug("request.cookies['#{COOKIE}'] (#{request.cookies[COOKIE].inspect}) means passthru")
             return false
           end
+
           unless request.params['cookies'] == 'accepted'
-            debug_log("request.params['cookies'] (#{request.params['cookies'].inspect}) means passthru")
+            debug("request.params['cookies'] (#{request.params['cookies'].inspect}) means passthru")
             return false
           end
-          debug_log('About to set the acceptance cookie and redirect')
+
+          debug('About to set the acceptance cookie and redirect')
           true
         end
 
-        def debug_log(msg)
-          logger.info("[Macmillan::Utils::Middleware::CookieMessage] #{msg}\n")
+        def debug(msg)
+          logger.tagged(self.class.name) { logger.debug(msg) }
         end
 
         def logger
-          @logger ||= @request.logger || NullLogger.new
+          @logger ||= @request.logger || default_logger
+        end
+
+        def default_logger
+          logger = ::Logger.new($stdout)
+          logger.level = default_log_level
+
+          ActiveSupport::TaggedLogging.new(logger)
+        end
+
+        def default_log_level
+          @log_level || ::Logger::INFO
         end
 
         def redirect_back(request)
           response = Rack::Response.new
           location = build_location(request)
 
-          debug_log("Redirecting to #{location}")
+          debug("Redirecting to #{location}")
 
           response.redirect(location)
           response.set_cookie(COOKIE, cookie_options(request))
@@ -79,31 +102,27 @@ module Macmillan
 
         def build_location(request)
           begin
-            debug_log("Attempting to determine redirect by parsing referrer #{request.referrer}")
+            debug("Attempting to determine redirect by parsing referrer #{request.referrer}")
             uri = URI.parse(request.referrer.to_s)
           rescue URI::InvalidURIError
-            debug_log("No that failed, attempting to determine redirect by parsing request.url #{request.url}")
+            debug("No that failed, attempting to determine redirect by parsing request.url #{request.url}")
             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
-          unless internal_redirect?(request, uri)
-            debug_log("Not internal redirect - so changing to #{request.url} instead of the above")
+          if internal_redirect?(request, uri)
+            uri.to_s
+          else
+            debug("Not internal redirect - so changing to #{request.url} instead of the above")
+            request.url
           end
-          internal_redirect?(request, uri) ? uri.to_s : request.url
         end
 
         def internal_redirect?(request, uri)
-          debug_log("Is redirect to #{uri.host}:#{uri.port} internal WRT #{request.host}:#{request.port}")
+          debug("Is redirect to #{uri.host}:#{uri.port} internal WRT #{request.host}:#{request.port}")
           request.host == uri.host # && request.port == uri.port
         end
-
-        class NullLogger
-          def method_missing(*args)
-            nil
-          end
-        end
       end
     end
   end

data/macmillan-utils.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'syslog-logger'
   spec.add_dependency 'rubocop'
   spec.add_dependency 'colorize'
+  spec.add_dependency 'activesupport', '>= 3.2.0'
 end

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

@@ -44,7 +44,7 @@ RSpec.describe Macmillan::Utils::Middleware::CookieMessage do
         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(%r{path=/;})
           expect(cookie).to match(/expires=Wed, 31 Jan 2018 00:00:00 -0000/)
         end
 
@@ -93,4 +93,79 @@ RSpec.describe Macmillan::Utils::Middleware::CookieMessage do
       end
     end
   end
+
+  describe 'logging' do
+    let(:url) { 'http://www.nature.com/' }
+    let(:request_method) { 'GET' }
+    let(:output) { StringIO.new }
+
+    matcher :have_output do |expected|
+      match do
+        expected === output(actual)
+      end
+
+      failure_message do |actual|
+        "expected that #{output(actual)} would equal #{expected}"
+      end
+
+      def output(io)
+        io.rewind && io.read
+      end
+    end
+
+    context 'default logging' do
+      subject { described_class.new(app) }
+
+      around do |example|
+        begin
+          stdout = $stdout
+          $stdout = output
+
+          example.run
+        ensure
+          $stdout = stdout
+        end
+      end
+
+      it 'produces no output' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+        expect(output).to have_output('')
+      end
+    end
+
+    context 'custom log level' do
+      subject { described_class.new(app, log_level: ::Logger::DEBUG) }
+
+      around do |example|
+        begin
+          stdout = $stdout
+          $stdout = output
+
+          example.run
+        ensure
+          $stdout = stdout
+        end
+      end
+
+      it 'produces tagged output' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+        expect(output).to have_output(/\[Macmillan::Utils::Middleware::CookieMessage\]/)
+        expect(output).to have_output(/request.post\? \(false\) means passthru/)
+      end
+    end
+
+    context 'custom logger' do
+      let(:logger) { ::Logger.new(output) }
+      subject { described_class.new(app, logger: logger) }
+
+      it 'produces tagged output' do
+        expect(app).to receive(:call).with(env).and_call_original
+        expect(response).to eq([200, {}, %w[body]])
+        expect(output).to have_output(/\[Macmillan::Utils::Middleware::CookieMessage\]/)
+        expect(output).to have_output(/request.post\? \(false\) means passthru/)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macmillan-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.0.41
 platform: ruby
 authors:
 - Springer Nature
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 description: 
 email:
 - npp-developers@macmillan.com