macmillan-utils 1.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 618626d3f23f078df01d4ff82448a7fbb61510c2
+  data.tar.gz: 6849bec7f310b4e0b94882f5ce30385bd7ce0dcb
+SHA512:
+  metadata.gz: bbc3d8a092c4eec621516f0280646d185451a2ce3caec1a1ba5833d51e9309ce66767c71001d7f0e4d4a25260d62ed36c557136164572ed6b1c910ab8456a6ac
+  data.tar.gz: e294f634ff213e82c1c400176d02255ac8b08a541a709b375293aeb61f8ef202d8f8fa0c2c108413cd7a2c68c6b5d01c1928fe007c8ef5fa224424d490f94410

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+RBENV_VERSION*
+Gemfile.lock

data/.hound.yml

@@ -0,0 +1,36 @@
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/DotPosition:
+  EnforcedStyle: leading

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--profile
+--warnings

data/.rubocop.yml

@@ -0,0 +1,36 @@
+Metrics/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/DotPosition:
+  EnforcedStyle: leading

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0
+  - jruby-19mode
+env:
+  - USE_SIMPLECOV=true CODECLIMATE_REPO_TOKEN=2175628fb41494d45b50b6938600a53c130e1f7ac3b81b072bb71e91073a5e4a

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in macmillan-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Macmillan Science and Education
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,113 @@
+= Macmillan::Utils
+
+A collection of useful patterns we use in our Ruby applications.
+
+{<img src="https://travis-ci.org/nature/macmillan-utils.svg?branch=log-formatter" alt="Build Status" />}[https://travis-ci.org/nature/macmillan-utils]
+{<img src="https://codeclimate.com/github/nature/macmillan-utils.png" alt="CodeClimate Rating" />}[https://codeclimate.com/github/nature/macmillan-utils]
+{<img src="https://codeclimate.com/github/nature/macmillan-utils/coverage.png" alt="Test Coverage" />}[https://codeclimate.com/github/nature/macmillan-utils]
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'macmillan-utils', require: false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install macmillan-utils
+
+== Usage
+
+=== Logger Objects
+
+To build logger objects quickly and easily:
+
+    require 'macmillan/utils/logger'
+
+    logger = Macmillan::Utils::Logger::Factory.build_logger(:syslog, tag: 'myapp')
+
+The logger will automatically use the {Macmillan::Utils::Logger::Formatter} formatter, and will log at the
+{Logger::INFO} level.
+
+See the class documentation for more information:
+
+* {Macmillan::Utils::Logger::Factory}
+* {Macmillan::Utils::Logger::Formatter}
+
+=== Settings
+
+Easily store and lookup configuration values in either environment variables, or a `application.yml` file.
+
+    ENV['REDIS_URL'] = 'localhost'
+    $settings        = Macmillan::Utils::Settings.instance
+    redis_url        = $settings.lookup('redis_url')          #=> 'localhost'
+
+The default action is to support BOTH environment variables and a `application.yml` file for settings - if you would
+prefer only one or the other, see the 'Switching Backends' section.
+
+If a setting is requested and it has not been set (in any configured backend), a Macmillan::Utils::Settings::KeyNotFoundError
+is raised.
+
+==== Evironment Variables
+
+Set your environment variables as you would normally, using all caps for the key name, and you can then fetch the value
+using `.lookup`.  Simples.
+
+==== `application.yml` Files
+
+If you prefer to use a YAML based config file, this is the option for you.  The code will first look for a `application.yml`
+file in a `config` directory (within the current working directory), if it doesn't find one, then it looks in the current
+working directory, and keeps moving up the filesystem until it finds one.  If it doesn't it raises an error.
+
+==== Switching Backends
+
+By default both the environment variable and application yaml backends are used, if you'd like only one, you need to specify this
+before building the settings instance, i.e.:
+
+    Macmillan::Utils::Settings.backends = [Macmillan::Utils::Settings::EnvVarsBackend]
+
+would only look for environment variables, whereas
+
+    Macmillan::Utils::Settings.backends = [Macmillan::Utils::Settings::AppYamlBackendBackend]
+
+would only look for settings in an `application.yml` file.
+
+=== RSpec Helpers
+
+Add the following to the top of your `spec_helper.rb`:
+
+    require 'macmillan/utils/rspec/rspec_defaults'
+    require 'macmillan/utils/rspec/webmock_helper'
+    require 'macmillan/utils/test_helpers/codeclimate_helper'
+    require 'macmillan/utils/test_helpers/simplecov_helper'
+    require 'macmillan/utils/test_helpers/fixture_loading_helper'
+
+=== Cucumber Helpers
+
+Add the following to the top of your `env.rb`:
+
+    require 'macmillan/utils/cucumber/cucumber_defaults'
+    require 'macmillan/utils/cucumber/webmock_helper'
+    require 'macmillan/utils/test_helpers/codeclimate_helper'
+    require 'macmillan/utils/test_helpers/simplecov_helper'
+    require 'macmillan/utils/test_helpers/fixture_loading_helper'
+
+=== StatsD
+
+* {Macmillan::Utils::StatsdDecorator} - Logging and more for StatsD calls.
+* {Macmillan::Utils::StatsdStub} - Stubbed StatsD class for use in test suites.
+* {Macmillan::Utils::StatsdMiddleware} - Rack middleware for sending web application metrics to StatsD
+* {Macmillan::Utils::StatsdControllerHelper} - Helper functions to send metrics to StatsD via {Macmillan::Utils::StatsdMiddleware}
+
+== Contributing
+
+1. Fork it ( https://github.com/nature/macmillan-utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec
+
+YARD::Rake::YardocTask.new do |task|
+  task.files = ['lib/**/*.rb']
+end

data/lib/macmillan/utils.rb

@@ -0,0 +1,16 @@
+##
+# Namespace for Macmillan code...
+#
+module Macmillan
+  ##
+  # Utils module for use in Macmillan applications
+  #
+  module Utils
+    autoload :Logger,                 'macmillan/utils/logger'
+    autoload :Middleware,             'macmillan/utils/middleware'
+    autoload :Settings,               'macmillan/utils/settings'
+    autoload :StatsdDecorator,        'macmillan/utils/statsd_decorator'
+    autoload :StatsdMiddleware,       'macmillan/utils/statsd_middleware'
+    autoload :StatsdControllerHelper, 'macmillan/utils/statsd_controller_helper'
+  end
+end

data/lib/macmillan/utils/bundler/gem_helper.rb

@@ -0,0 +1,9 @@
+module Bundler
+  class GemHelper
+    def rubygem_push(path)
+      gem_server_url = 'http://gems.npgsrv.com'
+      sh("gem inabox '#{path}' --host #{gem_server_url}")
+      Bundler.ui.confirm "Pushed #{name} #{version} to #{gem_server_url}"
+    end
+  end
+end

data/lib/macmillan/utils/cucumber/cucumber_defaults.rb

@@ -0,0 +1,12 @@
+require 'cucumber'
+require 'multi_test'
+
+# control rogue test/unit/autorun requires
+MultiTest.disable_autorun
+
+# exit the suite after the first failure
+if ENV['FAIL_FAST']
+  After do |scenario|
+    Cucumber.wants_to_quit = true if scenario.failed?
+  end
+end

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

@@ -0,0 +1,9 @@
+require 'webmock/cucumber'
+
+Before do
+  WebMock.disable_net_connect!(allow_localhost: true, allow: [/capybara-local/, /codeclimate/])
+end
+
+After do
+  WebMock.reset!
+end

data/lib/macmillan/utils/logger.rb

@@ -0,0 +1,11 @@
+module Macmillan
+  module Utils
+    ##
+    # Namespace for Logger utility classes
+    #
+    module Logger
+      autoload :Factory,   'macmillan/utils/logger/factory'
+      autoload :Formatter, 'macmillan/utils/logger/formatter'
+    end
+  end
+end

data/lib/macmillan/utils/logger/factory.rb

@@ -0,0 +1,77 @@
+require 'logger'
+require_relative 'formatter'
+
+module Macmillan
+  module Utils
+    module Logger
+      ##
+      # A factory class for building logger objects
+      #
+      # === Usage:
+      #
+      #   require 'macmillan/utils/logger'
+      #
+      #   Macmillan::Utils::Logger::Factory.build_logger(type, options)
+      #
+      class Factory
+        ##
+        # Builds a logger object
+        #
+        # Opts varies depending on the type of logger object you are creating:
+        #
+        #   opts for :syslog
+        #     :tag      => [String] the name of the syslog tag to use
+        #     :facility => [Integer] the 'LOG_LOCALx' syslog facility to use
+        #
+        #   opts for :logger
+        #     :target   => [String, Object] the target for the Logger object
+        #
+        #   opts for :null
+        #     none
+        #
+        # @param type [Symbol] the logger type, `:logger`, `:syslog` or `:null`
+        # @param opts [Hash] options to pass to your logger object
+        # @return [Logger] the configured logger object
+        #
+        def self.build_logger(type = :logger, opts = {})
+          logger = case type
+                   when :syslog then build_syslog_logger(opts)
+                   when :null   then build_normal_logger(target: '/dev/null')
+                   else
+                     build_normal_logger(opts)
+                   end
+
+          logger.formatter = ::Macmillan::Utils::Logger::Formatter.new
+          logger.level     = ::Logger::INFO
+
+          logger
+        end
+
+        def self.build_syslog_logger(opts)
+          require 'syslog-logger'
+
+          ::Logger::Syslog.class_eval do
+            alias_method :write, :info
+            alias_method :log, :info
+          end
+
+          tag      = opts.fetch(:tag)
+          facility = Syslog.const_get("LOG_LOCAL#{opts.fetch(:facility, 0)}")
+
+          ::Logger::Syslog.new(tag, facility)
+        end
+        private_class_method :build_syslog_logger
+
+        def self.build_normal_logger(opts)
+          ::Logger.class_eval do
+            alias_method :write, :info
+            alias_method :log, :info
+          end
+
+          ::Logger.new(opts.fetch(:target, $stdout))
+        end
+        private_class_method :build_normal_logger
+      end
+    end
+  end
+end

data/lib/macmillan/utils/logger/formatter.rb

@@ -0,0 +1,48 @@
+module Macmillan
+  module Utils
+    module Logger
+      ##
+      # A log formatter class for Logger objects.  This formatter is used automatically
+      # when you use the {Macmillan::Utils::Logger::Factory} class.
+      #
+      # === Usage:
+      #
+      #   require 'macmillan/utils/logger'
+      #
+      #   logger = Macmillan::Utils::Logger::Factory.build_logger(type, options)
+      #
+      class Formatter < ::Logger::Formatter
+        ##
+        # Builds a new instance of Formatter
+        #
+        # @param prefix [String] a string to prepend to all log lines
+        # @return [Formatter] the configured formatter object
+        #
+        def initialize(prefix = nil)
+          @format = "[%5s]: %s\n"
+          @format = "#{prefix} #{@format}" if prefix
+        end
+
+        ##
+        # Returns the log message formatted as desired
+        #
+        def call(severity, _time, _progname, msg)
+          @format % [severity, msg2str(msg)]
+        end
+
+        protected
+
+        def msg2str(msg)
+          case msg
+          when ::String
+            msg
+          when ::Exception
+            "#{ msg.message } (#{ msg.class })\n" << (msg.backtrace || []).join("\n")
+          else
+            msg.inspect
+          end
+        end
+      end
+    end
+  end
+end