maxemail_api 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c535e4c357aee80beca7c417bd9227a6298d02f
-  data.tar.gz: 47235986f230dd0d919730b22a90bb53e1da0080
+  metadata.gz: 532d04e35daedfca7a6598f8b668548e792f7ade
+  data.tar.gz: dc0228aa78feb5ede97bd14a5e104909446d03f4
 SHA512:
-  metadata.gz: 20395d82c76c386b2e173277c1d8b0926b81d9beff7d8c8b5aa9e4a60573ac56715dc0353d58fd6e8a4ff67387c788c76274efa83ca1ef4cdc4603086080efd2
-  data.tar.gz: 06572aef5194f213714a5a06a78744ccbb9b805dc3e9384a9b605aca174f436fa7a8243b0836085a033ad632f21f4c00b9efe30096d56765de5485e4dfe76632
+  metadata.gz: b425180553db383a4a1168e900de729ba1f3001c4c1504e0c898fcf9e5447d0e6a3d5fbe71a62b7ea656db4d2b09fb61d7cf1b69e80b95a4b627a17e5e09d74f
+  data.tar.gz: d81f90b604b2516f2cda763adb7aaae9f287795269da23029d7b9920a218d004c010a514d9c71f556e78537fafb9228819f7be95ef4ae49afd97f6a7b212ec12

data/lib/maxemail_api/response.rb

@@ -0,0 +1,23 @@
+class MaxemailApiResponse
+  attr_accessor :data
+
+  def initialize(data:, success:, message:)
+    @data = data
+    @data[:success] = success
+    @data[:message] = message
+  end
+
+  def to_json
+    {
+      data: @data
+    }.to_json
+  end
+
+  def successful?
+    @data[:success]
+  end
+
+  def message
+    @data[:message]
+  end
+end

data/lib/maxemail_api/shared.rb

@@ -0,0 +1,15 @@
+module MaxemailApiShared
+  class << self
+    def send_request(params:, method:)
+      HTTP.headers(authentication_header)
+          .get("#{ENV['MAXEMAIL_API_URL']}#{method}",
+               params: params)
+    end
+
+    private
+
+    def authentication_header
+      { Authorization: 'Basic ' + Base64.encode64(ENV['MAXEMAIL_USERNAME'] + ':' + ENV['MAXEMAIL_PASSWORD']).chomp("\n") }
+    end
+  end
+end

data/lib/maxemail_api/subscriptions.rb

@@ -0,0 +1,54 @@
+module MaxemailApiSubscriptions
+  extend self
+  include MaxemailApiShared
+
+  def subscribe(email_address:, list_id:)
+    return MaxemailApiShared.send_request(params: { method: 'insertRecipient', data: { email_address: email_address, subscribed: 1 }.to_json, listID: list_id }, method: 'list') unless inserted?(email_address: email_address, list_id: list_id)
+    MaxemailApiShared.send_request(params: { method: 'updateRecipient', data: { email_address: email_address, subscribed: 1 }.to_json, listID: list_id, recipientId: find_recipient_id(email_address: email_address) }, method: 'list')
+  end
+
+  def subscribed?(email_address:, list_id:)
+    response = MaxemailApiShared.send_request(params: { method: 'fetchRecipient', listID: list_id, recipientId: find_recipient_id(email_address: email_address) }, method: 'list')
+    return false if response.body.to_s == 'false'
+    response = JSON.parse(response.body)
+    return false if response['success'].to_s == 'false'
+    return false if response['subscribed'].to_s == '0'
+    return true if response['subscribed'].to_s == '1'
+  rescue StandardError
+    false
+  end
+
+  def inserted?(email_address:, list_id:)
+    response = MaxemailApiShared.send_request(params: { method: 'fetchRecipient', listID: list_id, recipientId: find_recipient_id(email_address: email_address) }, method: 'list')
+    return false if response.body.to_s == 'false'
+    response = JSON.parse(response.body)
+    return false if response['success'].to_s == 'false'
+    return true if response['subscribed'].to_s == '0'
+    return true if response['subscribed'].to_s == '1'
+  rescue StandardError
+    false
+  end
+
+  def unsubscribe(email_address: nil, recipient_id: nil, list_id:)
+    recipient_id = find_recipient_id(email_address: email_address) if recipient_id.nil?
+    MaxemailApiShared.send_request(params: { method: 'updateRecipient', data: { email_address: email_address, subscribed: 0 }.to_json, listID: list_id, recipientId: recipient_id }, method: 'list')
+  end
+
+  def subscriptions(email_address: nil, recipient_id: nil, list_id:)
+    recipient_id = find_recipient_id(email_address: email_address) if recipient_id.nil?
+    MaxemailApiShared.send_request(params: { method: 'fetchLists', listID: list_id, recipientId: recipient_id }, method: 'recipient')
+  end
+
+  def find_recipient_id(email_address: nil)
+    MaxemailApiShared.send_request(params: { method: 'findByEmailAddress', emailAddress: email_address }, method: 'recipient')
+  end
+
+  def available_subscriptions
+    lists = JSON.parse(fetch_list)
+    lists.delete_if { |list| list['type'] != 'include' }
+  end
+
+  def fetch_list
+    MaxemailApiShared.send_request(params: { method: 'fetchAll' }, method: 'list')
+  end
+end

