mailjet 1.5.0 → 1.6.0

data/lib/mailjet/resource.rb

@@ -20,6 +20,9 @@ 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
@@ -36,7 +39,10 @@ module Mailjet
           options[:api_key] || Mailjet.config.api_key,
           options[:secret_key] || Mailjet.config.secret_key,
           public_operations: public_operations,
-          read_only: read_only)
+          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
@@ -55,26 +61,32 @@ 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), opts[:perform_api_call])
+        response = connection(opts).get(default_headers.merge(params: params))
         attribute_array = parse_api_json(response)
         attribute_array.map{ |attributes| instanciate_from_api(attributes) }
       end
 
       def count(options = {})
-        opts = change_resource_path(options)
-        response_json = connection(opts).get(default_headers.merge(params: {limit: 1, countrecords: 1}), opts[:perform_api_call])
+        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['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, opts[:perform_api_call])).first
+        attributes = parse_api_json(connection(opts)[normalized_id].get(default_headers)).first
         instanciate_from_api(attributes)
 
       rescue Mailjet::ApiError => e
@@ -87,8 +99,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/'
@@ -102,16 +114,16 @@ 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(options)[id].delete(default_headers)
+         connection(opts)[id].delete(default_headers)
       end
 
       def instanciate_from_api(attributes = {})
@@ -120,6 +132,7 @@ module Mailjet
 
       def parse_api_json(response_json)
         response_hash = ActiveSupport::JSON.decode(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.
         response_hash = convert_dates_from(response_hash)
@@ -133,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
 
 
@@ -209,26 +222,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
@@ -243,24 +244,28 @@ module Mailjet
       attributes[:persisted]
     end
 
-    def save(options)
+    def save(options = {})
+      opts = self.class.define_options(options)
+
       if persisted?
-        response = connection(options)[attributes[:id]].put(formatted_payload, default_headers, options[:perform_api_call])
+        # case where the entity is updated
+        response = connection(opts)[attributes[:id]].put(formatted_payload, default_headers)
       else
-        response = connection(options).post(formatted_payload, default_headers, options[:perform_api_call])
+        # case where the entity is created
+        response = connection(opts).post(formatted_payload, default_headers)
       end
 
-      if options[:perform_api_call]
-        if self.resource_path == 'send/'
-          self.attributes = ActiveSupport::JSON.decode(response)
-          return true
+      if opts[:perform_api_call] && !persisted?
+        # get attributes only for entity creation
+        self.attributes = if self.resource_path == 'send'
+          ActiveSupport::JSON.decode(response)
+        else
+          parse_api_json(response).first
         end
-
-        self.attributes = parse_api_json(response).first
-        return true
-      else
-        return true
       end
+
+      return true
+
     rescue Mailjet::ApiError => e
       if e.code.to_s == "304"
         return true # When you save a record twice it should not raise error
@@ -269,7 +274,7 @@ module Mailjet
       end
     end
 
-    def save!(options)
+    def save!(options = {})
       save(options) || raise(StandardError.new("Resource not persisted"))
     end
 
@@ -280,11 +285,22 @@ module Mailjet
     end
 
     def update_attributes(attribute_hash = {}, options = {})
-      self.attributes = attribute_hash
-      save(options)
+      self.attributes.deep_merge!(attribute_hash) do |key, old, new|
+        if old.is_a?(Array) && new.is_a?(Array)
+          # uniqueness of hashes based on their value of "Name"
+          (new + old).uniq do |data|
+            data["Name"]
+          end
+        else
+          new
+        end
+      end
+
+      opts = self.class.define_options(options)
+      save(opts)
     end
 
-    def delete(call)
+    def delete
       self.class.delete(id)
     end
 
@@ -301,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") }
@@ -329,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

data/lib/mailjet/resources/newsletter.rb

@@ -4,7 +4,6 @@ module Mailjet
     self.resource_path = 'REST/newsletter'
     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]
-    self.resourceprop = [:callback, :campaign, :contacts_list, :created_at, :delivered_at, :edit_mode, :edit_type, :footer, :footer_address, :footer_wysiwyg_type, :header_filename, :header_link, :header_text, :header_url, :id, :ip, :is_handled, :is_starred, :is_text_part_included, :locale, :modified_at, :permalink, :permalink_host, :permalink_wysiwyg_type, :politeness_mode, :reply_email, :segmentation, :sender, :sender_email, :sender_name, :status, :subject, :template, :test_address, :title, :url, 'CampaignID', 'CampaignALT', 'ContactsListID', 'ContactsListALT', 'SegmentationID', 'SegmentationALT', :contacts_list_id]
-
+    self.resourceprop = [:callback, :campaign, :contacts_list, :created_at, :delivered_at, :edit_mode, :edit_type, :footer, :footer_address, :footer_wysiwyg_type, :header_filename, :header_link, :header_text, :header_url, :id, :ip, :is_handled, :is_starred, :is_text_part_included, :locale, :modified_at, :permalink, :permalink_host, :permalink_wysiwyg_type, :politeness_mode, :reply_email, :segmentation, :segmentation_id, :sender, :sender_email, :sender_name, :status, :subject, :template, :test_address, :title, :url, 'CampaignID', 'CampaignALT', 'ContactsListID', 'ContactsListALT', 'SegmentationID', 'SegmentationALT', :contacts_list_id]
   end
 end

data/lib/mailjet/resources/newsletter_schedule.rb

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

data/lib/mailjet/resources/statcounters.rb

@@ -0,0 +1,33 @@
+module Mailjet
+  class Statcounters
+    include Mailjet::Resource
+    self.resource_path = 'REST/statcounters'
+    self.public_operations = [:get]
+    self.filters = [:source_id, :counter_resolution, :counter_source, :counter_timing]
+    self.resourceprop = [
+      :api_key_id,
+      :event_click_delay,
+      :event_clicked_count,
+      :event_open_delay,
+      :event_opened_count,
+      :event_spam_count,
+      :event_unsubscribed_count,
+      :event_workflow_exited_count,
+      :message_blocked_count,
+      :message_clicked_count,
+      :message_deferred_count,
+      :message_hard_bounced_count,
+      :message_opened_count,
+      :message_queued_count,
+      :message_sent_count,
+      :message_soft_bounced_count,
+      :message_spam_count,
+      :message_unsubscribed_count,
+      :message_work_flow_exited_count,
+      :source_id,
+      :timeslice,
+      :total,
+    ]
+    self.read_only = true
+  end
+end

data/lib/mailjet/resources/template_detailcontent.rb

@@ -1,10 +1,26 @@
 module Mailjet
   class Template_detailcontent
     include Mailjet::Resource
-    self.resource_path = 'REST/template/id/${self.action}'
-    self.public_operations = [:get, :put, :post, :delete]
+    self.action = 'detailcontent'
+    self.resource_path = "REST/template/id/#{self.action}"
+    self.public_operations = [:get,:post]
     self.filters = [:api_key, :categories, :categories_selection_method, :edit_mode, :name, :owner_type, :purposes, :purposes_selection_method, :user]
     self.resourceprop = [:author, :categories, :copyright, :description, :edit_mode, :is_starred, :name, :owner_type, :presets, :purposes]
 
+    def self.find(id, options = {})
+      self.resource_path = create_action_resource_path(id)
+
+      opts = define_options(options)
+      response = connection(opts).get(default_headers)
+      attributes = parse_api_json(response).first
+
+      instanciate_from_api(attributes)
+    rescue Mailjet::ApiError => e
+      if e.code == 404
+        nil
+      else
+        raise e
+      end
+    end
   end
 end