mailjet 1.5.4 → 1.8.0

data/lib/mailjet/configuration.rb

@@ -1,17 +1,69 @@
-require 'active_support/core_ext/module/attribute_accessors'
-
 module Mailjet
   module Configuration
-    mattr_accessor :api_key, :secret_key, :default_from
+    def self.api_key
+      @api_key
+    end
+
+    def self.api_key=(api_key)
+      @api_key = api_key
+    end
+
+    def self.secret_key
+      @secret_key
+    end
+
+    def self.secret_key=(secret_key)
+      @secret_key = secret_key
+    end
+
+    def self.default_from
+      @default_from
+    end
+
+    def self.default_from=(default_from)
+      @default_from = default_from
+    end
+
+    def self.api_version
+      @api_version
+    end
+
+    def self.api_version=(api_version)
+      @api_version = api_version
+    end
+
+    def self.sandbox_mode
+      @sandbox_mode
+    end
+
+    def self.sandbox_mode=(sandbox_mode)
+      @sandbox_mode = sandbox_mode
+    end
+
+    def self.end_point
+      @end_point
+    end
+
+    def self.end_point=(end_point)
+      @end_point = end_point
+    end
+
+    def self.perform_api_call
+      @perform_api_call
+    end
+
+    def self.perform_api_call=(perform_api_call)
+      @perform_api_call = perform_api_call
+    end
 
     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

data/lib/mailjet/connection.rb

@@ -1,42 +1,32 @@
-require 'rest_client'
-require 'mailjet/gem_extensions/rest_client'
-require 'active_support/core_ext/module/delegation'
-require 'json'
+require 'faraday'
+require 'yajl'
 
 module Mailjet
   class Connection
 
-    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call
+    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call, :api_key, :secret_key, :options
     alias :read_only? :read_only
 
-    delegate :options, :concat_urls, :url, to: :adapter
-
     def [](suburl, &new_block)
-      broken_url = url.split("/")
+      broken_url = uri.path.split("/")
       if broken_url.include?("contactslist") && broken_url.include?("managemanycontacts") && broken_url.last.to_i > 0
-        self.class.new(url, options[:user], options[:password], options)
+        self.class.new(uri, api_key, secret_key, options)
       else
-        self.class.new(concat_urls(url, suburl), options[:user], options[:password], options)
+        self.class.new(concat_urls(suburl), api_key, secret_key, options)
       end
     end
 
     def initialize(end_point, api_key, secret_key, options = {})
-      # #charles proxy
-      # RestClient.proxy = "http://127.0.0.1:8888"
-      # #
-      # #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.options = options
+      self.api_key = api_key
+      self.secret_key = secret_key
       self.public_operations = options[:public_operations] || []
       self.read_only = options[:read_only]
-      # 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 = Faraday.new(end_point, ssl: { verify: false }) do |conn|
+        conn.response :raise_error, include_request: true
+        conn.request :authorization, :basic, api_key, secret_key
+        conn.headers['Content-Type'] = 'application/json'
+      end
       self.perform_api_call = options.key?(:perform_api_call) ? options[:perform_api_call] : true
     end
 
@@ -56,22 +46,31 @@ module Mailjet
       handle_api_call(:delete, additional_headers, &block)
     end
 
+    def concat_urls(suburl)
+      self.adapter.build_url(suburl.to_s)
+    end
+
+    def uri
+      self.adapter.build_url
+    end
+
     private
 
     def handle_api_call(method, additional_headers = {}, payload = {}, &block)
-      formatted_payload = (additional_headers[:content_type] == :json) ? payload.to_json : payload
+      formatted_payload = (additional_headers["Content-Type"] == 'application/json') ? Yajl::Encoder.encode(payload) : payload
       raise Mailjet::MethodNotAllowed unless method_allowed(method)
 
       if self.perform_api_call
         if [:get, :delete].include?(method)
