Class: MessagebusApi::Messagebus

Inherits:
Object
  • Object
show all
Defined in:
lib/messagebus_ruby_api/messagebus.rb

Constant Summary collapse

TEMPLATE = 
'template'
EMAIL = 
'email'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key) ⇒ Messagebus

Returns a new instance of Messagebus.



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 24

def initialize(api_key)
  @api_key = api_key
  init_http_connection(domain)

  @msg_buffer_size = 20
  @msg_buffer = []
  @msg_type = nil
  @msg_buffer_flushed = false
  @send_common_info = {}
  @results = base_response_params
  @rest_endpoints = define_rest_endpoints
  @rest_http_errors = define_rest_http_errors
end

Instance Attribute Details

#send_common_info=(value) ⇒ Object (writeonly)

Sets the attribute send_common_info

Parameters:

  • value —

    the value to set the attribute send_common_info to.



22
23
24
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 22

def send_common_info=(value)
  @send_common_info = value
end

Instance Method Details

#add_mailing_list_entry(mailing_list_key, merge_fields) ⇒ Object 



150
151
152
153
154
155
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 150

def add_mailing_list_entry(mailing_list_key, merge_fields)
  path = @rest_endpoints[:mailing_lists_entries].gsub("%KEY%", mailing_list_key)
  json = {:mergeFields => merge_fields}.to_json
  @results = make_api_post_call(path, json)
  @results
end

#add_message(params, flush_buffer = false) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 58

def add_message(params, flush_buffer = false)
  if params.key?(:templateKey)
    add_template_message(params)
  else
    add_email_message(params)
  end

  @msg_buffer_flushed = false
  if flush_buffer || @msg_buffer.size >= @msg_buffer_size
    flush
  end
  return
end

#api_version ⇒ Object 



54
55
56
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 54

def api_version
  make_api_get_call(@rest_endpoints[:version])
end

#cacert_info(cert_file) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 181

def cacert_info(cert_file)
  @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
  if !File.exists?(cert_file)
    raise MessagebusApi::MissingFileError.new("Unable to read file #{cert_file}")
  end
  @http.ca_file = File.join(cert_file)
end

#campaign_status(campaign_key) ⇒ Object 



138
139
140
141
142
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 138

def campaign_status(campaign_key)
  path = @rest_endpoints[:campaign_status].gsub("%KEY%", campaign_key)
  @results = make_api_get_call(path)
  @results
end

#campaigns ⇒ Object 



124
125
126
127
128
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 124

def campaigns
  path = @rest_endpoints[:campaigns]
  @results = make_api_get_call(path)
  @results
end

#campaigns_send(params) ⇒ Object 



130
131
132
133
134
135
136
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 130

def campaigns_send(params)
  path = @rest_endpoints[:campaigns_send]
  campaign_params = base_campaign_params.merge!(params)
  json = campaign_params.to_json
  @results = make_api_post_call(path, json)
  @results
end

#delete_mailing_list_entry(mailing_list_key, email) ⇒ Object 



144
145
146
147
148
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 144

def delete_mailing_list_entry(mailing_list_key, email)
  path = @rest_endpoints[:mailing_lists_entry_email].gsub("%KEY%", mailing_list_key).gsub("%EMAIL%", email)
  @results = make_api_delete_call(path)
  @results
end

#deliver(message) ⇒ Object 



193
194
195
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 193

def deliver(message)
  deliver!(message)
end

#deliver!(message) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 197

def deliver!(message)
  if message.to.first.nil? ||message.subject.nil? || message.from.first.nil? then
    raise "Messagebus API error=Missing required header: :toEmail => #{message.to.first} :subject => #{message.subject} :fromEmail => #{message.from.first}"
  end

  message_from_email = from_email_with_name(message.header[:from].to_s)

  from_name = ""
  from_email = message.from.first
  if !message_from_email.nil?
    from_name = message_from_email[1]
  end

  if !well_formed_address?(from_email)
    raise "Messagebus API error=From Address is invalid :toEmail => #{message.to.first} :subject => #{message.subject} :fromEmail => #{message.from.first}"
  end

  custom_headers = {}

  custom_headers["envelope-sender"] = message.return_path if !message.return_path.nil?
  custom_headers["bcc"] = message.bcc[0] if !message.bcc.nil?

  message.header.fields.each do |f|
    custom_headers[f.name] = f.value if f.name =~ /x-.*/i
   end

  msg = {
    :toEmail => message.to.first,
    :subject => message.subject,
    :fromEmail => from_email,
    :fromName => from_name,
    :customHeaders => custom_headers
  }

  msg[:plaintextBody] = ( message.body ) ? "#{message.body}" : "No plaintext version was supplied."

  if message.multipart?
    msg[:plaintextBody] = (message.text_part) ? message.text_part.body.to_s : "No plaintext version was supplied."
    msg[:htmlBody] = message.html_part.body.to_s if message.html_part
  end

  begin
    add_message(msg, true)
  rescue => message_bus_api_error
    raise "Messagebus API error=#{message_bus_api_error}, message=#{msg.inspect}"
  end
