mailjet 1.5.3 → 1.7.0

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

@@ -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,16 +1,13 @@
 require 'rest_client'
 require 'mailjet/gem_extensions/rest_client'
-require 'active_support/core_ext/module/delegation'
 require 'json'
 
 module Mailjet
   class Connection
 
-    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call
+    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
-
     def [](suburl, &new_block)
       broken_url = url.split("/")
       if broken_url.include?("contactslist") && broken_url.include?("managemanycontacts") && broken_url.last.to_i > 0
@@ -35,8 +32,10 @@ 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
 
@@ -56,6 +55,18 @@ module Mailjet
       handle_api_call(:delete, additional_headers, &block)
     end
 
+    def options
+      self.adapter.options
+    end
+
+    def concat_urls(*options)
+      self.adapter.concat_urls(*options)
+    end
+
+    def url
+      self.adapter.url
+    end
+
     private
 
     def handle_api_call(method, additional_headers = {}, payload = {}, &block)
@@ -85,7 +96,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,46 +26,55 @@ 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 = {})
+  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
+
+    # `options[:version]` primes on global config
+    version = options[:version] || Mailjet.config.api_version
 
-    if (@version == 'v3.1')
-      Mailjet::Send.create({:Messages => [setContentV3_1(mail)]}, options)
+    if (version == 'v3.1')
+      Mailjet::Send.create({ :Messages => [setContentV3_1(mail)], SandboxMode: Mailjet.config.sandbox_mode }, options)
     else
       Mailjet::Send.create(setContentV3_0(mail), options)
     end
@@ -108,7 +117,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
@@ -117,8 +126,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}
@@ -161,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
@@ -175,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
@@ -196,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)
@@ -263,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

data/lib/mailjet/rack/endpoint.rb

@@ -1,6 +1,5 @@
-require 'active_support'
 require 'rack/request'
-
+require 'json'
 
 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(JSON.parse(content))
           [200, { 'Content-Type' => 'text/html', 'Content-Length' => '0' }, []]
         else
           @app.call(env)

data/lib/mailjet/resource.rb

@@ -1,11 +1,7 @@
 require 'mailjet/connection'
-require 'active_support/hash_with_indifferent_access'
-require 'active_support/core_ext/class'
-require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/delegation'
-require 'active_support/concern'
-require 'active_support/json/decoding'
+require 'active_support/hash_with_indifferent_access'
 #require 'mail'
 require 'json'
 
@@ -18,35 +14,42 @@ require 'json'
 
 module Mailjet
   module Resource
-    extend ActiveSupport::Concern
+
+    # define here available options for filtering
+    OPTIONS = [:version, :url, :perform_api_call, :api_key, :secret_key, :read_timeout, :open_timeout]
 
     NON_JSON_URLS = ['v3/send/message'] # urls that don't accept JSON input
 
-    included do
-      cattr_accessor :resource_path, :public_operations, :read_only, :filters, :resourceprop, :action, :non_json_urls, :version
-      cattr_writer :connection
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        cattr_accessor :resource_path, :public_operations, :read_only, :filters, :resourceprop, :action, :non_json_urls, :version
+        cattr_writer :connection
 
-      def self.connection(options = {})
-        class_variable_get(:@@connection) || default_connection(options)
-      end
+        def self.connection(options = {})
+          class_variable_get(:@@connection) || default_connection(options)
+        end
 
-      def self.default_connection(options = {})
-        Mailjet::Connection.new(
-          "#{options[:url]}/#{options[:version]}/#{resource_path}",
-          options[:api_key] || Mailjet.config.api_key,
-          options[:secret_key] || Mailjet.config.secret_key,
-          public_operations: public_operations,
-          read_only: read_only,
-          perform_api_call: options[:perform_api_call])
-      end
+        def self.default_connection(options = {})
+          Mailjet::Connection.new(
+            "#{options[:url]}/#{options[:version]}/#{resource_path}",
+            options[:api_key] || Mailjet.config.api_key,
+            options[:secret_key] || Mailjet.config.secret_key,
+            public_operations: public_operations,
+            read_only: read_only,
+            perform_api_call: options[:perform_api_call],
+            open_timeout: options[:open_timeout],
+            read_timeout: options[:read_timeout])
+        end
 
