mailjet 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6f0712c222da5b6148645338771953d6885fb65
-  data.tar.gz: 238b87870601f1f7811d25fc8758a681d6f0e194
+  metadata.gz: bce510af0e64da9901c04173e262e897483fa7c8
+  data.tar.gz: e8824a8d720e46b0b37d5fdd654b2483a397eb43
 SHA512:
-  metadata.gz: e8e4431ff38ec080662933322d3a4896dad4ccebb17fe0cfb7dd626c0dfcafef625c39710586f8e9bdf9c4bd6f9c021fc7b56de7f37c90a099bc6a1f653071d2
-  data.tar.gz: 10ab0c2ab2f02c868d866a1496aaa856c77b60a373de65e43d260ea0c847e6cda08667d89e308fdd9c3a4c33917ef7d9367bd856c7bbcd9b2da2009d2979c7f9
+  metadata.gz: d34de055592b05c8b29a801972b6e9b157860650102e441ff13782cbc95ada82ea25b635773075453cd37cd268dd2f184773da37c87b7abdfb71a3661648b60b
+  data.tar.gz: 471a5630d3258ebc1c7a245dcc6c86cacc6ddacdd8413e44fe19a4742d01029471e2ff81a9aa486cc359dc55aae853cc6ed66aa06716e493f9c7726d2e9daad6

data/README.md

@@ -92,7 +92,7 @@ end
 ```
 
 
-`default_from` is optional if you send emails with :mailjet's SMTP (below)
+`default_from` is optional if you send emails with `:mailjet`'s SMTP (below)
 
 ### Send emails with ActionMailer
 A quick walkthrough to using Action Mailer from the documentation [HERE](http://guides.rubyonrails.org/action_mailer_basics.html)
@@ -152,12 +152,12 @@ class UserMailer < ApplicationMailer
   end
 end
 ```
-For sending email, you can call the method with a variety of MessageDelivery priorities:
+For sending email, you can call the method with a variety of `MessageDelivery` priorities:
 ```ruby
 #In this example, we are sending immediately
 UserMailer.welcome_email.deliver_now!
 ```
