mailgun-ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d2289f0c188dd1fd14e9560f3e7f9d8b14e9193
-  data.tar.gz: 35e39b90b7185d846a515c642b7eb2340f09d37d
+  metadata.gz: 523ed8383a3318e626e33482a72431daf0453235
+  data.tar.gz: 67a635eb9b247d1fdaeaf2cb1e2944d2b85261d5
 SHA512:
-  metadata.gz: ad0617bd4042f6dc27561c5ee864ec84f034f40c2b2fde569d996e10adfe830dbc9983d71b1be34dfd236154918c2659d1cebdee0487cb7e70f7685419037503
-  data.tar.gz: 39002d5ffd24977418dadc676925df6503cd09aa73122bf3c5c2b15fac8575dcf3717e4a11b4d28229b283123c35ccf0b8aaaffb47c63b75dc5b9f201bf5fcde
+  metadata.gz: 9f3a6cfd00e2c88bc755411b4953139bd6115062236904edce82334d495b7edc4e529ad01f8e0ed68e35974105d0763f6175dbb5da2be44deb7b488ccc7391ba
+  data.tar.gz: df50ed26167e1cf88271ca954a0b084da8b135c006b2a27fe2050e3f10b7b795e6b4b283be159fbee0b5b8507aba899881e8d311ff670e18aba0523c275c0f7f

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.2.0-preview1
+gemfile:
+  - Gemfile
+script:
+  - bundle exec rake spec

data/Events.md

@@ -0,0 +1,46 @@
+Mailgun - Events
+====================
+
+This is the Mailgun Ruby *Events* utility.
+
+The below assumes you've already installed the Mailgun Ruby SDK in your project.
+If not, go back to the master README for a few quick install steps.
+
+Events: Provides methods for traversing the Mailgun Events API.
+
+
+Usage - Events
+-----------------------------------------------------
+Here's how to use the Events Handler to pull events.
+
+```ruby
+# First, instantiate the SDK with your API credentials, domain, and required parameters for example.
+mg_client = Mailgun::Client.new("your-api-key")
+mg_events = Mailgun::Events.new(mg_client, "your-domain")
+
+result = mg_events.get({'limit' => 25,
+                        'recipient' => 'joe@example.com'})
+
+result.to_h['items'].each do | item |
+    # outputs "Delivered - 20140509184016.12571.48844@example.com"
+    puts "#{item['event']} - #{item['message']['headers']['message-id']}"
+end
+
+# Want more results?
+result = mg_events.next
+
+# Go backwards?
+result = mg_events.previous
+```
+
+A few notes:  
+1. Next will use the pagination links to advance the result set.
+Retain the mg_events object to query forward, or reverse, at any time.  
+2. If the result set is less than your limit, do not worry. A
+second query against "next" will return the next 25 results since the
+last time you called "next".
+
+More Documentation
+------------------
+See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
+for more information.

data/MessageBuilder.md

@@ -32,7 +32,11 @@ mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" =
 mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
 # Define the body of the message.
 mb_obj.set_text_body("This is the text body of the message!");
-
+# Set the Message-Id header, provide a valid Message-Id.
+mb_obj.set_message_id("<20141014000000.11111.11111@example.com>")
+# Or clear the Message-Id header, provide nil or empty string.
+mb_obj.set_message_id(nil)
+mb_obj.set_message_id('')
 # Campaign and other headers.
 mb_obj.add_campaign_id("My-Awesome-Campaign");
 mb_obj.add_custom_parameter("h:Customer-Id", "12345");
@@ -57,7 +61,7 @@ Here's how to use Batch Message to easily handle batch sending jobs.
 # 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(@mb_client, "example.com")
+mb_obj = Mailgun::BatchMessage.new(mg_client, "example.com")
 
 # Define the from address.
 mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