end

#delivery_errors(start_date = '', end_date = '', tag = '') ⇒ Object 



169
170
171
172
173
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 169

def delivery_errors(start_date = '', end_date = '', tag='')
  path = "#{@rest_endpoints[:delivery_errors]}?#{date_range(start_date, end_date)}&tag=#{URI.escape(tag)}"
  @results = make_api_get_call(path)
  @results
end

#feedbackloops(start_date = '', end_date = '') ⇒ Object 



163
164
165
166
167
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 163

def feedbackloops(start_date = '', end_date = '')
  path = "#{@rest_endpoints[:feedbackloops]}?#{date_range(start_date, end_date)}"
  @results = make_api_get_call(path)
  @results
end

#flush ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 72

def flush
  if (@msg_buffer.size==0)
    @results=@empty_send_results
    return
  end

  if @msg_type == TEMPLATE
    endpoint = @rest_endpoints[:templates_send]
  else
    endpoint = @rest_endpoints[:emails_send]
  end

  json = json_message_from_list(@msg_buffer)
  if (@last_init_time < Time.now.utc - 60)
    init_http_connection(domain)
  end
  @results=make_api_post_call(endpoint, json)
  @msg_buffer.clear
  @msg_buffer_flushed = true
  return
end

#flushed? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 50

def flushed?
  @msg_buffer_flushed
end

#format_iso_time(time) ⇒ Object 



189
190
191
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 189

def format_iso_time(time)
  time.strftime("%Y-%m-%dT%H:%M:%SZ")
end

#mailing_list_delete(mailing_list_key) ⇒ Object 



118
119
120
121
122
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 118

def mailing_list_delete(mailing_list_key)
  path = @rest_endpoints[:mailing_list_delete].gsub("%KEY%", mailing_list_key)
  @results = make_api_delete_call(path)
  @results
end

#mailing_lists ⇒ Object 



94
95
96
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 94

def mailing_lists
  make_api_get_call(@rest_endpoints[:mailing_lists])
end

#message_buffer_size ⇒ Object 



46
47
48
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 46

def message_buffer_size
  @msg_buffer_size
end

#message_buffer_size=(size) ⇒ Object 



42
43
44
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 42

def message_buffer_size=(size)
  @msg_buffer_size = size if (size >= 1 && size <= 100)
end

#overwrite_mailing_list(file_name, file_path, mailing_list_key) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 108

def overwrite_mailing_list(file_name, file_path, mailing_list_key)
  path = @rest_endpoints[:mailing_list_overwrite].gsub("%KEY%", mailing_list_key)
  File.open(file_path) do |f|
    headers = common_http_headers.merge(rest_upload_headers)
    req = Net::HTTP::Post::Multipart.new path, {:jsonData => "{\"name\":\"#{file_name}\"}", "fileData" => UploadIO.new(f, "text/plain", file_path)}, headers
    @results = @http.request(req)
  end
  check_response(@results)
end

#results ⇒ Object 



38
39
40
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 38

def results
  @results
end

#stats(start_date = '', end_date = '', tag = '') ⇒ Object 



175
176
177
178
179
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 175

def stats(start_date = '', end_date = '', tag = '')
  path = "#{@rest_endpoints[:stats]}?#{date_range(start_date, end_date)}&tag=#{URI.escape(tag)}"
  @results = make_api_get_call(path)
  @results
end

#unsubscribes(start_date = '', end_date = '') ⇒ Object 



157
158
159
160
161
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 157

def unsubscribes(start_date = '', end_date = '')
  path = "#{@rest_endpoints[:unsubscribes]}?#{date_range(start_date, end_date)}"
  @results = make_api_get_call(path)
  @results
end

#upload_mailing_list(name, file_path) ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/messagebus_ruby_api/messagebus.rb', line 98

def upload_mailing_list(name, file_path)
  path = @rest_endpoints[:mailing_lists_upload]
  File.open(file_path) do |f|
    headers = common_http_headers.merge(rest_upload_headers)
    req = Net::HTTP::Post::Multipart.new path, {:jsonData => "{\"name\":\"#{name}\"}", "fileData" => UploadIO.new(f, "text/plain", file_path)}, headers
    @results = @http.request(req)
  end
  check_response(@results)
end