mailjet 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce7a69f28969e1a632cc70e07a8a04b973576f5f
-  data.tar.gz: 3a7bf17b3fd83efeb88427b6bc09f184d41b9996
+  metadata.gz: 7240913ecc6542f14a4c9cc7078347f4c55032a3
+  data.tar.gz: 70d23c920e3b4d1e45d843eab8034fff9e2086bf
 SHA512:
-  metadata.gz: 3043cf5a15c67cb008677ea98b439ef656e5ce5f6bcad3f3fba3497ea1dae6f8f99e637d7a27cb07c11ee1f12d46e4e30b573ea01258e1901f32cdc6a4c7a5c2
-  data.tar.gz: 672355e584024830232f12dcbea25e1d6e5ac543ddf56476cd2a64b55e45b9a920eb4f667a7e08ae6f9ca5f0a7bf6f0d22812013705ecf49bac69ad70e344e5d
+  metadata.gz: 2bf10f5fd0dd62f207b1d84ee7bb178c31a2501a291b2983cfa391707e10e95b73d4e087fdf66713cf99cfd05f5863f51748eb1f11b8964339ad38073132f031
+  data.tar.gz: 1db8b006b9c5393fa185ba0dd36964e4bbb2395e9294a35d8ca76a2a170a2a8f397e623c1a9838c02e219a30b43f1214929058ea1ca9a0706d52d4150be809b1

data/README.md

@@ -103,6 +103,13 @@ end
 
 `default_from` is optional if you send emails with `:mailjet`'s SMTP (below)
 
+But if you are using Mailjet with Rails, you can simply generate it:
+
+```shell
+$ rails generate mailjet:initializer
+```
+
+
 ### Send emails via the Send API
 
 Find more about the Mailjet Send API in the [official guides](http://dev.mailjet.com/guides/?ruby#choose-sending-method)
@@ -229,7 +236,7 @@ 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:
 ```ruby
 # In this example, we are sending the email immediately
 UserMailer.welcome_email.deliver_now!
@@ -360,15 +367,15 @@ 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.
+In order to send emails through the API, you just have to `create` a new `Send` resource.
 
 ``` ruby
-Mailjet::MessageDelivery.create(from: "me@example.com", to: "you@example.com", subject: "Mailjet is awesome", text: "Yes, it is!")
+Mailjet::Send.create(from_email: "me@example.com", to: "you@example.com", subject: "Mailjet is awesome", text_part: "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!")
+Mailjet::Send.create(from_email: "me@example.com", to: "you@example.com, someone-else@example.com", subject: "Mailjet is awesome", text_part: "Yes, it is!")
 ```
 
 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`.

data/lib/generators/mailjet/initializer_generator.rb

@@ -0,0 +1,35 @@
+module Mailjet
+  class InitializerGenerator < Rails::Generators::Base
+    desc 'This generator creates an initializer file mailjet.rb at config/initializers'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_initializer_file
+      config_file_path = 'config/initializers/mailjet.rb'
+
+      say('Hey! We’re about to configure your Mailjet credentials for your application.')
+      say('You can find them on your account (https://app.mailjet.com/account/api_keys).')
+      say('Please help yourself by providing some intel:')
+
+      @api_key =      ask('API key: ')
+      @secret_key =   ask('Secret key: ')
+      @default_from = ask('Sender address:')
+
+      say("Don't forget that your sender address '#{@default_from}' has to be validated first on https://app.mailjet.com/account/sender.")
+
+      if @api_v3_1 = yes?('Do you want to use Mailjet API v3.1 for sending your emails? (y/n)')
+        @api_v3_1_notice = %{
+Mailjet API v3.1 is at the moment limited to Send API.
+We’ve not set the version to it directly since there is no other endpoint in that version.
+We recommend you create a dedicated instance of the wrapper set with it to send your emails.
+If you're only using the gem to send emails, then you can safely set it to this version.
+Otherwise, you can remove the dedicated line into #{config_file_path}.
+
+}
+        say(@api_v3_1_notice)
+      end
+
+      template 'mailjet.rb.erb', config_file_path
+    end
+  end
+end

data/lib/generators/mailjet/templates/mailjet.rb.erb

@@ -0,0 +1,8 @@
+# kindly generated by appropriated Rails generator
+Mailjet.configure do |config|
+  config.api_key = '<%= @api_key %>'
+  config.secret_key = '<%= @secret_key %>'
+  config.default_from = '<%= @default_from %>'
+<% if @api_v3_1 %><%= @api_v3_1_notice.split("\n").reject(&:empty?).map{ |l| '  # ' + l }.join("\n") %>
+  config.api_version = 'v3.1'<% end %>
+end

data/lib/mailjet/mailer.rb

@@ -26,46 +26,48 @@ ActionMailer::Base.add_delivery_method :mailjet, Mailjet::Mailer
 # Mailjet sends API expects a JSON payload as the input.
 # The deliver methods maps the Mail::Message attributes to the MailjetSend API JSON expected structure
 class Mailjet::APIMailer
-  def initialize(options = {})
-#    send = Mailjet.Send.new
-#    if send.version.exists
-#      version = send.version
-#    else
-      @version = Mailjet.config.api_version
-#    end
-    @delivery_method_options_v3_0 = options.slice(
-      :api_key, :secret_key,
-      :recipients, :'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign',
-      :'mj-templatelanguage', :'mj-templateerrorreporting', :'mj-templateerrordeliver', :'mj-templateid',
-      :'mj-trackopen', :'mj-trackclick',
-      :'mj-customid', :'mj-eventpayload', :vars, :headers,
-    )
-    @delivery_method_options_v3_1 = options.slice(
-      :api_key, :secret_key,
-      :'Priority', :'CustomCampaign', :'DeduplicateCampaign',
-      :'TemplateLanguage', :'TemplateErrorReporting', :'TemplateErrorDeliver', :'TemplateID',
-      :'TrackOpens', :'TrackClicks',
-      :'CustomID', :'EventPayload', :'Variables', :'Headers',
-    )
+  V3_0_PERMITTED_OPTIONS = [
+    :recipients, :'mj-prio', :'mj-campaign', :'mj-deduplicatecampaign',
+    :'mj-templatelanguage', :'mj-templateerrorreporting', :'mj-templateerrordeliver', :'mj-templateid',
+    :'mj-trackopen', :'mj-trackclick',
+    :'mj-customid', :'mj-eventpayload', :vars, :headers,
+  ]
+
+  V3_1_PERMITTED_OPTIONS = [
+    :'Priority', :'CustomCampaign', :'DeduplicateCampaign',
+    :'TemplateLanguage', :'TemplateErrorReporting', :'TemplateErrorDeliver', :'TemplateID',
+    :'TrackOpens', :'TrackClicks',
+    :'CustomID', :'EventPayload', :'Variables', :'Headers',
+  ]
+
+  CONNECTION_PERMITTED_OPTIONS = [:api_key, :secret_key]
+
+  def initialize(opts = {})
+    options = HashWithIndifferentAccess.new(opts)
+
+    @version = options[:version]
+    @delivery_method_options_v3_0 = options.slice(*V3_0_PERMITTED_OPTIONS)
+    @delivery_method_options_v3_1 = options.slice(*V3_1_PERMITTED_OPTIONS)
+    @connection_options = options.slice(*CONNECTION_PERMITTED_OPTIONS)
   end
 
-  def deliver!(mail, options = {})
+  def deliver!(mail, opts = {})
+    options = HashWithIndifferentAccess.new(opts)
 
-    if (options && options.kind_of?(Object) && options['version'].present?)
-      @version = options['version']
-    end
+    # Mailjet Send API does not support full from. Splitting the from field into two: name and email address
+    mail[:from] ||= Mailjet.config.default_from if Mailjet.config.default_from
 
-    if (!options.kind_of?(Object))
-      options = []
-    end
+    # add `@connection_options` in `options` only if not exist yet (values in `options` prime)
+    options.reverse_merge!(@connection_options)
 
-    # Mailjet Send API does not support full from. Splitting the from field into two: name and email address
-    if mail[:from].nil? && Mailjet.config.default_from.present?
-      mail[:from] = Mailjet.config.default_from
-    end
+    # add `@version` in options if set
+    options[:version] = @version if @version
+
+    # `options[:version]` primes on global config
+    version = options[:version] || Mailjet.config.api_version
 
-    if (@version == 'v3.1')
-      Mailjet::Send.create({:Messages => [setContentV3_1(mail)]}, options)
+    if (version == 'v3.1')
+      Mailjet::Send.create({ :Messages => [setContentV3_1(mail)] }, options)
     else
       Mailjet::Send.create(setContentV3_0(mail), options)
     end

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]
+
     NON_JSON_URLS = ['v3/send/message'] # urls that don't accept JSON input
 
     included do
