sidekiq-statsd 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.pryrc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'pathname'
+$LOAD_PATH.unshift(Pathname.getwd.join('lib').to_s)
+require 'sidekiq/throttler'
+
+def reload!
+  Dir["#{Dir.pwd}/lib/**/*.rb"].each { |f| load f }
+end

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0
+branches:
+  only:
+    - master
+notifications:
+  email:
+    recipients:
+      - pablo@pablocantero.com
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode
+    - rvm: 2.0.0

data/.yardopts

@@ -0,0 +1,3 @@
+--title 'Sidekiq::Throttler Documentation'
+--charset utf-8
+--markup markdown

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+guard "bundler" do
+  watch("Gemfile")
+  watch("sidekiq-statsd.gemspec")
+end
+
+guard "rspec" do
+  watch(%r{^spec/app/.+_worker\.rb$}) { "spec" }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end
+
+guard "yard" do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Pablo Cantero
+
+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.md

@@ -0,0 +1,51 @@
+# Sidekiq::Statsd
+
+[![Build Status](https://secure.travis-ci.org/phstc/sidekiq-statsd.png)](http://travis-ci.org/phstc/sidekiq-statsd)
+[![Dependency Status](https://gemnasium.com/phstc/sidekiq-statsd.png)](https://gemnasium.com/phstc/sidekiq-statsd)
+
+Sidekiq StatsD is a middleware to increment your worker executions counter (success and failures).
+
+## Compatibility
+
+Sidekiq::Statsd is tested against MRI 1.9.3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "sidekiq-statsd"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-statsd
+
+## Configuration
+
+In a Rails initializer or wherever you've configured Sidekiq, add
+Sidekiq::Statsd to your server middleware:
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Statsd, env: "production", prefix: "worker", host: "localhost", port: 8125
+  end
+end
+```
+
+## Usage
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+MIT Licensed. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => :spec
+
+require "yard"
+YARD::Rake::YardocTask.new
+
+desc "Start Pry with runtime dependencies loaded"
+task :console, :script do |t, args|
+  command  = "bundle exec pry"
+  command += "-r #{args[:script]}" if args[:script]
+  sh command
+end

data/lib/sidekiq-statsd.rb

@@ -0,0 +1,7 @@
+require "sidekiq"
+require "active_support"
+require "active_support/core_ext"
+
+require "sidekiq/statsd/version"
+require "sidekiq/statsd/client"
+require "sidekiq/statsd/server_middleware"

data/lib/sidekiq/statsd/client.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require "statsd"
+
+module Sidekiq::Statsd
+  class Client
+    ##
+    # Initializes StatsD client with options.
+    #
+    # @param [Hash] options The options to initialize the StatsD client.
+    # @option options [String] :env ("production")
+    # @option options [String] :prefix ("worker")
+    # @option options [String] :host ("localhost")
+    # @option options [String] :port ("8125")
+    def initialize options={}
+      @options = { "env"    => "production",
+                   "prefix" => "worker",
+                   "host"   => "localhost",
+                   "port"   => 8125 }.merge options
+
+      @statsd_client = ::Statsd.new @options["host"], @options["port"]
+    end
+
+    ##
+    # Increments the counter.
+    #
+    # StatsD key format: env.prefix.worker_name.success|failure.
+    #
+    # @param key [String] The key to be incremented.
+    def increment key
+      @statsd_client.increment [@options["env"], @options["prefix"], key].join(".")
+    end
+  end
+end
+

data/lib/sidekiq/statsd/server_middleware.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Sidekiq::Statsd
+  ##
+  # Sidekiq StatsD is a middleware to increment your worker executions counter (success and failures).
+  #
+  class ServerMiddleware
+    ##
+    # Initializes the middleware with options.
+    #
+    # @param [Hash] options The options to initialize the StatsD client.
+    # @option options [String] :env ("production")
+    # @option options [String] :prefix ("worker")
+    # @option options [String] :host ("localhost")
+    # @option options [String] :port ("8125")
+    def initialize options={}
+      @options = options
+    end
+
+    ##
+    # Increments the metrics.
+    #
+    # @param worker [Sidekiq::Worker] The worker the job belongs to.
+    # @param msg [Hash] The job message.
+    # @param queue [String] The current queue.
+    def call worker, msg, queue
+      stastd = Sidekiq::Statsd::Client.new @options
+      yield
+      stastd.increment [worker.class.name, "success"].join(".")
+    rescue => e
+      stastd.increment [worker.class.name, "failure"].join(".")
+      raise e
+    end
+  end # Statsd
+end # Sidekiq
+

data/lib/sidekiq/statsd/version.rb

@@ -0,0 +1,6 @@
+module Sidekiq
+  module Statsd
+    VERSION = "0.1.0"
+  end
+end
+

data/sidekiq-statsd.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/statsd/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "sidekiq-statsd"
+  gem.version       = Sidekiq::Statsd::VERSION
+  gem.authors       = ["Pablo Cantero"]
+  gem.email         = ["pablo@pablocantero.com"]
+  gem.description   = %q{Sidekiq StatsD is a middleware to increment your worker executions counter (success and failures).}
+  gem.summary       = %q{Sidekiq StatsD is a middleware to increment your worker executions counter (success and failures).}
+  gem.homepage      = "https://github.com/phstc/sidekiq-statsd"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+  gem.add_dependency "sidekiq", ">= 2.5", "< 3.0"
+  gem.add_dependency "statsd-ruby"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-redis_helper"
+  gem.add_development_dependency "timecop"
+  gem.add_development_dependency "simplecov"
+
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-bundler"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "guard-yard"
+  gem.add_development_dependency "rb-fsevent"
+  gem.add_development_dependency "rb-inotify"
+  gem.add_development_dependency "growl"
+end

data/spec/sidekiq/statsd/client_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+require "statsd"
+
+describe Sidekiq::Statsd::Client do
+  let(:worker_name)   { "ImageWorker" }
+  let(:statsd_client) { double "Statsd Client" }
+
+  before { ::Statsd.stub new: statsd_client }
+
+  context "user defined options" do
+    let(:options) do
+      { "prefix" => "super",
+        "env"    => "man",
+        "host"   => "lobster",
+        "port"   => 6666 }
+    end
+
+    subject(:statsd) { described_class.new options }
+
+    describe "#initialize" do
+      it "initializes Statsd client" do
+        ::Statsd.should_receive(:new).with options["host"], options["port"]
+        statsd
+      end
+    end
+
+    describe "#increment" do
+      it "increments counter" do
+        statsd_client.should_receive(:increment).with [options["env"], options["prefix"], worker_name].join(".")
+        statsd.increment worker_name
+      end
+    end
+  end
+
+  context "default options" do
+    subject(:statsd) { described_class.new }
+
+    describe "#initialize" do
+      it "initializes StatsD client" do
+        ::Statsd.should_receive(:new).with "localhost", 8125
+        statsd
+      end
+    end
+
+    describe "#increment" do
+      it "increments counter" do
+        statsd_client.should_receive(:increment).with "production.worker.#{worker_name}"
+        statsd.increment worker_name
+      end
+    end
+  end
+end
+

data/spec/sidekiq/statsd/server_middleware_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Sidekiq::Statsd::ServerMiddleware do
+  subject(:statsd) { described_class.new }
+
+  let(:worker) { double "Dummy worker" }
+  let(:msg)    { nil }
+  let(:queue)  { nil }
+  let(:client) { double "Statsd client" }
+
+  before do
+    Sidekiq::Statsd::Client.stub new: client
+  end
+
+  describe "#call" do
+    it "increments success" do
+      client.
+        should_receive(:increment).
+        with "#{worker.class.name}.success"
+
+      statsd.call(worker, msg, queue) {}
+    end
+
+    it "increments failure" do
+      client.
+        stub(:increment).
+        with "#{worker.class.name}.failure"
+
+      b = ->{ raise "error" }
+
+      expect{ statsd.call(worker, msg, queue, &b) }.to raise_error
+    end
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format progress

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+WORKERS = File.join(File.dirname(__FILE__), "app", "workers")
+$LOAD_PATH.unshift(WORKERS)
+
+unless ENV["CI"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+require "rspec"
+require "timecop"
+
+require "sidekiq-statsd"
+
+# Autoload every worker for the test suite that sits in spec/app/workers
+Dir[File.join(WORKERS, "*.rb")].sort.each do |file|
+  name = File.basename(file, ".rb")
+  autoload name.camelize.to_sym, name
+end
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/sidekiq.rb

@@ -0,0 +1,20 @@
+require "sidekiq/util"
+Sidekiq.logger.level = Logger::ERROR
+
+require "rspec-redis_helper"
+RSpec::RedisHelper::CONFIG = { :url => "redis://localhost/15", :namespace => "testy" }
+
+require "sidekiq/redis_connection"
+REDIS = Sidekiq::RedisConnection.create(RSpec::RedisHelper::CONFIG)
+
+RSpec.configure do |spec|
+  spec.include RSpec::RedisHelper, redis: true
+
+  # clean the Redis database around each run
+  # @see https://www.relishapp.com/rspec/rspec-core/docs/hooks/around-hooks
+  spec.around(:each, redis: true) do |example|
+    with_clean_redis do
+      example.run
+    end
+  end
+end