-      def self.default_headers
-        if NON_JSON_URLS.include?(self.resource_path) # don't use JSON if Send API
-          default_headers = { accept: :json, accept_encoding: :deflate }
-        else
-          default_headers = { accept: :json, accept_encoding: :deflate, content_type: :json } #use JSON if *not* Send API
+        def self.default_headers
+          if NON_JSON_URLS.include?(self.resource_path) # don't use JSON if Send API
+            default_headers = { accept: :json, accept_encoding: :deflate }
+          else
+            default_headers = { accept: :json, accept_encoding: :deflate, content_type: :json } #use JSON if *not* Send API
+          end
+          return default_headers.merge(user_agent: "mailjet-api-v3-ruby/#{Gem.loaded_specs["mailjet"].version}")
         end
-        return default_headers.merge(user_agent: "mailjet-api-v3-ruby/#{Gem.loaded_specs["mailjet"].version}")
       end
     end
 
@@ -56,7 +59,7 @@ module Mailjet
       end
 
       def all(params = {}, options = {})
-        opts = change_resource_path(options)
+        opts = define_options(options)
         params = format_params(params)
         response = connection(opts).get(default_headers.merge(params: params))
         attribute_array = parse_api_json(response)
@@ -64,18 +67,24 @@ module Mailjet
       end
 
       def count(options = {})
-        opts = change_resource_path(options)
+        opts = define_options(options)
         response_json = connection(opts).get(default_headers.merge(params: {limit: 1, countrecords: 1}))
-        response_hash = ActiveSupport::JSON.decode(response_json)
+        response_hash = JSON.parse(response_json)
         response_hash['Total']
       end
 
       def find(id, job_id = nil, options = {})
+        normalized_id = if id.is_a? String
+          URI.encode_www_form_component(id)
+        else
+          id
+        end
+
         # if action method, ammend url to appropriate id
-        opts = change_resource_path(options)
-        self.resource_path = create_action_resource_path(id, job_id) if self.action
+        opts = define_options(options)
+        self.resource_path = create_action_resource_path(normalized_id, job_id) if self.action
         #
-        attributes = parse_api_json(connection(opts)[id].get(default_headers)).first
+        attributes = parse_api_json(connection(opts)[normalized_id].get(default_headers)).first
         instanciate_from_api(attributes)
 
       rescue Mailjet::ApiError => e
@@ -88,8 +97,8 @@ module Mailjet
 
       def create(attributes = {}, options = {})
         # if action method, ammend url to appropriate id
-        opts = change_resource_path(options)
-        self.resource_path = create_action_resource_path(attributes[:id]) if self.action
+        opts = define_options(options)
+        self.resource_path = create_action_resource_path(attributes[:id]) if (self.action and attributes[:id])
         attributes.tap { |hs| hs.delete(:id) }
 
         if Mailjet.config.default_from and self.resource_path == 'send/'
@@ -103,14 +112,14 @@ module Mailjet
 
         self.new(attributes).tap do |resource|
           resource.save!(opts)
-          resource.persisted = true
+          resource.attributes[:persisted] = true
         end
 
       end
 
       def delete(id, options = {})
          # if action method, ammend url to appropriate id
-         opts = change_resource_path(options)
+         opts = define_options(options)
          self.resource_path = create_action_resource_path(id) if self.action
          connection(opts)[id].delete(default_headers)
       end
@@ -120,7 +129,7 @@ module Mailjet
       end
 
       def parse_api_json(response_json)
-        response_hash = ActiveSupport::JSON.decode(response_json)
+        response_hash = JSON.parse(response_json)
 
         #Take the response from the API and put it through a method -- taken from the ActiveSupport library -- which converts
         #the date-time from "2014-05-19T15:31:09Z" to "Mon, 19 May 2014 15:31:09 +0000" format.
@@ -135,17 +144,17 @@ module Mailjet
       end
 
       def create_action_resource_path(id, job_id = nil)
