analytics-ruby 0.5.4 → 0.6.0

data/Gemfile.lock

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

data/History.md

@@ -1,3 +1,8 @@
+0.6.0 / 2014-02-19
+==================
+* adding .group(), .page(), and .screen() calls
+* relaxing faraday dependency, fixes #31
+
 0.5.4 / 2013-12-31
 ==================
 * Add `requestId` fields to all requests for tracing.
@@ -16,7 +21,7 @@
 
 0.5.0 / 2013-10-03
 ==================
-* Removing global Analytics alias in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the `Analytics` namespace, you'll have to add `Analytics = AnalyticsRuby` to your config. Otherwise you WILL NOT be sending analytics data. See the [setup docs for more info](https://segment.io/libraries/ruby)
+* Removing global Analytics constant in favor of adding it to our config. NOTE: If you are upgrading from a previous version and want to continue using the `Analytics` namespace, you'll have to add `Analytics = AnalyticsRuby` to your config. Otherwise you WILL NOT be sending analytics data. See the [setup docs for more info](https://segment.io/libraries/ruby)
 
 0.4.0 / 2013-08-30
 ==================

data/analytics-ruby.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/segmentio/analytics-ruby'
   spec.license = 'MIT'
 
-  spec.add_dependency 'faraday', ['>= 0.8', '< 0.10']
+  spec.add_dependency 'faraday', ['>= 0.8']
   spec.add_dependency 'faraday_middleware', ['>= 0.8', '< 0.10']
   spec.add_dependency 'multi_json', ['~> 1.0']
 

data/lib/analytics-ruby.rb

@@ -23,6 +23,21 @@ module AnalyticsRuby
       @client.alias options
     end
 
+    def group(options)
+      return false unless @client
+      @client.group options
+    end
+
+    def page(options)
+      return false unless @client
+      @client.page options
+    end
+
+    def screen(options)
+      return false unless @client
+      @client.screen options
+    end
+
     def flush
       return false unless @client
       @client.flush

data/lib/analytics-ruby/client.rb

@@ -159,6 +159,108 @@ module AnalyticsRuby
       })
     end
 
+    # public: Associates a user identity with a group.
+    #
+    # options - Hash
+    #           :from      - String of the id to alias from
+    #           :to        - String of the id to alias to
+    #           :timestamp - Time of when the alias occured (optional)
+    #           :context   - Hash of context (optional)
+    def group(options)
+      check_secret
+      Util.symbolize_keys! options
+      group_id = options[:group_id].to_s
+      user_id = options[:user_id].to_s
+      traits = options[:traits] || {}
+      timestamp = options[:timestamp] || Time.new
+      context = options[:context] || {}
+
+      fail ArgumentError, '.traits must be a hash' unless traits.is_a? Hash
+
+      ensure_user group_id
+      ensure_user user_id
+      check_timestamp timestamp
+      add_context context
+
+      enqueue({
+        :groupId => group_id,
+        :userId => user_id,
+        :traits => traits,
+        :context => context,
+        :timestamp => timestamp.iso8601,
+        :action => 'group'
+      })
+    end
+
+    # public: Records a page view
+    #
+    # options - Hash
+    #           :user_id    - String of the id to alias from
+    #           :name       - String name of the page
+    #           :properties - Hash of page properties (optional)
+    #           :timestamp  - Time of when the pageview occured (optional)
+    #           :context    - Hash of context (optional)
+    def page(options)
+      check_secret
+      Util.symbolize_keys! options
+      user_id = options[:user_id].to_s
+      name = options[:name].to_s
+      properties = options[:properties] || {}
+      timestamp = options[:timestamp] || Time.new
+      context = options[:context] || {}
+
+      fail ArgumentError, '.name must be a string' unless !name.empty?
+      fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
+      Util.isoify_dates! properties
+
+      ensure_user user_id
+      check_timestamp timestamp
+      add_context context
+
+      enqueue({
+        :userId => user_id,
+        :name => name,
+        :properties => properties,
+        :context => context,
+        :timestamp => timestamp.iso8601,
+        :action => 'page'
+      })
+    end
+    # public: Records a screen view (for a mobile app)
+    #
+    # options - Hash
+    #           :user_id    - String of the id to alias from
+    #           :name       - String name of the screen
+    #           :properties - Hash of screen properties (optional)
+    #           :timestamp  - Time of when the screen occured (optional)
+    #           :context    - Hash of context (optional)
+    def screen(options)
+      check_secret
+      Util.symbolize_keys! options
+      user_id = options[:user_id].to_s
+      name = options[:name].to_s
+      properties = options[:properties] || {}
+      timestamp = options[:timestamp] || Time.new
+      context = options[:context] || {}
+
+      fail ArgumentError, '.name must be a string' if name.empty?
+      fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
+      Util.isoify_dates! properties
+
+      ensure_user user_id
+      check_timestamp timestamp
+      add_context context
+
+      enqueue({
+        :userId => user_id,
+        :name => name,
+        :properties => properties,
+        :context => context,
+        :timestamp => timestamp.iso8601,
+        :action => 'screen'
+      })
+    end
+
     # public: Returns the number of queued messages
     #
     # returns Fixnum of messages in the queue

