analytics-ruby 0.3.3 → 0.3.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    analytics-ruby (0.3.2)
+    analytics-ruby (0.3.3)
       faraday (>= 0.8, < 0.10)
       faraday_middleware (>= 0.8, < 0.10)
       multi_json (~> 1.0)

data/History.md

@@ -1,3 +1,7 @@
+0.3.4 / 2013-8-26
+===========
+* Pass `Time` values as iso8601 timestamp strings
+
 0.3.3 / 2013-8-2
 ===========
 * Allow init/track/identify/alias to accept strings as keys. by [@shipstar](https://github.com/shipstar)

data/Makefile

@@ -0,0 +1,5 @@
+
+test:
+	rake spec
+
+.PHONY: test

data/lib/analytics-ruby.rb

@@ -5,22 +5,22 @@ module AnalyticsRuby
   module ClassMethods
     # By default use a single client for the module
     def init(options = {})
-      @client = AnalyticsRuby::Client.new(options)
+      @client = AnalyticsRuby::Client.new options
     end
 
     def track(options)
       return false unless @client
-      @client.track(options)
+      @client.track options
     end
 
     def identify(options)
       return false unless @client
-      @client.identify(options)
+      @client.identify options
     end
 
     def alias(options)
       return false unless @client
-      @client.alias(options)
+      @client.alias options
     end
 
     def flush

data/lib/analytics-ruby/client.rb

@@ -18,7 +18,7 @@ module AnalyticsRuby
     #           :on_error       - Proc which handles error calls from the API
     def initialize(options = {})
 
-      Util.symbolize_keys!(options)
+      Util.symbolize_keys! options
 
       @queue = Queue.new
       @secret = options[:secret]
@@ -26,7 +26,7 @@ module AnalyticsRuby
 
       check_secret
 
-      @consumer = AnalyticsRuby::Consumer.new(@queue, @secret, options)
+      @consumer = AnalyticsRuby::Consumer.new @queue, @secret, options
       @thread = Thread.new { @consumer.run }
     end
 
@@ -52,7 +52,7 @@ module AnalyticsRuby
 
       check_secret
 
-      Util.symbolize_keys!(options)
+      Util.symbolize_keys! options
 
       event = options[:event]
       user_id = options[:user_id].to_s
@@ -60,23 +60,26 @@ module AnalyticsRuby
       timestamp = options[:timestamp] || Time.new
       context = options[:context] || {}
 
-      ensure_user(user_id)
-      check_timestamp(timestamp)
+      ensure_user user_id
+      check_timestamp timestamp
 
       if event.nil? || event.empty?
         fail ArgumentError, 'Must supply event as a non-empty string'
       end
 
       fail ArgumentError, 'Properties must be a Hash' unless properties.is_a? Hash
-
-      add_context(context)
-
-      enqueue({ event:      event,
-                userId:     user_id,
-                context:    context,
-                properties: properties,
-                timestamp:  timestamp.iso8601,
-                action:     'track' })
+      Util.isoify_dates! properties
+
+      add_context context
+
+      enqueue({
+        :event => event,
+        :userId => user_id,
+        :context =>  context,
+        :properties => properties,
+        :timestamp => timestamp.iso8601,
+        :action => 'track'
+      })
     end
 
     # public: Identifies a user
@@ -90,25 +93,28 @@ module AnalyticsRuby
 
       check_secret
 
-      Util.symbolize_keys!(options)
+      Util.symbolize_keys! options
 
       user_id = options[:user_id].to_s
       traits = options[:traits] || {}
       timestamp = options[:timestamp] || Time.new
       context = options[:context] || {}
 
-      ensure_user(user_id)
-      check_timestamp(timestamp)
+      ensure_user user_id
+      check_timestamp timestamp
 
       fail ArgumentError, 'Must supply traits as a hash' unless traits.is_a? Hash
+      Util.isoify_dates! traits
 
-      add_context(context)
+      add_context context
 
-      enqueue({ userId:    user_id,
-                context:   context,
-                traits:    traits,
-                timestamp: timestamp.iso8601,
-                action:    'identify' })
+      enqueue({
+        :userId => user_id,
+        :context => context,
+        :traits => traits,
+        :timestamp => timestamp.iso8601,
+        :action => 'identify'
+      })
     end
 
     # public: Aliases a user from one id to another
@@ -122,24 +128,26 @@ module AnalyticsRuby
 
       check_secret
 
-      Util.symbolize_keys!(options)
+      Util.symbolize_keys! options
 
       from = options[:from].to_s
       to = options[:to].to_s
       timestamp = options[:timestamp] || Time.new
       context = options[:context] || {}
 
-      ensure_user(from)
-      ensure_user(to)
-      check_timestamp(timestamp)
+      ensure_user from
+      ensure_user to
+      check_timestamp timestamp
 
-      add_context(context)
+      add_context context
 
-      enqueue({ from:      from,
-                to:        to,
-                context:   context,
-                timestamp: timestamp.iso8601,
-                action:    'alias' })
+      enqueue({
+        :from => from,
+        :to => to,
+        :context => context,
+        :timestamp => timestamp.iso8601,
+        :action => 'alias'
+      })
     end
 
     # public: Returns the number of queued messages

data/lib/analytics-ruby/consumer.rb

@@ -19,7 +19,7 @@ module AnalyticsRuby
     #           on_error   - Proc of what to do on an error
     #
     def initialize(queue, secret, options = {})
-      Util.symbolize_keys!(options)
+      Util.symbolize_keys! options
 
       @queue = queue
       @secret = secret
@@ -43,19 +43,19 @@ module AnalyticsRuby
     #
     def flush
       # Block until we have something to send
-      item = @queue.pop()
+      item = @queue.pop
 
       # Synchronize on additions to the current batch
       @mutex.synchronize {
         @current_batch << item
         until @current_batch.length >= @batch_size || @queue.empty?
-          @current_batch << @queue.pop()
+          @current_batch << @queue.pop
         end
       }
 
       req = AnalyticsRuby::Request.new
-      res = req.post(@secret, @current_batch)
-      @on_error.call(res.status, res.error) unless res.status == 200
+      res = req.post @secret, @current_batch
+      @on_error.call res.status, res.error unless res.status == 200
       @mutex.synchronize {
         @current_batch = []
       }

data/lib/analytics-ruby/defaults.rb

@@ -5,8 +5,8 @@ module AnalyticsRuby
     module Request
       BASE_URL = 'https://api.segment.io' unless defined? AnalyticsRuby::Defaults::Request::BASE_URL
       PATH = '/v1/import' unless defined? AnalyticsRuby::Defaults::Request::PATH
-      SSL = { verify: false } unless defined? AnalyticsRuby::Defaults::Request::SSL
-      HEADERS = { accept: 'application/json' } unless defined? AnalyticsRuby::Defaults::Request::HEADERS
+      SSL = { :verify => false } unless defined? AnalyticsRuby::Defaults::Request::SSL
+      HEADERS = { :accept => 'application/json' } unless defined? AnalyticsRuby::Defaults::Request::HEADERS
     end
 
     module Queue

data/lib/analytics-ruby/json.rb

@@ -7,7 +7,7 @@ module AnalyticsRuby
   #
   # .dump was added in MultiJson 1.3
   module JSON
-    if MultiJson.respond_to?(:dump)
+    if MultiJson.respond_to? :dump
       def self.dump(*args)
         MultiJson.dump(*args)
       end

data/lib/analytics-ruby/request.rb

@@ -18,7 +18,7 @@ module AnalyticsRuby
       options[:headers] ||= AnalyticsRuby::Defaults::Request::HEADERS
       @path = options[:path] || AnalyticsRuby::Defaults::Request::PATH
 
-      @conn = Faraday.new(options) do |faraday|
+      @conn = Faraday.new options do |faraday|
         faraday.request :json
         faraday.response :json, :content_type => /\bjson$/
         faraday.adapter Faraday.default_adapter
@@ -37,7 +37,7 @@ module AnalyticsRuby
           req.options[:timeout] = 8
           req.options[:open_timeout] = 3
           req.url(@path)
-          req.body = AnalyticsRuby::JSON::dump(secret: secret, batch: batch)
+          req.body = AnalyticsRuby::JSON::dump :secret => secret, :batch => batch
         end
         status = res.status
         error  = res.body["error"]
@@ -47,7 +47,7 @@ module AnalyticsRuby
         error = "Connection error: #{err}"
       end
 
-      AnalyticsRuby::Response.new(status, error)
+      AnalyticsRuby::Response.new status, error
     end
   end
 end

data/lib/analytics-ruby/util.rb

@@ -4,10 +4,21 @@ module Util
   end
 
   def self.symbolize_keys!(hash)
-    hash.replace symbolize_keys(hash)
+    hash.replace symbolize_keys hash
   end
 
   def self.stringify_keys(hash)
     hash.inject({}) { |memo, (k,v)| memo[k.to_s] = v; memo }
   end
+
+  def self.isoify_dates(hash)
+    hash.inject({}) { |memo, (k, v)|
+      memo[k] = v.respond_to?(:iso8601) ? v.iso8601 : v
+      memo
+    }
+  end
+
+  def self.isoify_dates!(hash)
+    hash.replace isoify_dates hash
+  end
 end

data/lib/analytics-ruby/version.rb

@@ -1,3 +1,3 @@
 module AnalyticsRuby
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/spec/client_spec.rb

@@ -11,7 +11,7 @@ describe Analytics::Client do
     end
 
     it 'should not error if a secret is supplied' do
-      Analytics::Client.new secret: AnalyticsHelpers::SECRET
+      Analytics::Client.new :secret => AnalyticsHelpers::SECRET
     end
 
     it 'should not error if a secret is supplied as a string' do
@@ -22,29 +22,51 @@ describe Analytics::Client do
   describe '#track' do
 
     before(:all) do
-      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+      @client = Analytics::Client.new :secret => AnalyticsHelpers::SECRET
+      @client.instance_variable_get(:@thread).kill
+      @queue = @client.instance_variable_get :@queue
     end
 
     it 'should error without an event' do
-      expect { @client.track(user_id: 'user') }.to raise_error(ArgumentError)
+      expect { @client.track(:user_id => 'user') }.to raise_error(ArgumentError)
     end
 
     it 'should error without a user_id' do
-      expect { @client.track(event: 'Event') }.to raise_error(ArgumentError)
+      expect { @client.track(:event => 'Event') }.to raise_error(ArgumentError)
     end
 
     it 'should error if properties is not a hash' do
       expect {
-        @client.track(user_id: 'user', event: 'Event', properties: [1,2,3])
+        @client.track({
+          :user_id => 'user',
+          :event => 'Event',
+          :properties => [1,2,3]
+        })
       }.to raise_error(ArgumentError)
     end
 
     it 'should not error with the required options' do
       @client.track AnalyticsHelpers::Queued::TRACK
+      @queue.pop
     end
 
     it 'should not error when given string keys' do
       @client.track Util.stringify_keys(AnalyticsHelpers::Queued::TRACK)
+      @queue.pop
+    end
+
+    it 'should convert Time properties into iso8601 format' do
+      @client.track({
+        :user_id => 'user',
+        :event => 'Event',
+        :properties => {
+          :time => Time.utc(2013),
+          :nottime => 'x'
+        }
+      })
+      message = @queue.pop
+      message[:properties][:time].should == '2013-01-01T00:00:00Z'
+      message[:properties][:nottime].should == 'x'
     end
   end
 
@@ -52,7 +74,9 @@ describe Analytics::Client do
   describe '#identify' do
 
     before(:all) do
-      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+      @client = Analytics::Client.new :secret => AnalyticsHelpers::SECRET
+      @client.instance_variable_get(:@thread).kill
+      @queue = @client.instance_variable_get :@queue
     end
 
     it 'should error without any user id' do
@@ -61,24 +85,39 @@ describe Analytics::Client do
 
     it 'should not error with the required options' do
       @client.identify AnalyticsHelpers::Queued::IDENTIFY
+      @queue.pop
     end
 
     it 'should not error with the required options as strings' do
       @client.identify Util.stringify_keys(AnalyticsHelpers::Queued::IDENTIFY)
+      @queue.pop
+    end
+
+    it 'should convert Time traits into iso8601 format' do
+      @client.identify({
+        :user_id => 'user',
+        :traits => {
+          :time => Time.utc(2013),
+          :nottime => 'x'
+        }
+      })
+      message = @queue.pop
+      message[:traits][:time].should == '2013-01-01T00:00:00Z'
+      message[:traits][:nottime].should == 'x'
     end
   end
 
   describe '#alias' do
     before :all do
-      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+      @client = Analytics::Client.new :secret => AnalyticsHelpers::SECRET
     end
 
     it 'should error without from' do
-      expect { @client.alias to: 1234 }.to raise_error(ArgumentError)
+      expect { @client.alias :to => 1234 }.to raise_error(ArgumentError)
     end
 
     it 'should error without to' do
-      expect { @client.alias from: 1234 }.to raise_error(ArgumentError)
+      expect { @client.alias :from => 1234 }.to raise_error(ArgumentError)
     end
 
     it 'should not error with the required options' do
@@ -92,7 +131,7 @@ describe Analytics::Client do
 
   describe '#flush' do
     before(:all) do
-      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+      @client = Analytics::Client.new :secret => AnalyticsHelpers::SECRET
     end
 
     it 'should wait for the queue to finish on a flush' do

data/spec/consumer_spec.rb

@@ -30,9 +30,8 @@ describe Analytics::Consumer do
 
     it 'should execute the error handler if the request is invalid' do
 
-      Analytics::Request.any_instance
-                        .stub(:post)
-                        .and_return(Analytics::Response.new(400, "Some error"))
+      Analytics::Request.any_instance.stub(:post).and_return(
+        Analytics::Response.new(400, "Some error"))
 
       on_error = Proc.new do |status, error|
         puts "#{status}, #{error}"
@@ -42,7 +41,7 @@ describe Analytics::Consumer do
 
       queue = Queue.new
       queue << {}
-      consumer = Analytics::Consumer.new(queue, 'secret', { on_error: on_error })
+      consumer = Analytics::Consumer.new queue, 'secret', :on_error => on_error
       consumer.flush
 
       Analytics::Request::any_instance.unstub(:post)
@@ -60,7 +59,7 @@ describe Analytics::Consumer do
 
       queue = Queue.new
       queue << AnalyticsHelpers::Requested::TRACK
-      consumer = Analytics::Consumer.new(queue, 'testsecret', { on_error: on_error })
+      consumer = Analytics::Consumer.new queue, 'testsecret', :on_error => on_error
       consumer.flush
 
       queue.should be_empty

data/spec/module_spec.rb

@@ -24,18 +24,18 @@ describe Analytics do
   describe '#init' do
 
     it 'should successfully init' do
-      Analytics.init secret: AnalyticsHelpers::SECRET
+      Analytics.init :secret => AnalyticsHelpers::SECRET
     end
   end
 
   describe '#track' do
 
     it 'should error without an event' do
-      expect { Analytics.track user_id: 'user' }.to raise_error(ArgumentError)
+      expect { Analytics.track :user_id => 'user' }.to raise_error(ArgumentError)
     end
 
     it 'should error without a user_id' do
-      expect { Analytics.track event: 'Event' }.to raise_error(ArgumentError)
+      expect { Analytics.track :event => 'Event' }.to raise_error(ArgumentError)
     end
 
     it 'should not error with the required options' do
@@ -47,7 +47,7 @@ describe Analytics do
 
   describe '#identify' do
     it 'should error without a user_id' do
-      expect { Analytics.identify traits: {} }.to raise_error(ArgumentError)
+      expect { Analytics.identify :traits => {} }.to raise_error(ArgumentError)
     end
 
     it 'should not error with the required options' do
@@ -58,11 +58,11 @@ describe Analytics do
 
   describe '#alias' do
     it 'should error without from' do
-      expect { Analytics.alias to: 1234 }.to raise_error(ArgumentError)
+      expect { Analytics.alias :to => 1234 }.to raise_error(ArgumentError)
     end
 
     it 'should error without to' do
-      expect { Analytics.alias from: 1234 }.to raise_error(ArgumentError)
+      expect { Analytics.alias :from => 1234 }.to raise_error(ArgumentError)
     end
 
     it 'should not error with the required options' do

data/spec/spec_helper.rb

@@ -3,41 +3,48 @@ module AnalyticsHelpers
 
   SECRET = 'testsecret'
 
-  TRACK = { event:     'Ruby Library test event',
-            properties: {
-              type:     'Chocolate',
-              is_a_lie: true,
-              layers:   20,
-              created:  Time.new
-            }
-          }
-
-  IDENTIFY =  { traits: {
-                  likes_animals: true,
-                  instrument:    'Guitar',
-                  age:           25
-                },
-                action:     'identify'
-              }
-
-  ALIAS = { from: 1234,
-            to:   'abcd' }
+  TRACK = {
+    :event => 'Ruby Library test event',
+    :properties => {
+      :type => 'Chocolate',
+      :is_a_lie => true,
+      :layers => 20,
+      :created =>  Time.new
+    }
+  }
+
+  IDENTIFY =  {
+    :traits => {
+      :likes_animals => true,
+      :instrument => 'Guitar',
+      :age => 25
+    },
+    :action => 'identify'
+  }
+
+  ALIAS = {
+    :from => 1234,
+    :to => 'abcd'
+  }
 
   USER_ID = 1234
 
   # Hashes sent to the client
   module Queued
-    TRACK = TRACK.merge({ user_id: USER_ID })
-
-    IDENTIFY = IDENTIFY.merge({ user_id:    USER_ID  })
+    TRACK = TRACK.merge :user_id => USER_ID
+    IDENTIFY = IDENTIFY.merge :user_id => USER_ID
   end
 
   # Hashes which are sent from the consumer
   module Requested
-    TRACK = TRACK.merge({ userId: USER_ID,
-                          action: 'track' })
-
-    IDENTIFY = IDENTIFY.merge({ userId:    USER_ID,
-                                action:    'identify' })
+    TRACK = TRACK.merge({
+      :userId => USER_ID,
+      :action => 'track'
+    })
+
+    IDENTIFY = IDENTIFY.merge({
+      :userId => USER_ID,
+      :action => 'identify'
+    })
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-03 00:00:00.000000000 Z
+date: 2013-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,7 @@ files:
 - lib/analytics-ruby/util.rb
 - lib/analytics-ruby/version.rb
 - lib/analytics-ruby.rb
+- Makefile
 - Rakefile
 - README.md
 - spec/client_spec.rb