em-stathat 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem 'rspec', ">= 2.7.0"
+end

data/README.md

@@ -0,0 +1,45 @@
+## What
+
+An Eventmachine-compatible wrapper for the stathat api
+(http://stathat.com), built on top of
+[em-http-request](https://github.com/igrigorik/em-http-request).
+
+**NOTE:** Currently, only the EZ api is supported.
+
+## Usage
+
+Configure your settings:
+
+```ruby
+EM::StatHat.config do |c|
+  c.ukey  = 'your unique user key'
+  c.email = 'user@example.com' # for sending stats via the EZ api
+end
+```
+
+### Send stats using the EZ api
+
+#### Timers
+
+```ruby
+EM::StatHat.new.time('stat name') do
+  # code to profile
+end
+```
+
+#### Counts
+
+```ruby
+EM::StatHat.new.ez_count('Users Created', 1) # defaults to 1
+```
+
+#### Values
+
+```ruby
+EM::StatHat.new.ez_value('some metric', 123)
+```
+
+## Reference
+
+* [stathat](https://github.com/patrickxb/stathat)
+* [em-http-request](https://github.com/igrigorik/em-http-request).

data/em-stathat.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-stathat/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-stathat"
+  s.version     = EventMachine::Stathat::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Sharp"]
+  s.email       = ["ajsharp@gmail.com"]
+  s.homepage    = "https://github.com/ajsharp/em-stathat"
+  s.summary     = %q{An EventMachine-compatible async wrapper for the stathat api.}
+  s.description = %q{Essentially a clone of the normal stathat gem, only for use with EventMachine.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'em-http-request', '~> 1.0'
+end

data/lib/em-stathat.rb

@@ -0,0 +1,100 @@
+require 'eventmachine'
+require 'em-http'
+
+module EventMachine
+  class StatHat
+    Config = Struct.new(:ukey, :email, :debug)
+    @@config = Config.new
+
+    class << self
+      # Configure EM::StatHat
+      #
+      # @example
+      #   EM::StatHat.config do |c|
+      #     c.ukey  = 'Qu9sj34ncWXi0e83'
+      #     u.email = 'your.email@wherever.com'
+      #   end
+      def config(&block)
+        if block_given?
+          @@config.tap(&block)
+        else
+          @@config
+        end
+      end
+
+      def configured?
+        !!config.ukey && !!config.email
+      end
+    end
+
+    def initialize(base_uri = 'http://api.stathat.com')
+      raise(RuntimeError, "You must configure EM::StatHat before using it!") unless self.class.configured?
+      @base_uri = base_uri
+    end
+
+    def config; self.class.config; end
+
+    # Time a block of code and send the duration as a value
+    #
+    # @example
+    #   StatHat.new.time('some identifying name') do
+    #     # code
+    #   end
+    #
+    # @param [String] name the name of the stat
+    # @param [Hash] opts a hash of options
+    # @option [Symbol] :ez Send data via the ez api (default: true)
+    def time(name, opts = {})
+      opts[:ez] ||= true
+
+      start = Time.now
+      yield if block_given?
+
+      if opts[:ez] == true
+        ez_value(name, (Time.now - start))
+      else
+        value(name, (Time.now - start))
+      end
+    end
+
+    # Record a value via the EZ api
+    def ez_value(stat_name, value)
+      ez(stat_name, {:value => value})
+    end
+
+    # Increment a counter via the EZ api
+    def ez_count(stat_name, count = 1)
+      ez(stat_name, {:count => count})
+    end
+
+    # Record a numeric value
+    #
+    # @param [String] name the stat name
+    # @param [Number] value the value to record
+    # def value(name, value)
+    #   request('/v', {:key => name, :value => value})
+    # end
+
+    # Increment a counter
+    #
+    # @param [String] name the stat name
+    # @param [Number] count the amount by which to increment the counter
+    # def count(name, count)
+    #   request('/c', {:key => name, :count => count})
+    # end
+
+    private
+
+    def ez(stat, value_or_count)
+      request('/ez', {
+        :stat  => stat,
+        :email => config.email
+      }.merge(value_or_count))
+    end
+
+    # Return a deferrable object
+    def request(endpoint, opts)
+      EventMachine::HttpRequest.new(@base_uri + endpoint).post(:body => opts)
+    end
+  end
+end

data/lib/em-stathat/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module Stathat
+    VERSION = '0.1.0'
+  end
+end

data/spec/em-stathat_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe EM::StatHat, '.config' do
+  before do
+    EM::StatHat.config { } # reset the config
+  end
+
+  it "can set ukey" do
+    EM::StatHat.config do |c|
+      c.ukey = 'thing'
+    end
+    EM::StatHat.config.ukey.should == 'thing'
+  end
+
+  it "returns a config instance" do
+    EM::StatHat.config() {}.should be_instance_of EM::StatHat::Config
+  end
+
+  it "can reset stuff" do
+    EM::StatHat.config do |c|
+      c.ukey = 'thing'
+    end
+
+    EM::StatHat.config do |c|
+      c.ukey = 'otherthing'
+    end
+    EM::StatHat.config.ukey.should == 'otherthing'
+  end
+
+  it "can set email" do
+    EM::StatHat.config do |c|
+      c.email = 'user@example.com'
+    end
+    EM::StatHat.config.email.should == 'user@example.com'
+  end
+end
+
+describe EM::StatHat, 'initializing' do
+  it "raises an error if EM::StatHat has not been configured" do
+    EM::StatHat.config { |c| c.ukey = nil }
+    expect {
+      EM::StatHat.new
+    }.to raise_error(RuntimeError, "You must configure EM::StatHat before using it!")
+  end
+
+  it "does not raise an error if ukey is configured" do
+    EM::StatHat.config { |u| u.ukey = 'key' }
+    expect { EM::StatHat.new }.not_to raise_error
+  end
+
+  it "sets the base url by default" do
+    #EM::StatHat.new.base_url.should ==
+  end
+end
+
+describe EM::StatHat, '.configured?' do
+  before { EM::StatHat.config { } }
+  subject { EM::StatHat.configured? }
+
+  it "returns true if both email and ukey are set" do
+    EM::StatHat.config { |c| c.ukey = 'key'; c.email = 'user@example.com' }
+    EM::StatHat.should be_configured
+  end
+
+  it "returns false if only email is configured" do
+    EM::StatHat.config { |c| c.ukey = nil; c.email = 'user@example.com' }
+    EM::StatHat.should_not be_configured
+  end
+
+  it "returns false if only ukey is configured" do
+    EM::StatHat.config { |c| c.ukey = 'key'; c.email = nil }
+    EM::StatHat.should_not be_configured
+  end
+
+  it "returns false if both are unconfigured" do
+    EM::StatHat.should_not be_configured
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/em-stathat'
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: em-stathat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &2156377520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156377520
+description: Essentially a clone of the normal stathat gem, only for use with EventMachine.
+email:
+- ajsharp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- em-stathat.gemspec
+- lib/em-stathat.rb
+- lib/em-stathat/version.rb
+- spec/em-stathat_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ajsharp/em-stathat
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: An EventMachine-compatible async wrapper for the stathat api.
+test_files:
+- spec/em-stathat_spec.rb
+- spec/spec_helper.rb