analytics-ruby 0.0.3 → 0.0.4

data/History.md

@@ -1,4 +1,10 @@
-0.0.3 / 2013-1-17
+0.0.4 / 2013-1-17
+==========
+* Updated readme and install instruction courtesy of [@zeke](https://github.com/zeke)
+* Removed typhoeus and reverted to default adapter
+* Removing session_id in favor of a single user_id
+
+0.0.3 / 2013-1-16
 ==========
 * Rakefile and renaming courtesy of [@kiennt](https://github.com/kiennt)
 * Updated tests with mocks

data/README.md

@@ -13,19 +13,6 @@ Setting up a new analytics solution can be a real pain. The APIs from each analy
 
 [Segment.io](https://segment.io) wraps all those APIs in one beautiful, simple API. Then we route your analytics data wherever you want, whether it's Google Analytics, Mixpanel, Customer io, Chartbeat, or any of our other integrations. After you set up Segment.io you can swap or add analytics providers at any time with a single click. You won't need to touch code or push to production. You'll save valuable development time so that you can focus on what really matters: your product.
 
-```ruby
-gem "analytics-ruby"; require "analytics"
-Analytics.init "secrettoken"
-Analytics.track(user_id: "ilya@segment.io", 
-                event: "Played a Song")
-```
-
-and turn on integrations with just one click at [Segment.io](https://segment.io).
-
-![](http://i.imgur.com/YnBWI.png)
-
-More on integrations [here](#integrations).
-
 ### High Performance
 
 This client uses an internal queue to efficiently send your events in aggregate, rather than making an HTTP
@@ -39,16 +26,18 @@ without worrying that it will make too many HTTP requests and slow down the prog
 If you haven't yet, get an API secret [here](https://segment.io).
 
 #### Install
-```bash
-gem install analytics-ruby
+
+Add analytics-ruby to your project's Gemfile
+```ruby
+gem "analytics-ruby"
 ```
 
 #### Initialize the client
 
-You can create separate analytics-ruby clients, but the easiest and recommended way is to just use the module:
+You can create separate analytics-ruby clients, but the easiest and recommended way is 
+to just use the module. If you're using Rails, put this in `config/initializers/analytics.rb`
 
 ```ruby
-gem 'analytics-ruby'; require 'analytics'
 Analytics.init 'secrettoken'
 ```
 
@@ -57,16 +46,13 @@ Analytics.init 'secrettoken'
 Whenever a user triggers an event, you’ll want to track it.
 
 ```ruby
-Analytics.identify(session_id: 'ajsk2jdj29fj298', 
-                   user_id: 'ilya@segment.io', 
-                   traits: { subscription_plan: "Free",
-                             friends: 30 })
+Analytics.identify(
+  user_id: 'ilya@segment.io', 
+  traits: {subscription_plan: "Free", friends: 30}
+)
 ```
 
-**session_id** (String) is a unique id associated with an anonymous user **before** they are logged in. Even if the user
-is logged in, you can still send us the **session_id** or you can just use `nil`.
-
-**user_id** (String) is the user's id **after** they are logged in. It's the same id as which you would recognize a signed-in user in your system. Note: you must provide either a `session_id` or a `user_id`.
+**user_id** (String) is the user's id **after** they are logged in. It's the same id you'd use to identify a signed-in user in your system. 
 
 **traits** (Hash) is a Hash with keys like `subscriptionPlan` or `favoriteGenre`. This argument is optional, but highly recommended—you’ll find these properties extremely useful later.
 
@@ -77,19 +63,14 @@ is logged in, you can still send us the **session_id** or you can just use `nil`
 Whenever a user triggers an event on your site, you’ll want to track it so that you can analyze and segment by those events later.
 
 ```ruby
-Analytics.track(session_id: 'skdj2jj2dj2j3i5', 
-                user_id: 'ilya@segment.io', 
-                event: 'Drank some milk', 
-                properties: {
-                    fat: 0.02,
-                    quantity:   '4 gallons' })
+Analytics.track(
+  user_id: 'ilya@segment.io', 
+  event: 'Drank some milk', 
+  properties: {fat: 0.02, quantity: '4 gallons'}
+)
 ```
 
-
-**session_id** (String) is a unique id associated with an anonymous user **before** they are logged in. Even if the user
-is logged in, you can still send us the **session_id** or you can just use `nil`.
-
-**user_id** (String) is the user's id **after** they are logged in. It's the same id as which you would recognize a signed-in user in your system. Note: you must provide either a `session_id` or a `user_id`.
+**user_id** (String) is the user's id **after** they are logged in. It's the same id as which you would recognize a signed-in user in your system.
 
 **event** (String) describes what this user just did. It's a human readable description like "Played a Song", "Printed a Report" or "Updated Status".
 

data/analytics.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   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')

data/lib/analytics/client.rb

@@ -31,23 +31,21 @@ module Analytics
     #
     # options - Hash
     #           :event      - String of event name.
-    #           :sessionId  - String of the user session. (optional with userId)
-    #           :userId     - String of the user id. (optional with sessionId)
-    #           :context    - Hash of context. (optional)
+    #           :user_id    - String of the user id.
     #           :properties - Hash of event properties. (optional)
     #           :timestamp  - Time of when the event occurred. (optional)
+    #           :context    - Hash of context. (optional)
     def track(options)
 
       check_secret
 
       event = options[:event]
-      session_id = options[:session_id]
       user_id = options[:user_id]
-      context = options[:context] || {}
       properties = options[:properties] || {}
       timestamp = options[:timestamp] || Time.new
+      context = options[:context] || {}
 
-      ensure_user(session_id, user_id)
+      ensure_user(user_id)
       check_timestamp(timestamp)
 
       if event.nil? || event.empty?
@@ -57,7 +55,6 @@ module Analytics
       add_context(context)
 
       enqueue({ event:      event,
-                sessionId:  session_id,
                 userId:     user_id,
                 context:    context,
                 properties: properties,
@@ -68,30 +65,27 @@ module Analytics
     # public: Identifies a user
     #
     # options - Hash
-    #           :sessionId - String of the user session. (optional with userId)
-    #           :userId    - String of the user id. (optional with sessionId)
-    #           :context   - Hash of context. (optional)
+    #           :user_id   - String of the user id
     #           :traits    - Hash of user traits. (optional)
     #           :timestamp - Time of when the event occurred. (optional)
+    #           :context   - Hash of context. (optional)
     def identify(options)
 
       check_secret
 
-      session_id = options[:session_id]
       user_id = options[:user_id]
-      context = options[:context] || {}
       traits = options[:traits] || {}
       timestamp = options[:timestamp] || Time.new
+      context = options[:context] || {}
 
-      ensure_user(session_id, user_id)
+      ensure_user(user_id)
       check_timestamp(timestamp)
 
       fail ArgumentError, 'Must supply traits as a hash' unless traits.is_a? Hash
 
       add_context(context)
 
-      enqueue({ sessionId: session_id,
-                userId:    user_id,
+      enqueue({ userId:    user_id,
                 context:   context,
                 traits:    traits,
                 timestamp: timestamp.iso8601,
@@ -119,14 +113,12 @@ module Analytics
 
     # private: Ensures that a user id was passed in.
     #
-    # session_id - String of the session
     # user_id    - String of the user id
     #
-    def ensure_user(session_id, user_id)
-      message = 'Must supply either a non-empty session_id or user_id (or both)'
+    def ensure_user(user_id)
+      message = 'Must supply a non-empty user_id'
 
       valid = user_id.is_a?(String) && !user_id.empty?
-      valid ||= session_id.is_a?(String) && !session_id.empty?
 
       fail ArgumentError, message unless valid
     end

data/lib/analytics/request.rb

@@ -4,8 +4,6 @@ require 'analytics/response'
 require 'multi_json'
 require 'faraday'
 require 'faraday_middleware'
-require 'typhoeus'
-require 'typhoeus/adapters/faraday'
 
 module Analytics
 
@@ -23,7 +21,7 @@ module Analytics
       @conn = Faraday.new(options) do |faraday|
         faraday.request :json
         faraday.response :json, :content_type => /\bjson$/
-        faraday.adapter :typhoeus
+        faraday.adapter Faraday.default_adapter
       end
     end
 

data/lib/analytics/version.rb

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

data/spec/client_spec.rb

@@ -26,7 +26,7 @@ describe Analytics::Client do
       expect { @client.track(user_id: 'user') }.to raise_error(ArgumentError)
     end
 
-    it 'should error without a user or session' do
+    it 'should error without a user_id' do
       expect { @client.track(event: 'Event') }.to raise_error(ArgumentError)
     end
 

data/spec/module_spec.rb

@@ -17,7 +17,7 @@ describe Analytics do
       expect { Analytics.track user_id: 'user' }.to raise_error(ArgumentError)
     end
 
-    it 'should error without a user or session' do
+    it 'should error without a user_id' do
       expect { Analytics.track event: 'Event' }.to raise_error(ArgumentError)
     end
 
@@ -28,7 +28,7 @@ describe Analytics do
 
 
   describe '#identify' do
-    it 'should error without a user or session' do
+    it 'should error without a user_id' do
       expect { Analytics.identify traits: {} }.to raise_error(ArgumentError)
     end
 

data/spec/spec_helper.rb

@@ -21,14 +21,12 @@ module AnalyticsHelpers
               }
 
   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 })
+    IDENTIFY = IDENTIFY.merge({ user_id:    USER_ID  })
   end
 
   # Hashes which are sent from the consumer
@@ -37,7 +35,6 @@ module AnalyticsHelpers
                           action: 'track' })
 
     IDENTIFY = IDENTIFY.merge({ userId:    USER_ID,
-                                sessionId: SESSION_ID,
                                 action:    'identify' })
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &22786760 !ruby/object:Gem::Requirement
+  requirement: &13401940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,10 +24,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *22786760
+  version_requirements: *13401940
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &22785200 !ruby/object:Gem::Requirement
+  requirement: &13401100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *22785200
+  version_requirements: *13401100
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &22784660 !ruby/object:Gem::Requirement
+  requirement: &13400440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,21 +46,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *22784660
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: &22784020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *22784020
+  version_requirements: *13400440
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22783500 !ruby/object:Gem::Requirement
+  requirement: &13399840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22783500
+  version_requirements: *13399840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &22781240 !ruby/object:Gem::Requirement
+  requirement: &13399080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,7 +68,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22781240
+  version_requirements: *13399080
 description: The Segment.io ruby analytics library
 email: friends@segment.io
 executables: []