mailjet 1.3.8 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24a1d0ef70fc633c438a865bea86925045192b5e
-  data.tar.gz: bf2f874c4ad803cf167cbbdfc38ad23c48d595e4
+  metadata.gz: 62dc8ec008afcbcb8dbc6fa2f114c9137b346770
+  data.tar.gz: 25ed9aef33563a4235e8e3e70136d2984c46e856
 SHA512:
-  metadata.gz: 10f4dfa0922c73c3f39e867d9fcd84d6f7d55d15b1691acfbf5ee7a2d68939069d58a058108ae3e8fd8664a11317a35a6024766d54f18932171da3c4a2bf2afd
-  data.tar.gz: 2271e8361d9fd718565ce78d350ee2fcf70a5687805894f7700056db6ac51ae26624ec8c1015a87a40a54f4362cf76ce8f904016184d9a4e907e819469188dbd
+  metadata.gz: 9d916e5f2c30e29b5e7a90dd9ecf24d7212a87543eee25dea1705f0c6332492e5de08e5a92edf2bf7a9418eaaaef6ceff995aa267b997f359717d0aa5bb7b9dc
+  data.tar.gz: 440fe3b06ec6792f7897d3d7949e0ef0a759e83de238db62a856a20e941a5cd539e3f4184056ad60b7639bbac1c38326f8278d7ce0575ef0551ce79ccede7689

data/README.md

@@ -49,7 +49,7 @@ Rails ActionMailer integration designed for Rails 3.X and 4.X
 
 IMPORTANT: Mailjet gem switched to API v3, the new API provided by Mailjet. For the wrapper for API v1, check the [v1 branch][v1-branch].
 
-Every code examples can be find on the [Mailjet Documentation][mailjet_doc]
+Every code example can be found in the [Mailjet Documentation][mailjet_doc]
 
 (Please refer to the [Mailjet Documentation Repository][api_doc] to contribute to the documentation examples)
 
@@ -124,24 +124,47 @@ p test.attributes['Sent']
 ```
 
 ### Send emails with ActionMailer
-A quick walkthrough to using Action Mailer from the documentation [HERE](http://guides.rubyonrails.org/action_mailer_basics.html)
-
-First set your delivery method:
+A quick walkthrough to use Rails Action Mailer [here](http://guides.rubyonrails.org/action_mailer_basics.html)
 
+First set your delivery method (here Mailjet SMTP relay servers):
 ```ruby
 # application.rb or config/environments specific settings, which take precedence
 config.action_mailer.delivery_method = :mailjet
 
 ```
 
-Or if you prefer sending messages through mailjet REST API:
-
+Or if you prefer sending messages through [Mailjet Send API](http://dev.mailjet.com/guides/#send-transactional-email):
 ```ruby
 # application.rb
 config.action_mailer.delivery_method = :mailjet_api
 ```
 
-You can use mailjet specific options with `delivery_method_options` as detailed in the official [ActionMailer doc][actionmailerdoc]
+You can use mailjet specific options with `delivery_method_options` as detailed in the official [ActionMailer doc][http://guides.rubyonrails.org/action_mailer_basics.html#sending-emails-with-dynamic-delivery-options].
+
+Supported options are:
+```ruby
+* :'mj-prio'
+* :'mj-campaign'
+* :'mj-deduplicatecampaign'
+* :'mj-templatelanguage'
+* :'mj-templateerrorreporting'
+* :'mj-templateerrordeliver'
+* :'mj-templateid'
+* :'mj-trackopen'
+* :'mj-trackclick'
+* :'mj-customid'
+* :'mj-eventpayload'
+* :'vars'
+* :'headers'
+* :'recipients'
+```
+
+Otherwise, you can pass the custom Mailjet SMTP headers directly:
+```ruby
+headers['X-MJ-CustomID'] = 'rubyPR_Test_ID_1469790724'
+headers['X-MJ-EventPayload'] = 'rubyPR_Test_Payload'
+headers['X-MJ-TemplateLanguage'] = '1'
+```
 
 Creating a Mailer:
 ```ruby
@@ -167,28 +190,40 @@ class UserMailer < ApplicationMailer
           subject: "This is a nice welcome email")
    end
 end
