mailgun-ruby 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0e2728bd22128bd8d8209b0b5b1f6c941501f5a
-  data.tar.gz: b8f2c9a4cccdccd328142fae44a14be8154cb9d6
+  metadata.gz: f7a3d2306cc5f23a9f5b198bbcef7767be64f1bc
+  data.tar.gz: aa73b428690d284c293a89e848359a9f7617476a
 SHA512:
-  metadata.gz: 779520a0342a79b09dbd433f516d969234636b7585d14ab3f7f827a08071611b55b2fc1b81c7aa6215a7ac6fb08535f95a792109a309557e5e612c6be5d02dc1
-  data.tar.gz: 0ad45cd374509486f177649b7d6dd3f3e3df7b14b3c40643657699670f6acb6e0b710200bc1df19a1bc7710795fe654dd6efcd1590e05650de00460898aca0e0
+  metadata.gz: 56e7617f35b16862fee5b06a428d45925447edb12f1d721fdc87e8c382b8db140f40d1de4a5c63de59c96904e1f4322c80097aac7dc3cab838dc2d945922ab42
+  data.tar.gz: ce165c6784831eed9240ef7b51b3ba855bea5066a5b294cbf3450eef321ddc33dd3d879d477b7c23cb8f80f4ac02f9125e26e3432f2273f69ec68ab9483aa928

data/.travis.yml

@@ -1,21 +1,23 @@
 language: ruby
 sudo: false
 rvm:
-- 2.3.1
-- 2.2
-- 2.1
 - 2.0.0
+- 2.1
+- 2.2
+- 2.3.1
 script:
+- bundle install
 - bundle exec rake spec
 - '[[ "${TRAVIS_PULL_REQUEST}" == "false" ]] && ( bundle exec rake spec:integration
   ) || ( echo "Testing PR - No integration tests available")'
 deploy:
   provider: rubygems
   api_key:
-    secure: QTNP+6720w38b8krtvXM25WDEOUxw9BlUwdXgWLrU0MGAOSvVFgnWTJs+7QvGWODjhrIqAfAm11zc+yEpzgD9P8np9cteWv5K7rMxsUMcb14kaGIA+MKO+RRJXlru4teBNX5jtp2GJiNS2mn7urzn5YhE9x9P7pMjcF+j5usoF0=
+    secure: DoX3w48gRyhDM1o1OLvtWsTi8ehLIarIsErzg/UlNRoLacQt5l5UzwD+u6wqsCEr4+c2uAHNahafpnw/j1rPG3LBPIXOK5A0SYbjovlckutiAC0330Q4PHwOZb73AFN1DG5JTeg4/fguEjdsEBdZObF7mh5gBMBQtNjo1Fos+4w=
   gemspec: mailgun.gemspec
   on:
     tags: true
+    condition: "$TRAVIS_RUBY_VERSION == 2.3.1"
 notifications:
   slack:
     rooms:

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.1.2'
+gem 'mailgun-ruby', '~>1.1.4'
 ```
 
 Usage
@@ -67,6 +67,15 @@ end
 ```
 Or have the initializer read your environment setting if you perfer.
 
+To use as the ActionMailer delivery method, add this to your `config/environments/whatever.yml`
+and replace `api-myapikey` and `mydomain.com` with your secret API key and domain, respectively:
+```ruby
+  config.action_mailer.delivery_method = :mailgun
+  config.action_mailer.mailgun_settings = {
+    api_key: 'api-myapikey',
+    domain: 'mydomain.com',
+  }
+```
 
 Response
 --------
