analytics-ruby 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78f87f89a21de0f30bcec88b62edc739f637b148
-  data.tar.gz: f05b8214e846b4399a698a0a5e30840529d247ed
+  metadata.gz: 1c32a838a458467589a5ac12e6ef9324d324ac32
+  data.tar.gz: f6d4c491a12271e49a567649d87f630939bda14e
 SHA512:
-  metadata.gz: b24cb50f53eb596c86de960516af9e19edec63c4f0268c0f242e7bb1c2910450702fc84c6095fe8de8af4c22bc7460170c33db673c4b30f5f6d9c29575312cbb
-  data.tar.gz: 64e1ff1189e5edca8d8d0ea697b6e1cc69d2676e09fff1cddbf65b9aea852c0e2bd5c7d80a1973672a1f82de54ba4c3ef997ac0fedfe7a4c74548120797e8e27
+  metadata.gz: 69a369b48f8f11f7fe1674fe09809189fb42272f1d0462c55af916869d083d033988628d10f0220d262a7f0107f97bf8546625146ad6430996a4223ecd2f1981
+  data.tar.gz: 1f6d0c9a728827100d5ee3c8f9a9968647d12f94f8cdb304c1c02e7f7b2f17fe1a7993e8284863c5a807e4add1d4b293e0d07a3d83923b7258ccc332b46f01e4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    analytics-ruby (2.0.5)
+    analytics-ruby (2.0.6)
 
 GEM
   remote: http://rubygems.org/

data/History.md

@@ -1,3 +1,7 @@
+2.0.7 / 2014-08-27
+==================
+* fix: include optional options hash in calls
+
 2.0.6 / 2014-08-12
 ==================
 * fix: category param on #page and #screen

data/lib/segment/analytics/client.rb

@@ -11,17 +11,17 @@ module Segment
 
       # public: Creates a new client
       #
-      # options - Hash
+      # attrs - Hash
       #           :write_key         - String of your project's write_key
       #           :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 = {}
-        symbolize_keys! options
+      def initialize attrs = {}
+        symbolize_keys! attrs
 
         @queue = Queue.new
-        @write_key = options[:write_key]
-        @max_queue_size = options[:max_queue_size] || Defaults::Queue::MAX_SIZE
-        @options = options
+        @write_key = attrs[:write_key]
+        @max_queue_size = attrs[:max_queue_size] || Defaults::Queue::MAX_SIZE
+        @options = attrs
         @worker_mutex = Mutex.new
         @worker = Worker.new @queue, @write_key, @options
 
@@ -43,20 +43,23 @@ module Segment
 
       # public: Tracks an event
       #
-      # options - Hash
-      #           :event      - String of event name.
-      #           :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
-        symbolize_keys! options
-        check_user_id! options
-
-        event = options[:event]
-        properties = options[:properties] || {}
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :context      - Hash of context. (optional)
+      #           :event        - String of event name.
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of event properties. (optional)
+      #           :timestamp    - Time of when the event occurred. (optional)
+      #           :user_id      - String of the user id.
+      def track attrs
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        event = attrs[:event]
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         check_timestamp! timestamp
 
