mailjet 1.7.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8196f5f49e3b7aa6766ad97b0e8a2346c4591f56f30a37e124a346ba46e06f3b
-  data.tar.gz: b7264d284ac5267785d26c0d8a14810f714ea74893f52eb8d82dc049347b1883
+  metadata.gz: c9c74309f3d5e557d27fe01548e0998a987c90a9bd1e5e52c187c23d33fb5475
+  data.tar.gz: 3c44b00a89c535c6143d0011fa6e11ca1d6bcdbc82ed984eea4b5f23b0483b89
 SHA512:
-  metadata.gz: e2c289c1757e6cbc7980296b2de8b9bf7052dbea80265e93d4131a8b8de720c11daa07e83d1ca0d42f4acbc8e637ed387130ca6cf12efbf896e089fb460cc4f8
-  data.tar.gz: 7502fade84d6f8690394c3a911dfdb48786d21a3414a79416436a04da69aba2f0450b35ea1912b586c69126d6b3052573c3b29a8f3929c969b3d97c3bb0d76ad
+  metadata.gz: a35a75e7a661f72c28fda90a8403f363252f36cf9573786e512f1721b807b6f450d51dafdc6d8ae8c816b4bd0f32b4abe008f67b6189647a0caa70f0ebbc929d
+  data.tar.gz: 513f1178e1f7e625b177faa7220d60fbb4208a5d38f91642d173ee7a63d39fa3758d189f04e9a4a3e928d84e8d4921a17c22d281bb9fca2b8cf47c7f9f7348ca

data/README.md

