mailjet 1.5.0 → 1.6.0

data/Rakefile

@@ -1,17 +1,22 @@
-#!/usr/bin/env rake
-require 'rake/testtask'
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require "rspec/core/rake_task"
 
-$:.push File.expand_path("../lib", __FILE__)
-
-Rake::TestTask.new(:spec) do |t|
-  t.libs << 'lib'
-  t.libs << 'spec'
-  # t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = true
-  t.test_files = Dir['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = [
+    "spec/mailjet/api_error_spec.rb",
+    "spec/mailjet/apikey_spec.rb",
+    "spec/mailjet/mailer_spec.rb",
+    "spec/mailjet/resource_spec.rb",
+    "spec/configuration_spec.rb",
+    "spec/mailjet_spec.rb",
+    "spec/resources/contact_spec.rb",
+    "spec/resources/contactmetadata_spec.rb",
+    "spec/resources/messagehistory_spec.rb",
+    "spec/resources/getcontactslists_spec.rb",
+    "spec/resources/template_detailcontent_spec.rb",
+    "spec/resources/integration_spec.rb",
+    "spec/resources/newsletter_spec.rb",
+    "spec/resources/statcounters_spec.rb",
+  ]
 end
 
-
-task :default => :spec
+task default: [:spec]

data/lib/generators/mailjet/initializer_generator.rb

@@ -0,0 +1,35 @@
+module Mailjet
+  class InitializerGenerator < Rails::Generators::Base
+    desc 'This generator creates an initializer file mailjet.rb at config/initializers'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_initializer_file
+      config_file_path = 'config/initializers/mailjet.rb'
+
+      say('Hey! We’re about to configure your Mailjet credentials for your application.')
+      say('You can find them on your account (https://app.mailjet.com/account/api_keys).')
+      say('Please help yourself by providing some intel:')
+
+      @api_key =      ask('API key: ')
+      @secret_key =   ask('Secret key: ')
+      @default_from = ask('Sender address:')
+
+      say("Don't forget that your sender address '#{@default_from}' has to be validated first on https://app.mailjet.com/account/sender.")
+
+      if @api_v3_1 = yes?('Do you want to use Mailjet API v3.1 for sending your emails? (y/n)')
+        @api_v3_1_notice = %{
+Mailjet API v3.1 is at the moment limited to Send API.
+We’ve not set the version to it directly since there is no other endpoint in that version.
+We recommend you create a dedicated instance of the wrapper set with it to send your emails.
+If you're only using the gem to send emails, then you can safely set it to this version.
+Otherwise, you can remove the dedicated line into #{config_file_path}.
+
+}
+        say(@api_v3_1_notice)
+      end
+
+      template 'mailjet.rb.erb', config_file_path
+    end
+  end
+end

data/lib/generators/mailjet/templates/mailjet.rb.erb

@@ -0,0 +1,8 @@
+# kindly generated by appropriated Rails generator
+Mailjet.configure do |config|
+  config.api_key = '<%= @api_key %>'
+  config.secret_key = '<%= @secret_key %>'
+  config.default_from = '<%= @default_from %>'
+<% if @api_v3_1 %><%= @api_v3_1_notice.split("\n").reject(&:empty?).map{ |l| '  # ' + l }.join("\n") %>
+  config.api_version = 'v3.1'<% end %>
+end

data/lib/mailjet/api_error.rb

@@ -1,29 +1,28 @@
-# encoding: utf-8
-require 'active_support'
+require "json"
 
 module Mailjet
   class ApiError < StandardError
+    attr_reader :code, :reason
 
-    attr_accessor :code, :reason
+    # @param code [Integer] HTTP response status code
+    # @param body [String] JSON response body
+    # @param request [Object] any request object
+    # @param url [String] request URL
+    # @param params [Hash] request headers and parameters
+    def initialize(code, body, request, url, params)
+      @code = code
+      @reason = begin
+        resdec = JSON.parse(body)
+        resdec['ErrorMessage']
+      rescue JSON::ParserError
+        body
+      end
 
+      message = "error #{code} while sending #{request.inspect} to #{url} with #{params.inspect}"
+      error_details = body.inspect
+      hint = "Please see https://dev.mailjet.com/guides/#status-codes for more informations on error numbers."
 
-    def initialize(code, res, request, request_path, params)
-      self.code = code
-      self.reason = ""
-      unless res.blank?
-        resdec = ActiveSupport::JSON.decode(res)
-        self.reason = resdec['ErrorMessage']
-      end
-      # code is ugly, output is pretty
-      super("error #{code} while sending #{request.inspect} to #{request_path} with #{params.inspect}\n\n" +
-        if res['errors'].present?
-          [(res['errors'] || [])].flatten.map do |param, text|
-            [param, text].map(&:to_s).reject(&:blank?).join(': ')
-          end.join("\n")
-        else
-          res.inspect
-        end + "\n\nPlease see https://dev.mailjet.com/guides/#status-codes for more informations on error numbers.\n\n"
-      )
+      super("#{message}\n\n#{error_details}\n\n#{hint}\n\n")
     end
   end
 end