@@ -138,15 +147,15 @@ mg_client.send_message("sending_domain.com", message_params)
 ```
 
 For usage examples on each API endpoint, head over to our official documentation
-pages. Or the [Snippets](Snippets.md) file.
+pages. Or the [Snippets](docs/Snippets.md) file.
 
 This SDK includes the following components:
-- [Message Builder](MessageBuilder.md)
-- [Batch Message](MessageBuilder.md)
-- [Opt-In Handler](OptInHandler.md)
-- [Domains](Domains.md)
-- [Webhooks](Webhooks.md)
-- [Events](Events.md)
+- [Message Builder](docs/MessageBuilder.md)
+- [Batch Message](docs/MessageBuilder.md)
+- [Opt-In Handler](docs/OptInHandler.md)
+- [Domains](docs/Domains.md)
+- [Webhooks](docs/Webhooks.md)
+- [Events](docs/Events.md)
 
 Message Builder allows you to quickly create the array of parameters, required
 to send a message, by calling a methods for each parameter.

data/{MessageBuilder.md → docs/MessageBuilder.md}

@@ -24,28 +24,41 @@ mb_obj = Mailgun::MessageBuilder.new()
 
 # Define the from address.
 mb_obj.from("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
+
 # Define a to recipient.
 mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
+
 # Define a cc recipient.
 mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
+
 # Define the subject.
 mb_obj.subject("A message from the Ruby SDK using Message Builder!");
+
 # Define the body of the message.
 mb_obj.body_text("This is the text body of the message!");
+
 # Set the Message-Id header, provide a valid Message-Id.
 mb_obj.message_id("<20141014000000.11111.11111@example.com>")
+
 # Or clear the Message-Id header, provide nil or empty string.
 mb_obj.message_id(nil)
 mb_obj.message_id('')
-# Campaign and other headers.
+
+# Campaigns and headers.
 mb_obj.add_campaign_id("My-Awesome-Campaign");
-mb_obj.add_custom_parameter("h:Customer-Id", "12345");
+mb_obj.header("Customer-Id", "12345");
+
+# Custom variables
+mb_obj.variable("Customer-Data", { :first_name => "John", :last_name => "Smith" })
 
 # Attach a file and rename it.
-mb_obj.add_attachment("/path/to/file/receipt_123491820.pdf", "Receipt.pdf");
+mb_obj.add_attachment "/path/to/file/receipt_123491820.pdf", "Receipt.pdf"
+
+# Attach an image inline.
+mb_obj.add_inline_image "/path/to/file/header.png"
 
 # Schedule message in the future
-mb_obj.delivery_at("tomorrow 8:00AM PST");
+mb_obj.deliver_at("tomorrow 8:00AM PST");
 
 # Finally, send your message using the client
 result = mg_client.send_message("sending_domain.com", mb_obj)
@@ -60,13 +73,16 @@ Here's how to use Batch Message to easily handle batch sending jobs.
 ```ruby
 # First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new("your-api-key")
