mailjet 1.5.4 → 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/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

@@ -6,6 +6,7 @@ module Mailjet
 
     DEFAULT = {
       api_version: 'v3',
+      sandbox_mode: false,
       end_point: 'https://api.mailjet.com',
       perform_api_call: true,
     }

data/lib/mailjet/connection.rb

@@ -6,7 +6,7 @@ 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
@@ -35,8 +35,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
 
@@ -85,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

@@ -42,6 +42,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 +74,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 +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
@@ -119,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}
@@ -163,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
@@ -177,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
@@ -198,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)
@@ -265,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/resource.rb

@@ -21,7 +21,7 @@ module Mailjet
     extend ActiveSupport::Concern
 
     # define here available options for filtering
-    OPTIONS = [:version, :url, :perform_api_call, :api_key, :secret_key]
+    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
 
@@ -40,7 +40,9 @@ module Mailjet
           options[:secret_key] || Mailjet.config.secret_key,
           public_operations: public_operations,
           read_only: read_only,
-          perform_api_call: options[:perform_api_call])
+          perform_api_call: options[:perform_api_call],
+          open_timeout: options[:open_timeout],
+          read_timeout: options[:read_timeout])
       end
 
       def self.default_headers
@@ -74,11 +76,17 @@ module Mailjet
       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 = define_options(options)
-        self.resource_path = create_action_resource_path(id, job_id) if self.action
+        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
@@ -92,7 +100,7 @@ module Mailjet
       def create(attributes = {}, options = {})
         # if action method, ammend url to appropriate id
         opts = define_options(options)
-        self.resource_path = create_action_resource_path(attributes[:id]) if self.action
+        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/'
@@ -106,7 +114,7 @@ module Mailjet
 
         self.new(attributes).tap do |resource|
           resource.save!(opts)
-          resource.persisted = true
+          resource.attributes[:persisted] = true
         end
 
       end
@@ -138,17 +146,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
 
 
@@ -292,7 +300,7 @@ module Mailjet
       save(opts)
     end
 
-    def delete(call)
+    def delete
       self.class.delete(id)
     end
 
@@ -309,7 +317,7 @@ 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") }
@@ -337,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

data/lib/mailjet/resources/campaigndraft.rb

@@ -1,7 +1,7 @@
 module Mailjet
   class Campaigndraft
     include Mailjet::Resource
-    self.resource_path = 'v3/REST/campaigndraft'
+    self.resource_path = 'REST/campaigndraft'
     self.public_operations = [:get, :put, :post]
     self.filters = [:campaign, :contacts_list, :delivered_at, :edit_mode, :is_archived, :is_campaign, :is_deleted, :is_handled, :is_starred, :modified, :news_letter_template, :segmentation, :status, :subject, :template]
     self.resourceprop = [:campaign, :contacts_list, :created_at, :delivered_at, :edit_mode, :id, :is_starred, :is_text_part_included, :locale, :modified_at, :preset, :reply_email, :segmentation, :sender, :sender_email, :sender_name, :status, :subject, :template_id, :title, :url, :used, 'CampaignID', 'CampaignALT', 'ContactsListID', 'ContactsListALT', 'SegmentationID', 'SegmentationALT', :contacts_list_id,'TemplateID']

data/lib/mailjet/resources/campaigndraft_detailcontent.rb

@@ -2,7 +2,7 @@ module Mailjet
   class Campaigndraft_detailcontent
     include Mailjet::Resource
     self.action = "detailcontent"
-    self.resource_path = "v3/REST/campaigndraft/id/#{self.action}"
+    self.resource_path = "REST/campaigndraft/id/#{self.action}"
     self.public_operations = [:get, :post]
     self.filters = []
     self.resourceprop = [:text_part, :html_part, :headers, :mjml_content]

data/lib/mailjet/resources/campaigndraft_schedule.rb

@@ -2,7 +2,7 @@ module Mailjet
   class Campaigndraft_schedule
     include Mailjet::Resource
     self.action = "schedule"
-    self.resource_path = "v3/REST/campaigndraft/id/#{self.action}"
+    self.resource_path = "REST/campaigndraft/id/#{self.action}"
     self.public_operations = [:post, :delete , :get]
     self.filters = []
     self.resourceprop = [:date]

data/lib/mailjet/resources/campaigndraft_send.rb

@@ -2,7 +2,7 @@ module Mailjet
   class Campaigndraft_send
     include Mailjet::Resource
     self.action = "send"
-    self.resource_path = "v3/REST/campaigndraft/id/#{self.action}"
+    self.resource_path = "REST/campaigndraft/id/#{self.action}"
     self.public_operations = [:post]
     self.filters = []
     self.resourceprop = []

data/lib/mailjet/resources/campaigndraft_status.rb

@@ -2,7 +2,7 @@ module Mailjet
   class Campaigndraft_status
     include Mailjet::Resource
     self.action = 'status'
-    self.resource_path = "v3/REST/campaigndraft/id/#{self.action}"
+    self.resource_path = "REST/campaigndraft/id/#{self.action}"
     self.public_operations =  [:get]
     self.filters = []
     self.resourceprop = []

data/lib/mailjet/resources/campaigndraft_test.rb

@@ -2,7 +2,7 @@ module Mailjet
   class Campaigndraft_test
     include Mailjet::Resource
     self.action = "test"
-    self.resource_path = "v3/REST/campaigndraft/id/#{self.action}"
+    self.resource_path = "REST/campaigndraft/id/#{self.action}"
     self.public_operations = [:post]
     self.filters = []
     self.resourceprop = [:email, :name]

data/lib/mailjet/resources/contact_getcontactslists.rb

@@ -6,5 +6,22 @@ module Mailjet
     self.public_operations = [:get]
     self.filters = []
     self.resourceprop = []
+
+    def self.find(id, job_id = nil, options = {})
+      opts = define_options(options)
+      self.resource_path = create_action_resource_path(id, job_id) if self.action
+
+      raw_data = parse_api_json(connection(opts).get(default_headers))
+
+      raw_data.map do |entity|
+        instanciate_from_api(entity)
+      end
+    rescue Mailjet::ApiError => e
+      if e.code == 404
+        nil
+      else
+        raise e
+      end
+    end
   end
 end

data/lib/mailjet/resources/messagehistory.rb

@@ -8,5 +8,21 @@ module Mailjet
 
     self.read_only = true
 
+    def self.find(id, job_id = nil, options = {})
+      opts = define_options(options)
+      self.resource_path = create_action_resource_path(id, job_id) if self.action
+
+      raw_data = parse_api_json(connection(opts)[id].get(default_headers))
+
+      raw_data.map do |entity|
+        instanciate_from_api(entity)
+      end
+    rescue Mailjet::ApiError => e
+      if e.code == 404
+        nil
+      else
+        raise e
+      end
+    end
   end
 end