metric 0.1.0 → 0.1.1

data/lib/metric.rb

@@ -1,6 +1,8 @@
 require 'metric/configuration'
+require 'metric/util'
 require 'metric/track'
 require 'metric/receive'
+require 'metric/rails'
 require 'cgi'
 
 module Metric

data/lib/metric/rails.rb

@@ -0,0 +1,13 @@
+require 'metric/rails/controller_methods'
+
+module Metric
+  module Rails
+    def self.initialize
+      if defined?(ActionController::Base)
+        ActionController::Base.send(:include, Metric::Rails::ControllerMethods)
+      end
+    end
+  end
+end
+
+Metric::Rails.initialize

data/lib/metric/rails/controller_methods.rb

@@ -0,0 +1,18 @@
+module Metric
+  module Rails
+    module ControllerMethods
+      def metric_current_user
+        user = current_user
+        return {} if current_user.nil?
+
+        parameters = {}
+        [:id, :name, :username, :email].each do |attribute|
+          parameters[attribute.to_s] = user.send(attribute) if user.respond_to?(attribute)
+        end
+        parameters
+      rescue NoMethodError, NameError
+        {}
+      end
+    end
+  end
+end

data/lib/metric/receive.rb

@@ -21,12 +21,13 @@ module Metric
     # @param [String] range Range identifier, either total, today, week or month
     # @return [String]
     def self.compose(metric, range)
+      token = generate_token(metric, range)
+      parameters = {"metric" => metric, "range" => range, "token" => token}
       api_key = Metric.configuration.api_key
       url = Metric.configuration.protocol + "://" + Metric.configuration.host
-      url << "/v1/sites/#{api_key}/statistics"
-      url << parse_metric(metric)
-      url << "&range=" + range
-      url << "&token=" + generate_token(metric, range)
+      url << "/v1/sites/#{api_key}/statistics?"
+      url << Metric::Util.build_query_string(parameters)
+      url
     end
 
     # Returns and memoizes a Faraday connection
@@ -48,14 +49,6 @@ module Metric
       response = connection.get(url)
       MultiJson.decode(response.body)[range]
     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

@@ -10,22 +10,20 @@ module Metric
     # @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]
+      customer = options[:customer]
+
+      parameters = {"metric" => metric, "amount" => amount, "date" => date,
+                    "meta" => meta, "customer" => customer}
 
       api_key = Metric.configuration.api_key
       url = Metric.configuration.protocol + "://" + Metric.configuration.host
-      url << "/v1/sites/#{api_key}/track"
-      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 << "/v1/sites/#{api_key}/track?"
+      url << Metric::Util.build_query_string(parameters)
       url
     end
 
@@ -46,7 +44,7 @@ module Metric
 
     # 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?
+      return true if defined?(::Rails) && !::Rails.env.production?
       return true if ENV['RACK_ENV'] && ENV['RACK_ENV'] != "production"
       return true if options[:amount] && options[:amount] == 0
       false

data/lib/metric/util.rb

@@ -0,0 +1,21 @@
+module Metric
+  class Util
+    def self.escape(string)
+      URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.build_query_string(object, prefix = nil)
+      string = []
+      object.each_pair do |key, value|
+        k = prefix ? "#{prefix}[#{key}]" : key
+        next if value.nil?
+        if value.is_a?(Hash)
+          string << build_query_string(value, k)
+        else
+          string << "#{escape(k)}=#{escape(value.to_s)}"
+        end
+      end
+      string.join("&")
+    end
+  end
+end

data/lib/metric/version.rb

@@ -1,3 +1,3 @@
 module Metric
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/metric/track_spec.rb

@@ -19,7 +19,7 @@ describe Metric::Track do
   end
 
   it "encodes the input" do
-    result = "https://api.metric.io/v1/sites/spec/track?metric=hits+and+spaces"
+    result = "https://api.metric.io/v1/sites/spec/track?metric=hits%20and%20spaces"
     Metric::Track.compose("hits and spaces").should == result
   end
 
@@ -39,13 +39,8 @@ describe Metric::Track do
   end
 
   it "passes in meta information" do
-    result = "https://api.metric.io/v1/sites/spec/track?metric=payment&meta=userid%3A+1"
+    result = "https://api.metric.io/v1/sites/spec/track?metric=payment&meta=userid%3A%201"
     Metric::Track.compose("payment", :meta => "userid: 1").should == result
   end
-
-  it "sends trigger param" do
-    result = "https://api.metric.io/v1/sites/spec/track?metric=hits&trigger=1"
-    Metric::Track.compose("hits", :trigger => true).should == result
-  end
 end
 

data/spec/metric/util_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Metric::Util do
+  it 'builds a nested query string' do
+    object = {"amount" => 1, "customer" => {"id" => "1"}}
+    Metric::Util.build_query_string(object).should == "amount=1&customer%5Bid%5D=1"
+  end
+
+  it 'skips nil values' do
+    object = {"amount" => 1, "date" => nil}
+    Metric::Util.build_query_string(object).should == "amount=1"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-03 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -90,13 +90,17 @@ files:
 - Rakefile
 - lib/metric.rb
 - lib/metric/configuration.rb
+- lib/metric/rails.rb
+- lib/metric/rails/controller_methods.rb
 - lib/metric/receive.rb
 - lib/metric/track.rb
+- lib/metric/util.rb
 - lib/metric/version.rb
 - metric.gemspec
 - spec/metric/configuration_spec.rb
 - spec/metric/receive_spec.rb
 - spec/metric/track_spec.rb
+- spec/metric/util_spec.rb
 - spec/metric_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/bittersweet/metric
@@ -127,5 +131,6 @@ test_files:
 - spec/metric/configuration_spec.rb
 - spec/metric/receive_spec.rb
 - spec/metric/track_spec.rb
+- spec/metric/util_spec.rb
 - spec/metric_spec.rb
 - spec/spec_helper.rb