Class: Outbound::Client

Inherits:

Object

• Object
• Outbound::Client

Includes:

Defaults

Defined in:

lib/outbound.rb

Constant Summary

Constants included from Defaults

Defaults::HEADERS

Instance Method Summary

• #alias(user_id, previous_id) ⇒ Object
• #disable(platform, user_id, token) ⇒ Object
• #disable_all(platform, user_id) ⇒ Object
• #identify(user_id, info = {}) ⇒ Object
• #initialize(api_key, logger) ⇒ Client constructor

  A new instance of Client.

• #register(platform, user_id, token) ⇒ Object
• #subscription(user_id, unsubscribe = false, all = false, campaign_ids = nil) ⇒ Object
• #track(user_id, event, properties = {}, user_info = {}, timestamp = Time.now.to_i) ⇒ Object

Constructor Details

#initialize(api_key, logger) ⇒ Client

Returns a new instance of Client.

# File 'lib/outbound.rb', line 158

def initialize(api_key, logger)
  @api_key = api_key
  @logger = logger
end

Instance Method Details

#alias(user_id, previous_id) ⇒ Object

# File 'lib/outbound.rb', line 163

def alias(user_id, previous_id)
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  unless previous_id.is_a? String or previous_id.is_a? Numeric
    res = Result.new Outbound::ERROR_PREVIOUS_ID, false
    @logger.error res.error
    return res
  end

  user_data = {:user_id => user_id, :previous_id => previous_id}
  return post(@api_key, '/identify', user_data)
end

#disable(platform, user_id, token) ⇒ Object

# File 'lib/outbound.rb', line 227

def disable(platform, user_id, token)
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  unless token.is_a? String
    res = Result.new Outbound::ERROR_TOKEN, false
    @logger.error res.error
    return res
  end

  unless [Outbound::APNS, Outbound::GCM].include? platform
    res = Result.new Outbound::ERROR_PLATFORM, false
    @logger.error res.error
    return res
  end

  return post(@api_key, "/#{platform}/disable", {:token => token, :user_id => user_id})
end

#disable_all(platform, user_id) ⇒ Object

# File 'lib/outbound.rb', line 249

def disable_all(platform, user_id)
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  unless [Outbound::APNS, Outbound::GCM].include? platform
    res = Result.new Outbound::ERROR_PLATFORM, false
    @logger.error res.error
    return res
  end

  return post(@api_key, "/#{platform}/disable", {:all => true, :user_id => user_id})
end

#identify(user_id, info = {}) ⇒ Object

# File 'lib/outbound.rb', line 180

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
    return res
  end

  user_data = {:user_id => user_id}
  begin
    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."
  end

  return post(@api_key, '/identify', user_data)
end

#register(platform, user_id, token) ⇒ Object

# File 'lib/outbound.rb', line 265

def register(platform, user_id, token)
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  unless token.is_a? String
    res = Result.new Outbound::ERROR_TOKEN, false
    @logger.error res.error
    return res
  end

  unless [Outbound::APNS, Outbound::GCM].include? platform
    res = Result.new Outbound::ERROR_PLATFORM, false
    @logger.error res.error
    return res
  end

  return post(@api_key, "/#{platform}/register", {:token => token, :user_id => user_id})
end

#subscription(user_id, unsubscribe = false, all = false, campaign_ids = nil) ⇒ Object

# File 'lib/outbound.rb', line 287

def subscription user_id, unsubscribe=false, all=false, campaign_ids=nil
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  if !all
    unless !campaign_ids.nil? && campaign_ids.is_a?(Array) && campaign_ids.length > 0
      res = Result.new Outbound::ERROR_CAMPAIGN_IDS, false
      @logger.error res.error
      return res
    end
  end

  url = '/' + (unsubscribe ? 'unsubscribe' : 'subscribe') + '/' + (all ? 'all' : 'campaigns')
  data = {:user_id => user_id}
  if !all
    data[:campaign_ids] = campaign_ids
  end
  return post(@api_key, url, data)
end

#track(user_id, event, properties = {}, user_info = {}, timestamp = Time.now.to_i) ⇒ Object

# File 'lib/outbound.rb', line 198

def track(user_id, event, properties={}, user_info={}, timestamp=Time.now.to_i)
  unless user_id.is_a? String or user_id.is_a? Numeric
    res = Result.new Outbound::ERROR_USER_ID, false
    @logger.error res.error
    return res
  end

  unless event.is_a? String
    res = Result.new Outbound::ERROR_EVENT_NAME, false
    @logger.error res.error
    return res
  end

  data = {:user_id => user_id, :event => event}

  if properties.is_a? Hash
    if properties.length > 0
      data[:properties] = properties
    end
  else
    @logger.error "Could not use event properties (#{properties}) given to track call."
  end

  data[:timestamp] = timestamp
  puts timestamp

  return post(@api_key, '/track', data)
end