data/lib/mailjet/configuration.rb

@@ -2,18 +2,18 @@ require 'active_support/core_ext/module/attribute_accessors'
 
 module Mailjet
   module Configuration
-    mattr_accessor :api_key
-    mattr_accessor :secret_key
-    mattr_accessor :default_from
-    mattr_accessor :api_version do
-      'v3'
-    end
-    mattr_accessor :end_point do
-      'https://api.mailjet.com'
-    end
-    mattr_accessor :perform_api_call do
-      true
-    end
+    mattr_accessor :api_key, :secret_key, :default_from
 
+    DEFAULT = {
+      api_version: 'v3',
+      sandbox_mode: false,
+      end_point: 'https://api.mailjet.com',
+      perform_api_call: true,
+    }
+
+    DEFAULT.each do |param, default_value|
+      mattr_accessor param
+      self.send("#{param}=", default_value)
+    end
   end
 end

data/lib/mailjet/connection.rb

@@ -6,7 +6,7 @@ require 'json'
 module Mailjet
   class Connection
 
-    attr_accessor :adapter, :public_operations, :read_only
+    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call, :read_timeout, :open_timeout
     alias :read_only? :read_only
 
     delegate :options, :concat_urls, :url, to: :adapter
@@ -35,38 +35,43 @@ module Mailjet
       adapter_class = options[:adapter_class] || RestClient::Resource
       self.public_operations = options[:public_operations] || []
       self.read_only = options[:read_only]
+      self.read_timeout = options[:read_timeout]
+      self.open_timeout = options[:open_timeout]
       # self.adapter = adapter_class.new(end_point, options.merge(user: api_key, password: secret_key, :verify_ssl => false, content_type: 'application/json'))
-      self.adapter = adapter_class.new(end_point, options.merge(user: api_key, password: secret_key, content_type: 'application/json'))
+      self.adapter = adapter_class.new(end_point, options.merge(user: api_key, password: secret_key, content_type: 'application/json', read_timeout: self.read_timeout, open_timeout: self.open_timeout))
+      self.perform_api_call = options.key?(:perform_api_call) ? options[:perform_api_call] : true
     end
 
-    def get(additional_headers = {}, perform_api_call, &block)
-      handle_api_call(:get, additional_headers, perform_api_call, &block)
+    def get(additional_headers = {}, &block)
+      handle_api_call(:get, additional_headers, &block)
     end
 
-    def post(payload, additional_headers = {}, perform_api_call, &block)
-      handle_api_call(:post, additional_headers, payload, perform_api_call, &block)
+    def post(payload, additional_headers = {}, &block)
+      handle_api_call(:post, additional_headers, payload, &block)
     end
 
-    def put(payload, additional_headers = {}, perform_api_call, &block)
-      handle_api_call(:put, additional_headers, payload, perform_api_call, &block)
+    def put(payload, additional_headers = {}, &block)
+      handle_api_call(:put, additional_headers, payload, &block)
     end
 
-    def delete(additional_headers = {}, perform_api_call, &block)
-      handle_api_call(:delete, additional_headers, perform_api_call, &block)
+    def delete(additional_headers = {}, &block)
+      handle_api_call(:delete, additional_headers, &block)
     end
 
     private
 
-    def handle_api_call(method, additional_headers = {}, payload = {}, perform_api_call, &block)
+    def handle_api_call(method, additional_headers = {}, payload = {}, &block)
       formatted_payload = (additional_headers[:content_type] == :json) ? payload.to_json : payload
       raise Mailjet::MethodNotAllowed unless method_allowed(method)
 
-      if perform_api_call
+      if self.perform_api_call
         if [:get, :delete].include?(method)
           @adapter.send(method, additional_headers, &block)
         else
           @adapter.send(method, formatted_payload, additional_headers, &block)
         end
+      else
+        return {'Count' => 0, 'Data' => [mock_api_call: true], 'Total' => 0}.to_json
       end
     rescue RestClient::Exception => e
       handle_exception(e, additional_headers, formatted_payload)
@@ -82,7 +87,13 @@ module Mailjet
       formatted_payload = (additional_headers[:content_type] == :json) ? JSON.parse(payload) : payload
       params = params.merge(formatted_payload)
 