@@ -75,7 +79,7 @@ mb_obj.add_recipient(:to, "bob.doe@example.com", {"first" => "Bob", "last" => "D
 mb_obj.add_recipient(:to, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
 
 # Call finalize to get a list of message ids and totals.
-message_ids = mg_client.finalize
+message_ids = mb_obj.finalize
 # {'id1234@example.com' => 1000, 'id5678@example.com' => 15}
 ```
 

data/Messages.md

@@ -21,7 +21,7 @@ Here's how to use Message Builder to build your Message.
 ```ruby
 # First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new("your-api-key")
-mb_obj = Mailgun::MessageBuilder.new(@mb_client, "example.com")
+mb_obj = Mailgun::MessageBuilder.new
 
 # Define the from address.
 mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
@@ -33,7 +33,11 @@ mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" =
 mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
 # Define the body of the message.
 mb_obj.set_text_body("This is the text body of the message!");
-
+# Set the Message-Id header. Pass in a valid Message-Id.
+mb_obj.set_message_id("<20141014000000.11111.11111@example.com>")
+# Clear the Message-Id header. Pass in nil or empty string.
+mb_obj.set_message_id(nil)
+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");
@@ -52,23 +56,35 @@ 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")
-mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+mb_obj = Mailgun::BatchMessage.new(mg_client, "example.com")
 
 # Define the from address.
 mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
 # Define the subject.
 mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
 # Define the body of the message.
-mb_obj.set_text_body("This is the text body of the message!");
+mb_obj.set_text_body("Hello %recipient.first%, 
+                     This is the text body of the message 
+                     using recipient variables!
+                     If you need to include custom data, 
+                     you could do it like this: %account-id%.");
 
-mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
-mb_obj.add_recipient(:to, "jane.doe@example.com", {"first" => "Jane", "last" => "Doe"});
-mb_obj.add_recipient(:to, "bob.doe@example.com", {"first" => "Bob", "last" => "Doe"});
+mb_obj.add_recipient(:to, "john.doe@example.com", {"first"      => "John", 
+                                                   "last"       => "Doe", 
+                                                   "account-id" => 1234});
+mb_obj.add_recipient(:to, "jane.doe@example.com", {"first"      => "Jane", 
+                                                   "last"       => "Doe", 
+                                                   "account-id" => 5678});
+mb_obj.add_recipient(:to, "bob.doe@example.com", {"first"       => "Bob", 
+                                                  "last"        => "Doe", 
+                                                  "account-id"  => 91011});
 ...
-mb_obj.add_recipient(:to, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
+mb_obj.add_recipient(:to, "sally.doe@example.com", {"first"      => "Sally", 
+                                                    "last"       => "Doe", 
+                                                    "account-id" => 121314});
 
 # Send your message through the client
-message_ids = mg_client.finalize
+message_ids = mb_obj.finalize
 ```
 
 More Documentation

data/README.md

@@ -1,6 +1,8 @@
 Mailgun-Ruby
 ============
 
+[![Build Status](https://travis-ci.org/mailgun/mailgun-ruby.svg?branch=master)](https://travis-ci.org/mailgun/mailgun-ruby) [![Gem Version](https://badge.fury.io/rb/mailgun-ruby.svg)](http://badge.fury.io/rb/mailgun-ruby)
+
 This is the Mailgun Ruby Library. This library contains methods for easily interacting
 with the Mailgun API.
 Below are examples to get you started. For additional examples, please see our
@@ -18,7 +20,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', "~>1.0.2"
+gem 'mailgun-ruby', '~>1.0.3', require: 'mailgun'
 ```
 
 Include
@@ -128,7 +130,7 @@ For usage examples on each API endpoint, head over to our official documentation
 pages. Or the [Snippets](Snippets.md) file.
 
 This SDK includes a [Message Builder](Messages.md),
-[Batch Message](Messages.md) and [Opt-In Handler](OptInHandler.md) component.
+[Batch Message](Messages.md), [Opt-In Handler](OptInHandler.md) and [Events](Events.md) component.
 
 Message Builder allows you to quickly create the array of parameters, required
 to send a message, by calling a methods for each parameter.
@@ -146,5 +148,5 @@ information about our API.
 If you find a bug, please submit the issue in Github directly.
 [Mailgun-Ruby Issues](https://github.com/mailgun/mailgun-ruby/issues)
 
-As always, if you need additional assistance, drop us a note at
-[support@mailgun.com](mailto:support@mailgun.com).
+As always, if you need additional assistance, drop us a note through your Control Panel at
+[https://mailgun.com/cp/support](https://mailgun.com/cp/support).

data/Snippets.md

@@ -83,6 +83,7 @@ bm_obj = Mailgun::BatchMessage.new
 
 # Build message using Message Builder
 bm_obj.set_from_address :from, "sender@example.com", {'first' => 'Sending', 'last' => 'User'}
+bm_obj.set_message_id("<20141014000000.11111.11111@example.com>") # optional
 bm_obj.set_subject :subject, "This is the subject!"
 bm_obj.set_text_body :text, "This is the text body."
 

data/lib/mailgun.rb

@@ -70,7 +70,7 @@ module Mailgun
         response = @http_client[resource_path].post(data)
         Response.new(response)
       rescue Exception => e
-        raise CommunicationError.new(e), e.response
+        communication_error e
       end
     end
 
@@ -91,7 +91,7 @@ module Mailgun
         end
         Response.new(response)
       rescue Exception => e
-        raise CommunicationError.new(e), e.response
+        communication_error e
       end
     end
 
@@ -108,7 +108,7 @@ module Mailgun
         response = @http_client[resource_path].put(data)
         Response.new(response)
       rescue Exception => e
-        raise CommunicationError.new(e), e.response
+        communication_error e
       end
     end
 
@@ -123,7 +123,7 @@ module Mailgun
         response = @http_client[resource_path].delete()
         Response.new(response)
       rescue Exception => e
-        raise CommunicationError.new(e), e.response
+        communication_error e
       end
     end
 
@@ -156,6 +156,18 @@ module Mailgun
         "#{scheme}://#{api_host}"
       end
     end
+
+    # Raises CommunicationError and stores response in it if present
+    #
+    # @param [Exception] e upstream exception object
+
+    def communication_error(e)
+      if e.respond_to? :response
+        raise CommunicationError.new(e.message, e.response)
+      else
+        raise CommunicationError.new(e.message)
+      end
+    end
   end
 
   # A Mailgun::Response object is instantiated for each response generated

data/lib/mailgun/exceptions/exceptions.rb

@@ -1,27 +1,20 @@
 module Mailgun
 
-  class ParameterError < RuntimeError
+  class Error < RuntimeError
     attr_reader :object
 
     def initialize(message=nil, object=nil)
+      @message = message
       @object = object
     end
-  end
-
-  class CommunicationError < RuntimeError
-    attr_reader :object
 
-    def initialize(message=nil, object=nil)
-      @object = object
+    def to_s
+      @message || self.class.to_s
     end
   end
 
-  class ParseError < RuntimeError
-    attr_reader :object
-
-    def initialize(message=nil, object=nil)
-      @object = object
-    end
-  end
+  class ParameterError     < Error; end
+  class CommunicationError < Error; end
+  class ParseError         < Error; end
 
 end

data/lib/mailgun/lists/opt_in_handler.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'uri'
 require 'base64'
-require 'digest/hmac'
+require 'openssl'
 
 module Mailgun
 
@@ -21,7 +21,8 @@ module Mailgun
 
       innerPayloadEncoded = Base64.encode64(JSON.generate(innerPayload))
 
-      digest = Digest::HMAC.hexdigest(innerPayloadEncoded, secret_app_id, Digest::SHA1)
+      sha1_digest = OpenSSL::Digest.new('sha1')
+      digest = OpenSSL::HMAC.hexdigest(sha1_digest, secret_app_id, innerPayloadEncoded)
 
       outerPayload = {'h' => digest,
                       'p' => innerPayloadEncoded}
@@ -40,7 +41,8 @@ module Mailgun
     def self.validate_hash(secret_app_id, unique_hash)
       outerPayload = JSON.parse(Base64.decode64(URI.unescape(unique_hash)))
 
-      generated_hash = Digest::HMAC.hexdigest(outerPayload['p'], secret_app_id, Digest::SHA1)
+      sha1_digest = OpenSSL::Digest.new('sha1')
+      generated_hash = OpenSSL::HMAC.hexdigest(sha1_digest, secret_app_id, outerPayload['p'])
 
       innerPayload = JSON.parse(Base64.decode64(URI.unescape(outerPayload['p'])))
 

data/lib/mailgun/messages/batch_message.rb

@@ -96,6 +96,9 @@ module Mailgun
 
     def send_message(message)
       simple_setter("recipient-variables", JSON.generate(@recipient_variables))
+      if @message.has_key?("recipient-variables")
+        @message["recipient-variables"] = @message["recipient-variables"].first
+      end
       response = @client.send_message(@domain, @message).to_h!
       message_id = response['id'].gsub(/\>|\</, '')
       @message_ids[message_id] = count_recipients()

data/lib/mailgun/messages/message_builder.rb

@@ -8,11 +8,11 @@ module Mailgun
   # generation through your code, this class is for you.
   #
   # See the Github documentation for full examples.
-
   class MessageBuilder
 
     attr_reader :message, :counters
 
+
     def initialize()
       @message = Hash.new{|hash, key| hash[key] = []}
       @counters = {:recipients  =>
@@ -26,13 +26,13 @@ module Mailgun
                     :tag           => 0}}
     end
 
+
     # Adds a specific type of recipient to the message object.
     #
     # @param [String] recipient_type The type of recipient. "to", "cc", "bcc" or "h:reply-to".
     # @param [String] address The email address of the recipient to add to the message object.
     # @param [Hash] variables A hash of the variables associated with the recipient. We recommend "first" and "last" at a minimum!
     # @return [void]
-
     def add_recipient(recipient_type, address, variables=nil)
       if (@counters[:recipients][recipient_type] == 1000)
         raise ParameterError.new("Too many recipients added to message.", address)
@@ -46,49 +46,49 @@ module Mailgun
       end
     end
 
+
     # Sets the from address for the message
     #
     # @param [String] address The address of the sender.
     # @param [Hash] variables A hash of the variables associated with the recipient. We recommend "first" and "last" at a minimum!
     # @return [void]
-
     def set_from_address(address, variables=nil)
       add_recipient("from", address, variables)
     end
 
+
     # Set a subject for the message object
     #
     # @param [String] subject The subject for the email.
     # @return [void]
-
     def set_subject(subject=nil)
       simple_setter(:subject, subject)
     end
 
+
     # Set a text body for the message object
     #
     # @param [String] text_body The text body for the email.
     # @return [void]
-
     def set_text_body(text_body=nil)
       simple_setter(:text, text_body)
     end
 
+
     # Set a html body for the message object
     #
     # @param [String] html_body The html body for the email.
     # @return [void]
-
     def set_html_body(html_body=nil)
       simple_setter(:html, html_body)
     end
 
+
     # Adds a series of attachments, when called upon.
     #
     # @param [String] attachment A file object for attaching as an attachment.
     # @param [String] filename The filename you wish the attachment to be.
     # @return [void]
-
     def add_attachment(attachment, filename=nil)
       if attachment.is_a?(String)
         attachment = File.open(attachment, "r")
@@ -102,12 +102,12 @@ module Mailgun
       complex_setter(:attachment, attachment)
     end
 
+
     # Adds an inline image to the mesage object.
     #
     # @param [String] inline_image A file object for attaching an inline image.
     # @param [String] filename The filename you wish the inline image to be.
     # @return [void]
-
     def add_inline_image(inline_image, filename=nil)
       if inline_image.is_a?(String)
         inline_image = File.open(inline_image, "r")
@@ -121,29 +121,29 @@ module Mailgun
       complex_setter(:inline, inline_image)
     end
 
+
     # Send a message in test mode. (The message won't really be sent to the recipient)
     #
     # @param [Boolean] test_mode The boolean or string value (will fix itself)
     # @return [void]
-
     def set_test_mode(test_mode)
       simple_setter("o:testmode", bool_lookup(test_mode))
     end
 
+
     # Turn DKIM on or off per message
     #
     # @param [Boolean] dkim The boolean or string value(will fix itself)
     # @return [void]
-
     def set_dkim(dkim)
       simple_setter("o:dkim", bool_lookup(dkim))
     end
 
+
     # Add campaign IDs to message. Limit of 3 per message.
     #
     # @param [String] campaign_id A defined campaign ID to add to the message.
     # @return [void]
-
     def add_campaign_id(campaign_id)
       if (@counters[:attributes][:campaign_id] == 3)
         raise ParameterError.new("Too many campaigns added to message.", campaign_id)
@@ -151,12 +151,12 @@ module Mailgun
       complex_setter("o:campaign", campaign_id)
       @counters[:attributes][:campaign_id] += 1
     end
-
+    
+    
     # Add tags to message. Limit of 3 per message.
     #
     # @param [String] tag A defined campaign ID to add to the message.
     # @return [void]
-
     def add_tag(tag)
       if (@counters[:attributes][:tag] == 3)
         raise ParameterError.new("Too many tags added to message.", tag)
@@ -165,24 +165,25 @@ module Mailgun
       @counters[:attributes][:tag] += 1
     end
 
+    
     # Turn Open Tracking on and off, on a per message basis.
     #
     # @param [Boolean] tracking Boolean true or false.
     # @return [void]
-
     def set_open_tracking(tracking)
       simple_setter("o:tracking-opens", bool_lookup(tracking))
     end
-
+    
+    
     # Turn Click Tracking on and off, on a per message basis.
     #
     # @param [String] tracking True, False, or HTML (for HTML only tracking)
     # @return [void]
-
     def set_click_tracking(tracking)
       simple_setter("o:tracking-clicks", bool_lookup(tracking))
     end
 
+    
     # Enable Delivery delay on message. Specify an RFC2822 date, and Mailgun
     # will not deliver the message until that date/time. For conversion
     # options, see Ruby "Time". Example: "October 25, 2013 10:00PM CST" will
@@ -190,19 +191,18 @@ module Mailgun
     #
     # @param [String] timestamp A date and time, including a timezone.
     # @return [void]
-
     def set_delivery_time(timestamp)
       time_str = DateTime.parse(timestamp)
       simple_setter("o:deliverytime", time_str.rfc2822)
     end
 
+    
     # Add custom data to the message. The data should be either a hash or JSON
     # encoded. The custom data will be added as a header to your message.
     #
     # @param [string] name A name for the custom data. (Ex. X-Mailgun-<Name of Data>: {})
     # @param [Hash] data Either a hash or JSON string.
     # @return [void]
-
     def set_custom_data(name, data)
       if data.is_a?(Hash)
         data = data.to_json
@@ -218,18 +218,37 @@ module Mailgun
       simple_setter("v:#{name}", data)
     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.
     #
     # @param [string] name A name for the custom parameter.
-    # @param [string] data A string of data for the paramter.
+    # @param [string] data A string of data for the parameter.
     # @return [void]
 
     def add_custom_parameter(name, data)
       complex_setter(name, data)
     end
+    
+
+    # Set the Message-Id header to a custom value. Don't forget to enclose the
+    # Message-Id in angle brackets, and ensure the @domain is present. Doesn't
+    # use simple or complex setters because it should not set value in an array.
+    #
+    # @param [string] data A string of data for the parameter. Passing nil or empty string will delete h:Message-Id key and value from @message hash.
+    # @return [void]
+    def set_message_id(data)
+      key = "h:Message-Id"
+      
+      if data.to_s.empty?
+        @message.delete_if { |k, v| k == key }
+      else
+        @message[key] = data
+      end
+    end
 
+    
     private
 
     # Sets values within the multidict, however, prevents
@@ -238,7 +257,6 @@ module Mailgun
     # @param [String] parameter The message object parameter name.
     # @param [String] value The value of the parameter.
     # @return [void]
-
     def simple_setter(parameter, value)
       if value.nil?
         @message[parameter] = ['']
@@ -247,13 +265,13 @@ module Mailgun
       end
     end
 
+
     # Sets values within the multidict, however, allows
     # duplicate values for keys.
     #
     # @param [String] parameter The message object parameter name.
     # @param [String] value The value of the parameter.
     # @return [void]
-
     def complex_setter(parameter, value)
       if value.nil?
         @message[parameter] << ''
@@ -262,11 +280,11 @@ module Mailgun
       end
     end
 
+    
     # Converts boolean type to string
     #
     # @param [String] value The item to convert
     # @return [void]
-
     def bool_lookup(value)
       if value.is_a?(TrueClass) || value.is_a?(FalseClass)
         return value ? "yes" : "no"
@@ -288,7 +306,6 @@ module Mailgun
     #
     # @param [String] json_ The suspected JSON string.
     # @return [void]
-
     def valid_json? json_
       JSON.parse(json_)
       return true
@@ -303,7 +320,6 @@ module Mailgun
     # @param [String] address The email address to parse.
     # @param [Hash] variables A list of recipient variables.
     # @return [void]
-
     def parse_address(address, variables)
       if variables.nil?
         return address

data/lib/mailgun/version.rb

@@ -1,5 +1,5 @@
 module Mailgun
 
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 
 end

data/mailgun.gemspec

@@ -22,15 +22,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.post_install_message = %q{
-    ---------------------------------------------------------------
-    Congrats, you've successfully installed the Mailgun SDK!
-    Check out our documentation at http://documentation.mailgun.com
-
-    Contact us at support@mailgunhq.com with any questions.
-    ----------------------------------------------------------------
-  }
-
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "rake", "~> 10.1"

data/spec/unit/connection/test_client.rb

@@ -152,26 +152,6 @@ module Mailgun
       end
     end
 
-    def to_h
-      begin
-        JSON.parse(@body)
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
-    # Replace @body with Ruby Hash
-    #
-    # @return [Hash] A standard Ruby Hash containing the HTTP result.
-
-    def to_h!
-      begin
-        @body = JSON.parse(@body)
-      rescue Exception => e
-        raise ParseError.new(e), e
-      end
-    end
-
     # Return response as Yaml
     #
     # @return [String] A string containing response as YAML

data/spec/unit/messages/message_builder_spec.rb

@@ -180,26 +180,26 @@ describe 'The method set_test_mode' do
   end
   it 'turns on test mode with boolean true' do
     @mb_obj.set_test_mode(true)
-    @mb_obj.message["o:testmode"][0].should eq ("yes")
+    @mb_obj.message["o:testmode"][0].should eq("yes")
   end
   it 'turns on test mode with string true' do
     @mb_obj.set_test_mode("true")
-    @mb_obj.message["o:testmode"][0].should eq ("yes")
+    @mb_obj.message["o:testmode"][0].should eq("yes")
   end
   it 'turns off test mode with boolean false' do
     @mb_obj.set_test_mode(false)
-    @mb_obj.message["o:testmode"][0].should eq ("no")
+    @mb_obj.message["o:testmode"][0].should eq("no")
   end
   it 'turns off test mode with string false' do
     @mb_obj.set_test_mode("false")
-    @mb_obj.message["o:testmode"][0].should eq ("no")
+    @mb_obj.message["o:testmode"][0].should eq("no")
   end
   it 'does not allow multiple values' do
     @mb_obj.set_test_mode("false")
     @mb_obj.set_test_mode("true")
     @mb_obj.set_test_mode("false")
     @mb_obj.message["o:testmode"].length.should eq(1)
-    @mb_obj.message["o:testmode"][0].should eq ("no")
+    @mb_obj.message["o:testmode"][0].should eq("no")
   end
 end
 
@@ -209,26 +209,26 @@ describe 'The method set_dkim' do
   end
   it 'turns on dkim with boolean true' do
     @mb_obj.set_dkim(true)
-    @mb_obj.message["o:dkim"][0].should eq ("yes")
+    @mb_obj.message["o:dkim"][0].should eq("yes")
   end
   it 'turns on dkim with string true' do
     @mb_obj.set_dkim("true")
-    @mb_obj.message["o:dkim"][0].should eq ("yes")
+    @mb_obj.message["o:dkim"][0].should eq("yes")
   end
   it 'turns off dkim with boolean false' do
     @mb_obj.set_dkim(false)
-    @mb_obj.message["o:dkim"][0].should eq ("no")
+    @mb_obj.message["o:dkim"][0].should eq("no")
   end
   it 'turns off dkim with string false' do
     @mb_obj.set_dkim("false")
-    @mb_obj.message["o:dkim"][0].should eq ("no")
+    @mb_obj.message["o:dkim"][0].should eq("no")
   end
   it 'does not allow multiple values' do
     @mb_obj.set_dkim("false")
     @mb_obj.set_dkim("true")
     @mb_obj.set_dkim("false")
     @mb_obj.message["o:dkim"].length.should eq(1)
-    @mb_obj.message["o:dkim"][0].should eq ("no")
+    @mb_obj.message["o:dkim"][0].should eq("no")
   end
 end
 
@@ -244,9 +244,9 @@ describe 'The method add_campaign_id' do
     @mb_obj.add_campaign_id('My-Campaign-Id-1')
     @mb_obj.add_campaign_id('My-Campaign-Id-2')
     @mb_obj.add_campaign_id('My-Campaign-Id-3')
-    @mb_obj.message["o:campaign"][0].should eq ("My-Campaign-Id-1")
-    @mb_obj.message["o:campaign"][1].should eq ("My-Campaign-Id-2")
-    @mb_obj.message["o:campaign"][2].should eq ("My-Campaign-Id-3")
+    @mb_obj.message["o:campaign"][0].should eq("My-Campaign-Id-1")
+    @mb_obj.message["o:campaign"][1].should eq("My-Campaign-Id-2")
+    @mb_obj.message["o:campaign"][2].should eq("My-Campaign-Id-3")
   end
   it 'adds too many campaign IDs to the message' do
     expect{
@@ -262,15 +262,15 @@ describe 'The method add_tag' do
   end
   it 'adds a tag to the message' do
     @mb_obj.add_tag('My-Tag-1')
-    @mb_obj.message["o:tag"][0].should eq ("My-Tag-1")
+    @mb_obj.message["o:tag"][0].should eq("My-Tag-1")
   end
   it 'adds a few more tags to the message' do
     @mb_obj.add_tag('My-Tag-1')
     @mb_obj.add_tag('My-Tag-2')
     @mb_obj.add_tag('My-Tag-3')
-    @mb_obj.message["o:tag"][0].should eq ("My-Tag-1")
-    @mb_obj.message["o:tag"][1].should eq ("My-Tag-2")
-    @mb_obj.message["o:tag"][2].should eq ("My-Tag-3")
+    @mb_obj.message["o:tag"][0].should eq("My-Tag-1")
+    @mb_obj.message["o:tag"][1].should eq("My-Tag-2")
+    @mb_obj.message["o:tag"][2].should eq("My-Tag-3")
   end
   it 'adds too many tags to the message' do
     expect{
@@ -286,13 +286,13 @@ describe 'The method set_open_tracking' do
   end
   it 'enables/disables open tracking on a per message basis.' do
     @mb_obj.set_open_tracking('Yes')
-    @mb_obj.message["o:tracking-opens"][0].should eq ("yes")
+    @mb_obj.message["o:tracking-opens"][0].should eq("yes")
     @mb_obj.set_open_tracking('No')
-    @mb_obj.message["o:tracking-opens"][0].should eq ("no")
+    @mb_obj.message["o:tracking-opens"][0].should eq("no")
     @mb_obj.set_open_tracking(true)
-    @mb_obj.message["o:tracking-opens"][0].should eq ("yes")
+    @mb_obj.message["o:tracking-opens"][0].should eq("yes")
     @mb_obj.set_open_tracking(false)
-    @mb_obj.message["o:tracking-opens"][0].should eq ("no")
+    @mb_obj.message["o:tracking-opens"][0].should eq("no")
   end
 end
 
@@ -302,15 +302,15 @@ describe 'The method set_click_tracking' do
   end
   it 'enables/disables click tracking on a per message basis.' do
     @mb_obj.set_click_tracking('Yes')
-    @mb_obj.message["o:tracking-clicks"][0].should eq ("yes")
+    @mb_obj.message["o:tracking-clicks"][0].should eq("yes")
     @mb_obj.set_click_tracking('No')
-    @mb_obj.message["o:tracking-clicks"][0].should eq ("no")
+    @mb_obj.message["o:tracking-clicks"][0].should eq("no")
     @mb_obj.set_click_tracking(true)
-    @mb_obj.message["o:tracking-clicks"][0].should eq ("yes")
+    @mb_obj.message["o:tracking-clicks"][0].should eq("yes")
     @mb_obj.set_click_tracking(false)
-    @mb_obj.message["o:tracking-clicks"][0].should eq ("no")
+    @mb_obj.message["o:tracking-clicks"][0].should eq("no")
     @mb_obj.set_click_tracking('html')
-    @mb_obj.message["o:tracking-clicks"][0].should eq ("html")
+    @mb_obj.message["o:tracking-clicks"][0].should eq("html")
   end
 end
 
@@ -320,7 +320,7 @@ describe 'The method set_delivery_time' do
   end
   it 'defines a time/date to deliver a message in RFC2822 format.' do
     @mb_obj.set_delivery_time('October 25, 2013 10:00PM CST')
-    @mb_obj.message["o:deliverytime"][0].should eq ("Fri, 25 Oct 2013 22:00:00 -0600")
+    @mb_obj.message["o:deliverytime"][0].should eq("Fri, 25 Oct 2013 22:00:00 -0600")
   end
 end
 
@@ -330,12 +330,12 @@ describe 'The method set_custom_data' do
   end
   it 'accepts valid JSON and appends as data to the message.' do
     @mb_obj.set_custom_data('my-data', '{"key":"value"}')
-    @mb_obj.message["v:my-data"][0].should eq ("{\"key\":\"value\"}")
+    @mb_obj.message["v:my-data"][0].should eq("{\"key\":\"value\"}")
   end
   it 'accepts a hash and appends as data to the message.' do
     data = {'key'=> 'value'}
     @mb_obj.set_custom_data('my-data', data)
-    @mb_obj.message["v:my-data"][0].should eq ("{\"key\":\"value\"}")
+    @mb_obj.message["v:my-data"][0].should eq("{\"key\":\"value\"}")
   end
   it 'throws an exception on broken JSON.' do
     data = 'This is some crappy JSON.'
@@ -349,6 +349,27 @@ describe 'The method add_custom_parameter' do
   end
   it 'adds an undefined parameter to the message.' do
     @mb_obj.add_custom_parameter('h:my-sweet-header', 'datagoeshere')
-    @mb_obj.message["h:my-sweet-header"][0].should eq ("datagoeshere")
+    @mb_obj.message["h:my-sweet-header"][0].should eq("datagoeshere")
+  end
+end
+
+describe 'The method set_message_id' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+    @the_message_id = '<20141014000000.11111.11111@example.com>'
+  end
+  it 'correctly sets the Message-Id header' do
+    @mb_obj.set_message_id(@the_message_id)
+    @mb_obj.message['h:Message-Id'].should eq(@the_message_id)
+  end
+  it 'correctly clears the Message-Id header when passed nil' do
+    @mb_obj.set_message_id(nil)
+    @mb_obj.message.has_key?('h:Message-Id').should eq(false)
+  end
+  it 'correctly sets the Message-Id header when passed an empty string' do
+    @mb_obj.set_message_id(@the_message_id)
+    @mb_obj.message.has_key?('h:Message-Id').should eq(true)
+    @mb_obj.set_message_id('')
+    @mb_obj.message.has_key?('h:Message-Id').should eq(false)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mailgun
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 description: Mailgun's Official Ruby SDK for interacting with the Mailgun API.
@@ -87,7 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- Events.md
 - Gemfile
 - LICENSE
 - MessageBuilder.md
@@ -120,27 +122,23 @@ homepage: http://www.mailgun.com
 licenses:
 - Apache
 metadata: {}
-post_install_message: "\n    ---------------------------------------------------------------\n
-  \   Congrats, you've successfully installed the Mailgun SDK!\n    Check out our
-  documentation at http://documentation.mailgun.com\n\n    Contact us at support@mailgunhq.com
-  with any questions.\n    ----------------------------------------------------------------\n
-  \ "
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Mailgun's Official Ruby SDK