data/lib/analytics-ruby/version.rb

@@ -1,3 +1,3 @@
 module AnalyticsRuby
-  VERSION = '0.5.4'
+  VERSION = '0.6.0'
 end

data/spec/client_spec.rb

@@ -129,6 +129,72 @@ describe AnalyticsRuby::Client do
     end
   end
 
+  describe '#group' do
+    before :all do
+      @client = AnalyticsRuby::Client.new :secret => AnalyticsRubyHelpers::SECRET
+    end
+
+    it 'should error without group_id' do
+      expect { @client.group :user_id => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without user_id' do
+      expect { @client.group :group_id => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      @client.group AnalyticsRubyHelpers::Queued::GROUP
+    end
+
+    it 'should not error with the required options as strings' do
+      @client.group Util.stringify_keys(AnalyticsRubyHelpers::Queued::GROUP)
+    end
+  end
+
+  describe '#page' do
+    before :all do
+      @client = AnalyticsRuby::Client.new :secret => AnalyticsRubyHelpers::SECRET
+    end
+
+    it 'should error without user_id' do
+      expect { @client.page :name => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without name' do
+      expect { @client.page :user_id => 1 }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      @client.page AnalyticsRubyHelpers::Queued::PAGE
+    end
+
+    it 'should not error with the required options as strings' do
+      @client.page Util.stringify_keys(AnalyticsRubyHelpers::Queued::PAGE)
+    end
+  end
+
+  describe '#screen' do
+    before :all do
+      @client = AnalyticsRuby::Client.new :secret => AnalyticsRubyHelpers::SECRET
+    end
+
+    it 'should error without user_id' do
+      expect { @client.screen :name => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without name' do
+      expect { A@client.screen :user_id => 1 }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      @client.screen AnalyticsRubyHelpers::Queued::SCREEN
+    end
+
+    it 'should not error with the required options as strings' do
+      @client.screen Util.stringify_keys(AnalyticsRubyHelpers::Queued::SCREEN)
+    end
+  end
+
   describe '#flush' do
     before(:all) do
       @client = AnalyticsRuby::Client.new :secret => AnalyticsRubyHelpers::SECRET

data/spec/module_spec.rb

@@ -71,6 +71,51 @@ describe AnalyticsRuby do
     end
   end
 
+  describe '#group' do
+    it 'should error without group_id' do
+      expect { AnalyticsRuby.group :user_id => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without user_id' do
+      expect { AnalyticsRuby.group :group_id => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      AnalyticsRuby.group AnalyticsRubyHelpers::Queued::GROUP
+      sleep(1)
+    end
+  end
+
+  describe '#page' do
+    it 'should error without user_id' do
+      expect { AnalyticsRuby.page :name => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without name' do
+      expect { AnalyticsRuby.page :user_id => 1 }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      AnalyticsRuby.page AnalyticsRubyHelpers::Queued::PAGE
+      sleep(1)
+    end
+  end
+
+  describe '#screen' do
+    it 'should error without user_id' do
+      expect { AnalyticsRuby.screen :name => 'foo' }.to raise_error(ArgumentError)
+    end
+
+    it 'should error without name' do
+      expect { AnalyticsRuby.screen :user_id => 1 }.to raise_error(ArgumentError)
+    end
+
+    it 'should not error with the required options' do
+      AnalyticsRuby.screen AnalyticsRubyHelpers::Queued::SCREEN
+      sleep(1)
+    end
+  end
+
   describe '#flush' do
 
     it 'should flush without error' do

data/spec/spec_helper.rb

@@ -18,8 +18,7 @@ module AnalyticsRubyHelpers
       :likes_animals => true,
       :instrument => 'Guitar',
       :age => 25
-    },
-    :action => 'identify'
+    }
   }
 
   ALIAS = {
@@ -27,15 +26,29 @@ module AnalyticsRubyHelpers
     :to => 'abcd'
   }
 
+  GROUP = {}
+
+  PAGE = {
+    :name => 'home'
+  }
+
+  SCREEN = {
+    :name => 'main'
+  }
+
   USER_ID = 1234
+  GROUP_ID = 1234
 
-  # Hashes sent to the client
+  # Hashes sent to the client, snake_case
   module Queued
     TRACK = TRACK.merge :user_id => USER_ID
     IDENTIFY = IDENTIFY.merge :user_id => USER_ID
+    GROUP = GROUP.merge :group_id => GROUP_ID, :user_id => USER_ID
+    PAGE = PAGE.merge :user_id => USER_ID
+    SCREEN = SCREEN.merge :user_id => USER_ID
   end
 
-  # Hashes which are sent from the consumer
+  # Hashes which are sent from the consumer, camel_cased
   module Requested
     TRACK = TRACK.merge({
       :userId => USER_ID,
@@ -46,5 +59,14 @@ module AnalyticsRubyHelpers
       :userId => USER_ID,
       :action => 'identify'
     })
+
+    GROUP = GROUP.merge({
+      :groupId => GROUP_ID,
+      :userId => USER_ID,
+      :action => 'group'
+    })
+
+    PAGE = PAGE.merge :userId => USER_ID
+    SCREEN = SCREEN.merge :userId => USER_ID
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,9 +19,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,9 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement