mailjet 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b099b2cb56312e539e49fe4ef484811cc78759d
-  data.tar.gz: 8afee6d3003543cd89580ad10d2919966bf559f3
+  metadata.gz: b6f0712c222da5b6148645338771953d6885fb65
+  data.tar.gz: 238b87870601f1f7811d25fc8758a681d6f0e194
 SHA512:
-  metadata.gz: c9bfa9d80dc50955a7694f280c7ad89695f26ee22bc01ac241e5f141d3e88734fb31902f9728b5faa697e812a3f4ae02bd0ae1a7d65beaefe69a47c0c7ca4343
-  data.tar.gz: e768169fee0d10f1e4cc735ce796913332989531b960d509c585a7b51c070422d224108aac620dacbd39623a81ab74b3e8e6586aa2a5581c71d78d7240daaee6
+  metadata.gz: e8e4431ff38ec080662933322d3a4896dad4ccebb17fe0cfb7dd626c0dfcafef625c39710586f8e9bdf9c4bd6f9c021fc7b56de7f37c90a099bc6a1f653071d2
+  data.tar.gz: 10ab0c2ab2f02c868d866a1496aaa856c77b60a373de65e43d260ea0c847e6cda08667d89e308fdd9c3a4c33917ef7d9367bd856c7bbcd9b2da2009d2979c7f9

data/README.md

@@ -91,16 +91,16 @@ Mailjet.configure do |config|
 end
 ```
 
-`domain` is needed 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)
 
-As easy as:
+First set your delivery method:
 
 ```ruby
-# application.rb
+# application.rb or config/environments specific settings, which take precedence
 config.action_mailer.delivery_method = :mailjet
 
 ```
@@ -114,6 +114,53 @@ config.action_mailer.delivery_method = :mailjet_api
 
 You can use mailjet specific options with `delivery_method_options` as detailed in the official [ActionMailer doc][actionmailerdoc]
 
+Creating a Mailer:
+```ruby
+$ rails generate mailer UserMailer
+
+create  app/mailers/user_mailer.rb
+create  app/mailers/application_mailer.rb
+invoke  erb
+create    app/views/user_mailer
+create    app/views/layouts/mailer.text.erb
+create    app/views/layouts/mailer.html.erb
+invoke  test_unit
+create    test/mailers/user_mailer_test.rb
+create    test/mailers/previews/user_mailer_preview.rb
+```
+
+In the UserMailer class you can set up your email method:
+```ruby
+#app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome_email()
+     mail(from: "me@mailjet.com", to: "you@mailjet.com",
+          subject: "This is a nice welcome email")
+   end
+end
+
+```
+There's also the ability to set [Mailjet custom headers](https://dev.mailjet.com/guides/send-api-guide/)
+```ruby
+#app/mailers/user_mailer.rb
+class UserMailer < ApplicationMailer
+  def welcome_email()
+      mail.header['X-MJ-CustomID'] = 'custom value'
+      mail.header['X-MJ-EventPayload'] = 'custom payload'
+    mail(from: "me@mailjet.com", to: "you@mailjet.com",
+          subject: "This is a nice welcome email")
+  end
+end
+```
+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)
+
+
+
 ## Manage your campaigns
 
 This gem provide a convenient wrapper for consuming the mailjet API. The wrapper is highly inspired by [ActiveResource][activeresource] even though it does not depend on it.
@@ -207,7 +254,13 @@ Mailjet::MessageDelivery.create(from: "me@example.com", to: ["you@example.com",
 
 In order to Mailjet modifiers, you cannot use the regular form of Ruby 2 hashes. Instead, use a String `e.g.: 'mj-prio' => 2` or a quoted symbol `e.g.: 'mj-prio' => 2`.
 
-You can check available params in the [official doc][send-api-doc].
+In these modifiers, there is now the ability to add a Mailjet custom-id or Mailjet Custom payload using the following:
+```ruby
+'mj-customid' => "A useful custom ID"
+'mj-eventpayload' => '{"message": "hello world"}'
+```
+
+For more information on custom properties and available params, see the [official doc][send-api-doc].
 
 ## Track email delivery
 

data/lib/mailjet/connection.rb

@@ -15,11 +15,22 @@ module Mailjet
     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.public_operations = options[:public_operations] || []
       self.read_only = options[:read_only]
-      self.adapter = adapter_class.new(end_point, options.merge(user: api_key, password: secret_key))
+      # 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'))
     end
 
     def get(additional_headers = {}, &block)
@@ -41,12 +52,13 @@ module Mailjet
     private
 
     def handle_api_call(method, additional_headers = {}, payload = {}, &block)
+      format_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, payload, additional_headers, &block)
+        @adapter.send(method, format_payload, additional_headers, &block)
       end
     rescue RestClient::Exception => e
       handle_exeception(e, additional_headers, payload)

data/lib/mailjet/mailer.rb

@@ -22,7 +22,7 @@ ActionMailer::Base.add_delivery_method :mailjet, Mailjet::Mailer
 class Mailjet::APIMailer
   def initialize(options = {})
     ActionMailer::Base.default(:from => Mailjet.config.default_from) if Mailjet.config.default_from.present?
-    @delivery_method_options = options.slice(:'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign', :'mj-trackopen', :'mj-trackclick', :'header')
+    @delivery_method_options = options.slice(:'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign', :'mj-trackopen', :'mj-trackclick', :'mj-customid', :'mj-eventpayload', :'header')
   end
 
   def deliver!(mail)
@@ -43,7 +43,9 @@ class Mailjet::APIMailer
       to: mail.to,
       cc: mail.cc,
       bcc: mail.bcc,
-      subject: mail.subject
+      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/message_delivery.rb

@@ -5,6 +5,6 @@ module Mailjet
     include Mailjet::Resource
     self.resource_path = 'v3/send/message'
     self.public_operations = [:post]
-    self.properties = [:from, :sender, :to, :cc, :bcc, :subject, :text, :html, :attachment, :inlineattachment, :header]
+    self.properties = [:from, :sender, :to, :cc, :bcc, :subject, :text, :html, :attachment, :inlineattachment, :header, :'mj-customid', :'mj-eventpayload', :'mj-trackclick']
   end
 end

data/lib/mailjet/resource.rb

@@ -19,10 +19,11 @@ module Mailjet
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :resource_path, :public_operations, :read_only, :filters, :properties, :action
+      cattr_accessor :resource_path, :public_operations, :read_only, :filters, :properties, :action, :non_json_urls
       cattr_writer :connection
 
       def self.connection
+        @non_json_urls = ["v3/send/message"] #urls that don't accept JSON input
         class_variable_get(:@@connection) || default_connection
       end
 
@@ -36,7 +37,11 @@ module Mailjet
       end
 
       def self.default_headers
-        { accept: :json, accept_encoding: :deflate }
+        if @non_json_urls.include?(self.resource_path)#don't use JSON if Send API
+          { accept: :json, accept_encoding: :deflate }
+        else
+          { accept: :json, accept_encoding: :deflate, content_type: :json } #use JSON if *not* Send API
+        end
       end
     end
 

data/lib/mailjet/resources/contactdata.rb

@@ -6,7 +6,7 @@ module Mailjet
     self.resource_path = 'v3/REST/contactdata'
     self.public_operations = [:get, :put, :post, :delete]
     self.filters = [:campaign, :contacts_list, :fields, :is_unsubscribed, :last_activity_at, :recipient, :status]
-    self.properties = [:contact_id, :data, :id]
+    self.properties = [:contact_id, :data, :id, 'ContactID', 'Name', 'Value']
 
   end
 end

data/lib/mailjet/resources/manycontacts.rb

@@ -6,7 +6,7 @@ module Mailjet
     self.resource_path = 'v3/REST/manycontacts'
     self.public_operations = [:post]
     self.filters = []
-    self.properties = [:action, :addresses, :errors, :force, :list, :recipients]
+    self.properties = [:action, :addresses, :errors, :force, :list_id, :recipients]
 
   end
 end

data/lib/mailjet/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Tyler Nappy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -223,20 +223,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -382,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Mailjet a powerful all-in-one email service provider clients can use to get