Merge pull request #3 from outboundio/upgrading-to-1.0.0

moving to 1.0.0, combining user info and attributes in calls

Author: usmanity

README.md

@@ -1,96 +1,4 @@
 # Outbound Ruby Library
 
-## Install
-### Simple
-    gem install outbound
-
-### Bundler
-    gem 'outbound', '~> 0.1.0', :require => 'outbound'
-
-## Setup
-    require 'outbound'
-    require 'logger'
-
-    Outbound.init("Your API KEY", Logger::ERROR)
-
-## Identify User
-
-    require 'outbound'
-    user_info = {
-        :first_name => "FirstName",
-        :last_name => "LastName",
-        :email => "[email protected]",
-        :phone_number => "5551234567",
-        :apns_tokens => ["ios device token"],
-        :gcm_tokens => ["android device token"]
-    }
-    user_attributes = {
-        :some_other_attribute => "Something"
-    }
-    Outbound.identify("USER ID", user_info, user_attributes)
-
-## Track Event
-
-    require 'outbound'
-    event_properties = {
-        :some_event_property => "Something"
-    }
-    Outbound.track("USER ID", "EVENT NAME", event_properties)
-
-## Register a device token
-You can register device tokens for push notification by sending them in the `identify` or individually using the `register` call.
-
-    require 'outbound'
-
-    # To register a token for Apple Push Notification Service (iOS)
-    Outbound.register Outbound.APNS, "USER_ID", "DEVICE_TOKEN_HERE"
-
-    # To register a token for Google Cloud Messaging (Android)
-    Outbound.register Outbound.GCM, "USER_ID", "DEVICE_TOKEN_HERE"
-
-## Disable a device token
-You can also disable a previously registered device tokens.
-
-    require 'outbound'
-
-    # To disable a token for Apple Push Notification Service (iOS)
-    Outbound.disable Outbound.APNS, "USER_ID", "DEVICE_TOKEN_HERE"
-
-    # To disable a token for Google Cloud Messaging (Android)
-    Outbound.disable Outbound.GCM, "USER_ID", "DEVICE_TOKEN_HERE"
-
-## Specifics
-### User ID
-- A user ID must ALWAYS be a string or a number. Anything else will trigger an error and the call will not be sent to Outbound. User IDs are always stored as strings. Keep this in mind if you have different types. A user with ID of 1 (the number) will be considered the same as user with ID of "1" (the string).
-- A user ID should be static. It should be the same value you use to identify the user in your own system.
-- Some times you don't have a user id yet for a user but you still want to identify them and trigger events for them. You can do this by generating a new ID (call this the anonymous ID) and identify the user as you normally would. Then, once the user becomes a real, identifiable user and you have a real ID for them, make another identify call, this time pass in the anonymous ID as the previous ID.
-
-        user_info = {
-            :previous_id => anonymous_id,
-        }
-        Outbound.identify("USER ID", user_info)
-
-### Groups
-You can create a set of attributes and have them be inherited by a group of users. This can all be done with the `identify` call.
-
-    user_info = {
-        :group_id => 'group identifier',
-        :group_attributes => {
-            ... attributes shared by the group ...
-        }
-    }
-    Outbound.identify("USER ID", user_info)
-
-- Group IDs are treated just like user IDs. They should only be strings or numbers.
-- Users in a group will inherit group attributes but user attributes take precedences. So if there is an attribute `state` set on the group and it is set to "California" and there is also a `state` attribute set on the user but set to "New York", the value for that user is "New York". If the user didn't have that attribute, the value of `state` for that user would be the group value which is "California".
-- You only need to pass in the group attributes when they are initially set or when they are updated but you do need to set the group id for each user you want to be in the group.
-
-### Event Name
-- An event name in a track can only be a string. Any other type of value will trigger an error and the call will not be sent to Outbound.
-- Event names can be anything you want them to be (as long as they are strings) and contain any character you want.
-
-### Device Tokens
-- If you send a device token through an `identify` call, that is equivalent to sending a `register` call. Regardless of the state of that token it will become active again and we will attempt to send notifications to it. It is recommended that if you use the `register` and `disable` calls that you DO NOT send any tokens in `identify` calls. This way you can more easily control the state of your tokens.
-
-### Results
-- Both the `identify` and `track` methods return a `Outbound::Result` instance. It has `error` and `received_call` attributes that are accesible. `received_call` is a boolean that indicates if the http request was even made. `error` will be either `nil` or a string error message. There is also a `success?` method that returns true if the call went through to Outbound and did not have any errors. There are also `?` method available for each different error type.
+Learn more about the Outbound Ruby Library by going
+to [docs.outbound.io](http://docs.outbound.io/v2/docs/ruby). 

lib/outbound.rb

@@ -4,7 +4,7 @@
 require 'uri'
 
 module Outbound
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
   BASE_URL = 'https://api.outbound.io/v2'
 
   APNS = "apns"
@@ -34,23 +34,22 @@ def Outbound.init api_key, log_level=Logger::ERROR
     @ob = Outbound::Client.new api_key, @logger
   end
 
-  def Outbound.identify user_id, info={}, attributes={}
+  def Outbound.identify user_id, info={}
     if @ob == nil
       res = Result.new Outbound::ERROR_INIT, false
       @logger.error res.error
       return res
     end
-
-    return @ob.identify user_id, info, attributes
+    return @ob.identify user_id, info
   end
 
-  def Outbound.track user_id, event, properties={}, user_info={}, user_attributes={}
+  def Outbound.track user_id, event, properties={}, user_info={}, timestamp
     if @ob == nil
       res = Result.new Outbound::ERROR_INIT, false
       @logger.error res.error
       return res
     end
-    return @ob.track user_id, event, properties, user_info, user_attributes
+    return @ob.track user_id, event, properties, user_info, timestamp
   end
 
   def Outbound.disable platform, user_id, token
@@ -119,7 +118,7 @@ def initialize api_key, logger
       @logger = logger
     end
 
-    def identify user_id, info={}, attributes={}
+    def identify user_id, info={}
       unless user_id.is_a? String or user_id.is_a? Numeric
         res = Result.new Outbound::ERROR_USER_ID, false
         @logger.error res.error
@@ -128,7 +127,7 @@ def identify user_id, info={}, attributes={}
 
       user_data = {:user_id => user_id}
       begin
-        user = user(info, attributes)
+        user = user(info)
         user_data = user_data.merge user
       rescue
         @logger.error "Could not use user info (#{info}) and/or user attributes #{attributes} given to identify call."
@@ -137,7 +136,7 @@ def identify user_id, info={}, attributes={}
       return post(@api_key, '/identify', user_data)
     end
 
-    def track user_id, event, properties={}, user_info={}, user_attributes={}
+    def track user_id, event, properties={}, user_info={}, timestamp
       unless user_id.is_a? String or user_id.is_a? Numeric
         res = Result.new Outbound::ERROR_USER_ID, false
         @logger.error res.error
@@ -153,7 +152,7 @@ def track user_id, event, properties={}, user_info={}, user_attributes={}
       data = {:user_id => user_id, :event => event}
 
       begin
-        user = user(user_info, user_attributes)
+        user = user(user_info)
         if user.length > 0
           data[:user] = user
         end
@@ -169,6 +168,16 @@ def track user_id, event, properties={}, user_info={}, user_attributes={}
         @logger.error "Could not use event properties (#{properties}) given to track call."
       end
 
+      puts timestamp
+
+      unless timestamp == {}
+        data[:timestamp] = timestamp
+      else
+        data[:timestamp] = Time.now.to_i
+      end
+
+      puts data[:timestamp]
+
       return post(@api_key, '/track', data)
     end
 
@@ -244,8 +253,8 @@ def post api_key, path, data
       return err, true
     end
 
-    def user info={}, attributes={}
-      unless info.is_a? Hash and attributes.is_a? Hash
+    def user info={}
+      unless info.is_a? Hash
         raise
       end
 
@@ -259,9 +268,10 @@ def user info={}, attributes={}
         :group_id => info[:group_id],
         :group_attributes => info[:group_attributes],
         :previous_id => info[:previous_id],
-        :attributes => attributes,
+        :attributes => info[:attributes],
       }
       return user.delete_if { |k, v| v.nil? || v.empty? }
     end
+
   end
 end