macmillan-utils 1.0.11

data/spec/lib/macmillan/utils/statsd_decorator_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Macmillan::Utils::StatsdDecorator do
+  let(:statsd)    { double(:statsd) }
+  let(:logger)    { double(:logger, debug: nil) }
+  let(:env)       { 'development' }
+  let(:stat_name) { 'wibble.flibble' }
+
+  subject { Macmillan::Utils::StatsdDecorator.new(statsd, env, logger) }
+
+  statsd_calls = {
+    increment: nil,
+    decrement: nil,
+    count:     12,
+    guage:     12,
+    set:       12,
+    timing:    12
+  }
+
+  statsd_calls.each do |method, method_args|
+    describe "##{method}" do
+      before do
+        @args = [stat_name]
+        @args << method_args if method_args
+        @args << 1 # sample_rate
+      end
+
+      it 'should send a message to the logger' do
+        expect(logger).to receive(:debug).once
+        subject.public_send(method, *@args)
+      end
+
+      context 'when in the "production" environment' do
+        let(:env) { 'production' }
+
+        it 'will pass on messages to the statsd delegatee' do
+          expect(statsd).to receive(method).with(*@args).once
+          subject.public_send(method, *@args)
+        end
+      end
+
+      context 'when in a non "production" environment' do
+        it 'will not pass on messages to the statsd delegatee' do
+          expect(statsd).to_not receive(method)
+          subject.public_send(method, *@args)
+        end
+      end
+    end
+  end
+
+  describe '#time' do
+    it 'should require a block' do
+      expect { subject.time(stat_name) }.to raise_error
+    end
+
+    it 'should call the block' do
+      block_called = false
+
+      subject.time(stat_name) do
+        block_called = true
+      end
+
+      expect(block_called).to be(true)
+    end
+
+    it 'should return the output of the block' do
+      expected = double
+      actual   = subject.time(stat_name) { expected }
+      expect(actual).to eq(expected)
+    end
+
+    it 'should send a message to the logger' do
+      expect(logger).to receive(:debug).once
+      subject.time(stat_name) { true }
+    end
+
+    context 'when in the "production" environment' do
+      let(:env) { 'production' }
+
+      it 'should send a #timing message to the statsd delegatee' do
+        expect(statsd).to receive(:timing).once
+        subject.time(stat_name) { true }
+      end
+    end
+
+    context 'when in a non "production" environment' do
+      it 'should not send a #timing message to the statsd delegatee' do
+        expect(statsd).to_not receive(:timing)
+        subject.time(stat_name) { true }
+      end
+    end
+  end
+end

data/spec/lib/macmillan/utils/statsd_middleware_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Macmillan::Utils::StatsdMiddleware do
+  let(:app)           { ->(env) { [200, env, 'app'] } }
+  let(:request)       { req_for('http://example.com') }
+  let(:statsd_client) { spy(:statsd_client) }
+
+  subject { Macmillan::Utils::StatsdMiddleware.new(app, client: statsd_client) }
+
+  it 'sends an increment metric for the status_code' do
+    subject.call(request.env)
+    expect(statsd_client).to have_received(:increment).with('rack.http_status.request.200').once
+  end
+
+  it 'sends an increment metric for all requests' do
+    subject.call(request.env)
+    expect(statsd_client).to have_received(:increment).with('rack.increments.request').once
+  end
+
+  it 'sends a timing metric for all requests' do
+    subject.call(request.env)
+    expect(statsd_client).to have_received(:timing).with('rack.timers.request', anything).once
+  end
+
+  context 'when extra metrics have been pushed into the env' do
+    let(:app) do
+      ->(env) do
+        env['statsd.timers']     << 'foo.bar'
+        env['statsd.increments'] << 'woo.waa'
+
+        [200, env, 'app']
+      end
+    end
+
+    it 'sends these to statsd' do
+      subject.call(request.env)
+      expect(statsd_client).to have_received(:timing).with('rack.timers.foo.bar', anything).once
+      expect(statsd_client).to have_received(:increment).with('rack.increments.woo.waa').once
+      expect(statsd_client).to have_received(:increment).with('rack.http_status.woo.waa.200').once
+    end
+  end
+
+  context 'upon error' do
+    let(:app) { ->(env) { raise } }
+
+    it 'sends an exception increment to statsd and raises the error' do
+      expect { subject.call(request.env) }.to raise_error
+      expect(statsd_client).to have_received(:increment).with('rack.exception').once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.join(__FILE__, '../../lib')
+
+require 'bundler'
+Bundler.setup(:default, :test)
+
+require 'macmillan/utils/rspec/rspec_defaults'
+require 'macmillan/utils/rspec/rack_test_helper'
+require 'macmillan/utils/test_helpers/simplecov_helper'
+
+require 'pry'
+require 'syslog-logger'
+
+require 'macmillan/utils'

metadata

@@ -0,0 +1,296 @@
+--- !ruby/object:Gem::Specification
+name: macmillan-utils
+version: !ruby/object:Gem::Version
+  version: 1.0.11
+platform: ruby
+authors:
+- Macmillan Science and Education (New Publsihing Platforms)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syslog-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- npp-developers@macmillan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/macmillan/utils.rb
+- lib/macmillan/utils/bundler/gem_helper.rb
+- lib/macmillan/utils/cucumber/cucumber_defaults.rb
+- lib/macmillan/utils/cucumber/webmock_helper.rb
+- lib/macmillan/utils/logger.rb
+- lib/macmillan/utils/logger/factory.rb
+- lib/macmillan/utils/logger/formatter.rb
+- lib/macmillan/utils/middleware.rb
+- lib/macmillan/utils/middleware/weak_etags.rb
+- lib/macmillan/utils/rails/statsd_instrumentation.rb
+- lib/macmillan/utils/rspec/rack_test_helper.rb
+- lib/macmillan/utils/rspec/rspec_defaults.rb
+- lib/macmillan/utils/rspec/webmock_helper.rb
+- lib/macmillan/utils/settings.rb
+- lib/macmillan/utils/settings/app_yaml_backend.rb
+- lib/macmillan/utils/settings/env_vars_backend.rb
+- lib/macmillan/utils/settings/key_not_found.rb
+- lib/macmillan/utils/settings/lookup.rb
+- lib/macmillan/utils/settings/value.rb
+- lib/macmillan/utils/statsd_controller_helper.rb
+- lib/macmillan/utils/statsd_decorator.rb
+- lib/macmillan/utils/statsd_middleware.rb
+- lib/macmillan/utils/statsd_stub.rb
+- lib/macmillan/utils/test_helpers/codeclimate_helper.rb
+- lib/macmillan/utils/test_helpers/fixture_loading_helper.rb
+- lib/macmillan/utils/test_helpers/simplecov_helper.rb
+- macmillan-utils.gemspec
+- 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/weak_etags_spec.rb
+- spec/lib/macmillan/utils/settings_spec.rb
+- spec/lib/macmillan/utils/statsd_controller_helper_spec.rb
+- spec/lib/macmillan/utils/statsd_decorator_spec.rb
+- spec/lib/macmillan/utils/statsd_middleware_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nature/macmillan-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A collection of useful patterns we (Macmillan Science and Education) use
+  in our Ruby applications.
+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/weak_etags_spec.rb
+- spec/lib/macmillan/utils/settings_spec.rb
+- spec/lib/macmillan/utils/statsd_controller_helper_spec.rb
+- spec/lib/macmillan/utils/statsd_decorator_spec.rb
+- spec/lib/macmillan/utils/statsd_middleware_spec.rb
+- spec/spec_helper.rb
+has_rdoc: