http_statsd 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+  - ree

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Grzesiek Kolodziejczyk
+
+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,73 @@
+# HttpStatsd
+
+[![Build Status](https://secure.travis-ci.org/grk/http_statsd.png)](http://travis-ci.org/grk/http_statsd)
+
+HttpStatsd provides a HTTP proxy for the statsd protocol. The use case is when
+you need to collect metrics from an external source, but for obvious reasons
+don't want to expose the udp interface of statsd.
+
+It also provides a client for that proxy for easy integration with Ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'http_statsd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_statsd
+
+## Usage
+
+### Server
+
+There is an example `config.ru` file included in the repo. To use the proxy,
+you need to provide at least one api key, with:
+
+```ruby
+HttpStatsd::Server.set :api_keys, {
+  "username1" => "pass1",
+  "username2" => "pass2"
+}
+```
+
+You can also set the statsd server host and port (default is "localhost:8125"):
+
+```ruby
+HttpStatsd::Server.set :statsd_host, "statsd.example.com"
+HttpStatsd::Server.set :statsd_port, 8125
+```
+
+### Client
+
+To access the server, you can use the built in client:
+
+```ruby
+c = HttpStatsd::Client.new(base_uri: "http://statsd.example.com",
+                           username: "username1", password: "pass1")
+```
+
+Then, you can use the same interface as with the
+[statsd-ruby](https://github.com/github/statsd-ruby) gem:
+
+```ruby
+sample_rate = 0.1
+c.increment("metric.counter", sample_rate)
+c.decrement("metric.counter", sample_rate)
+c.count("metric.counter", 121, sample_rate)
+c.gauge("metric.gauge", 123)
+c.timing("metric.timing", 15.52, sample_rate)
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/examples/config.ru

@@ -0,0 +1,14 @@
+# example config.ru
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require 'http_statsd/server'
+
+HttpStatsd::Server.set :api_keys, {
+  "api1" => "pass1",
+  "api2" => "pass2"
+}
+run HttpStatsd::Server

data/http_statsd.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_statsd/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "http_statsd"
+  gem.version       = HttpStatsd::VERSION
+  gem.authors       = ["Grzesiek Kolodziejczyk"]
+  gem.email         = ["gk@code-fu.pl"]
+  gem.summary       = %q{HTTP proxy for statsd with basic auth}
+  gem.homepage      = "https://github.com/grk/http_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_runtime_dependency "sinatra"
+  gem.add_runtime_dependency "statsd-ruby"
+  gem.add_runtime_dependency "httparty"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rake"
+end

data/lib/http_statsd/client.rb

@@ -0,0 +1,47 @@
+require "httparty"
+
+module HttpStatsd
+  class Client
+    include HTTParty
+
+    def initialize(opts = {})
+      @base_uri = opts[:base_uri]
+      @auth = {:username => opts[:username], :password => opts[:password]}
+    end
+
+    def increment(name, sample_rate = nil)
+      query = {:name => name}
+      query.merge!({:sample_rate => sample_rate}) if sample_rate
+      request(:increment, query)
+    end
+
+    def decrement(name, sample_rate = nil)
+      query = {:name => name}
+      query.merge!({:sample_rate => sample_rate}) if sample_rate
+      request(:decrement, query)
+    end
+
+    def count(name, value, sample_rate = nil)
+      query = {:name => name, :value => value}
+      query.merge!({:sample_rate => sample_rate}) if sample_rate
+      request(:count, query)
+    end
+
+    def gauge(name, value)
+      query = {:name => name, :value => value}
+      request(:gauge, query)
+    end
+
+    def timing(name, value, sample_rate = nil)
+      query = {:name => name, :value => value}
+      query.merge!({:sample_rate => sample_rate}) if sample_rate
+      request(:timing, query)
+    end
+
+    private
+    def request(action, query = {})
+      options = {:basic_auth => @auth, :query => query}
+      self.class.get("#{@base_uri}/#{action}", options)
+    end
+  end
+end

data/lib/http_statsd/server.rb

@@ -0,0 +1,56 @@
+require 'statsd'
+require 'sinatra'
+
+module HttpStatsd
+  class Server < Sinatra::Base
+    set :api_keys, {}
+    set :statsd_host, "localhost"
+    set :statsd_port, 8125
+
+    def statsd
+      @statsd ||= Statsd.new(settings.statsd_host, settings.statsd_port)
+    end
+
+    use Rack::Auth::Basic do |username, password|
+      settings.api_keys[username] == password
+    end
+
+    get '/increment' do
+      args = [params["name"]]
+      args << params["sample_rate"].to_f if params["sample_rate"]
+      statsd.increment(*args)
+      204
+    end
+
+    get '/decrement' do
+      args = [params["name"]]
+      args << params["sample_rate"].to_f if params["sample_rate"]
+      statsd.decrement(*args)
+      204
+    end
+
+    get '/count' do
+      args = [params["name"], params["value"].to_f]
+      args << params["sample_rate"].to_f if params["sample_rate"]
+      statsd.count(*args)
+      204
+    end
+
+    get '/gauge' do
+      args = [params["name"], params["value"].to_f]
+      statsd.gauge(*args)
+      204
+    end
+
+    get '/timing' do
+      args = [params["name"], params["value"].to_f]
+      args << params["sample_rate"].to_f if params["sample_rate"]
+      statsd.timing(*args)
+      204
+    end
+
+    get '/' do
+      200
+    end
+  end
+end

data/lib/http_statsd/version.rb

@@ -0,0 +1,3 @@
+module HttpStatsd
+  VERSION = "0.0.1"
+end

data/lib/http_statsd.rb

@@ -0,0 +1,6 @@
+require "http_statsd/version"
+require "http_statsd/server"
+require "http_statsd/client"
+
+module HttpStatsd
+end

data/spec/client_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe HttpStatsd::Client do
+  let(:base_uri) { "http://localhost" }
+  let(:username) { "api1" }
+  let(:password) { "pass1" }
+  let(:client) { HttpStatsd::Client.new(:base_uri => base_uri,
+    :username => username, :password => password) }
+
+  describe "increment" do
+    it "should make a request with metric name and sample rate" do
+      stub_request(:get, "api1:pass1@localhost/increment").
+        with(:query => {:name => "metric.one", :sample_rate => "0.1"})
+      client.increment("metric.one", "0.1")
+    end
+  end
+
+  describe "decrement" do
+    it "should make a request with metric name and sample rate" do
+      stub_request(:get, "api1:pass1@localhost/decrement").
+        with(:query => {:name => "metric.one", :sample_rate => "0.1"})
+      client.decrement("metric.one", "0.1")
+    end
+  end
+
+  describe "count" do
+    it "should make a request with metric name, value and sample rate" do
+      stub_request(:get, "api1:pass1@localhost/count").
+        with(:query => {:name => "metric.one", :value => "11.1",
+          :sample_rate => "0.1"})
+      client.count("metric.one", 11.1, 0.1)
+    end
+  end
+
+  describe "gauge" do
+    it "should make a request with metric name and value" do
+      stub_request(:get, "api1:pass1@localhost/gauge").
+        with(:query => {:name => "metric.one", :value => "11.1"})
+      client.gauge("metric.one", 11.1)
+    end
+  end
+
+  describe "timing" do
+    it "should make a request with metric name, value and sample rate" do
+      stub_request(:get, "api1:pass1@localhost/timing").
+        with(:query => {:name => "metric.one", :value => "11.1",
+          :sample_rate => "0.1"})
+      client.timing("metric.one", 11.1, 0.1)
+    end
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe HttpStatsd::Server do
+  let(:statsd) { mock(Statsd).as_null_object }
+
+  before(:all) do
+    app.set :api_keys, {"app1" => "key1"}
+  end
+
+  before(:each) do
+    authorize "app1", "key1"
+    Statsd.stub(:new => statsd)
+  end
+
+  describe "api keys" do
+    it "should allow valid api keys" do
+      authorize "app1", "key1"
+      get "/"
+      last_response.should be_ok
+    end
+
+    it "should reject invalid api keys" do
+      authorize "app2", "key2"
+      get "/"
+      last_response.status.should eql(401)
+    end
+  end
+
+  describe "/increment" do
+    it "should create statsd client with given host and port" do
+      Statsd.should_receive(:new).with("localhost", 8125).and_return(statsd)
+      get "/increment", :name => "metric.one"
+    end
+
+    it "should increment in statsd" do
+      statsd.should_receive(:increment).with("metric.one", 0.1)
+      get "/increment", :name => "metric.one", :sample_rate => "0.1"
+    end
+  end
+
+  describe "/decrement" do
+    it "should decrement in statsd" do
+      statsd.should_receive(:decrement).with("metric.one", 0.1)
+      get "/decrement", :name => "metric.one", :sample_rate => "0.1"
+    end
+  end
+
+  describe "/count" do
+    it "should count in statsd" do
+      statsd.should_receive(:count).with("metric.one", 11.1, 0.1)
+      get "/count", :name => "metric.one", :value => "11.1",
+        :sample_rate => "0.1"
+    end
+  end
+
+  describe "/gauge" do
+    it "should store gauge in statsd" do
+      statsd.should_receive(:gauge).with("metric.one", 11.1)
+      get "/gauge", :name => "metric.one", :value => "11.1"
+    end
+  end
+
+  describe "/timing" do
+    it "should measure timing in statsd" do
+      statsd.should_receive(:timing).with("metric.one", 11.1, 0.1)
+      get "/timing", :name => "metric.one", :value => "11.1",
+        :sample_rate => "0.1"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rack/test'
+require 'webmock/rspec'
+
+require 'http_statsd'
+
+def app
+  HttpStatsd::Server
+end
+
+app.set :environment, :test
+app.set :raise_errors, true
+app.set :logging, false
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: http_statsd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grzesiek Kolodziejczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- gk@code-fu.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/config.ru
+- http_statsd.gemspec
+- lib/http_statsd.rb
+- lib/http_statsd/client.rb
+- lib/http_statsd/server.rb
+- lib/http_statsd/version.rb
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/grk/http_statsd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1477210855689509257
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1477210855689509257
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HTTP proxy for statsd with basic auth
+test_files:
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb