analytics-ruby 0.0.2 → 0.0.3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/History.md

@@ -0,0 +1,4 @@
+0.0.3 / 2013-1-17
+==========
+* Rakefile and renaming courtesy of [@kiennt](https://github.com/kiennt)
+* Updated tests with mocks

data/README.md

@@ -3,6 +3,8 @@ analytics-ruby
 
 analytics-ruby is a ruby client for [Segment.io](https://segment.io).
 
+[![Build Status](https://travis-ci.org/segmentio/analytics-ruby.png?branch=master)](https://travis-ci.org/segmentio/analytics-ruby)
+
 ### Ruby Analytics Made Simple
 
 [Segment.io](https://segment.io) is the cleanest, simplest API for recording analytics data.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/analytics.gemspec

@@ -9,10 +9,16 @@ Gem::Specification.new do |spec|
   spec.files   = Dir.glob('**/*')
   spec.require_paths = ['lib']
   spec.summary = 'Segment.io analytics library'
-  spec.authors = ['friends@segment.io']
+  spec.description = 'The Segment.io ruby analytics library'
+  spec.authors = ['Segment.io']
+  spec.email = 'friends@segment.io'
+  spec.homepage = 'https://github.com/segmentio/analytics-ruby'
 
   spec.add_dependency 'faraday', ['~> 0.8', '< 0.10']
   spec.add_dependency 'faraday_middleware', ['~> 0.9.0']
   spec.add_dependency 'multi_json', ['~> 1.0']
   spec.add_dependency 'typhoeus', ['~> 0.5.0']
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
 end

data/lib/analytics/client.rb

@@ -9,11 +9,12 @@ module Analytics
 
   class Client
 
-    # Public: Creates a new client
+    # public: Creates a new client
     #
     # options - Hash
     #           :secret         - String of your project's secret
     #           :max_queue_size - Fixnum of the max calls to remain queued (optional)
+    #           :on_error       - Proc which handles error calls from the API
     def initialize (options = {})
 
       @queue = Queue.new
@@ -26,7 +27,7 @@ module Analytics
       Thread.new { @consumer.run }
     end
 
-    # Public: Tracks an event
+    # public: Tracks an event
     #
     # options - Hash
     #           :event      - String of event name.
@@ -64,7 +65,7 @@ module Analytics
                 action:     'track' })
     end
 
-    # Public: Identifies a user
+    # public: Identifies a user
     #
     # options - Hash
     #           :sessionId - String of the user session. (optional with userId)
@@ -97,10 +98,16 @@ module Analytics
                 action:    'identify' })
     end
 
+    # public: Returns the number of queued messages
+    #
+    # returns Fixnum of messages in the queue
+    def queued_messages
+      @queue.length
+    end
 
     private
 
-    # Private: Enqueues the action.
+    # private: Enqueues the action.
     #
     # returns Boolean of whether the item was added to the queue.
     def enqueue(action)
@@ -110,7 +117,7 @@ module Analytics
       !queue_full
     end
 
-    # Private: Ensures that a user id was passed in.
+    # private: Ensures that a user id was passed in.
     #
     # session_id - String of the session
     # user_id    - String of the user id
@@ -124,19 +131,19 @@ module Analytics
       fail ArgumentError, message unless valid
     end
 
-    # Private: Adds contextual information to the call
+    # private: Adds contextual information to the call
     #
     # context - Hash of call context
     def add_context(context)
       context[:library] = 'analytics-ruby'
     end
 
-    # Private: Checks that the secret is properly initialized
+    # private: Checks that the secret is properly initialized
     def check_secret
       fail 'Secret must be initialized' if @secret.nil?
     end
 
-    # Private: Checks the timstamp option to make sure it is a Time.
+    # private: Checks the timstamp option to make sure it is a Time.
     def check_timestamp(timestamp)
       fail ArgumentError, 'Timestamp must be a Time' unless timestamp.is_a? Time
     end

data/lib/analytics/consumer.rb

@@ -11,11 +11,19 @@ module Analytics
     # The consumer continuously takes messages off the queue
     # and makes requests to the segment.io api
     #
+    # queue   - Queue synchronized between client and consumer
+    # secret  - String of the project's secret
+    # options - Hash of consumer options
+    #           batch_size - Fixnum of how many items to send in a batch
+    #           on_error   - Proc of what to do on an error
+    #
     def initialize(queue, secret, options = {})
-      @current_batch = []
       @queue = queue
-      @batch_size = options[:batch_size] || Analytics::Defaults::Queue::BATCH_SIZE
       @secret = secret
+      @batch_size = options[:batch_size] || Analytics::Defaults::Queue::BATCH_SIZE
+      @on_error = options[:on_error] || Proc.new { |status, error| }
+
+      @current_batch = []
     end
 
     # public: Continuously runs the loop to check for new events
@@ -26,9 +34,7 @@ module Analytics
       end
     end
 
-    private
-
-    # private: Flush some events from our queue
+    # public: Flush some events from our queue
     #
     def flush
 
@@ -41,18 +47,9 @@ module Analytics
 
       req = Analytics::Request.new
       res = req.post(@secret, @current_batch)
-
-      onError(res) unless res.status == 200
-
+      @on_error.call(res.status, res.error) unless res.status == 200
       @current_batch = []
     end
 
-    # private: Error handler whenever the api does not
-    #          return a valid response
-    def onError(res)
-      puts res.status
-      puts res.body
-    end
-
   end
 end

data/lib/analytics/request.rb

@@ -1,5 +1,6 @@
 
 require 'analytics/defaults'
+require 'analytics/response'
 require 'multi_json'
 require 'faraday'
 require 'faraday_middleware'
@@ -26,13 +27,27 @@ module Analytics
       end
     end
 
-    # public: Posts
+    # public: Posts the secret and batch of messages to the API.
     #
+    # returns - Response of the status and error if it exists
     def post(secret, batch)
-      @conn.post do |req|
-        req.url(@path)
-        req.body = MultiJson.dump(secret: secret, batch: batch)
+
+      status, error = nil, nil
+
+      begin
+        res = @conn.post do |req|
+          req.url(@path)
+          req.body = MultiJson.dump(secret: secret, batch: batch)
+        end
+        status = res.status
+        error  = res.body["error"]
+
+      rescue Exception => err
+        status = -1
+        error = "Connection error: #{err}"
       end
+
+      Analytics::Response.new(status, error)
     end
   end
 end

data/lib/analytics/response.rb

@@ -0,0 +1,17 @@
+
+module Analytics
+
+  class Response
+
+    attr_reader :status
+    attr_reader :error
+
+    # public: Simple class to wrap responses from the API
+    #
+    #
+    def initialize(status = 200, error = nil)
+      @status = status
+      @error  = error
+    end
+  end
+end

data/lib/analytics/version.rb

@@ -1,3 +1,3 @@
 module Analytics
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/client_spec.rb

@@ -0,0 +1,58 @@
+require 'analytics'
+require 'spec_helper'
+
+
+describe Analytics::Client do
+
+  describe '#init' do
+
+    it 'should error if no secret is supplied' do
+      expect { Analytics::Client.new }.to raise_error(RuntimeError)
+    end
+
+    it 'should not error if a secret is supplied' do
+      Analytics::Client.new secret: AnalyticsHelpers::SECRET
+    end
+
+  end
+
+  describe '#track' do
+
+    before(:all) do
+      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+    end
+
+    it 'should error without an event' do
+      expect { @client.track(user_id: 'user') }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without a user or session' do
+      expect { @client.track(event: 'Event') }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      @client.track AnalyticsHelpers::Queued::TRACK
+    end
+
+  end
+
+
+  describe '#identify' do
+
+    before(:all) do
+      @client = Analytics::Client.new secret: AnalyticsHelpers::SECRET
+    end
+
+    it 'should error without any user id' do
+      expect { @client.identify({}) }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      @client.identify AnalyticsHelpers::Queued::IDENTIFY
+    end
+
+  end
+
+end
+
+

data/spec/consumer_spec.rb

@@ -0,0 +1,61 @@
+require 'analytics'
+require 'thread'
+require 'spec_helper'
+
+describe Analytics::Consumer do
+
+  describe '#flush' do
+
+    it 'should not error if the endpoint is unreachable' do
+
+      Faraday::Connection.any_instance.stub(:post).and_raise(Exception)
+
+      queue = Queue.new
+      queue << {}
+      consumer = Analytics::Consumer.new(queue, 'secret')
+      consumer.flush
+
+      queue.should be_empty
+
+      Faraday::Connection.any_instance.unstub(:post)
+    end
+
+    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"))
+
+      on_error = Proc.new do |status, error|
+        puts "#{status}, #{error}"
+      end
+
+      on_error.should_receive(:call).once
+
+      queue = Queue.new
+      queue << {}
+      consumer = Analytics::Consumer.new(queue, 'secret', { on_error: on_error })
+      consumer.flush
+
+      Analytics::Request::any_instance.unstub(:post)
+
+      queue.should be_empty
+    end
+
+    it 'should not call on_error if the request is good' do
+
+      on_error = Proc.new do |status, error|
+        puts "#{status}, #{error}"
+      end
+
+      on_error.should_receive(:call).at_most(0).times
+
+      queue = Queue.new
+      queue << AnalyticsHelpers::Requested::TRACK
+      consumer = Analytics::Consumer.new(queue, 'testsecret', { on_error: on_error })
+      consumer.flush
+
+      queue.should be_empty
+    end
+  end
+end

data/spec/module_spec.rb

@@ -0,0 +1,39 @@
+require 'analytics'
+require 'spec_helper'
+
+describe Analytics do
+
+  describe '#init' do
+
+    it 'should successfully init' do
+      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)
+    end
+
+    it 'should error without a user or session' do
+      expect { Analytics.track event: 'Event' }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      Analytics.track AnalyticsHelpers::Queued::TRACK
+    end
+  end
+
+
+  describe '#identify' do
+    it 'should error without a user or session' do
+      expect { Analytics.identify traits: {} }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      Analytics.identify AnalyticsHelpers::Queued::IDENTIFY
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+
+module AnalyticsHelpers
+
+  SECRET = 'testsecret'
+
+  TRACK = { event:     'Baked a cake',
+            properties: {
+              type:     'Chocolate',
+              is_a_lie: true,
+              layers:   20,
+              created:  Time.new
+            }
+          }
+
+  IDENTIFY =  { traits: {
+                  likes_animals: true,
+                  instrument:    'Guitar',
+                  age:           25
+                },
+                action:     'identify'
+              }
+
+  USER_ID = 'Bret'
+  SESSION_ID = '4815162342'
+
+  # Hashes sent to the client
+  module Queued
+    TRACK = TRACK.merge({ user_id: USER_ID })
+
+    IDENTIFY = IDENTIFY.merge({ user_id:    USER_ID,
+                                session_id: SESSION_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,
+                                sessionId: SESSION_ID,
+                                action:    'identify' })
+  end
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
-- friends@segment.io
+- Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &14967320 !ruby/object:Gem::Requirement
+  requirement: &22786760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,10 +24,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *14967320
+  version_requirements: *22786760
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &14962920 !ruby/object:Gem::Requirement
+  requirement: &22785200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *14962920
+  version_requirements: *22785200
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &14961260 !ruby/object:Gem::Requirement
+  requirement: &22784660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14961260
+  version_requirements: *22784660
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &14956120 !ruby/object:Gem::Requirement
+  requirement: &22784020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,26 +57,52 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *14956120
-description: 
-email: 
+  version_requirements: *22784020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &22783500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22783500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &22781240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22781240
+description: The Segment.io ruby analytics library
+email: friends@segment.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - analytics.gemspec
+- Gemfile
 - README.md
 - lib/analytics.rb
+- lib/analytics/response.rb
 - lib/analytics/defaults.rb
 - lib/analytics/consumer.rb
 - lib/analytics/request.rb
 - lib/analytics/version.rb
 - lib/analytics/client.rb
-- analytics-ruby-0.0.1.gem
-- spec/test.rb
-- spec/client.rb
-- spec/module.rb
-homepage: 
+- History.md
+- Rakefile
+- spec/client_spec.rb
+- spec/module_spec.rb
+- spec/spec_helper.rb
+- spec/consumer_spec.rb
+homepage: https://github.com/segmentio/analytics-ruby
 licenses: []
 post_install_message: 
 rdoc_options: []

data/spec/client.rb

@@ -1,21 +0,0 @@
-require_relative '../lib/analytics'
-
-
-describe Analytics::Client, '#track' do
-
-  before(:all) { @client = Analytics::Client.new(secret: 'testsecret') }
-
-  it 'should error without an event' do
-    expect { @client.track(user_id: 'user') }.to raise_error(ArgumentError)
-  end
-
-  it 'should error without a user or session' do
-    expect { @client.track(event: 'Event') }.to raise_error(ArgumentError)
-  end
-
-  it 'should not error with the required options' do
-    @client.track(user_id: 'user',
-                  event:   'Event')
-  end
-
-end

data/spec/module.rb

@@ -1,27 +0,0 @@
-require_relative '../lib/analytics'
-
-
-describe Analytics, '#init' do
-
-  it 'should successfully init' do
-    Analytics.init secret: 'testsecret'
-  end
-end
-
-
-describe Analytics, '#track' do
-
-  it 'should error without an event' do
-    expect { Analytics.track user_id: 'user' }.to raise_error(ArgumentError)
-  end
-
-  it 'should error without a user or session' do
-    expect { Analytics.track event: 'Event' }.to raise_error(ArgumentError)
-  end
-
-  it 'should not error with the required options' do
-    Analytics.track user_id: 'user',
-                    event:   'Event'
-  end
-
-end

data/spec/test.rb

@@ -1,25 +0,0 @@
-
-
-module Analytics
-  module Defaults
-    module Request
-      BASE_URL = "http://localhost:7001"
-    end
-  end
-end
-
-require_relative '../lib/analytics'
-
-puts "Hello"
-
-
-client = Analytics::Client.new(secret: "testsecret")
-
-puts "Client made"
-
-100.times do
-  client.identify(user_id: "user")
-  client.track(user_id: "user",
-               event:   "No Typhoeus")
-end
-sleep 10