-For more information on ActionMailer::MessageDeilvery, see the documentation [HERE](http://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html)
+For more information on `ActionMailer::MessageDeilvery`, see the documentation [HERE](http://edgeapi.rubyonrails.org/classes/ActionMailer/MessageDelivery.html)
 
 
 
@@ -239,16 +239,58 @@ You can refine queries using [API Filters][apidoc-recipient]`*` as well as the f
 => #<Mailjet::Listrecipient>
  ```
 
+### Action Endpoints
+
+Some APIs allow the use of action endpoints:
+* [/newsletter](http://dev.mailjet.com/email-api/v3/newsletter/)
+* [/contact](http://dev.mailjet.com/email-api/v3/contact/)
+* [/contactslist](http://dev.mailjet.com/email-api/v3/contactslist/)
+
+To use them in this wrapper, the API endpoint is in the beginning, followed by an underscore, followed by the action you are performing.
+
+For example, the following performs `managemanycontacts` on the `contactslist` endpoint:
+where 4 is the `listid` and 3025 is the `jobid`
+``` ruby
+Mailjet::Contactslist_managemanycontacts.find(4, 3025)
+```
+
+Each action endpoint requires the ID of the object you are changing.  To 'create' (POST), pass the ID as a variable like such:
+``` ruby
+Mailjet::Contactslist_managecontact.create(id: 1, action: "unsub", email: "example@me.com", name: "tyler")
+```
+
+To 'find' (GET), pass the ID as a variable like such:
+``` ruby
+Mailjet::Contact_getcontactslists.find(1)
+# will return all the lists containing the contact with id 1
+```
+
+Managing large amount of contacts asyncronously, uploading many contacts and returns a `job_id`
+``` ruby
+managecontactslists = Mailjet::Contact_managemanycontacts.create(contacts_lists: [{:ListID => 234, :action => "addnoforce"}])
+```
+
+To 'find' (GET) with also a job ID, pass two parameters - first, the ID of the object; second, the job ID:
+``` ruby
+Mailjet::Contactslist_managemanycontacts.find(1, 34062)
+# where 1 is the contactlist id and 34062 is the job id
+```
+
+Some actions are not attached to a specific resource, like /contact/managemanycontacts. In these cases when there is a job ID but no ID for the object when 'find'ing, pass `nil` as the first parameter:
+``` ruby
+Mailjet::Contact_managemanycontacts.find(nil, 34062)
+```
+
 ## Send emails through API
 
 In order to send emails through the API, you just have to `create` a new `MessageDelivery` resource.
 
-```
+``` ruby
 Mailjet::MessageDelivery.create(from: "me@example.com", to: "you@example.com", subject: "Mailjet is awesome", text: "Yes, it is!")
 ```
 
 If you want to send it to multiple recipients, just use an array:
-```
+``` ruby
 Mailjet::MessageDelivery.create(from: "me@example.com", to: ["you@example.com", "someone-else@example.com"], subject: "Mailjet is awesome", text: "Yes, it is!")
 ```
 
@@ -262,6 +304,8 @@ In these modifiers, there is now the ability to add a Mailjet custom-id or Mailj
 
 For more information on custom properties and available params, see the [official doc][send-api-doc].
 
+##
+
 ## Track email delivery
 
 You can setup your Rack application in order to receive feedback on emails you sent (clicks, etc.)

data/lib/mailjet/configuration.rb

@@ -7,6 +7,8 @@ module Mailjet
     mattr_accessor :end_point
     mattr_accessor :default_from
 
+    # @@end_point = 'https://api.preprod.mailjet.com'
     @@end_point = 'https://api.mailjet.com'
+
   end
 end

data/lib/mailjet/connection.rb

@@ -1,6 +1,7 @@
 require 'rest_client'
 require 'mailjet/gem_extensions/rest_client'
 require 'active_support/core_ext/module/delegation'
+require 'json'
 
 module Mailjet
   class Connection
@@ -11,7 +12,12 @@ module Mailjet
     delegate :options, :concat_urls, :url, to: :adapter
 
     def [](suburl, &new_block)
-      self.class.new(concat_urls(url, suburl), options[:user], options[:password], options)
+      broken_url = url.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)
+      else
+        self.class.new(concat_urls(url, suburl), options[:user], options[:password], options)
+      end
     end
 
     def initialize(end_point, api_key, secret_key, options = {})
@@ -52,16 +58,16 @@ module Mailjet
     private
 
     def handle_api_call(method, additional_headers = {}, payload = {}, &block)
-      format_payload = (additional_headers[:content_type] == :json) ? payload.to_json : payload  
+      formatted_payload = (additional_headers[:content_type] == :json) ? payload.to_json : payload
       raise Mailjet::MethodNotAllowed unless method_allowed(method)
 
       if [:get, :delete].include?(method)
         @adapter.send(method, additional_headers, &block)
       else
-        @adapter.send(method, format_payload, additional_headers, &block)
+        @adapter.send(method, formatted_payload, additional_headers, &block)
       end
     rescue RestClient::Exception => e
-      handle_exeception(e, additional_headers, payload)
+      handle_exception(e, additional_headers, formatted_payload)
     end
 
     def method_allowed(method)
@@ -69,9 +75,10 @@ module Mailjet
       public_operations.include?(method) && (method == :get || !read_only?)
     end
 
-    def handle_exeception(e, additional_headers, payload = {})
+    def handle_exception(e, additional_headers, payload = {})
       params = additional_headers[:params] || {}
-      params = params.merge(payload)
+      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)
     end

data/lib/mailjet/mailer.rb

@@ -28,24 +28,24 @@ class Mailjet::APIMailer
   def deliver!(mail)
     if mail.multipart?
       content = {
-        text: mail.text_part.try(:decoded),
-        html: mail.html_part.try(:decoded),
-        attachment: mail.attachments.select{ |a| !a.inline? }.try(:decoded),
-        inlineattachment: mail.attachments.select{ |a| !a.inline? }.try(:decoded)
+        :text => mail.text_part.try(:decoded),
+        :html => mail.html_part.try(:decoded),
+        :attachment => mail.attachments.select{ |a| !a.inline? }.try(:decoded),
+        :inlineattachment => mail.attachments.select{ |a| !a.inline? }.try(:decoded)
       }
     else
-      content = (mail.mime_type == "text/html") ? {html: mail.body.decoded} : {text: mail.body.decoded}
+      content = (mail.mime_type == "text/html") ? {:html => mail.body.decoded} : {:text => mail.body.decoded}
     end
 
     payload = {
-      from: mail.from || Mailjet.config.default_from,
-      sender: mail.sender,
-      to: mail.to,
-      cc: mail.cc,
-      bcc: mail.bcc,
-      subject: mail.subject,
-      'mj-customid': mail['X-MJ-CustomID'] && mail['X-MJ-CustomID'].value,
-      'mj-eventpayload': mail['X-MJ-EventPayload'] && mail['X-MJ-EventPayload'].value
+      :from => mail.from || Mailjet.config.default_from,
+      :sender => mail.sender,
+      :to => mail.to,
+      :cc => mail.cc,
+      :bcc => mail.bcc,
+      :subject => mail.subject,
+      :'mj-customid' => mail['X-MJ-CustomID'] && mail['X-MJ-CustomID'].value,
+      :'mj-eventpayload' => mail['X-MJ-EventPayload'] && mail['X-MJ-EventPayload'].value
     }.merge(content).merge(@delivery_method_options)
 
     Mailjet::MessageDelivery.create(payload)

data/lib/mailjet/resource.rb

@@ -38,10 +38,11 @@ module Mailjet
 
       def self.default_headers
         if @non_json_urls.include?(self.resource_path)#don't use JSON if Send API
-          { accept: :json, accept_encoding: :deflate }
+          default_headers = { accept: :json, accept_encoding: :deflate }
         else
-          { accept: :json, accept_encoding: :deflate, content_type: :json } #use JSON if *not* Send API
+          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
     end
 
@@ -62,9 +63,9 @@ module Mailjet
         response_hash['Total']
       end
 
-      def find(id)
+      def find(id, job_id = nil)
          # if action method, ammend url to appropriate id
-         self.resource_path = create_action_resource_path(id) if self.action
+         self.resource_path = create_action_resource_path(id, job_id) if self.action
          #
         attributes = parse_api_json(connection[id].get(default_headers)).first
         instanciate_from_api(attributes)
@@ -108,10 +109,15 @@ module Mailjet
         response_data_array.map{ |response_data| underscore_keys(response_data) }
       end
 
-      def create_action_resource_path(id)
+      def create_action_resource_path(id, job_id = nil)
          url_elements = self.resource_path.split("/")
-         url_elements[3] = id.to_s
-         return url_elements.join("/")
+         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 self.action != "managemanycontacts" || (self.action == "managemanycontacts" && url_elements[2] == "contactslist")
+           url_elements[3] = id.to_s
+        end
+         url_elements << job_id.to_s if job_id #if job_id exists, ammend it to end of the URI
+         url = url_elements.join("/")
+         return url
       end
 
 

data/lib/mailjet/resources/contact_getcontactslists.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Contact_getcontactslists
+    include Mailjet::Resource
+    self.action = "getcontactslists"
+    self.resource_path = "v3/REST/contact/id/#{self.action}"
+    self.public_operations = [:get]
+    self.filters = []
+    self.properties = []
+  end
+end

data/lib/mailjet/resources/contact_managecontactslists.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Contact_managecontactslists
+    include Mailjet::Resource
+    self.action = "managecontactslists"
+    self.resource_path = "v3/REST/contact/id/#{self.action}"
+    self.public_operations = [:post]
+    self.filters = []
+    self.properties = [:contacts_lists, 'ListID', :list_id, :action] #need 'ListID' and :action in a subpacket
+  end
+end

data/lib/mailjet/resources/contact_managemanycontacts.rb

@@ -0,0 +1,13 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Contact_managemanycontacts
+    include Mailjet::Resource
+    self.action = "managemanycontacts"
+    #might be different
+    self.resource_path = "v3/REST/contact/#{self.action}"
+    self.public_operations = [:post, :get] #GET is for job_id ammended at the end
+    self.filters = []
+    self.properties = [:contacts_lists, :contacts, :list_id, 'ListID', :action, :email, :name, :properties] #need 'ListID' and :action in a subpacket
+  end
+end

data/lib/mailjet/resources/contactslist_managecontact.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Contactslist_managecontact
+    include Mailjet::Resource
+    self.action = "managecontact"
+    self.resource_path = "v3/REST/contactslist/id/#{self.action}"
+    self.public_operations = [:post]
+    self.filters = []
+    self.properties = [:email, :name, :action, :properties]
+  end
+end

data/lib/mailjet/resources/contactslist_managemanycontacts.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class Contactslist_managemanycontacts
+    include Mailjet::Resource
+    self.action = "managemanycontacts"
+    self.resource_path = "v3/REST/contactslist/id/#{self.action}"
+    self.public_operations = [:post, :get] #GET is for when job_id is there
+    self.filters = []
+    self.properties = [:action, :contacts, :email, :name, :properties]
+  end
+end

data/lib/mailjet/resources/dns.rb

@@ -0,0 +1,12 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class DNS
+    include Mailjet::Resource
+    self.resource_path = 'v3/REST/dns'
+    self.public_operations = [:get]
+    self.filters = []
+    self.properties = [:id, :isCheckInProgress, :DKIMStatus, :DKIMValue, :DKIMName, :format, :lastCheckedAt, :SPFStatus, :SPFValue, :ownershipToken]
+
+  end
+end

data/lib/mailjet/resources/dns_check.rb

@@ -0,0 +1,13 @@
+require 'mailjet/resource'
+
+module Mailjet
+  class DNS_check
+    include Mailjet::Resource
+    self.action = "check"
+    self.resource_path = "v3/REST/dns/id/#{self.action}"
+    self.public_operations = [:post]
+    self.filters = []
+    self.properties = []
+
+  end
+end

data/lib/mailjet/version.rb

@@ -1,3 +1,3 @@
 module Mailjet
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Tyler Nappy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -300,14 +300,21 @@ files:
 - lib/mailjet/resources/campaignstatistics.rb
 - lib/mailjet/resources/clickstatistics.rb
 - lib/mailjet/resources/contact.rb
+- lib/mailjet/resources/contact_getcontactslists.rb
+- lib/mailjet/resources/contact_managecontactslists.rb
+- lib/mailjet/resources/contact_managemanycontacts.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_managecontact.rb
+- lib/mailjet/resources/contactslist_managemanycontacts.rb
 - lib/mailjet/resources/contactslistsignup.rb
 - lib/mailjet/resources/contactstatistics.rb
 - lib/mailjet/resources/csvimport.rb
+- lib/mailjet/resources/dns.rb
+- lib/mailjet/resources/dns_check.rb
 - lib/mailjet/resources/domainstatistics.rb
 - lib/mailjet/resources/eventcallbackurl.rb
 - lib/mailjet/resources/geostatistics.rb