Module: Outbound

Defined in:
lib/outbound.rb

Defined Under Namespace

Modules: Defaults Classes: Client, Result

Constant Summary collapse

VERSION = 
'1.1.0'
BASE_URL = 
'https://api.outbound.io/v2'
APNS = 
"apns"
GCM = 
"gcm"
ERROR_USER_ID = 
"User ID must be a string or number."
ERROR_EVENT_NAME = 
"Event name must be a string."
ERROR_CONNECTION = 
"Outbound connection error"
ERROR_INIT = 
"Must call init() before identify() or track()."
ERROR_TOKEN = 
"Token must be a string."
ERROR_PLATFORM = 
"Unsupported platform specified."
ERROR_CAMPAIGN_IDS = 
"At least one campaign ID is required."

Class Method Summary collapse

Class Method Details

.disable(platform, user_id, token) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/outbound.rb', line 56

def Outbound.disable(platform, user_id, token)
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.disable(platform, user_id, token)
end

.disable_all(platform, user_id) ⇒ Object 



65
66
67
68
69
70
71
72
 
# File 'lib/outbound.rb', line 65

def Outbound.disable_all(platform, user_id)
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.disable_all(platform, user_id)
end

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



38
39
40
41
42
43
44
45
 
# File 'lib/outbound.rb', line 38

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)
end

.init(api_key, log_level = Logger::ERROR) ⇒ Object 



33
34
35
36
 
# File 'lib/outbound.rb', line 33

def Outbound.init(api_key, log_level=Logger::ERROR)
  @logger.level = log_level
  @ob = Outbound::Client.new api_key, @logger
end

.register(platform, user_id, token) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/outbound.rb', line 74

def Outbound.register(platform, user_id, token)
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.register(platform, user_id, token)
end

.subscribe(user_id, all = false, campaign_ids = nil) ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/outbound.rb', line 92

def Outbound.subscribe user_id, all=false, campaign_ids=nil
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.subscription user_id, false, all, campaign_ids
end

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



47
48
49
50
51
52
53
54
 
# File 'lib/outbound.rb', line 47

def Outbound.track(user_id, event, properties={}, timestamp=Time.now.to_i)
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.track(user_id, event, properties, timestamp)
end

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



83
84
85
86
87
88
89
90
 
# File 'lib/outbound.rb', line 83

def Outbound.unsubscribe user_id, all=false, campaign_ids=nil
  if @ob == nil
    res = Result.new Outbound::ERROR_INIT, false
    @logger.error res.error
    return res
  end
  return @ob.subscription user_id, true, all, campaign_ids
end