data/lib/maxemail_api/triggered.rb

@@ -0,0 +1,77 @@
+module MaxemailApiTriggered
+  extend self
+  include MaxemailApiShared
+
+  def send(folder_name: nil, email_name: nil, email_id: nil, email_address:, profile_data:)
+    email_id = MaxemailApiTriggered.find_email_id(folder_name: folder_name, email_name: email_name) if email_id.nil?
+    MaxemailApiTriggered.send_triggered(email_address: email_address, email_id: email_id, profile_data: profile_data)
+  end
+
+  def send_triggered(email_address: nil, email_id: nil, profile_data: nil)
+    return MaxemailApiResponse.new(data: {}, success: false, message: 'Template not found') if email_id.nil?
+    return MaxemailApiResponse.new(data: {}, success: false, message: 'Invalid Profile data') unless valid_profile_data?(profile_data)
+    return MaxemailApiResponse.new(data: {}, success: false, message: 'Invalid Email address') unless valid_email?(email_address)
+    response = JSON.parse(MaxemailApiShared.send_request(params: { method: 'trigger',
+                                                                   emailAddress: email_address,
+                                                                   emailId: email_id,
+                                                                   profileData: profile_data.to_json }, method: 'email_send').body)
+    return MaxemailApiResponse.new(data: {}, success: true, message: 'Mail sent') if response['success'] == true
+    return MaxemailApiResponse.new(data: {}, success: false, message: 'Server error') if response['success'] == false
+  rescue StandardError => e
+    puts 'MaxemailApiResponse Error:'
+    puts e
+    puts 'END MaxemailApiResponse Error:'
+    return MaxemailApiResponse.new(data: {}, success: false, message: 'Server error') if response['success'] == false
+  end
+
+  def find_email_id(folder_name: nil, email_name: nil)
+    folder_id = find_folder_id(folder_name: folder_name)
+    response = JSON.parse(fetch_tree(tree: 'email', node_id: folder_id, node_class: 'folder'))
+    response.map do |node|
+      node['nodeId'].to_i if node['text'] == email_name
+    end.compact.first
+  rescue StandardError
+    nil
+  end
+
+  def fetch_root(tree: 'email', children: '[]')
+    MaxemailApiShared.send_request(params: { method: 'fetchRoot',
+                                             tree: tree,
+                                             children: children }, method: 'tree')
+  end
+
+  def fetch_tree(tree: 'email', node_id: nil, node_class: 'folder')
+    MaxemailApiShared.send_request(params: { method: 'fetchTree',
+                                             tree: tree,
+                                             nodeId: node_id,
+                                             nodeClass: node_class }, method: 'tree')
+  end
+
+  def fetch_trigged(folder_id: nil)
+    MaxemailApiShared.send_request(params: { method: 'fetchAll',
+                                             folderId: folder_id }, method: 'email_triggered')
+  end
+
+  def find_folder_id(folder_name: nil)
+    response = JSON.parse(fetch_root)
+    response[0]['children'].map do |node|
+      node['nodeId'].to_i if node['text'] == folder_name
+    end.compact.first
+  rescue StandardError
+    nil
+  end
+
+  def valid_email?(email_address)
+    valid = '[A-Za-z\d.+-]+'
+    (email_address =~ /#{valid}@#{valid}\.#{valid}/).zero?
+  rescue StandardError
+    false
+  end
+
+  def valid_profile_data?(profile_data)
+    JSON.parse(profile_data.to_s)
+    true
+  rescue StandardError
+    false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maxemail_api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Murray Catto
@@ -31,6 +31,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/maxemail_api.rb
+- lib/maxemail_api/response.rb
+- lib/maxemail_api/shared.rb
+- lib/maxemail_api/subscriptions.rb
+- lib/maxemail_api/triggered.rb
 homepage: 
 licenses: []
 metadata: {}