@@ -56,7 +59,7 @@ 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))
         attribute_array = parse_api_json(response)
@@ -64,7 +67,7 @@ module Mailjet
       end
 
       def count(options = {})
-        opts = change_resource_path(options)
+        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']
@@ -72,7 +75,7 @@ module Mailjet
 
       def find(id, job_id = nil, 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, job_id) if self.action
         #
         attributes = parse_api_json(connection(opts)[id].get(default_headers)).first
@@ -88,7 +91,7 @@ module Mailjet
 
       def create(attributes = {}, 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(attributes[:id]) if self.action
         attributes.tap { |hs| hs.delete(:id) }
 
@@ -110,7 +113,7 @@ module Mailjet
 
       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(opts)[id].delete(default_headers)
       end
@@ -211,26 +214,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
@@ -246,7 +237,7 @@ module Mailjet
     end
 
     def save(options = {})
-      opts = self.class.change_resource_path(options)
+      opts = self.class.define_options(options)
 
       if persisted?
         # case where the entity is updated
@@ -297,7 +288,7 @@ module Mailjet
         end
       end
 
-      opts = self.class.change_resource_path(options)
+      opts = self.class.define_options(options)
       save(opts)
     end
 

data/lib/mailjet/version.rb

@@ -1,3 +1,3 @@
 module Mailjet
-  VERSION = "1.5.3"
+  VERSION = "1.5.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailjet
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.5.4
 platform: ruby
 authors:
 - Tyler Nappy
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -277,6 +277,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- 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
@@ -374,7 +376,17 @@ files:
 homepage: http://www.mailjet.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |2+
+
+    The Ruby wrapper for Mailjet has just been installed successfully, congrats!
+    Maybe you want to configure your credentials to use your account.
+    All informations available on https://github.com/mailjet/mailjet-gem.
+    But if you are using Rails, you'll be glad to generate it easily using:
+
+      $ rails generate mailjet:initializer
+
+    We hope you will enjoy Mailjet!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -390,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Mailjet a powerful all-in-one email service provider clients can use to get