-          @adapter.send(method, additional_headers, &block)
+          @adapter.send(method, nil, additional_headers[:params], &block)
         else
-          @adapter.send(method, formatted_payload, additional_headers, &block)
+          @adapter.send(method, nil, formatted_payload, additional_headers, &block)
         end
       else
-        return {'Count' => 0, 'Data' => [mock_api_call: true], 'Total' => 0}.to_json
+        return Yajl::Encoder.encode({'Count' => 0, 'Data' => [mock_api_call: true], 'Total' => 0})
       end
-    rescue RestClient::Exception => e
+
+    rescue Faraday::Error => e
       handle_exception(e, additional_headers, formatted_payload)
     end
 
@@ -81,16 +80,52 @@ module Mailjet
     end
 
     def handle_exception(e, additional_headers, payload = {})
+      return e.response_body if e.response_headers[:content_type].include?("text/plain")
+
       params = additional_headers[:params] || {}
-      formatted_payload = (additional_headers[:content_type] == :json) ? JSON.parse(payload) : payload
-      params = params.merge(formatted_payload)
+      formatted_payload = (additional_headers[:content_type] == :json) ? Yajl::Parser.parse(payload) : payload
+      params = params.merge!(formatted_payload) if formatted_payload.is_a?(Hash)
+
+      response_body = if e.response_headers[:content_type].include?("application/json")
+        e.response_body
+      else
+        "{}"
+      end
 
-      raise Mailjet::ApiError.new(e.http_code, e.http_body, @adapter, @adapter.url, params)
+      if sent_invalid_email?(e.response_body, @adapter.build_url)
+        return e.response_body
+      else
+        raise communication_error(e)
+      end
+    end
+
+    def communication_error(e)
+      if e.respond_to?(:response) && e.response
+        return case e.response_status
+        when Unauthorized::CODE
+          Unauthorized.new(e.message, e)
+        when BadRequest::CODE
+          BadRequest.new(e.message, e)
+        else
+          CommunicationError.new(e.message, e)
+        end
+      end
+      CommunicationError.new(e.message)
+    end
+
+    def sent_invalid_email?(error_http_body, uri)
+      return false unless uri.path.include?('v3.1/send')
+      return unless error_http_body
+
+      parsed_body = Yajl::Parser.parse(error_http_body)
+      error_message = parsed_body.dig('Messages')&.first&.dig('Errors')&.first&.dig('ErrorMessage') || []
+      error_message.include?('is an invalid email address.')
+    rescue
+      false
     end
 
   end
 
   class MethodNotAllowed < StandardError
-
   end
 end

data/lib/mailjet/exception/errors.rb

@@ -0,0 +1,94 @@
+require 'yajl'
+require 'json'
+
+module Mailjet
+  class Error < StandardError
+    attr_reader :object
+
+    def initialize(message = nil, object = nil)
+      super(message)
+      @object = object
+    end
+  end
+
+  class ApiError < StandardError
+    attr_reader :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
+
+      if request.respond_to?(:options)
+        request.options[:user] = '***'
+        request.options[:password] = '***'
+      end
+
+      message = "error #{code} while sending #{request.inspect} to #{url} with #{params.inspect}"
+      error_details = body.inspect
+      hint = "Please see https://dev.mailjet.com/email/reference/overview/errors/ for more informations on error numbers."
+
+      super("#{message}\n\n#{error_details}\n\n#{hint}\n\n")
+    end
+  end
+
+  class CommunicationError < Error
+    attr_reader :code
+
+    NOCODE = 000
+
+    def initialize(message = nil, response = nil)
+      @response = response
+      @code = if response.nil?
+                NOCODE
+              else
+                response.response_status
+              end
+
+      api_message = begin
+        Yajl::Parser.parse(response.response_body)['ErrorMessage']
+      rescue Yajl::ParseError
+        response.response_body
+      rescue NoMethodError
+        "Unknown API error"
+      rescue
+        'Unknown API error'
+      end
+
+      message ||=  ''
+      api_message ||= ''
+      message = message + ': ' + api_message
+
+      super(message, response)
+    rescue NoMethodError, JSON::ParserError
+      @code = NOCODE
+      super(message, response)
+    end
+  end
+
+  class Unauthorized < CommunicationError
+    CODE = 401
+
+    def initialize(error_message, response)
+      error_message = error_message + ' - Invalid Domain or API key'
+      super(error_message, response)
+    end
+  end
+
+  class BadRequest < CommunicationError
+    CODE = 400
+
+    def initialize(error_message, response)
+      super(error_message, response)
+    end
+  end
+end

data/lib/mailjet/mailer.rb

@@ -1,7 +1,8 @@
 require 'action_mailer'
 require 'mail'
 require 'base64'
-require 'json'
+require 'yajl'
+
 
 # Mailjet::Mailer enables to send a Mail::Message via Mailjet SMTP relay servers
 # User is the API key, and password the API secret
@@ -15,7 +16,7 @@ class Mailjet::Mailer < ::Mail::SMTP
       user_name: options.delete(:api_key) || Mailjet.config.api_key,
       password: options.delete(:secret_key) || Mailjet.config.secret_key,
       enable_starttls_auto: true
-    }.merge(options))
+    }.merge!(options))
   end
 end
 
@@ -42,6 +43,13 @@ class Mailjet::APIMailer
 
   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)
 
@@ -67,7 +75,7 @@ class Mailjet::APIMailer
     version = options[:version] || Mailjet.config.api_version
 
     if (version == 'v3.1')
-      Mailjet::Send.create({ :Messages => [setContentV3_1(mail)] }, options)
+      Mailjet::Send.create({ :Messages => [setContentV3_1(mail)], SandboxMode: Mailjet.config.sandbox_mode }, options)
     else
       Mailjet::Send.create(setContentV3_0(mail), options)
     end
@@ -110,7 +118,7 @@ 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
@@ -119,8 +127,8 @@ class Mailjet::APIMailer
     # ReplyTo property was added in v3.1
     # Passing it as an header if mail.reply_to
 
-    if mail.reply_to
-      if mail.reply_to.respond_to?(:display_names) && 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[:ReplyTo] = {:Email=> mail[:reply_to].addresses.first}
@@ -163,8 +171,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
@@ -177,7 +190,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
@@ -189,16 +203,33 @@ class Mailjet::APIMailer
 
     payload = {
       :To=> to,
-    }.merge(content)
-    .merge(base_from)
-    .merge(@delivery_method_options_v3_1)
+    }.merge!(content, base_from, @delivery_method_options_v3_1)
 
     payload[:Subject] = mail.subject if !mail.subject.blank?
     payload[:Sender] = mail[:sender] if !mail[:sender].blank?
     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)
@@ -262,10 +293,8 @@ class Mailjet::APIMailer
     payload[:bcc] = mail[:bcc].formatted.join(', ') if mail[:bcc]
 
     # Send the final payload to Mailjet Send API
-    payload.merge(content)
-    .merge(base_from)
-    .merge(@delivery_method_options_v3_0)
-    end
+    payload.merge!(content, base_from, @delivery_method_options_v3_0)
+  end
 end
 
 ActionMailer::Base.add_delivery_method :mailjet_api, Mailjet::APIMailer

data/lib/mailjet/rack/endpoint.rb

@@ -1,6 +1,5 @@
-require 'active_support'
 require 'rack/request'
-
+require 'yajl'
 
 module Mailjet
   module Rack
@@ -13,7 +12,7 @@ module Mailjet
 
       def call(env)
         if env['PATH_INFO'] == @path && (content = env['rack.input'].read)
-          @block.call(ActiveSupport::JSON.decode(content))
+          @block.call(Yajl::Parser.parse(content))
           [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
         else
           @app.call(env)