@@ -71,10 +74,11 @@ module Segment
 
         enqueue({
           :event => event,
-          :userId => options[:user_id],
-          :anonymousId => options[:anonymous_id],
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
           :context =>  context,
-          :integrations => options[:integrations],
+          :options => attrs[:options],
+          :integrations => attrs[:integrations],
           :properties => properties,
           :timestamp => datetime_in_iso8601(timestamp),
           :type => 'track'
@@ -83,18 +87,21 @@ module Segment
 
       # public: Identifies a user
       #
-      # options - Hash
-      #           :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
-        symbolize_keys! options
-        check_user_id! options
-
-        traits = options[:traits] || {}
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :context      - Hash of context. (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :timestamp    - Time of when the event occurred. (optional)
+      #           :traits       - Hash of user traits. (optional)
+      #           :user_id      - String of the user id
+      def identify attrs
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        traits = attrs[:traits] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         check_timestamp! timestamp
 
@@ -104,11 +111,12 @@ module Segment
         add_context context
 
         enqueue({
-          :userId => options[:user_id],
-          :anonymousId => options[:anonymous_id],
-          :integrations => options[:integrations],
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
+          :integrations => attrs[:integrations],
           :context => context,
           :traits => traits,
+          :options => attrs[:options],
           :timestamp => datetime_in_iso8601(timestamp),
           :type => 'identify'
         })
@@ -116,18 +124,20 @@ module Segment
 
       # public: Aliases a user from one id to another
       #
-      # options - Hash
-      #           :previous_id      - String of the id to alias from
-      #           :user_id        - String of the id to alias to
-      #           :timestamp - Time of when the alias occured (optional)
-      #           :context   - Hash of context (optional)
-      def alias(options)
-        symbolize_keys! options
-
-        from = options[:previous_id]
-        to = options[:user_id]
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :context     - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :previous_id - String of the id to alias from
+      #           :timestamp   - Time of when the alias occured (optional)
+      #           :user_id     - String of the id to alias to
+      def alias(attrs)
+        symbolize_keys! attrs
+
+        from = attrs[:previous_id]
+        to = attrs[:user_id]
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         check_presence! from, 'previous_id'
         check_presence! to, 'user_id'
@@ -137,8 +147,9 @@ module Segment
         enqueue({
           :previousId => from,
           :userId => to,
-          :integrations => options[:integrations],
+          :integrations => attrs[:integrations],
           :context => context,
+          :options => attrs[:options],
           :timestamp => datetime_in_iso8601(timestamp),
           :type => 'alias'
         })
@@ -146,20 +157,22 @@ module Segment
 
       # public: Associates a user identity with a group.
       #
-      # options - Hash
-      #           :previous_id      - String of the id to alias from
-      #           :user_id        - String of the id to alias to
-      #           :timestamp - Time of when the alias occured (optional)
-      #           :context   - Hash of context (optional)
-      def group(options)
-        symbolize_keys! options
-        check_user_id! options
-
-        group_id = options[:group_id]
-        user_id = options[:user_id]
-        traits = options[:traits] || {}
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :previous_id  - String of the id to alias from
+      #           :timestamp    - Time of when the alias occured (optional)
+      #           :user_id      - String of the id to alias to
+      def group(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        group_id = attrs[:group_id]
+        user_id = attrs[:user_id]
+        traits = attrs[:traits] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         fail ArgumentError, '.traits must be a hash' unless traits.is_a? Hash
         isoify_dates! traits
@@ -172,7 +185,8 @@ module Segment
           :groupId => group_id,
           :userId => user_id,
           :traits => traits,
-          :integrations => options[:integrations],
+          :integrations => attrs[:integrations],
+          :options => attrs[:options],
           :context => context,
           :timestamp => datetime_in_iso8601(timestamp),
           :type => 'group'
@@ -181,21 +195,24 @@ module Segment
 
       # 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)
-      #           :category   - String of the page category (optional)
-      #           :timestamp  - Time of when the pageview occured (optional)
-      #           :context    - Hash of context (optional)
-      def page(options)
-        symbolize_keys! options
-        check_user_id! options
-
-        name = options[:name].to_s
-        properties = options[:properties] || {}
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :category     - String of the page category (optional)
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :name         - String name of the page
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of page properties (optional)
+      #           :timestamp    - Time of when the pageview occured (optional)
+      #           :user_id      - String of the id to alias from
+      def page(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        name = attrs[:name].to_s
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         fail ArgumentError, '.name must be a string' unless !name.empty?
         fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
@@ -205,12 +222,13 @@ module Segment
         add_context context
 
         enqueue({
-          :userId => options[:user_id],
-          :anonymousId => options[:anonymous_id],
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
           :name => name,
-          :category => options[:category],
+          :category => attrs[:category],
           :properties => properties,
-          :integrations => options[:integrations],
+          :integrations => attrs[:integrations],
+          :options => attrs[:options],
           :context => context,
           :timestamp => datetime_in_iso8601(timestamp),
           :type => 'page'
@@ -218,21 +236,24 @@ module Segment
       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
-      #           :category   - String screen category (optional)
-      #           :properties - Hash of screen properties (optional)
-      #           :timestamp  - Time of when the screen occured (optional)
-      #           :context    - Hash of context (optional)
-      def screen(options)
-        symbolize_keys! options
-        check_user_id! options
-
-        name = options[:name].to_s
-        properties = options[:properties] || {}
-        timestamp = options[:timestamp] || Time.new
-        context = options[:context] || {}
+      # attrs - Hash
+      #           :anonymous_id - String of the user's id when you don't know who they are yet. (optional but you must provide either an anonymous_id or user_id. See: https://segment.io/docs/tracking - api/track/#user - id)
+      #           :category     - String screen category (optional)
+      #           :context      - Hash of context (optional)
+      #           :integrations - Hash specifying what integrations this event goes to. (optional)
+      #           :name         - String name of the screen
+      #           :options      - Hash specifying options such as user traits. (optional)
+      #           :properties   - Hash of screen properties (optional)
+      #           :timestamp    - Time of when the screen occured (optional)
+      #           :user_id      - String of the id to alias from
+      def screen(attrs)
+        symbolize_keys! attrs
+        check_user_id! attrs
+
+        name = attrs[:name].to_s
+        properties = attrs[:properties] || {}
+        timestamp = attrs[:timestamp] || Time.new
+        context = attrs[:context] || {}
 
         fail ArgumentError, '.name must be a string' if name.empty?
         fail ArgumentError, '.properties must be a hash' unless properties.is_a? Hash
@@ -242,12 +263,13 @@ module Segment
         add_context context
 
         enqueue({
-          :userId => options[:user_id],
-          :anonymousId => options[:anonymous_id],
+          :userId => attrs[:user_id],
+          :anonymousId => attrs[:anonymous_id],
           :name => name,
           :properties => properties,
-          :category => options[:category],
-          :integrations => options[:integrations],
+          :category => attrs[:category],
+          :options => attrs[:options],
+          :integrations => attrs[:integrations],
           :context => context,
           :timestamp => timestamp.iso8601,
           :type => 'screen'
@@ -317,8 +339,8 @@ module Segment
         }
       end
 
-      def check_user_id! options
-        fail ArgumentError, 'Must supply either user_id or anonymous_id' unless options[:user_id] || options[:anonymous_id]
+      def check_user_id! attrs
+        fail ArgumentError, 'Must supply either user_id or anonymous_id' unless attrs[:user_id] || attrs[:anonymous_id]
       end
 
       def ensure_worker_running

data/lib/segment/analytics/version.rb

@@ -1,5 +1,5 @@
 module Segment
   class Analytics
-    VERSION = '2.0.6'
+    VERSION = '2.0.7'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: analytics-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Segment.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -133,9 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Segment.io analytics library
 test_files: []
-has_rdoc: