metric 0.0.5 → 0.0.6

data/Gemfile

@@ -1,7 +1,11 @@
 source 'http://rubygems.org'
 
-gem "ruby-debug", :platform => :ruby_18
-gem "linecache19", :platform => :ruby_19
-gem "ruby-debug19", :platform => :ruby_19
+gem 'ruby-debug', :platform => :ruby_18
+gem 'linecache19', :platform => :ruby_19
+gem 'ruby-debug19', :platform => :ruby_19
+
+group :test do
+  gem 'webmock'
+end
 
 gemspec

data/README.markdown

@@ -1,4 +1,4 @@
-# Metric
+# Metric [![Build Status](http://travis-ci.org/bittersweet/metric.png)](http://travis-ci.org/bittersweet/metric)
 
 Track simple metrics via [metric.io](metric.io).
 
@@ -51,6 +51,10 @@ def register
 end
 ```
 
+## Documentation
+
+Although the code is pretty lightweight and self-explanatory, [documentation](http://rdoc.info/github/bittersweet/metric/master/frames) is available via rdoc.info.
+
 ## Thanks
 
 [jeffkreeftmeijer](https://github.com/jeffkreeftmeijer) for providing me with the awesome domainname!

data/lib/metric.rb

@@ -1,40 +1,35 @@
 require 'metric/configuration'
-require 'open-uri'
+require 'metric/track'
+require 'metric/receive'
 require 'cgi'
 
 module Metric
   class << self
+    # Holds the configuration for easy access to settings
     attr_accessor :configuration
 
+    # Configures gem options
+    #
+    # @param [Block]
     def configure
       self.configuration ||= Metric::Configuration.new
       yield(configuration)
     end
 
-    def compose(metric, options = {})
-      amount = options[:amount]
-      trigger = options[:trigger]
-
-      key = "?api_key=" + Metric.configuration.api_key
-      url = Metric.configuration.metric_host + '/track'
-      url << key
-      url << parse_metric(metric)
-      url << "&amount=#{amount}" if amount
-      url << "&trigger=1" if trigger
-      url
-    end
-
+    # Tracks metrics
+    #
+    # @param [String, Hash]
+    # @return [nil]
     def track(metric, options = {})
-      return if defined?(Rails) && !Rails.env.production?
-
-      url = compose(metric, options)
-      Thread.new do
-        `curl "#{url}" 2>&1 ; `
-      end
+      Metric::Track.track(metric, options)
     end
 
-    def parse_metric(metric)
-    "&metric=#{CGI.escape(metric)}"
+    # Fetches data from the API
+    #
+    # @param [String, String]
+    # @return [Hash]
+    def receive(metric, range)
+      Metric::Receive.receive(metric, range)
     end
   end
 end

data/lib/metric/configuration.rb

@@ -1,10 +1,20 @@
 module Metric
+
+  # Used for configuration of the Metric gem. The only required option is
+  # api_key, secret_key is only used if you want to pull data out from the API
+  # and metric_host is used for local debugging purposes.
+
   class Configuration
+    # Key used to identify the website
     attr_accessor :api_key
 
-    # Allows setting a different host, used for development purposes
+    # Allows setting a different host to send data to, used for development purposes
     attr_accessor :metric_host
 
+    # Used to generate a hash for getting data out
+    attr_accessor :secret_key
+
+    # Sets defaults
     def initialize
       @metric_host = "http://api.metric.io"
     end

data/lib/metric/receive.rb

@@ -0,0 +1,61 @@
+require 'digest/md5'
+require 'faraday'
+require 'multi_json'
+
+module Metric
+
+  # Fetch data via the metric.io API
+
+  class Receive
+    # Generate a hash of the site's secret_key and metric identifier
+    #
+    # @param [String] metric Metric identifier
+    # @return [String]
+    def self.generate_token(metric)
+      Digest::MD5.hexdigest(Metric.configuration.secret_key + metric)
+    end
+
+    # Generate the url with query strings
+    #
+    # @param [String] metric Metric identifier
+    # @param [String] range Range identifier, either total, today, week or month
+    # @return [String]
+    def self.compose(metric, range)
+      key = "?api_key=" + Metric.configuration.api_key
+      url = Metric.configuration.metric_host + '/receive'
+      url << key
+      url << "&token=" + generate_token(metric)
+      url << parse_metric(metric)
+      url << "&range=" + range
+    end
+
+    # Returns and memoizes a Faraday connection
+    #
+    # @return [Faraday::Connection]
+    def self.connection
+      @connection ||= Faraday.new do |builder|
+        builder.adapter :net_http
+      end
+    end
+
+    # Perform the actual request and parse JSON
+    #
+    # @param [String] metric Metric identifier
+    # @param [String] range Range identifier, either total, today, week or month
+    # @return [Hash] response from the API
+    def self.receive(metric, range)
+      url = compose(metric, range)
+      response = connection.get(url)
+      MultiJson.decode(response.body)
+    end
+
+    # CGI escape the metric name so spaces and characters are allowed
+    #
+    # @param [String] metric Metric identifier
+    # @return [String]
+    def self.parse_metric(metric)
+      "&metric=#{CGI.escape(metric)}"
+    end
+  end
+end
+

data/lib/metric/track.rb

@@ -0,0 +1,49 @@
+module Metric
+
+  # Used to track metrics
+
+  class Track
+    # Generate the url with query strings
+    #
+    # @param [String] metric Metric identifier
+    # @param [Hash] options Options
+    # @option options [Symbol] :amount Amount to track
+    # @option options [Symbol] :trigger Flag for email notification
+    # @return [String]
+    def self.compose(metric, options = {})
+      amount = options[:amount]
+      trigger = options[:trigger]
+
+      key = "?api_key=" + Metric.configuration.api_key
+      url = Metric.configuration.metric_host + '/track'
+      url << key
+      url << parse_metric(metric)
+      url << "&amount=#{amount}" if amount
+      url << "&trigger=1" if trigger
+      url
+    end
+
+    # Uses a thread to perform the request
+    # @note If this gem is used with Rails it will only track data in the production environment
+    #
+    # @param [String, Hash]
+    # @return [nil]
+    def self.track(metric, options = {})
+      return if defined?(Rails) && !Rails.env.production?
+      return if options[:amount] && options[:amount] == 0
+
+      url = compose(metric, options)
+      Thread.new do
+        `curl "#{url}" 2>&1 ; `
+      end
+    end
+
+    # CGI escape the metric name so spaces and characters are allowed
+    #
+    # @param [String]
+    # @return [String]
+    def self.parse_metric(metric)
+      "&metric=#{CGI.escape(metric)}"
+    end
+  end
+end

data/lib/metric/version.rb

@@ -1,3 +1,3 @@
 module Metric
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/metric.gemspec

@@ -15,6 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Metric::VERSION
 
+  gem.add_runtime_dependency 'faraday'
+  gem.add_runtime_dependency 'multi_json'
+
   # Tests
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'

data/spec/metric/configuration_spec.rb

@@ -8,6 +8,13 @@ describe Metric::Configuration do
     Metric.configuration.metric_host.should == "http://api.metric.io"
   end
 
+  it "configures metric host" do
+    Metric.configure do |config|
+      config.metric_host = "http://localhost:5000"
+    end
+    Metric.configuration.metric_host.should == "http://localhost:5000"
+  end
+
   it "configures api_key" do
     Metric.configure do |config|
       config.api_key = "test"
@@ -15,10 +22,10 @@ describe Metric::Configuration do
     Metric.configuration.api_key.should == "test"
   end
 
-  it "configures metric host" do
+  it "configures secret key" do
     Metric.configure do |config|
-      config.metric_host = "http://localhost:5000"
+      config.secret_key = "random_string"
     end
-    Metric.configuration.metric_host.should == "http://localhost:5000"
+    Metric.configuration.secret_key.should == "random_string"
   end
 end

data/spec/metric/receive_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Metric::Receive do
+  before do
+    reset_config
+    Metric.configure do |config|
+      config.secret_key = "1234"
+    end
+  end
+
+  it "generates correct hash via secret_token" do
+    Metric::Receive.generate_token("hits").should == "c6daa87bcf8bf7cb4d1c74d872793e5e"
+  end
+
+  it "gets total" do
+    request = "http://api.metric.io/receive?api_key=spec&token=c6daa87bcf8bf7cb4d1c74d872793e5e&metric=hits&range=total"
+    Metric::Receive.compose("hits", "total").should == request
+  end
+
+  it "gets today" do
+    request = "http://api.metric.io/receive?api_key=spec&token=c6daa87bcf8bf7cb4d1c74d872793e5e&metric=hits&range=today"
+    Metric::Receive.compose("hits", "today").should == request
+  end
+
+  it "gets week" do
+    request = "http://api.metric.io/receive?api_key=spec&token=c6daa87bcf8bf7cb4d1c74d872793e5e&metric=hits&range=week"
+    Metric::Receive.compose("hits", "week").should == request
+  end
+
+  it "gets month" do
+    request = "http://api.metric.io/receive?api_key=spec&token=c6daa87bcf8bf7cb4d1c74d872793e5e&metric=hits&range=month"
+    Metric::Receive.compose("hits", "month").should == request
+  end
+
+  it "grabs actual data" do
+    stub_request(:get, "http://api.metric.io/receive?api_key=spec&metric=hits&range=today&token=c6daa87bcf8bf7cb4d1c74d872793e5e").
+      to_return(:status => 200, :body => "{\"total\":\"1\"}", :headers => {})
+    Metric::Receive.receive("hits", "today").should == {"total" => "1"}
+  end
+end
+

data/spec/metric/track_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Metric::Track do
+  before do
+    reset_config
+  end
+
+  it "composes the request url" do
+    Metric::Track.compose("hits").should == "http://api.metric.io/track?api_key=spec&metric=hits"
+  end
+
+  it "gets correct url when tracking" do
+    Metric::Track.should_receive(:compose).with("hits", {})
+    Metric::Track.track("hits")
+  end
+
+  it "encodes the request url" do
+    Metric::Track.parse_metric("hits and spaces").should == "&metric=hits+and+spaces"
+  end
+
+  it "sends trigger param" do
+    url = "http://api.metric.io/track?api_key=spec&metric=hits&trigger=1"
+    Metric::Track.compose("hits", {:trigger => true}).should == url
+  end
+
+  it "sends custom amount" do
+    url = "http://api.metric.io/track?api_key=spec&metric=hits&amount=42"
+    Metric::Track.compose("hits", {:amount => 42}).should == url
+  end
+
+  it "does nothing if amount is 0" do
+    Metric::Track.track("hits", {:amount => 0}).should == nil
+  end
+end
+
+

data/spec/metric_spec.rb

@@ -5,27 +5,14 @@ describe Metric do
     reset_config
   end
 
-  it "composes the request url" do
-    Metric.compose("hits").should == "http://api.metric.io/track?api_key=spec&metric=hits"
-  end
-
-  it "gets correct url when tracking" do
-    Metric.should_receive(:compose).with("hits", {})
+  it "passes through options to track" do
+    Metric::Track.should_receive(:track).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://api.metric.io/track?api_key=spec&metric=hits&trigger=1"
-    Metric.compose("hits", {:trigger => true}).should == url
-  end
-
-  it "sends custom amount" do
-    url = "http://api.metric.io/track?api_key=spec&metric=hits&amount=42"
-    Metric.compose("hits", {:amount => 42}).should == url
+  it "passes through options to receive" do
+    Metric::Receive.should_receive(:receive).with("hits", "total")
+    Metric.receive("hits", "total")
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metric
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Mark Mulder
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-31 00:00:00 +02:00
+date: 2011-09-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: faraday
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -30,10 +30,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: multi_json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,8 +44,36 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  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
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Track metrics via metric.io
 email: 
 - markmulder@gmail.com
@@ -60,13 +88,18 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - README.markdown
 - Rakefile
 - lib/metric.rb
 - lib/metric/configuration.rb
+- lib/metric/receive.rb
+- lib/metric/track.rb
 - lib/metric/version.rb
 - metric.gemspec
 - spec/metric/configuration_spec.rb
+- spec/metric/receive_spec.rb
+- spec/metric/track_spec.rb
 - spec/metric_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -99,11 +132,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Companion gem to the metric.io site to track metrics
 test_files: 
 - spec/metric/configuration_spec.rb
+- spec/metric/receive_spec.rb
+- spec/metric/track_spec.rb
 - spec/metric_spec.rb
 - spec/spec_helper.rb