+
 # Create a Batch Message object, pass in the client and your domain.
 mb_obj = Mailgun::BatchMessage.new(mg_client, "example.com")
 
 # Define the from address.
 mb_obj.from("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
+
 # Define the subject.
 mb_obj.subject("A message from the Ruby SDK using Message Builder!");
+
 # Define the body of the message.
 mb_obj.body_text("This is the text body of the message!");
 

data/{Messages.md → docs/Messages.md}

@@ -50,8 +50,8 @@ mb_obj.set_message_id('')
 
 # Other Optional Parameters.
 mb_obj.add_campaign_id("My-Awesome-Campaign")
-mb_obj.add_custom_parameter("h:Customer-Id", "12345")
-mb_obj.add_attachment("@/tron.jpg")
+mb_obj.header("Customer-Id", "12345")
+mb_obj.add_attachment("./tron.jpg")
 mb_obj.set_delivery_time("tomorrow 8:00AM PST")
 mb_obj.set_click_tracking(true)
 

data/{Snippets.md → docs/Snippets.md}

@@ -75,6 +75,26 @@ mb_obj.set_text_body "This is the text body."
 mg_client.send_message "sending_domain.com", mb_obj
 ```
 
+**Build a message with attachments, part by part, with Message Builder:**
+
+```ruby
+mb_obj = Mailgun::MessageBuilder.new
+
+mb_obj.set_from_address "sender@example.com", {'first' => 'Sending', 'last' => 'User'}
+mb_obj.add_recipient :to, "recipient@example.com", {'first' => 'Recipient', 'last' => 'User'}
+mb_obj.set_subject "This is the subject!"
+mb_obj.set_text_body "This is the text body."
+
+# Add separate attachments
+mb_obj.add_attachment "/path/to/file/invoice_8675309.pdf", "Order Invoice - 8675309.pdf"
+mb_obj.add_attachment "/path/to/file/datasheet_00001.pdf", "Product Datasheet - 00001.pdf"
+
+# Attach inline image to message
+mb_obj.add_inline_image "/path/to/file/product_image_00001.png"
+
+mg_client.send_message "sending_domain.com", mb_obj
+```
+
 **Send batches of 1000 messages per post:**
 
 ```ruby

data/lib/mailgun-ruby.rb

@@ -1 +1,2 @@
-require 'mailgun'
+require 'mailgun'
+require 'railgun' if defined?(Rails)

data/lib/mailgun/client.rb

@@ -62,6 +62,11 @@ module Mailgun
 
       case data
       when Hash
+        # Remove nil values from the data hash
+        # Submitting nils to the API will likely cause an error.
+        #  See also: https://github.com/mailgun/mailgun-ruby/issues/32
+        data = data.select { |k, v| v != nil }
+
         if data.key?(:message)
           if data[:message].is_a?(String)
             data[:message] = convert_string_to_file(data[:message])

data/lib/mailgun/messages/batch_message.rb

@@ -48,7 +48,7 @@ module Mailgun
       send_message if @counters[:recipients][recipient_type] == Mailgun::Chains::MAX_RECIPIENTS
 
       compiled_address = parse_address(address, variables)
-      complex_setter(recipient_type, compiled_address)
+      set_multi_complex(recipient_type, compiled_address)
 
       store_recipient_variables(recipient_type, address, variables) if recipient_type != :from
 
@@ -84,7 +84,7 @@ module Mailgun
     # @return [Boolean]
     def send_message
       rkey = 'recipient-variables'
-      simple_setter rkey, JSON.generate(@recipient_variables)
+      set_multi_simple rkey, JSON.generate(@recipient_variables)
       @message[rkey] = @message[rkey].first if @message.key?(rkey)
 
       response = @client.send_message(@domain, @message).to_h!

data/lib/mailgun/messages/message_builder.rb

@@ -40,7 +40,7 @@ module Mailgun
       end
 
       compiled_address = parse_address(address, variables)
-      complex_setter(recipient_type, compiled_address)
+      set_multi_complex(recipient_type, compiled_address)
 
       @counters[:recipients][recipient_type] += 1 if @counters[:recipients].key?(recipient_type)
     end
@@ -63,14 +63,14 @@ module Mailgun
     # Set the message's Reply-To address.
     #
     # Rationale: According to RFC, only one Reply-To address is allowed, so it
-    # is *okay* to bypass the simple_setter and set reply-to directly.
+    # is *okay* to bypass the set_multi_simple and set reply-to directly.
     #
     # @param [String] address The email address to provide as Reply-To.
     # @param [Hash] variables A hash of variables associated with the recipient.
     # @return [void]
     def reply_to(address, variables = nil)
       compiled_address = parse_address(address, variables)
-      @message["h:reply-to"] = compiled_address
+      header("reply-to", compiled_address)
     end
 
     # Set a subject for the message object
@@ -78,7 +78,7 @@ module Mailgun
     # @param [String] subject The subject for the email.
     # @return [void]
     def subject(subj = nil)
-      simple_setter(:subject, subj)
+      set_multi_simple(:subject, subj)
     end
 
     # Deprecated: Please use "subject" instead.
@@ -92,7 +92,7 @@ module Mailgun
     # @param [String] text_body The text body for the email.
     # @return [void]
     def body_text(text_body = nil)
-      simple_setter(:text, text_body)
+      set_multi_simple(:text, text_body)
     end
 
     # Deprecated: Please use "body_text" instead.
@@ -106,7 +106,7 @@ module Mailgun
     # @param [String] html_body The html body for the email.
     # @return [void]
     def body_html(html_body = nil)
-      simple_setter(:html, html_body)
+      set_multi_simple(:html, html_body)
     end
 
     # Deprecated: Please use "body_html" instead.
@@ -138,7 +138,7 @@ module Mailgun
     # @param [Boolean] mode The boolean or string value (will fix itself)
     # @return [void]
     def test_mode(mode)
-      simple_setter('o:testmode', bool_lookup(mode))
+      set_multi_simple('o:testmode', bool_lookup(mode))
     end
 
     # Deprecated: 'set_test_mode' is depreciated. Please use 'test_mode' instead.
@@ -152,7 +152,7 @@ module Mailgun
     # @param [Boolean] mode The boolean or string value(will fix itself)
     # @return [void]
     def dkim(mode)
-      simple_setter('o:dkim', bool_lookup(mode))
+      set_multi_simple('o:dkim', bool_lookup(mode))
     end
 
     # Deprecated: 'set_dkim' is deprecated. Please use 'dkim' instead.
@@ -168,7 +168,7 @@ module Mailgun
     def add_campaign_id(campaign_id)
       fail(Mailgun::ParameterError, 'Too many campaigns added to message.', campaign_id) if @counters[:attributes][:campaign_id] >= Mailgun::Chains::MAX_CAMPAIGN_IDS
 
-      complex_setter('o:campaign', campaign_id)
+      set_multi_complex('o:campaign', campaign_id)
       @counters[:attributes][:campaign_id] += 1
     end
 
@@ -180,7 +180,7 @@ module Mailgun
       if @counters[:attributes][:tag] >= Mailgun::Chains::MAX_TAGS
         fail Mailgun::ParameterError, 'Too many tags added to message.', tag
       end
-      complex_setter('o:tag', tag)
+      set_multi_complex('o:tag', tag)
       @counters[:attributes][:tag] += 1
     end
 
@@ -189,7 +189,7 @@ module Mailgun
     # @param [Boolean] tracking Boolean true or false.
     # @return [void]
     def track_opens(mode)
-      simple_setter('o:tracking-opens', bool_lookup(mode))
+      set_multi_simple('o:tracking-opens', bool_lookup(mode))
     end
 
     # Deprecated: 'set_open_tracking' is deprecated. Please use 'track_opens' instead.
@@ -203,7 +203,7 @@ module Mailgun
     # @param [String] mode True, False, or HTML (for HTML only tracking)
     # @return [void]
     def track_clicks(mode)
-      simple_setter('o:tracking-clicks', bool_lookup(mode))
+      set_multi_simple('o:tracking-clicks', bool_lookup(mode))
     end
 
     # Depreciated: 'set_click_tracking. is deprecated. Please use 'track_clicks' instead.
@@ -221,7 +221,7 @@ module Mailgun
     # @return [void]
     def deliver_at(timestamp)
       time_str = DateTime.parse(timestamp)
-      simple_setter('o:deliverytime', time_str.rfc2822)
+      set_multi_simple('o:deliverytime', time_str.rfc2822)
     end
 
     # Deprecated: 'set_delivery_time' is deprecated. Please use 'deliver_at' instead.
@@ -238,8 +238,12 @@ module Mailgun
     # @return [void]
     def header(name, data)
       fail(Mailgun::ParameterError, 'Header name for message must be specified') if name.to_s.empty?
-      jsondata = make_json data
-      simple_setter("v:#{name}", jsondata)
+      begin
+        jsondata = make_json data
+        set_single("h:#{name}", jsondata)
+      rescue Mailgun::ParameterError
+        set_single("h:#{name}", data)
+      end
     end
 
     # Deprecated: 'set_custom_data' is deprecated. Please use 'header' instead.
@@ -248,6 +252,19 @@ module Mailgun
       header name, data
     end
 
+    # Attaches custom JSON data to the message. See the following doc page for more info.
+    # https://documentation.mailgun.com/user_manual.html#attaching-data-to-messages
+    #
+    # @param [String] name A name for the custom variable block.
+    # @param [String|Hash] data Either a string or a hash. If it is not valid JSON or
+    #                           can not be converted to JSON, ParameterError will be raised.
+    # @return [void]
+    def variable(name, data)
+      fail(Mailgun::ParameterError, 'Variable name must be specified') if name.to_s.empty?
+      jsondata = make_json data
+      set_single("v:#{name}", jsondata)
+    end
+
     # Add custom parameter to the message. A custom parameter is any parameter that
     # is not yet supported by the SDK, but available at the API. Note: No validation
     # is performed. Don't forget to prefix the parameter with o, h, or v.
@@ -256,7 +273,7 @@ module Mailgun
     # @param [string] data A string of data for the parameter.
     # @return [void]
     def add_custom_parameter(name, data)
-      complex_setter(name, data)
+      set_multi_complex(name, data)
     end
 
     # Set the Message-Id header to a custom value. Don't forget to enclose the
@@ -269,7 +286,7 @@ module Mailgun
     def message_id(data = nil)
       key = 'h:Message-Id'
       return @message.delete(key) if data.to_s.empty?
-      @message[key] = data
+      set_single(key, data)
     end
 
     # Deprecated: 'set_message_id' is deprecated. Use 'message_id' instead.
@@ -280,13 +297,23 @@ module Mailgun
 
     private
 
+    # Sets a single value in the message hash where "multidict" features are not needed.
+    # Does *not* permit duplicate params.
+    #
+    # @param [String] parameter The message object parameter name.
+    # @param [String] value The value of the parameter.
+    # @return [void]
+    def set_single(parameter, value)
+      @message[parameter] = value ? value : ''
+    end
+
     # Sets values within the multidict, however, prevents
     # duplicate values for keys.
     #
     # @param [String] parameter The message object parameter name.
     # @param [String] value The value of the parameter.
     # @return [void]
-    def simple_setter(parameter, value)
+    def set_multi_simple(parameter, value)
       @message[parameter] = value ? [value] : ['']
     end
 
@@ -296,7 +323,7 @@ module Mailgun
     # @param [String] parameter The message object parameter name.
     # @param [String] value The value of the parameter.
     # @return [void]
-    def complex_setter(parameter, value)
+    def set_multi_complex(parameter, value)
       @message[parameter] << (value || '')
     end
 
@@ -327,9 +354,9 @@ module Mailgun
     #
     # Returns a JSON object or raises ParameterError
     def make_json(obj)
-      return JSON.parse(obj).to_s if obj.is_a?(String)
-      return obj.to_s if obj.is_a?(Hash)
-      return JSON.generate(obj).to_s
+      return JSON.parse(obj).to_json if obj.is_a?(String)
+      return obj.to_json if obj.is_a?(Hash)
+      return JSON.generate(obj).to_json
     rescue
       raise Mailgun::ParameterError, 'Provided data could not be made into JSON. Try a JSON string or Hash.', obj
     end
@@ -371,7 +398,7 @@ module Mailgun
         attachment.instance_variable_set :@original_filename, filename
         attachment.instance_eval 'def original_filename; @original_filename; end'
       end
-      complex_setter(disposition, attachment)
+      set_multi_complex(disposition, attachment)
     end
   end
 

data/lib/mailgun/version.rb

@@ -1,4 +1,4 @@
 # It's the version. Yeay!
 module Mailgun
-  VERSION = '1.1.3'
+  VERSION = '1.1.4'
 end

data/lib/railgun.rb

@@ -1,6 +1,4 @@
-require 'action_mailer'
-require 'active_support/rescuable'
-
+require 'railgun/railtie'
 require 'railgun/attachment'
 require 'railgun/errors'
 require 'railgun/mailer'

data/lib/railgun/mailer.rb

@@ -158,5 +158,3 @@ module Railgun
   end
 
 end
-
-ActionMailer::Base.add_delivery_method :mailgun, Railgun::Mailer

data/lib/railgun/railtie.rb

@@ -0,0 +1,9 @@
+require 'railgun/mailer'
+
+module Railgun
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      ActionMailer::Base.add_delivery_method :mailgun, Railgun::Mailer
+    end
+  end
+end

data/mailgun.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version          = Mailgun::VERSION
   spec.homepage         = 'http://www.mailgun.com'
   spec.platform         = Gem::Platform::RUBY
-  spec.license          = 'Apache'
+  spec.license          = 'Apache-2.0'
 
   spec.summary          = "Mailgun's Official Ruby SDK"
   spec.description      = "Mailgun's Official Ruby SDK for interacting with the Mailgun API."

data/spec/unit/messages/message_builder_spec.rb

@@ -485,19 +485,31 @@ describe 'The method header' do
   it 'accepts valid JSON and appends as data to the message.' do
     @mb_obj.header('my-data', '{"key":"value"}')
 
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"key"=>"value"}')
+    expect(@mb_obj.message["h:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["h:my-data"].to_s).to eq('{"key":"value"}')
+  end
+end
+
+describe 'The method variable' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'accepts valid JSON and stores it as message[param].' do
+    @mb_obj.variable('my-data', '{"key":"value"}')
+
+    expect(@mb_obj.message["v:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["v:my-data"].to_s).to eq('{"key":"value"}')
   end
   it 'accepts a hash and appends as data to the message.' do
     data = {'key' => 'value'}
-    @mb_obj.header('my-data', data)
+    @mb_obj.variable('my-data', data)
 
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"key"=>"value"}')
+    expect(@mb_obj.message["v:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["v:my-data"].to_s).to eq('{"key":"value"}')
   end
   it 'throws an exception on broken JSON.' do
     data = 'This is some crappy JSON.'
-    expect {@mb_obj.header('my-data', data)}.to raise_error(Mailgun::ParameterError)
+    expect {@mb_obj.variable('my-data', data)}.to raise_error(Mailgun::ParameterError)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,17 +134,17 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-env.yml.example"
 - ".travis.yml"
-- Domains.md
-- Events.md
 - Gemfile
 - LICENSE
-- MessageBuilder.md
-- Messages.md
-- OptInHandler.md
 - README.md
 - Rakefile
-- Snippets.md
-- Webhooks.md
+- docs/Domains.md
+- docs/Events.md
+- docs/MessageBuilder.md
+- docs/Messages.md
+- docs/OptInHandler.md
+- docs/Snippets.md
+- docs/Webhooks.md
 - lib/mailgun-ruby.rb
 - lib/mailgun.rb
 - lib/mailgun/address.rb
@@ -165,6 +165,7 @@ files:
 - lib/railgun/errors.rb
 - lib/railgun/mailer.rb
 - lib/railgun/message.rb
+- lib/railgun/railtie.rb
 - mailgun.gemspec
 - spec/integration/bounces_spec.rb
 - spec/integration/campaign_spec.rb
@@ -209,7 +210,7 @@ files:
 - vcr_cassettes/webhooks.yml
 homepage: http://www.mailgun.com
 licenses:
-- Apache
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []