macmillan-utils 1.0.11

data/lib/macmillan/utils/middleware.rb

@@ -0,0 +1,7 @@
+module Macmillan
+  module Utils
+    module Middleware
+      autoload :WeakEtags, 'macmillan/utils/middleware/weak_etags'
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Macmillan
+  module Utils
+    module Middleware
+      ##
+      # Rack Middleware for use when proxying a rack app with Nginx using gzip compression.
+      #
+      # Nginx will convert ETags generated by our rack apps from STRONG etags, to WEAK etags,
+      # this middleware converts the ETags back to STRONG for use within the consuming app.
+      #
+      # @ref http://akshaykarle.com/blog/2014/09/17/rails-caching-with-nginx/
+      class WeakEtags
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          dup.process(env)
+        end
+
+        def process(env)
+          etag = env['HTTP_IF_NONE_MATCH']
+
+          if etag && etag.match(/^W\//)
+            env['HTTP_IF_NONE_MATCH'] = etag.gsub(/^W\//, '')
+          end
+
+          status, headers, body = @app.call(env)
+          [status, headers, body]
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/rails/statsd_instrumentation.rb

@@ -0,0 +1,64 @@
+require 'socket'
+
+##
+# Default $statsD instrumentation for Rails applications
+#
+# ASSUMPTION: Your StatsD client is stored in a global variable $statsd
+#
+# Usage (in `config/initializers/statsd.rb`):
+#
+#   require 'statsd-ruby'
+#   require 'macmillan/utils/statsd_decorator'
+#
+#   $statsd = Statsd.new('http://statsd.example.com', 8080)
+#   $statsd = Macmillan::Utils::StatsdDecorator.new($statsd, Rails.env, Rails.logger)
+#
+#   require 'macmillan/utils/rails/statsd_instrumentation'
+#
+# Options (Set as environment variables):
+#
+#   STRIP_DOMAIN_FROM_HOST = domain name (string) to strip from the servers' host name
+#
+# Credit:
+#
+# The code below is knocked togther from ideas in...
+#   * http://railstips.org/blog/archives/2011/03/21/hi-my-name-is-john/
+#   * http://www.mikeperham.com/2012/08/25/using-statsd-with-rails/
+#   * http://37signals.com/svn/posts/3091-pssst-your-rails-application-has-a-secret-to-tell-you
+#
+# Notes:
+#
+#   Uses ActiveSupport::Notifications to hook in some instrumentation...
+#   @see http://guides.rubyonrails.org/active_support_instrumentation.html
+#
+ActiveSupport::Notifications.subscribe /process_action.action_controller/ do |*args|
+  event      = ActiveSupport::Notifications::Event.new(*args)
+  controller = event.payload[:controller].gsub('Controller', '_controller').gsub('::', '.')
+  action     = event.payload[:action]
+  format     = event.payload[:format]
+  format     = 'other' unless %i(html json xml ris csv).include?(format)
+  status     = event.payload[:status].to_i
+  status     = '5xx' if status >= 500 && status <= 599
+  hostname   = Socket.gethostname.downcase
+  hostname   = hostname.gsub(ENV['STRIP_DOMAIN_FROM_HOST'], '') if ENV['STRIP_DOMAIN_FROM_HOST']
+  key        = "controllers.#{controller}.#{action}.#{format}".downcase
+
+  # count reponses
+  $statsd.increment('http_status.overall')
+  $statsd.increment("http_status.#{status}")
+  $statsd.increment("#{key}.http_status.#{status}")
+  $statsd.increment("#{key}.#{hostname}.http_status.#{status}")
+
+  # only record timings on success
+  if status == 200
+    $statsd.timing('response_time', event.duration)
+
+    $statsd.timing("#{key}.response_time", event.duration)
+    $statsd.timing("#{key}.db_time", event.payload[:db_runtime])
+    $statsd.timing("#{key}.view_time", event.payload[:view_runtime])
+
+    $statsd.timing("#{key}.#{hostname}.response_time", event.duration)
+    $statsd.timing("#{key}.#{hostname}.db_time", event.payload[:db_runtime])
+    $statsd.timing("#{key}.#{hostname}.view_time", event.payload[:view_runtime])
+  end
+end

data/lib/macmillan/utils/rspec/rack_test_helper.rb

@@ -0,0 +1,12 @@
+require 'rack/test'
+
+module RackTestHelper
+  def req_for(url, opts = {})
+    Rack::Request.new(env_for(url, opts))
+  end
+
+  def env_for(url, opts = {})
+    Rack::MockRequest.env_for(url, opts)
+  end
+end
+include RackTestHelper

data/lib/macmillan/utils/rspec/rspec_defaults.rb

@@ -0,0 +1,44 @@
+def check_rubocop_and_hound
+  # ASSUMPTION: We are running the RSpec suite from the root of a project tree
+  update_rubocop     = true
+  rubocop_file       = '.rubocop.yml'
+  local_rubocop_file = File.join(Dir.getwd, rubocop_file)
+  local_hound_file   = File.join(Dir.getwd, '.hound.yml')
+
+  if File.exist?(local_rubocop_file)
+    latest_rubocop_conf  = File.read(File.expand_path("../../../../../#{rubocop_file}", __FILE__))
+    current_rubocop_conf = File.read(local_rubocop_file)
+    update_rubocop       = false if current_rubocop_conf == latest_rubocop_conf
+  end
+
+  if !File.exist?(local_hound_file) || !File.symlink?(local_hound_file)
+    system "rm -f #{local_hound_file}"
+    system "ln -s #{rubocop_file} #{local_hound_file}"
+  end
+
+  if update_rubocop
+    puts 'WARNING: You do not have the latest set of rubocop style preferences.'
+    puts '         These have now been updated for you. :)'
+    puts ''
+    puts '         You can run RSpec again now.'
+    puts ''
+    puts "         Don't forget to commit the '.rubocop.yml' and '.hound.yml' files to git!"
+
+    File.open(local_rubocop_file, 'w') do |file|
+      file.print latest_rubocop_conf
+    end
+
+    fail RuntimeError, '...'
+  end
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+
+  # Exit the suite on the first failure
+  config.fail_fast = true if ENV['FAIL_FAST']
+
+  config.before(:suite) do
+    check_rubocop_and_hound
+  end
+end

data/lib/macmillan/utils/rspec/webmock_helper.rb

@@ -0,0 +1,13 @@
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(allow_localhost: true, allow: [/codeclimate/])
+
+RSpec.configure do |config|
+  config.after(:each) do
+    WebMock.reset!
+  end
+
+  config.after(:suite) do
+    WebMock.disable!
+  end
+end

data/lib/macmillan/utils/settings.rb

@@ -0,0 +1,33 @@
+module Macmillan
+  module Utils
+    module Settings
+      autoload :AppYamlBackend, 'macmillan/utils/settings/app_yaml_backend'
+      autoload :EnvVarsBackend, 'macmillan/utils/settings/env_vars_backend'
+      autoload :Lookup,         'macmillan/utils/settings/lookup'
+      autoload :Value,          'macmillan/utils/settings/value'
+      autoload :KeyNotFound,    'macmillan/utils/settings/key_not_found'
+
+      class KeyNotFoundError < StandardError; end
+
+      class << self
+        # Get an instance of the settings looker-upper
+        def instance
+          @instance ||= begin
+            backend_instances = backends.map(&:new)
+            Lookup.new(backend_instances)
+          end
+        end
+
+        # Backends must respond to the following interface:
+        #   # `.new`    :: Return an instance of the backend
+        #   # `#get key`:: Return a Value for the key.
+        #               :: If there's no setting, return
+        #               :: a KeyNotFound
+        #
+        attr_accessor :backends
+      end
+
+      self.backends = [EnvVarsBackend, AppYamlBackend]
+    end
+  end
+end

data/lib/macmillan/utils/settings/app_yaml_backend.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+module Macmillan
+  module Utils
+    module Settings
+      class AppYamlBackend
+        def get(key)
+          return build_value(key) if yaml.key?(key)
+          KeyNotFound.new(key, self, key)
+        end
+
+        private
+
+        def build_value(key)
+          Value.new(key, yaml[key], self, key)
+        end
+
+        def yaml
+          @yaml ||= begin
+            YAML.load(File.open(application_yml_path))
+          end
+        end
+
+        def application_yml_path
+          search_pattern  = File.join('config', 'application.yml')
+          here            = File.expand_path(Dir.pwd)
+          path_components = here.split(/\//)
+          found_path      = nil
+
+          path_components.size.downto(1) do |path_size|
+            break if found_path
+            search_path = path_components[0, path_size]
+            search_file = File.join(search_path, search_pattern)
+            found_path  = search_file if File.exist?(search_file)
+          end
+
+          fail 'cannot find application.yml' if found_path.nil?
+
+          found_path
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/settings/env_vars_backend.rb

@@ -0,0 +1,13 @@
+module Macmillan
+  module Utils
+    module Settings
+      class EnvVarsBackend
+        def get(key)
+          backend_key = key.to_s.upcase
+          return KeyNotFound.new(key, self, backend_key) unless ENV.key?(backend_key)
+          Value.new(key, ENV[backend_key].dup, self, backend_key)
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/settings/key_not_found.rb

@@ -0,0 +1,13 @@
+module Macmillan
+  module Utils
+    module Settings
+      class KeyNotFound
+        def initialize(lookup_key, backend, backend_key)
+          @lookup_key  = lookup_key
+          @backend     = backend
+          @backend_key = backend_key
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/settings/lookup.rb

@@ -0,0 +1,29 @@
+module Macmillan
+  module Utils
+    module Settings
+      class Lookup
+        def initialize(backends)
+          @backends = backends
+        end
+
+        def lookup(key)
+          value = nil
+
+          @backends.each do |backend|
+            break if value
+            result = backend.get(key)
+            value  = result.value unless result.is_a?(KeyNotFound)
+          end
+
+          fail KeyNotFoundError.new("Cannot find a settings value for #{key}") unless value
+
+          value
+        end
+
+        # Backwards compatibility: in the past this has been used like a Hash
+        alias_method :[], :lookup
+        alias_method :fetch, :lookup
+      end
+    end
+  end
+end

data/lib/macmillan/utils/settings/value.rb

@@ -0,0 +1,16 @@
+module Macmillan
+  module Utils
+    module Settings
+      class Value
+        attr_reader :value
+
+        def initialize(lookup_key, value, backend, backend_key)
+          @lookup_key  = lookup_key
+          @value       = value
+          @backend     = backend
+          @backend_key = backend_key
+        end
+      end
+    end
+  end
+end

data/lib/macmillan/utils/statsd_controller_helper.rb

@@ -0,0 +1,81 @@
+require_relative 'statsd_middleware'
+
+module Macmillan
+  module Utils
+    ##
+    # Helper functions for working with {Macmillan::Utils::StatsdMiddleware}
+    # in Rack based web applications.
+    #
+    # This code is heavily inspired by {https://github.com/mleinart/sinatra-statsd-helper sinatra-statsd-helper}
+    #
+    # == Usage:
+    #
+    # Add 'macmillan-utils' to your Gemfile:
+    #
+    #   gem 'macmillan-utils', require: false
+    #
+    # First, setup the {Macmillan::Utils::StatsdMiddleware} as described in its
+    # documentation. Then simply include this module in your controller classes.
+    #
+    # i.e. in Sinatra
+    #
+    #   require 'macmillan/utils/statsd_controller_helper'
+    #
+    #   class Server < Sinatra::Base
+    #     include Macmillan::Utils::StatsdControllerHelper
+    #
+    #     get '/' do
+    #       add_statsd_timer('get.homepage') # sends a timer to the stat 'get.homepage' with the timing of the request
+    #     end
+    #
+    #     get '/inc' do
+    #       add_statsd_increment('get.inc') # sends an increment to the stat 'get.inc'
+    #     end
+    #
+    #     get '/both' do
+    #       add_statsd_timer_and_increment('get.both') # sends both an timer and increment stat to 'get.both'
+    #     end
+    #   end
+    #
+    # Rails works identically:
+    #
+    #   require 'macmillan/utils/statsd_controller_helper'
+    #
+    #   class SiteController < ApplicationController
+    #     include Macmillan::Utils::StatsdControllerHelper
+    #
+    #     def index
+    #       add_statsd_timer_and_increment('get.site_controller.index')
+    #     end
+    #   end
+    #
+    module StatsdControllerHelper
+      module_function
+
+      ##
+      # Send a timer stat to statsd (with the timing of the whole rack request)
+      #
+      # @param key [String] the statsd/graphite statistic name/key
+      def add_statsd_timer(key)
+        request.env[::Macmillan::Utils::StatsdMiddleware::TIMERS] << key
+      end
+
+      ##
+      # Send an increment stat to statsd
+      #
+      # @param key [String] the statsd/graphite statistic name/key
+      def add_statsd_increment(key)
+        request.env[::Macmillan::Utils::StatsdMiddleware::INCREMENTS] << key
+      end
+
+      ##
+      # Send both a timer and an increment stat to statsd
+      #
+      # @param key [String] the statsd/graphite statistic name/key
+      def add_statsd_timer_and_increment(key)
+        add_statsd_timer(key)
+        add_statsd_increment(key)
+      end
+    end
+  end
+end

data/lib/macmillan/utils/statsd_decorator.rb

@@ -0,0 +1,98 @@
+module Macmillan
+  module Utils
+    ##
+    # Utility class to wrap the Statsd class from {http://rubygems.org/gems/statsd-ruby statsd-ruby}.
+    #
+    # This will allow you to log Statsd messages to your logs, but only
+    # really send messages to the StatsD server when running in a
+    # 'production' environment.
+    #
+    # === Usage:
+    #
+    # Add 'statsd-ruby' and 'macmillan-utils' to your Gemfile:
+    #
+    #   gem 'statsd-ruby'
+    #   gem 'macmillan-utils', require: false
+    #
+    # Then in your code:
+    #
+    #   require 'statsd'
+    #   require 'macmillan/utils/statsd_decorator'
+    #
+    #   statsd = Statsd.new('http://statsd.example.com', 8080)
+    #   statsd = Macmillan::Utils::StatsdDecorator.new(statsd, ENV['RACK_ENV'])
+    #
+    # i.e. when using rails, use the rails env and logger:
+    #
+    #   statsd = Statsd.new('http://statsd.example.com', 8080)
+    #   statsd = Macmillan::Utils::StatsdDecorator.new(statsd, Rails.env, Rails.logger)
+    #
+    # @see http://rubygems.org/gems/statsd-ruby
+    #
+    class StatsdDecorator < SimpleDelegator
+      attr_accessor :env, :logger
+
+      ##
+      # Builds a new instance of StatsdDecorator
+      #
+      # @param delegatee [Statsd] a Statsd object
+      # @param env [String] the current application environment - i.e. 'development' or 'production'
+      # @param logger [Logger] a Logger object
+      # @return [Statsd] the decorated Statsd class
+      #
+      def initialize(delegatee, env = 'development', logger = Macmillan::Utils::Logger::Factory.build_logger)
+        @env    = env
+        @logger = logger
+        super(delegatee)
+      end
+
+      def increment(stat, sample_rate = 1)
+        log_stat %{increment - "#{stat}" (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def decrement(stat, sample_rate = 1)
+        log_stat %{decrement - "#{stat}" (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def count(stat, count, sample_rate = 1)
+        log_stat %{count - "#{stat}" #{count} (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def guage(stat, value, sample_rate = 1)
+        log_stat %{gauge - "#{stat}" #{value} (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def set(stat, value, sample_rate = 1)
+        log_stat %{set - "#{stat}" #{value} (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def timing(stat, ms, sample_rate = 1)
+        log_stat %{timing - "#{stat}" #{ms}ms (sample_rate: #{sample_rate})}
+        super if send_to_delegatee?
+      end
+
+      def time(stat, sample_rate = 1, &block)
+        start    = Time.now
+        result   = block.call
+        duration = ((Time.now - start) * 1000).round
+        timing(stat, duration, sample_rate)
+        result
+      end
+
+      private
+
+      def log_stat(msg)
+        logger.debug "[StatsD] #{msg}"
+      end
+
+      def send_to_delegatee?
+        env == 'production'
+      end
+    end
+  end
+end