metric 0.0.7 → 0.0.8

data/lib/metric.rb

@@ -18,16 +18,18 @@ module Metric
 
     # Tracks metrics
     #
-    # @param [String, Hash]
-    # @return [nil]
+    # @param [String] metric Metric identifier
+    # @param [Hash] options Options
+    # @return [Hash] API Response
     def track(metric, options = {})
       Metric::Track.track(metric, options)
     end
 
     # Fetches data from the API
     #
-    # @param [String, String]
-    # @return [Hash]
+    # @param [String] metric Metric identifier
+    # @param [String] range Range identifier, either total, today, week or month
+    # @return [Hash] API Response
     def receive(metric, range)
       Metric::Receive.receive(metric, range)
     end

data/lib/metric/configuration.rb

@@ -16,7 +16,7 @@ module Metric
 
     # Sets defaults
     def initialize
-      @metric_host = "http://api.metric.io"
+      @metric_host = "https://api.metric.io"
     end
   end
 end

data/lib/metric/track.rb

@@ -8,17 +8,23 @@ module Metric
     # @param [String] metric Metric identifier
     # @param [Hash] options Options
     # @option options [Symbol] :amount Amount to track
+    # @option options [Symbol] :date Override the default date (today)
+    # @option options [Symbol] :meta Pass in custom meta data about the metric
     # @option options [Symbol] :trigger Flag for email notification
     # @return [String]
     def self.compose(metric, options = {})
       amount = options[:amount]
       trigger = options[:trigger]
+      date = options[:date]
+      meta = options[:meta]
 
       key = "?api_key=" + Metric.configuration.api_key
       url = Metric.configuration.metric_host + '/track'
       url << key
-      url << parse_metric(metric)
+      url << "&metric=#{CGI.escape(metric)}"
       url << "&amount=#{amount}" if amount
+      url << "&date=#{date}" if date
+      url << "&meta=#{CGI.escape(meta)}" if meta
       url << "&trigger=1" if trigger
       url
     end
@@ -36,6 +42,8 @@ module Metric
       end
     end
 
+    private
+
     # Check if Rails or Rack env is production, or amount is 0
     def self.quit_early?(options)
       return true if defined?(Rails) && !Rails.env.production?
@@ -43,13 +51,5 @@ module Metric
       return true if options[:amount] && options[:amount] == 0
       false
     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.7"
+  VERSION = "0.0.8"
 end

data/spec/metric/configuration_spec.rb

@@ -9,14 +9,14 @@ describe Metric::Configuration do
     Metric.configure do |config|
       config.api_key = "test"
     end
-    Metric.configuration.metric_host.should == "http://api.metric.io"
+    Metric.configuration.metric_host.should == "https://api.metric.io"
   end
 
   it "configures metric host" do
     Metric.configure do |config|
-      config.metric_host = "http://localhost:5000"
+      config.metric_host = "https://localhost:5000"
     end
-    Metric.configuration.metric_host.should == "http://localhost:5000"
+    Metric.configuration.metric_host.should == "https://localhost:5000"
   end
 
   it "configures api_key" do

data/spec/metric/receive_spec.rb

@@ -5,30 +5,32 @@ describe Metric::Receive 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
+  context "generating correct url" do
+    it "total" do
+      request = "https://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 "today" do
+      request = "https://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 "week" do
+      request = "https://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
+    it "month" do
+      request = "https://api.metric.io/receive?api_key=spec&token=c6daa87bcf8bf7cb4d1c74d872793e5e&metric=hits&range=month"
+      Metric::Receive.compose("hits", "month").should == request
+    end
   end
 
   it "grabs actual data" do
-    stub_request(:get, "http://api.metric.io/receive?api_key=spec&metric=hits&range=today&token=c6daa87bcf8bf7cb4d1c74d872793e5e").
+    stub_request(:get, "https://api.metric.io/receive?api_key=spec&metric=hits&range=total&token=c6daa87bcf8bf7cb4d1c74d872793e5e").
       to_return(:status => 200, :body => "{\"total\":\"1\"}", :headers => {})
-    Metric::Receive.receive("hits", "today").should == {"total" => "1"}
+    Metric::Receive.receive("hits", "total").should == {"total" => "1"}
   end
 end
 

data/spec/metric/track_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Metric::Track do
   it "composes the request url" do
-    Metric::Track.compose("hits").should == "http://api.metric.io/track?api_key=spec&metric=hits"
+    Metric::Track.compose("hits").should == "https://api.metric.io/track?api_key=spec&metric=hits"
   end
 
   it "gets correct url when tracking" do
@@ -11,23 +11,34 @@ describe Metric::Track do
     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
+  it "encodes the input" do
+    url = "https://api.metric.io/track?api_key=spec&metric=hits+and+spaces"
+    Metric::Track.compose("hits and spaces").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
+    url = "https://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
+    Metric::Track.should_not_receive(:compose)
+    Metric::Track.track("hits", :amount => 0)
+  end
+
+  it "passes in custom date" do
+    url = "https://api.metric.io/track?api_key=spec&metric=hits&date=20120101"
+    Metric::Track.compose("hits", :date => "20120101").should == url
   end
-end
 
+  it "passes in meta information" do
+    url = "https://api.metric.io/track?api_key=spec&metric=payment&meta=userid%3A+1"
+    Metric::Track.compose("payment", :meta => "userid: 1").should == url
+  end
+
+  it "sends trigger param" do
+    url = "https://api.metric.io/track?api_key=spec&metric=hits&trigger=1"
+    Metric::Track.compose("hits", :trigger => true).should == url
+  end
+end
 

metadata

@@ -1,72 +1,93 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: metric
-version: !ruby/object:Gem::Version
-  version: 0.0.7
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
 platform: ruby
-authors:
+authors: 
 - Mark Mulder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-26 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: faraday
-  requirement: &2152308620 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152308620
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  requirement: &2161467860 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2161467860
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &2161467000 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2161467000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: webmock
-  requirement: &2161465040 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2161465040
+  version_requirements: *id004
 description: Track metrics via metric.io
-email:
+email: 
 - markmulder@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - README.markdown
 - Rakefile
 - lib/metric.rb
@@ -80,31 +101,41 @@ files:
 - spec/metric/track_spec.rb
 - spec/metric_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/bittersweet/metric
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Companion gem to the metric.io site to track metrics
-test_files:
+test_files: 
 - spec/metric/configuration_spec.rb
 - spec/metric/receive_spec.rb
 - spec/metric/track_spec.rb