-      raise Mailjet::ApiError.new(e.http_code, e.http_body, @adapter, @adapter.url, params)
+      http_body = if e.http_headers[:content_type] == "application/json"
+        e.http_body
+      else
+        "{}"
+      end
+
+      raise Mailjet::ApiError.new(e.http_code, http_body, @adapter, @adapter.url, params)
     end
 
   end

data/lib/mailjet/mailer.rb

@@ -26,60 +26,75 @@ ActionMailer::Base.add_delivery_method :mailjet, Mailjet::Mailer
 # 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 = {})
-#    send = Mailjet.Send.new
-#    if send.version.exists
-#      version = send.version
-#    else
-      @version = Mailjet.config.api_version
-#    end
-    @delivery_method_options_v3_0 = options.slice(
-      :api_key, :secret_key,
-      :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,
-    )
-    @delivery_method_options_v3_1 = options.slice(
-      :api_key, :secret_key,
-      :'Priority', :'CustomCampaign', :'DeduplicateCampaign',
-      :'TemplateLanguage', :'TemplateErrorReporting', :'TemplateErrorDeliver', :'TemplateID',
-      :'TrackOpens', :'TrackClicks',
-      :'CustomID', :'EventPayload', :'Variables', :'Headers',
-    )
+  V3_0_PERMITTED_OPTIONS = [
+    :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,
+  ]
+
+  V3_1_PERMITTED_OPTIONS = [
+    :'Priority', :'CustomCampaign', :'DeduplicateCampaign',
+    :'TemplateLanguage', :'TemplateErrorReporting', :'TemplateErrorDeliver', :'TemplateID',
+    :'TrackOpens', :'TrackClicks',
+    :'CustomID', :'EventPayload', :'Variables', :'Headers',
+  ]
+
+  CONNECTION_PERMITTED_OPTIONS = [:api_key, :secret_key]
+
+  HEADER_BLACKLIST = [
+    'from', 'sender', 'subject', 'to', 'cc', 'bcc', 'return-path', 'delivered-to', 'dkim-signature',
+    'domainkey-status', 'received-spf', 'authentication-results', 'received', 'user-agent', 'x-mailer',
+    'x-feedback-id', 'list-id', 'date', 'x-csa-complaints', 'message-id', 'reply-to', 'content-type',
+    'mime-version', 'content-transfer-encoding'
+  ]
+
+  def initialize(opts = {})
+    options = HashWithIndifferentAccess.new(opts)
+
+    @version = options[:version]
+    @delivery_method_options_v3_0 = options.slice(*V3_0_PERMITTED_OPTIONS)
+    @delivery_method_options_v3_1 = options.slice(*V3_1_PERMITTED_OPTIONS)
+    @connection_options = options.slice(*CONNECTION_PERMITTED_OPTIONS)
   end
 
-  def deliver!(mail, options = nil)
-#    p mail.header.fields
+  def deliver!(mail, opts = {})
+    options = HashWithIndifferentAccess.new(opts)
 
-    if (options && options.kind_of?(Object) && options['version'].present?)
-      @version = options['version']
-    end
+    # Mailjet Send API does not support full from. Splitting the from field into two: name and email address
+    mail[:from] ||= Mailjet.config.default_from if Mailjet.config.default_from
 
-    if (!options.kind_of?(Object))
-      options = []
-    end
+    # add `@connection_options` in `options` only if not exist yet (values in `options` prime)
+    options.reverse_merge!(@connection_options)
 
-    # Mailjet Send API does not support full from. Splitting the from field into two: name and email address
-    if mail[:from].nil? && Mailjet.config.default_from.present?
-      mail[:from] = Mailjet.config.default_from
-    end
+    # add `@version` in options if set
+    options[:version] = @version if @version
 
-    if (@version == 'v3.1')
-      Mailjet::Send.create({:Messages => [setContentV3_1(mail)]})
+    # `options[:version]` primes on global config
+    version = options[:version] || Mailjet.config.api_version
+
+    if (version == 'v3.1')
+      Mailjet::Send.create({ :Messages => [setContentV3_1(mail)], SandboxMode: Mailjet.config.sandbox_mode }, options)
     else
-      Mailjet::Send.create(setContentV3_0(mail))
+      Mailjet::Send.create(setContentV3_0(mail), options)
     end
   end
 
   def setContentV3_1(mail)
     content = {}
+
     content[:TextPart] = mail.text_part.try(:decoded) if !mail.text_part.blank?
     content[:HTMLPart] = mail.html_part.try(:decoded) if !mail.html_part.blank?
 
+    # try message `body` as fallback if no content found
+    unless content[:TextPart] || content[:HTMLPart] || mail.body.try(:raw_source).empty?
+      content[mail.content_type.try(:include?,'text/html') ? :HTMLPart : :TextPart] = mail.body.raw_source
+    end
+
+
     if mail.attachments.any?
       content[:Attachments] = []
