metric 0.0.1 → 0.0.3

data/.travis.yml

@@ -0,0 +1,17 @@
+bundler_args: --binstubs
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+
+script: "bundle exec rspec spec"    
+
+notifications:
+  recipients:
+    - markmulder@gmail.com
+
+branches:
+  only:
+    - master
+

data/Gemfile

@@ -1,3 +1,7 @@
 source 'http://rubygems.org'
 
+gem "ruby-debug", :platform => :ruby_18
+gem "linecache19", :platform => :ruby_19
+gem "ruby-debug19", :platform => :ruby_19
+
 gemspec

data/README.markdown

@@ -0,0 +1,56 @@
+# Metric
+
+Track simple metrics via [metric.io](metric.io).
+
+## Installation
+
+Add the following anywhere in your Gemfile and run `bundle install`.
+
+``` ruby
+gem 'metric'
+```
+
+And create the following initializer:
+
+``` ruby
+Metric.configure do |config|
+  config.api_key = "YOUR_API_KEY"
+end
+```
+
+Now you are all set to start tracking some metrics!
+
+Note: If you are using Rails it will only track events in Production mode.
+
+## Usage
+
+You can track whatever metric you want, it will automatically show up in your
+dashboard.
+
+``` ruby
+def show
+  @article = Article.find(params[:id])
+  Metric.track("article_view")
+end
+```
+
+You can also add a custom amount to log multiple metrics in one go:
+
+``` ruby
+def notify(users)
+  # send mails to everyone involved
+  Metric.track("email_notifications", {:amount => users.count})
+end
+```
+
+To receive emails whenever a metric gets tracked pass in `trigger => true`
+
+``` ruby
+def register
+  Metric.track("user_signup", {:trigger => true})
+end
+```
+
+## Thanks
+
+[jeffkreeftmeijer](https://github.com/jeffkreeftmeijer) for providing me with the awesome domainname!

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks

data/lib/metric.rb

@@ -1,4 +1,3 @@
-require 'metric/version'
 require 'metric/configuration'
 require 'open-uri'
 require 'cgi'
@@ -12,10 +11,26 @@ module Metric
       yield(configuration)
     end
 
-    def track(metric)
+    def compose(metric, options = {})
+      amount = options[:amount]
+      trigger = options[:trigger]
+
       key = "?api_key=" + Metric.configuration.api_key
-      url = Metric.configuration.metric_host + '/track.js' + key + parse_metric(metric)
-      open(url).read
+      url = Metric.configuration.metric_host + '/track.js'
+      url << key
+      url << parse_metric(metric)
+      url << "&amount=#{amount}" if amount
+      url << "&trigger=1" if trigger
+      url
+    end
+
+    def track(metric, options = {})
+      return if defined?(Rails) && !Rails.env.production?
+
+      url = compose(metric, options)
+      Thread.new do
+        `curl "#{url}" 2>&1 ; `
+      end
     end
 
     def parse_metric(metric)

data/lib/metric/version.rb

@@ -1,3 +1,3 @@
 module Metric
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/metric.gemspec

@@ -18,6 +18,5 @@ Gem::Specification.new do |gem|
   # Tests
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'
-  gem.add_development_dependency 'ruby-debug'
 end
 

data/spec/metric_spec.rb

@@ -5,15 +5,27 @@ describe Metric do
     reset_config
   end
 
-  it "calls metric.io" do
-    stub_request(:get, "http://metric.io/track.js").
-      with(:query => {"api_key" => "spec", "metric" => "hits"}).
-      to_return(:status => 200, :body => "{\"total\":1}", :headers => {})
-    Metric.track("hits").should == "{\"total\":1}"
+  it "composes the request url" do
+    Metric.compose("hits").should == "http://metric.io/track.js?api_key=spec&metric=hits"
+  end
+
+  it "gets correct url when tracking" do
+    Metric.should_receive(:compose).with("hits", {})
+    Metric.track("hits")
   end
 
   it "encodes the request url" do
     Metric.parse_metric("hits and spaces").should == "&metric=hits+and+spaces"
   end
+
+  it "sends trigger param" do
+    url = "http://metric.io/track.js?api_key=spec&metric=hits&trigger=1"
+    Metric.compose("hits", {:trigger => true}).should == url
+  end
+
+  it "sends custom amount" do
+    url = "http://metric.io/track.js?api_key=spec&metric=hits&amount=42"
+    Metric.compose("hits", {:amount => 42}).should == url
+  end
 end
 

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "../lib", "metric")
+require File.expand_path('../../lib/metric', __FILE__)
 require 'ruby-debug'
 require 'webmock/rspec'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metric
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mark Mulder
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 +02:00
+date: 2011-08-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,20 +46,6 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
 description: Track metrics via metric.io
 email: 
 - markmulder@gmail.com
@@ -71,7 +57,9 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
+- README.markdown
 - Rakefile
 - lib/metric.rb
 - lib/metric/configuration.rb