@@ -76,7 +76,7 @@ Check out all the resources and Ruby code examples in the [Offical Documentation
 
 This library requires **Ruby v2.2.X**.
 
-The Rails ActionMailer integration is designed for Rails 3.X and 4.X.
+The Rails ActionMailer integration is designed for Rails >= 5.
 
 ## Installation
 
@@ -139,7 +139,7 @@ Here's an example on how to send an email:
 require 'mailjet'
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
   config.api_version = "v3.1"
 end
 variable = Mailjet::Send.create(messages: [{
@@ -177,7 +177,7 @@ Since most Email API endpoints are located under `v3`, it is set as the default
 require 'mailjet'
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
   config.api_version = "v3.1"
 end
 ```
@@ -189,7 +189,7 @@ The default base domain name for the Mailjet API is `https://api.mailjet.com`. Y
 ```ruby
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
   config.api_version = "v3.1"
   config.end_point = "https://api.us.mailjet.com"
 end
@@ -221,7 +221,7 @@ Use the `create` method of the Mailjet CLient (i.e. `variable = Mailjet::$resour
 require 'mailjet'
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
 end
 variable = Mailjet::Contact.create(email: "Mister@mailjet.com"
 )
@@ -239,7 +239,7 @@ Use `id` to specify the ID you want to apply a POST request to (used in case of
 require 'mailjet'
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
 end
 variable = Mailjet::Contact_managecontactslists.create(id: $ID, contacts_lists: [{
     'ListID'=> '$ListID_1',
@@ -285,7 +285,7 @@ Use the `.find` method to retrieve a specific object. Specify the ID of the obje
 require 'mailjet'
 Mailjet.configure do |config|
   config.api_key = ENV['MJ_APIKEY_PUBLIC']
-  config.secret_key = ENV['MJ_APIKEY_PRIVATE']  
+  config.secret_key = ENV['MJ_APIKEY_PRIVATE']
 end
 variable = Mailjet::Contact.find($CONTACT_EMAIL)
 p variable.attributes['Data']
@@ -483,6 +483,17 @@ UserMailer.welcome_email.deliver_now!
 
 For more information on `ActionMailer::MessageDelivery`, see the documentation [HERE](http://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html)
 
+#### Manage contacts via CSV Upload
+Create the CSV content in a format compatible with the Mailjet API, see the documentation [HERE](https://dev.mailjet.com/email/guides/contact-management/#manage-contacts-via-csv-upload)
+```ruby
+Mailjet::ContactslistCsv.send_data(ID_CONTACTLIST, File.open('some_csvdata.csv', 'r'))
+```
+
+#### [Delete the Contact](https://dev.mailjet.com/email/guides/contact-management/#gdpr-delete-contacts)
+```ruby
+Mailjet::ContactPii.delete(contact_ID)
+```
+
 ## Track email delivery
 
 You can setup your Rack application in order to receive feedback on emails you sent (clicks, etc.)

data/lib/mailjet/connection.rb

@@ -1,41 +1,32 @@
-require 'rest_client'
-require 'mailjet/gem_extensions/rest_client'
-require 'json'
+require 'faraday'
+require 'yajl'
 
 module Mailjet
   class Connection
 
-    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call, :read_timeout, :open_timeout
+    attr_accessor :adapter, :public_operations, :read_only, :perform_api_call, :api_key, :secret_key, :options
     alias :read_only? :read_only
 
     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.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', read_timeout: self.read_timeout, open_timeout: self.open_timeout))
+      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
 
@@ -55,34 +46,31 @@ 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)
+    def concat_urls(suburl)
+      self.adapter.build_url(suburl.to_s)
     end
 
-    def url
-      self.adapter.url
+    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
 
@@ -92,28 +80,44 @@ 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)
 
-      http_body = if e.http_headers[:content_type].include?("application/json")
-        e.http_body
+      response_body = if e.response_headers[:content_type].include?("application/json")
+        e.response_body
       else
         "{}"
       end
 
-      if sent_invalid_email?(e.http_body, @adapter.url)
-        return e.http_body
+      if sent_invalid_email?(e.response_body, @adapter.build_url)
+        return e.response_body
       else
-        raise Mailjet::ApiError.new(e.http_code, http_body, @adapter, @adapter.url, params)
+        raise communication_error(e)
       end
     end
 
-    def sent_invalid_email?(error_http_body, url)
-      return false unless url.include?('v3.1/send')
+    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 = JSON.parse(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
@@ -123,6 +127,5 @@ module Mailjet
   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
 
@@ -202,9 +203,7 @@ 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?
@@ -294,9 +293,7 @@ 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)
+    payload.merge!(content, base_from, @delivery_method_options_v3_0)
   end
 end
 

data/lib/mailjet/rack/endpoint.rb

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

data/lib/mailjet/resource.rb

@@ -1,11 +1,9 @@
 require 'mailjet/connection'
+require 'yajl'
+require 'active_support'
 require 'active_support/core_ext/string'
-require 'active_support/core_ext/module/delegation'
-#require 'mail'
-require 'active_support/hash_with_indifferent_access'
-require 'active_support/core_ext/hash'
-require 'active_support/json/decoding'
-require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+
 
 
 # This option automatically transforms the date output by the API into something a bit more readable.
@@ -16,11 +14,11 @@ require 'json'
 
 module Mailjet
   module Resource
-
     # define here available options for filtering
-    OPTIONS = [:version, :url, :perform_api_call, :api_key, :secret_key, :read_timeout, :open_timeout]
+    OPTIONS = [:version, :url, :perform_api_call, :api_key, :secret_key]
 
     NON_JSON_URLS = ['v3/send/message'] # urls that don't accept JSON input
+    DATA_URLS = ['plain', 'csv'] # url for send binary data , 'CSVError/text:csv'
 
     def self.included(base)
       base.extend ClassMethods
@@ -41,18 +39,20 @@ module Mailjet
             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])
+            perform_api_call: options[:perform_api_call])
         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 }
+            default_headers = { 'Accept' =>'application/json', 'Accept-Encoding' => 'deflate' }
+          elsif DATA_URLS.any? do |data_type|
+            default_headers = { 'Content-Type' => "text/#{data_type}" } if self.resource_path.include?(data_type)
+            end
           else
-            default_headers = { accept: :json, accept_encoding: :deflate, content_type: :json } #use JSON if *not* Send API
+            # use JSON if *not* Send API
+            default_headers = {'Content-Type' =>'application/json', 'Accept' =>'application/json', 'Accept-Encoding' => 'deflate'}
           end
-          return default_headers.merge(user_agent: "mailjet-api-v3-ruby/#{Gem.loaded_specs["mailjet"].version}")
+          return default_headers.merge!('User-Agent' => "mailjet-api-v3-ruby/#{Gem.loaded_specs["mailjet"].version}")
         end
       end
     end
@@ -60,21 +60,27 @@ module Mailjet
     module ClassMethods
       def first(params = {}, options = {})
         all(params.merge!(limit: 1), options).first
+      rescue Mailjet::ApiError => error
+        raise error
       end
 
       def all(params = {}, options = {})
         opts = define_options(options)
         params = format_params(params)
-        response = connection(opts).get(default_headers.merge(params: params))
-        attribute_array = parse_api_json(response)
+        response = connection(opts).get(default_headers.merge!(params: params))
+        attribute_array = parse_api_json(response.body)
         attribute_array.map{ |attributes| instanciate_from_api(attributes) }
+      rescue Mailjet::ApiError => error
+        raise error
       end
 
       def count(options = {})
         opts = define_options(options)
-        response_json = connection(opts).get(default_headers.merge(params: {limit: 1, countrecords: 1}))
-        response_hash = JSON.parse(response_json)
+        response_json = connection(opts).get(default_headers.merge!(params: {limit: 1, countrecords: 1}))
+        response_hash = Yajl::Parser.parse(response_json.body)
         response_hash['Total']
+      rescue Mailjet::ApiError => error
+        raise error
       end
 
       def find(id, job_id = nil, options = {})
@@ -87,11 +93,11 @@ module Mailjet
         # if action method, ammend url to appropriate id
         opts = define_options(options)
         self.resource_path = create_action_resource_path(normalized_id, job_id) if self.action
-        #
-        attributes = parse_api_json(connection(opts)[normalized_id].get(default_headers)).first
+
+        attributes = parse_api_json(connection(opts)[normalized_id].get(default_headers).body).first
         instanciate_from_api(attributes)
 
-      rescue Mailjet::ApiError => e
+      rescue Mailjet::CommunicationError => e
         if e.code == 404
           nil
         else
@@ -99,6 +105,14 @@ module Mailjet
         end
       end
 
+
+      def find_by_id(id, options = {})
+        # if action method, ammend url to appropriate id
+        opts = define_options(options)
+        self.resource_path = create_action_resource_path(id) if self.action
+        connection(opts).get(default_headers)
+      end
+
       def create(attributes = {}, options = {})
         # if action method, ammend url to appropriate id
         opts = define_options(options)
@@ -118,7 +132,6 @@ module Mailjet
           resource.save!(opts)
           resource.attributes[:persisted] = true
         end
-
       end
 
       def delete(id, options = {})
@@ -126,14 +139,25 @@ module Mailjet
          opts = define_options(options)
          self.resource_path = create_action_resource_path(id) if self.action
          connection(opts)[id].delete(default_headers)
+      rescue Mailjet::ApiError => error
+        raise error
+      end
+
+      def send_data(id, binary_data = nil, options = {})
+        opts = define_options(options)
+        self.resource_path = create_action_resource_path(id) if self.action
+        response = connection(opts).post(binary_data, default_headers.merge({'Content-Length' => "#{binary_data.size}", 'Transfer-Encoding' => 'chunked'}))
+
+        response_hash = response.respond_to?(:body) ? Yajl::Parser.parse(response.body) : Yajl::Parser.parse(response)
+        response_hash['ID'] ? response_hash['ID'] : response_hash
       end
 
       def instanciate_from_api(attributes = {})
-        self.new(attributes.merge(persisted: true))
+        self.new(attributes.merge!(persisted: true))
       end
 
       def parse_api_json(response_json)
-        response_hash = JSON.parse(response_json)
+        response_hash = Yajl::Parser.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.
@@ -169,9 +193,9 @@ module Mailjet
         case data
         when nil
           nil
-       when /^(?:\d{4}-\d{2}-\d{2}|\d{4}-\d{1,2}-\d{1,2}[T \t]+\d{1,2}:\d{2}:\d{2}(\.[0-9]*)?(([ \t]*)Z|[-+]\d{2}?(:\d{2})?))$/
+        when /^(?:\d{4}-\d{2}-\d{2}|\d{4}-\d{1,2}-\d{1,2}[T \t]+\d{1,2}:\d{2}:\d{2}(\.[0-9]*)?(([ \t]*)Z|[-+]\d{2}?(:\d{2})?))$/
           begin
-            DateTime.parse(data)
+            DateTime.iso8601(data)
           rescue ArgumentError
             data
           end
@@ -260,9 +284,9 @@ module Mailjet
       if opts[:perform_api_call] && !persisted?
         # get attributes only for entity creation
         self.attributes = if self.resource_path == 'send'
-          JSON.parse(response)
+          Yajl::Parser.parse(response.body)
         else
-          parse_api_json(response).first
+          parse_api_json(response.body).first
         end
       end
 

data/lib/mailjet/resources/campaigndraft_detailcontent.rb

@@ -11,12 +11,12 @@ module Mailjet
       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 = parse_api_json(connection(opts)[id].get(default_headers).body)
 
       raw_data.map do |entity|
         instanciate_from_api(entity)
       end
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/resources/contact.rb

@@ -5,20 +5,15 @@ module Mailjet
     self.public_operations = [:get, :put, :post]
     self.filters = [:campaign, :contacts_list, :is_unsubscribed, :last_activity_at, :recipient, :status]
     self.resourceprop = [
-      :created_at,
       :delivered_count,
       :email,
       :id,
       :is_opt_in_pending,
       :is_spam_complaining,
-      :last_activity_at,
-      :last_update_at,
       :name,
-      :unsubscribed_at,
       :unsubscribed_by,
       :is_excluded_from_campaigns
     ]
     self.read_only_attributes = [:created_at, :last_activity_at, :last_update_at, :unsubscribed_at]
-
   end
 end

data/lib/mailjet/resources/contact_getcontactslists.rb

@@ -11,12 +11,12 @@ module Mailjet
       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 = parse_api_json(connection(opts).get(default_headers).body)
 
       raw_data.map do |entity|
         instanciate_from_api(entity)
       end
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/resources/contact_pii.rb

@@ -0,0 +1,8 @@
+module Mailjet
+  class ContactPii
+    include Mailjet::Resource
+    self.version = 'v4'
+    self.resource_path = 'contacts'
+    self.public_operations = [:delete]
+  end
+end

data/lib/mailjet/resources/contactslist_csv.rb

@@ -0,0 +1,8 @@
+module Mailjet
+  class ContactslistCsv
+    include Mailjet::Resource
+    self.action = "DATA/contactslist"
+    self.resource_path = "#{self.action}/id/CSVData/text:plain"
+    self.public_operations = [:post]
+  end
+end

data/lib/mailjet/resources/csvimport.rb

@@ -5,6 +5,5 @@ module Mailjet
     self.public_operations = [:get, :put, :post]
     self.filters = []
     self.resourceprop = [:alive_at, :contacts_list, :count, :current, :data_id, :errcount, :err_treshold, :id, :import_options, :job_end, :job_start, :method, :request_at, :status]
-
   end
 end

data/lib/mailjet/resources/listrecipient.rb

@@ -4,7 +4,8 @@ module Mailjet
     self.resource_path = 'REST/listrecipient'
     self.public_operations = [:get, :put, :post, :delete]
     self.filters = [:active, :blocked, :contact, :contact_email, :contacts_list, :last_activity_at, :list_name, :opened, :status, :unsub]
-    self.resourceprop = [:contact, :id, :is_active, :is_unsubscribed, :list, :unsubscribed_at, :contact_id, :list_id, 'ContactID', 'ListID', 'ContactALT', 'ListALT']
+    self.resourceprop = [:contact, :id, :is_active, :is_unsubscribed, :list, :contact_id, :list_id, 'ContactID', 'ListID', 'ContactALT', 'ListALT']
 
+    self.read_only_attributes = [:subscribed_at, :unsubscribed_at]
   end
 end

data/lib/mailjet/resources/messagehistory.rb

@@ -12,12 +12,12 @@ module Mailjet
       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 = parse_api_json(connection(opts)[id].get(default_headers).body)
 
       raw_data.map do |entity|
         instanciate_from_api(entity)
       end
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/resources/messageinformation.rb

@@ -12,12 +12,12 @@ module Mailjet
       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 = parse_api_json(connection(opts)[id].get(default_headers).body)
 
       raw_data.map do |entity|
         instanciate_from_api(entity)
       end
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/resources/openinformation.rb

@@ -12,12 +12,12 @@ module Mailjet
       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 = parse_api_json(connection(opts)[id].get(default_headers).body)
 
       raw_data.map do |entity|
         instanciate_from_api(entity)
       end
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/resources/retrieve_errors_csv.rb

@@ -0,0 +1,8 @@
+module Mailjet
+  class RetrieveErrosCsv
+    include Mailjet::Resource
+    self.action = "DATA/BatchJob"
+    self.resource_path = "#{self.action}/id/CSVError/text:csv"
+    self.public_operations = [:get]
+  end
+end

data/lib/mailjet/resources/template_detailcontent.rb

@@ -12,10 +12,10 @@ module Mailjet
 
       opts = define_options(options)
       response = connection(opts).get(default_headers)
-      attributes = parse_api_json(response).first
+      attributes = parse_api_json(response.body).first
 
       instanciate_from_api(attributes)
-    rescue Mailjet::ApiError => e
+    rescue Mailjet::CommunicationError => e
       if e.code == 404
         nil
       else

data/lib/mailjet/version.rb

@@ -1,3 +1,3 @@
 module Mailjet
-  VERSION = "1.7.3"
+  VERSION = "1.8.0"
 end

data/lib/mailjet.rb

@@ -1,13 +1,11 @@
 require 'json/ext'
-require 'ostruct'
-require 'mailjet/core_extensions/ostruct'
+require 'yajl'
 require 'mailjet/configuration'
-require 'mailjet/api_error'
 
 require 'mailjet/resource'
 require 'mailjet/message_delivery'
 
-Dir[File.expand_path("../mailjet/resources/*.rb", __FILE__)].each do |file|
+Dir[File.expand_path("../mailjet/{resources,exception}/*.rb", __FILE__)].each do |file|
   require file
 end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Tyler Nappy
 - Jean-Baptiste Escoyez
 - Aurélien AMILIN
 - Benoit Bénézech
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -42,33 +42,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -168,12 +182,10 @@ files:
 - lib/generators/mailjet/initializer_generator.rb
 - lib/generators/mailjet/templates/mailjet.rb.erb
 - lib/mailjet.rb
-- lib/mailjet/api_error.rb
 - lib/mailjet/collection_proxy.rb
 - lib/mailjet/configuration.rb
 - lib/mailjet/connection.rb
-- lib/mailjet/core_extensions/ostruct.rb
-- lib/mailjet/gem_extensions/rest_client.rb
+- lib/mailjet/exception/errors.rb
 - lib/mailjet/mailer.rb
 - lib/mailjet/message_delivery.rb
 - lib/mailjet/rack/endpoint.rb
@@ -203,11 +215,13 @@ files:
 - lib/mailjet/resources/contact_getcontactslists.rb
 - lib/mailjet/resources/contact_managecontactslists.rb
 - lib/mailjet/resources/contact_managemanycontacts.rb
+- lib/mailjet/resources/contact_pii.rb
 - lib/mailjet/resources/contactdata.rb
 - lib/mailjet/resources/contactfilter.rb
 - lib/mailjet/resources/contacthistorydata.rb
 - lib/mailjet/resources/contactmetadata.rb
 - lib/mailjet/resources/contactslist.rb
+- lib/mailjet/resources/contactslist_csv.rb
 - lib/mailjet/resources/contactslist_managecontact.rb
 - lib/mailjet/resources/contactslist_managemanycontacts.rb
 - lib/mailjet/resources/contactslistsignup.rb
@@ -248,6 +262,7 @@ files:
 - lib/mailjet/resources/openstatistics.rb
 - lib/mailjet/resources/parseroute.rb
 - lib/mailjet/resources/preferences.rb
+- lib/mailjet/resources/retrieve_errors_csv.rb
 - lib/mailjet/resources/send.rb
 - lib/mailjet/resources/sender.rb
 - lib/mailjet/resources/sender_validate.rb
@@ -291,11 +306,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Mailjet a powerful all-in-one email service provider clients can use to get
   maximum insight and deliverability results from both their marketing and transactional
   emails. Our analytics tools and intelligent APIs give senders the best understanding
   of how to maximize benefits for each individual contact, with each email sent.
 test_files: []
+...

data/lib/mailjet/api_error.rb

@@ -1,28 +0,0 @@
-require "json"
-
-module Mailjet
-  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
-
-      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."
-
-      super("#{message}\n\n#{error_details}\n\n#{hint}\n\n")
-    end
-  end
-end

data/lib/mailjet/core_extensions/ostruct.rb

@@ -1,9 +0,0 @@
-class OpenStruct
-  
-  # when asked for id, ruby 1.8.7's implementation of OpenStruct returns object's inner id instead of table's value if present. Evilishish infamous Monkey-Patch.
-  if RUBY_VERSION =~ /1\.8\./
-    def id
-      send(:eval, "@table[:id]")
-    end
-  end
-end

data/lib/mailjet/gem_extensions/rest_client.rb

@@ -1,19 +0,0 @@
-module RestClient
-  module Payload
-    class Base
-      def flatten_params_array value, calculated_key
-        result = []
-        value.each do |elem|
-          if elem.is_a? Hash
-            result += flatten_params(elem, calculated_key)
-          elsif elem.is_a? Array
-            result += flatten_params_array(elem, calculated_key)
-          else
-            result << ["#{calculated_key}", elem]
-          end
-        end
-        result
-      end
-    end
-  end
-end