-         url_elements = self.resource_path.split("/")
-         url_elements.delete_at(url_elements.length-1) if url_elements.last.to_i > 0 #if there is a trailing number for the job id from last call, delete it
+        url_elements = self.resource_path.split("/")
+        url_elements.delete_at(url_elements.length-1) if url_elements.last.to_i > 0 #if there is a trailing number for the job id from last call, delete it
 
-         if !(url_elements[1] == "contacts" && self.action == "managemanycontacts")
-           url_elements[2] = id.to_s
-         end
+        if !(url_elements[1] == "contacts" && self.action == "managemanycontacts")
+          url_elements[2] = id.to_s
+        end
 
-         url_elements << job_id.to_s if job_id #if job_id exists, amend it to end of the URI
-         url = url_elements.join("/")
+        url_elements << job_id.to_s if job_id #if job_id exists, amend it to end of the URI
+        url = url_elements.join("/")
 
-         return url
+        return url
       end
 
 
@@ -211,26 +220,14 @@ module Mailjet
         end
       end
 
-      def change_resource_path(options = {})
-        ver = choose_version(options)
-        url = Mailjet.config.end_point
-        perform_api_call = Mailjet.config.perform_api_call
-        if options.any?
-          if options.key?(:perform_api_call)
-            perform_api_call = options[:perform_api_call]
-          end
-          if options.key?(:url)
-            url = options[:url]
-          end
-        end
-        ret = {version: ver, url: url, perform_api_call: perform_api_call}
-        ret
-      end
-
-      def choose_version(options = {})
-        ver = options['version'] || Mailjet.config.api_version || version
-
-        ver
+      def define_options(options = {})
+        # merge default options with given ones on-the-fly
+        {
+          version: version || Mailjet.config.api_version,
+          url: Mailjet.config.end_point,
+          perform_api_call: Mailjet.config.perform_api_call
+        }
+        .merge(options.symbolize_keys.slice(*OPTIONS))
       end
 
     end
@@ -246,7 +243,7 @@ module Mailjet
     end
 
     def save(options = {})
-      opts = self.class.change_resource_path(options)
+      opts = self.class.define_options(options)
 
       if persisted?
         # case where the entity is updated
@@ -259,7 +256,7 @@ module Mailjet
       if opts[:perform_api_call] && !persisted?
         # get attributes only for entity creation
         self.attributes = if self.resource_path == 'send'
-          ActiveSupport::JSON.decode(response)
+          JSON.parse(response)
         else
           parse_api_json(response).first
         end
@@ -297,11 +294,11 @@ module Mailjet
         end
       end
 
-      opts = self.class.change_resource_path(options)
+      opts = self.class.define_options(options)
       save(opts)
     end
 
-    def delete(call)
+    def delete
       self.class.delete(id)
     end
 
@@ -318,12 +315,14 @@ module Mailjet
     def formatted_payload
       payload = attributes.reject { |k,v| v.blank? }
       if persisted?
-        payload = payload.slice(*resourceprop)
+        payload = payload.slice(*resourceprop.map(&:to_s))
       end
       payload = camelcase_keys(payload)
       payload.tap { |hs| hs.delete("Persisted") }
       payload.inject({}) do |h, (k, v)|
-        v = v.utc.as_json if v.respond_to? :utc
+        if v.respond_to? :utc
+          v = v.utc.to_s
+        end
         h.merge!({k => v})
       end
     end
@@ -346,20 +345,16 @@ module Mailjet
 
     def method_missing(method_symbol, *arguments) #:nodoc:
       method_name = method_symbol.to_s
-       if method_name =~ /(=|\?)$/
-        case $1
-        when "="
-          attributes[$`] = arguments.first
-        when "?"
-          attributes[$`]
-        end
-      else
-        return attributes[method_name] if attributes.include?(method_name)
-        # not set right now but we know about it
-        # return nil if known_attributes.include?(method_name)
-        super
+      if method_name.end_with?("=")
+        attributes[method_name.chop] = arguments.first
+        return
       end
-    end
 
+      if attributes.include?(method_name)
+        return attributes[method_name]
+      end
+
+      super
+    end
   end
 end