+```
+
+Next, create your templates in the views folder:
+```ruby
+#app/views/user_mailer/welcome_email.html.erb
+Hello world in HTML!
 
+#app/views/user_mailer/welcome_email.text.erb
+Hello world in plain text!
 ```
-There's also the ability to set [Mailjet custom headers](https://dev.mailjet.com/guides/send-api-guide/)
+
+There's also the ability to set [Mailjet custom headers](http://dev.mailjet.com/guides/#send-api-json-properties)
 ```ruby
 #app/mailers/user_mailer.rb
 class UserMailer < ApplicationMailer
   def welcome_email()
-      mail.header['X-MJ-CustomID'] = 'custom value'
-      mail.header['X-MJ-EventPayload'] = 'custom payload'
-    mail(from: "me@mailjet.com", to: "you@mailjet.com",
-          subject: "This is a nice welcome email")
+    headers['X-MJ-CustomID'] = 'custom value'
+    headers['X-MJ-EventPayload'] = 'custom payload'
+
+    mail(
+    from: "me@mailjet.com",
+    to: "you@mailjet.com",
+    subject: "This is a nice welcome email"
+    )
   end
 end
 ```
 For sending email, you can call the method with a variety of `MessageDelivery` priorities:
 ```ruby
-#In this example, we are sending immediately
+# In this example, we are sending the email immediately
 UserMailer.welcome_email.deliver_now!
 ```
-For more information on `ActionMailer::MessageDeilvery`, see the documentation [HERE](http://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html)
-
 
+For more information on `ActionMailer::MessageDeilvery`, see the documentation [HERE](http://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html)
 
 ## Manage your campaigns
 

data/lib/mailjet/connection.rb

@@ -21,17 +21,17 @@ module Mailjet
     end
 
     def initialize(end_point, api_key, secret_key, options = {})
-      ##charles proxy
+      # #charles proxy
       # RestClient.proxy = "http://127.0.0.1:8888"
-      ##
-      ##Output for debugging
+      # #
+      # #Output for debugging
       # RestClient.log =
       # Object.new.tap do |proxy|
       #   def proxy.<<(message)
       #     Rails.logger.info message
       #   end
       # end
-      ##
+      # #
       adapter_class = options[:adapter_class] || RestClient::Resource
       self.public_operations = options[:public_operations] || []
       self.read_only = options[:read_only]

data/lib/mailjet/mailer.rb

@@ -1,55 +1,110 @@
 require 'action_mailer'
 require 'mail'
+require 'base64'
+require 'json'
 
+# Mailjet::Mailer enables to send a Mail::Message via Mailjet SMTP relay servers
+# User is the API key, and password the API secret
 class Mailjet::Mailer < ::Mail::SMTP
   def initialize(options = {})
-    ActionMailer::Base.default(:from => Mailjet.config.default_from) if Mailjet.config.default_from.present?
+    ActionMailer::Base.default(from: Mailjet.config.default_from) if Mailjet.config.default_from.present?
     super({
-      :address  => "in-v3.mailjet.com",
-      :port  => 587,
-      :authentication  => 'plain',
-      :user_name => Mailjet.config.api_key,
-      :password  => Mailjet.config.secret_key,
-      :enable_starttls_auto => true
+      address: 'in-v3.mailjet.com',
+      port: 587,
+      authentication: 'plain',
+      user_name: Mailjet.config.api_key,
+      password: Mailjet.config.secret_key,
+      enable_starttls_auto: true
     }.merge(options))
   end
 end
 
 ActionMailer::Base.add_delivery_method :mailjet, Mailjet::Mailer
 
-
-
+# Mailjet::APIMailer maps a Mail::Message coming from ActionMailer
+# To Mailjet Send API (see full documentation here dev.mailjet.com/guides/#send-transactional-email)
+# Mailjet sends API expects a JSON payload as the input.
+# The deliver methods maps the Mail::Message attributes to the MailjetSend API JSON expected structure
 class Mailjet::APIMailer
   def initialize(options = {})
-    ActionMailer::Base.default(:from => Mailjet.config.default_from) if Mailjet.config.default_from.present?
-    @delivery_method_options = options.slice(:'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign', :'mj-trackopen', :'mj-trackclick', :'mj-customid', :'mj-eventpayload', :'header')
+    @delivery_method_options = options.slice(
+      :recipients, :'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign',
+      :'mj-templatelanguage', :'mj-templateerrorreporting', :'mj-templateerrordeliver', :'mj-templateid',
+      :'mj-trackopen', :'mj-trackclick',
+      :'mj-customid', :'mj-eventpayload', :vars, :headers
+    )
   end
 
   def deliver!(mail)
-    if mail.multipart?
-      content = {
-        :text => mail.text_part.try(:decoded),
-        :html => mail.html_part.try(:decoded),
-        :attachment => mail.attachments.select{ |a| !a.inline? }.try(:decoded),
-        :inlineattachment => mail.attachments.select{ |a| !a.inline? }.try(:decoded)
-      }
-    else
-      content = (mail.mime_type == "text/html") ? {:html => mail.body.decoded} : {:text => mail.body.decoded}
+    content = {}
+
+    if mail.text_part
+      content[:text_part] = mail.text_part.try(:decoded)
+      content[:text] = mail.text_part.try(:decoded)
+    end
+
+    if mail.html_part
+      content[:html_part] = mail.html_part.try(:decoded)
+      content[:html] = mail.html_part.try(:decoded)
+    end
+
+    # Formatting attachments (inline + regular)
+    unless mail.attachments.empty?
+      content[:attachments] = []
+      content[:inline_attachments] = []
+
+      mail.attachments.each do |attachment|
+        mailjet_attachment = {
+          'Content-Type' => attachment.content_type.split(';')[0],
+          'Filename' => attachment.filename,
+          'content' => Base64.encode64(attachment.body.decoded)
+        }
+
+        if attachment.inline?
+          content[:inline_attachments].push(mailjet_attachment)
+        else
+          content[:attachments].push(mailjet_attachment)
+        end
+      end
     end
 
+    if mail.header && !mail.header.fields.empty?
+      content[:headers] = {}
+      mail.header.fields.each do |header|
+        if header.name.start_with?('X-MJ') || header.name.start_with?('X-Mailjet')
+          content[:headers][header.name] = header.value
+        end
+      end
+    end
+
+    # Reply-To is not a property in Mailjet Send API
+    # Passing it as an header
+    content[:headers]['Reply-To'] = mail.reply_to.join(', ') if mail.reply_to
+
+    # Mailjet Send API does not support full from. Splitting the from field into two: name and email address
+    if Mailjet.config.default_from.present?
+      # from_address = Mail::AddressList.new(Mailjet.config.default_from).addresses[0]
+      mail[:from] = Mailjet.config.default_from
+    end
+
+    base_from = { from_name: mail[:from].display_names.first,
+                  from_email: mail[:from].addresses.first }
+
     payload = {
-      :from => mail.from || Mailjet.config.default_from,
-      :sender => mail.sender,
-      :to => mail.to,
-      :reply_to => mail.reply_to,
-      :cc => mail.cc,
-      :bcc => mail.bcc,
-      :subject => mail.subject,
-      :'mj-customid' => mail['X-MJ-CustomID'] && mail['X-MJ-CustomID'].value,
-      :'mj-eventpayload' => mail['X-MJ-EventPayload'] && mail['X-MJ-EventPayload'].value
-    }.merge(content).merge(@delivery_method_options)
-
-    Mailjet::MessageDelivery.create(payload)
+      to: mail[:to].formatted.join(', '),
+      sender: mail[:sender],
+      subject: mail.subject
+    }
+              .merge(content)
+              .merge(base_from)
+              .merge(@delivery_method_options)
+
+    payload[:cc] = mail[:cc].formatted.join(', ') if mail[:cc]
+    payload[:reply_to] = mail[:reply_to].formatted.join(', ') if mail[:reply_to]
+    payload[:bcc] = mail[:bcc].formatted.join(', ') if mail[:bcc]
+
+    # Send the final payload to Mailjet Send API
+    Mailjet::Send.create(payload)
   end
 end
 

data/lib/mailjet/message_delivery.rb

@@ -5,6 +5,6 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'v3/send/message'
     self.public_operations = [:post]
-    self.resourceprop = [:from, :sender, :to, :cc, :bcc, :subject, :text, :html, :attachment, :inlineattachment, :header, :'mj-customid', :'mj-eventpayload', :'mj-trackclick']
+    self.resourceprop = [:from, :sender, :to, :cc, :bcc, :subject, :text, :html, :attachment, :inline_attachments, :headers]
   end
 end

data/lib/mailjet/resource.rb

@@ -7,6 +7,7 @@ require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/concern'
 require 'active_support/json/decoding'
+require 'mail'
 require 'json'
 
 
@@ -72,6 +73,7 @@ module Mailjet
         #
         attributes = parse_api_json(connection[id].get(default_headers)).first
         instanciate_from_api(attributes)
+
       rescue Mailjet::ApiError => e
         if e.code == 404
           nil
@@ -86,7 +88,8 @@ module Mailjet
         attributes.tap { |hs| hs.delete(:id) }
 
         if Mailjet.config.default_from and self.resource_path == 'v3/send/'
-          default_attributes = { :from_email => Mailjet.config.default_from }
+		  address = Mail::AddressList.new(Mailjet.config.default_from).addresses[0]
+		  default_attributes = { :from_email => address.address, :from_name => address.display_name}
         else
           default_attributes = {}
         end
@@ -189,6 +192,8 @@ module Mailjet
               'Text-part'
             elsif key == "html_part"
               'Html-part'
+            elsif key == "inline_attachments"
+              'Inline_attachments'
             else
               key.to_s.send(method)
             end
@@ -210,7 +215,7 @@ module Mailjet
 
     def save
       if persisted?
-        response = connection[id].put(formatted_payload, default_headers)
+        response = connection[attributes[:id]].put(formatted_payload, default_headers)
       else
         response = connection.post(formatted_payload, default_headers)
       end

data/lib/mailjet/resources/newsletter_detailcontent.rb

@@ -4,10 +4,10 @@ module Mailjet
   class Newsletter_detailcontent
     include Mailjet::Resource
     self.action = "detailcontent"
-    self.resource_path = "v3/REST/newsletter/id/#{self.action}"
-    self.public_operations = [:get, :put, :post, :delete]
+    self.resource_path = "v3/REST/template/id/#{self.action}"
+    self.public_operations = [:get, :post]
     self.filters = []
-    self.resourceprop = [:text_part, :html_part]
+    self.resourceprop = [:text_part, :html_part, :headers, :mjml_content]
 
   end
 end

data/lib/mailjet/resources/template.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Template
+    include Mailjet::Resource
+    self.resource_path = 'v3/REST/template'
+    self.public_operations = [:get, :put, :post, :delete]
+    self.filters = [:api_key, :categories, :categories_selection_method, :edit_mode, :name, :owner_type, :purposes, :purposes_selection_method, :user]
+    self.resourceprop = [:author, :categories, :copyright, :description, :edit_mode, :is_starred, :name, :owner_type, :presets, :purposes]
+
+  end
+end

data/lib/mailjet/resources/template_detailcontent.rb

@@ -0,0 +1,13 @@
+
+require 'mailjet/resource'
+
+module Mailjet
+  class Template_detailcontent
+    include Mailjet::Resource
+    self.resource_path = 'v3/REST/template/id/${self.action}'
+    self.public_operations = [:get, :put, :post, :delete]
+    self.filters = [:api_key, :categories, :categories_selection_method, :edit_mode, :name, :owner_type, :purposes, :purposes_selection_method, :user]
+    self.resourceprop = [:author, :categories, :copyright, :description, :edit_mode, :is_starred, :name, :owner_type, :presets, :purposes]
+
+  end
+end

data/lib/mailjet/version.rb

@@ -1,3 +1,3 @@
 module Mailjet
-  VERSION = "1.3.8"
+  VERSION = "1.4.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.8
 platform: ruby
 authors:
 - Tyler Nappy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -356,6 +356,8 @@ files:
 - lib/mailjet/resources/sender.rb
 - lib/mailjet/resources/sender_validate.rb
 - lib/mailjet/resources/senderstatistics.rb
+- lib/mailjet/resources/template.rb
+- lib/mailjet/resources/template_detailcontent.rb
 - lib/mailjet/resources/toplinkclicked.rb
 - lib/mailjet/resources/trigger.rb
 - lib/mailjet/resources/user.rb
@@ -382,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Mailjet a powerful all-in-one email service provider clients can use to get