-      content[:InlineAttachments] = []
+      content[:InlinedAttachments] = []
 
       mail.attachments.each do |attachment|
         mailjet_attachment = {
@@ -90,7 +105,7 @@ class Mailjet::APIMailer
 
         if attachment.inline?
           mailjet_attachment['ContentId'] = attachment.content_id
-          content[:InlineAttachments].push(mailjet_attachment)
+          content[:InlinedAttachments].push(mailjet_attachment)
         else
           content[:Attachments].push(mailjet_attachment)
         end
@@ -102,20 +117,20 @@ class Mailjet::APIMailer
     if mail.header && mail.header.fields.any?
       content[:Headers] = {}
       mail.header.fields.each do |header|
-        if header.name.start_with?('X-') && !header.name.start_with?('X-MJ') && !header.name.start_with?('X-Mailjet')
+        if !header.name.start_with?('X-MJ') && !header.name.start_with?('X-Mailjet') && !HEADER_BLACKLIST.include?(header.name.downcase)
           content[:Headers][header.name] = header.value
         end
       end
     end
 
-    # Reply-To is not a property in Mailjet Send API
+    # ReplyTo property was added in v3.1
     # Passing it as an header if mail.reply_to
 
-    if mail.reply_to
-      if mail.reply_to.display_names.first
-        content[:Headers]['Reply-To'] = {:Email=> mail[:reply_to].addresses.first, :Name=> mail[:reply_to].display_names.first}
+    if mail[:reply_to]
+      if mail[:reply_to].respond_to?(:display_names) && mail[:reply_to].display_names.first
+        content[:ReplyTo] = {:Email=> mail[:reply_to].addresses.first, :Name=> mail[:reply_to].display_names.first}
       else
-        content[:Headers]['Reply-To'] = {:Email=> mail[:reply_to].addresses.first}
+        content[:ReplyTo] = {:Email=> mail[:reply_to].addresses.first}
       end
     end
 
@@ -155,8 +170,13 @@ class Mailjet::APIMailer
           ccs =[{:Email=>mail[:cc].address.first}]
         end
       else
+        ccs = []
         mail[:cc].each do |cc|
-          ccs << {:Email=> cc.address, :Name=>cc.display_name}
+          if cc.display_name
+            ccs << {:Email=> cc.address, :Name=>cc.display_name}
+          else
+            ccs << {:Email=> cc.address}
+          end
         end
       end
     end
@@ -169,7 +189,8 @@ class Mailjet::APIMailer
           payload[:Bcc] = [{:Email=>mail[:bcc].address.first}]
         end
       else
-        mail[:bcc].formatted.each do |bcc|
+        bccs = []
+        mail[:bcc].each do |bcc|
           if bcc.display_name
             bccs << {:Email=> bcc.address, :Name=>bcc.display_name}
           else
@@ -190,7 +211,26 @@ class Mailjet::APIMailer
     payload[:Cc] = ccs if mail[:cc]
     payload[:Bcc] = bccs if mail[:bcc]
 
-    payload
+    decode_emails_V3_1!(payload)
+  end
+
+  def decode_emails_V3_1!(payload)
+    # ActionMailer may have handed us encoded email
+    # addresses, mailjet will reject. Therefore we
+    # walk through the payload to decode them back.
+    payload.each do |key, value|
+      if key == :Email
+        payload[key] = Mail::Encodings.value_decode(value)
+      elsif value.is_a?(Hash)
+        decode_emails_V3_1! value
+      elsif value.is_a?(Array)
+        value.each do |item|
+          if item.is_a?(Hash)
+            decode_emails_V3_1! item
+          end
+        end
+      end
+    end
   end
 
   def setContentV3_0(mail)
@@ -199,6 +239,11 @@ class Mailjet::APIMailer
     content[:text_part] = mail.text_part.try(:decoded) if !mail.text_part.blank?
     content[:html_part] = mail.html_part.try(:decoded) if !mail.html_part.blank?
 
+    # try message `body` as fallback if no content found
+    unless content[:text_part] || content[:html_part] || mail.body.try(:raw_source).empty?
+      content[mail.content_type.try(:include?,'text/html') ? :html_part : :text_part] = mail.body.raw_source
+    end
+
     # Formatting attachments (inline + regular)
     unless mail.attachments.empty?
       content[:attachments] = []
@@ -252,7 +297,7 @@ class Mailjet::APIMailer
     payload.merge(content)
     .merge(base_from)
     .merge(@delivery_method_options_v3_0)
-    end
+  end
 end
 
 ActionMailer::Base.add_delivery_method :mailjet_api, Mailjet::APIMailer