mailgun-ruby 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 523ed8383a3318e626e33482a72431daf0453235
-  data.tar.gz: 67a635eb9b247d1fdaeaf2cb1e2944d2b85261d5
+  metadata.gz: 15c6226ce2745501543bd148db41a0297f2d58df
+  data.tar.gz: 2110bec8de2f21d49fee5d56ad41aef0d4fbc2b7
 SHA512:
-  metadata.gz: 9f3a6cfd00e2c88bc755411b4953139bd6115062236904edce82334d495b7edc4e529ad01f8e0ed68e35974105d0763f6175dbb5da2be44deb7b488ccc7391ba
-  data.tar.gz: df50ed26167e1cf88271ca954a0b084da8b135c006b2a27fe2050e3f10b7b795e6b4b283be159fbee0b5b8507aba899881e8d311ff670e18aba0523c275c0f7f
+  metadata.gz: 04f6a82d67c5d8cda08c7a38956edfab2ff28b9c16b9344fcee2e3ec3caf1e0e69f901797de3a98640a962af9c28fff58d7151deb3cffbc32bee740df48eb901
+  data.tar.gz: 4fc8aec4b0e5e5c100a707c3cf44151b9eb2fe1e1cd047bf0df3c0122c1443c9264e048d27fe65390e23a9718be2ce5ab8d6009deaaf7ec0f512e9a7217f3552

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 .DS_Store
 test.rb
 ruby
+.ruby-env.yml
+.rspec-local

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-07 12:11:06 -0500 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 169
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 9
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/mailgun/messages/message_builder.rb'

data/.ruby-env.yml.example

@@ -0,0 +1,12 @@
+---
+# To assist with testing.
+#
+# DO NOT CHANGE AND COMMIT. YOU HAVE BEEN WARNED.
+# Alternatively, use environment variables of the same.
+#
+# Replace <THESE_VALUES> with yours from
+# https://mailgun.com/app/dashboard (don't include <brackets>)
+# and rename to/save as: .ruby-env.yml
+MAILGUN_APIKEY : '<MAILGUN_APIKEY'>
+MAILGUN_PUB_APIKEY : '<MAILGUN_PUBLIC_APIKEY>'
+MAILGUN_TESTDOMAIN : '<MAILGUN_SANDBOX_DOMAIN>'

data/.travis.yml

@@ -1,15 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.2
+  - 2.1
   - 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
+  - 1.9.3
+sudo: false
+gemfile: Gemfile
+script: bundle exec rake spec

data/Domains.md

@@ -0,0 +1,36 @@
+Mailgun - Domains
+====================
+
+This is the Mailgun Ruby *Domain* utilities.
+
+The below assumes you've already installed the Mailgun Ruby SDK in to your
+project. If not, go back to the master README for instructions. It currently supports
+all calls except credentials.
+
+Usage - Domains
+-----------------------
+
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new('your-api-key')
+domainer = Mailgun::Domains.new(mg_client)
+
+# Get a list of current domains.
+domainer.list
+
+# View details of a domain
+domainer.info 'my.perfect.domain'
+
+# Add a new domain
+domainer.create 'my.new.moreness'
+# or with options
+domainer.create 'my.new.moreness', { some: 'options' }
+
+# Remove a domain
+domainer.remove 'this.one.is.not.needed.'
+```
+
+More Documentation
+------------------
+See the official [Mailgun Domain Docs](https://documentation.mailgun.com/api-domains.html)
+for more information

data/MessageBuilder.md

@@ -1,21 +1,21 @@
 Mailgun - Messages
 ====================
 
-This is the Mailgun Ruby *Message* utilities. 
+This is the Mailgun Ruby *Message* utilities.
 
 The below assumes you've already installed the Mailgun Gem. If not, go back to the master README for instructions.
 
-There are two utilities included, Message Builder and Batch Message. 
+There are two utilities included, Message Builder and Batch Message.
 
-Message Builder: Allows you to build a message object by calling methods for 
-each attribute. 
-Batch Message: Inherits Message Builder and allows you to iterate through 
-recipients from a list. Messages will fire after the 1,000th recipient has been 
-added. 
+Message Builder: Allows you to build a message object by calling methods for
+each attribute.
+Batch Message: Inherits Message Builder and allows you to iterate through
+recipients from a list. Messages will fire after the 1,000th recipient has been
+added.
 
 Usage - Message Builder
 -----------------------
-Here's how to use Message Builder to build your Message. 
+Here's how to use Message Builder to build your Message.
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
@@ -28,7 +28,7 @@ mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
 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. 
+# 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!");
@@ -45,7 +45,7 @@ mb_obj.add_custom_parameter("h:Customer-Id", "12345");
 mb_obj.add_attachment("/path/to/file/receipt_123491820.pdf", "Receipt.pdf");
 
 # Schedule message in the future
-mb_obj.set_delivery_time("tomorrow 8:00AM", "PST");
+mb_obj.set_delivery_time("tomorrow 8:00AM PST");
 
 # Finally, send your message using the client
 result = mg_client.send_message("sending_domain.com", mb_obj)
@@ -55,7 +55,7 @@ puts result.body.to_s
 
 Usage - Batch Message
 ---------------------
-Here's how to use Batch Message to easily handle batch sending jobs. 
+Here's how to use Batch Message to easily handle batch sending jobs.
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
@@ -65,7 +65,7 @@ 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. 
+# 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!");
@@ -85,5 +85,5 @@ message_ids = mb_obj.finalize
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html) 
-for more information.
+See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
+for more information.

data/Messages.md

@@ -24,26 +24,36 @@ mg_client = Mailgun::Client.new("your-api-key")
 mb_obj = Mailgun::MessageBuilder.new
 
 # Define the from address.
-mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"});
+mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"})
+
 # Define a to recipient.
-mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"});
+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"});
+mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"})
+
 # Define the subject.
-mb_obj.set_subject("A message from the Ruby SDK using Message Builder!");
+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("This is the text body of the message!")
+
+# Define the HTML text of the message
+mb_obj.set_html_body("<html><body><p>This is the text body of the message</p></body></html>")
+
 # 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");
-mb_obj.add_attachment("@/tron.jpg");
-mb_obj.set_delivery_time("tomorrow 8:00AM", "PST");
-mb_obj.set_click_tracking(true);
+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.set_delivery_time("tomorrow 8:00AM PST")
+mb_obj.set_click_tracking(true)
 
 # Send your message through the client
 mg_client.send_message("sending_domain.com", mb_obj)
@@ -59,29 +69,33 @@ mg_client = Mailgun::Client.new("your-api-key")
 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"});
+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!");
+mb_obj.set_subject("A message from the Ruby SDK using Message Builder!")
+
 # Define the body of the message.
-mb_obj.set_text_body("Hello %recipient.first%, 
-                     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", 
-                                                   "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});
+                     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",
+                                                   "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", 
-                                                    "account-id" => 121314});
+mb_obj.add_recipient(:to, "sally.doe@example.com", {"first"      => "Sally",
+                                                    "last"       => "Doe",
+                                                    "account-id" => 121314})
 
 # Send your message through the client
 message_ids = mb_obj.finalize
@@ -89,5 +103,5 @@ message_ids = mb_obj.finalize
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html)
+See the official [Mailgun Docs](https://documentation.mailgun.com/api-sending.html)
 for more information.

data/OptInHandler.md

@@ -1,25 +1,25 @@
 Mailgun - Lists
 ====================
 
-This is the Mailgun Ruby *Lists* utilities. 
+This is the Mailgun Ruby *Lists* utilities.
 
-The below assumes you've already installed the Mailgun Ruby SDK in your project. 
+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.
 
-OptInHandler: Provides methods for authenticating an Opt-In Request. 
+OptInHandler: Provides methods for authenticating an Opt-In Request.
 
-The typical flow for using this utility would be as follows:  
-**Recipient Requests Subscribe** -> [Validate Recipient Address] -> [Generate Opt-In Link] -> [Email Recipient Opt-In Link]  
-**Recipient Clicks Opt-In Link** -> [Validate Opt-In Link] -> [Subscribe User] -> [Send final confirmation]  
+The typical flow for using this utility would be as follows:
+**Recipient Requests Subscribe** -> [Validate Recipient Address] -> [Generate Opt-In Link] -> [Email Recipient Opt-In Link]
+**Recipient Clicks Opt-In Link** -> [Validate Opt-In Link] -> [Subscribe User] -> [Send final confirmation]
 
 The above flow is modeled below.
 
 Usage - Opt-In Handler (Recipient Requests Subscribe)
 -----------------------------------------------------
-Here's how to use Opt-In Handler to validate Opt-In requests. 
+Here's how to use Opt-In Handler to validate Opt-In requests.
 
 ```ruby
-# First, instantiate the SDK with your API credentials, domain, and required parameters for example. 
+# First, instantiate the SDK with your API credentials, domain, and required parameters for example.
 mg_client = Mailgun::Client.new("your-api-key")
 mg_validate = Mailgun::Client.new("your-pub-api-key")
 
@@ -31,22 +31,23 @@ recipient_address = 'recipient@example.com';
 
 # Let's validate the customer's email address, using Mailgun's validation endpoint.
 result = mg_validate.get('address/validate', {:address => recipient_address});
+body = JSON.parse(result.body)
 
-if result[:body]["is_valid"] == true
+if body['is_valid'] == true
 	# Next, generate a hash.
 	generated_hash = Mailgun::OptInHandler.generate_hash(mailing_list, secret_app_id, recipient_address);
 	
 	# Now, let's send a confirmation to the recipient with our link.
-	mg_client.send_message(domain, {:from    => 'bob@example.com', 
-	                                :to      => recipient_address, 
-	                                :subject => 'Please Confirm!', 
-	                                :html    => "<html><body>Hello,<br><br>You have requested to be subscribed 
-		                            to the mailing list #{mailing_list}. Please <a 
+	mg_client.send_message(domain, {:from    => 'bob@example.com',
+	                                :to      => recipient_address,
+	                                :subject => 'Please Confirm!',
+	                                :html    => "<html><body>Hello,<br><br>You have requested to be subscribed
+		                            to the mailing list #{mailing_list}. Please <a
 		                            href=\"http://yourdomain.com/subscribe.php?hash=#{generated_hash}\">
 		                            confirm</a> your subscription.<br><br>Thank you!</body></html>"});
 	                                			  
 	# Finally, let's add the subscriber to a Mailing List, as unsubscribed, so we can track non-conversions.
-	mg_client.post("lists/#{mailing_list}/members", {:address    => recipient_address, 
+	mg_client.post("lists/#{mailing_list}/members", {:address    => recipient_address,
 	                                		         :subscribed => 'no',
 	                                			     :upsert     => 'yes'});
 end
@@ -54,10 +55,10 @@ end
 
 Usage - Opt-In Handler (Recipient Clicks Opt In Link)
 -----------------------------------------------------
-Here's how to use Opt-In Handler to validate an Opt-In Hash. 
+Here's how to use Opt-In Handler to validate an Opt-In Hash.
 
 ```ruby
-# First, instantiate the SDK with your API credentials and domain. 
+# First, instantiate the SDK with your API credentials and domain.
 mg_client = Mailgun::Client.new("your-api-key")
 domain = 'example.com';
 
@@ -69,35 +70,34 @@ if !hash_validation.nil?
 	validated_list = hash_validation['mailing_list'];
 	validated_recipient = hash_validation['recipient_address'];
 	
-	mg_client.put("lists/#{validated_list}/members/#{validated_recipient}", 
-							{:address    => validated_recipient, 
+	mg_client.put("lists/#{validated_list}/members/#{validated_recipient}",
+							{:address    => validated_recipient,
 	                         :subscribed => 'yes'})
     
-    mg_client.send_message(domain, {:from    => 'bob@example.com', 
-                                    :to      => validated_recipient, 
-                                    :subject => 'Confirmation Received!', 
+    mg_client.send_message(domain, {:from    => 'bob@example.com',
+                                    :to      => validated_recipient,
+                                    :subject => 'Confirmation Received!',
                                     :html    => "<html><body>Hello,<br><br>We've successfully subscribed you to the list, #{validated_list}!<br><br>Thank you!
-                                    </body></html>"));
+                                    </body></html>"});
 end
 ```
 
-A few notes:  
-1. 'secret_app_id' can be anything. It's used as the *key* in hashing, 
-since your email address will vary. It should be secured like a password.  
-2. validateHash will return an array containing the recipient address and list 
-address.  
-3. You should *always* send an email confirmation before and after the 
-subscription request. This is what double-opt in means.  
+A few notes:
+1. 'secret_app_id' can be anything. It's used as the *key* in hashing,
+since your email address will vary. It should be secured like a password.
+2. validateHash will return an array containing the recipient address and list
+address.
+3. You should *always* send an email confirmation before and after the
+subscription request. This is what double-opt in means.
 
 
 Available Functions
 -----------------------------------------------------
 
-`string generate_hash(string mailing_list, string secret_app_id, string recipient_address)` 
+`string generate_hash(string mailing_list, string secret_app_id, string recipient_address)`
 
-`array validate_hash(string secret_app_id, string unique_hash)`  
+`array validate_hash(string secret_app_id, string unique_hash)`
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html) 
-for more information.
+See the official [Mailgun Docs](https://documentation.mailgun.com/api-sending.html) for more information.

data/README.md

@@ -6,8 +6,7 @@ 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
-official documentation
-at http://documentation.mailgun.com
+official documentation at https://documentation.mailgun.com
 
 Installation
 ------------
@@ -20,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.0.3', require: 'mailgun'
+gem 'mailgun-ruby', '~>1.0.5', require: 'mailgun'
 ```
 
 Include
@@ -36,31 +35,44 @@ Here's how to send a message using the library:
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new "your-api-key"
+mg_client = Mailgun::Client.new 'your-api-key'
 
 # Define your message parameters
-message_params = {:from    => 'bob@sending_domain.com',
-                  :to      => 'sally@example.com',
-                  :subject => 'The Ruby SDK is awesome!',
-                  :text    => 'It is really easy to send a message!'}
+message_params =  { from: 'bob@sending_domain.com',
+                    to:   'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text:    'It is really easy to send a message!'
+                  }
 
 # Send your message through the client
-mg_client.send_message "sending_domain.com", message_params
+mg_client.send_message 'sending_domain.com', message_params
 ```
 
 Or obtain the last couple log items:
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new "your-api-key"
+mg_client = Mailgun::Client.new 'your-api-key'
 
 # Define the domain you wish to query
-domain = "example.com"
+domain = 'example.com'
 
 # Issue the get request
 result = mg_client.get("#{domain}/events", {:event => 'delivered'})
 ```
 
+Rails
+-----
+
+The library can be initialized with a Rails initializer containing similar:
+```ruby
+Mailgun.configure do |config|
+  config.api_key = 'your-secret-key'
+end
+```
+Or have the initializer read your environment setting if you perfer.
+
+
 Response
 --------
 
@@ -84,12 +96,14 @@ Here's an example, breaking out the response:
 ```ruby
 mg_client = Mailgun::Client.new("your-api-key")
 
-message_params = {:from    => 'bob@example.com',
-                  :to      => 'sally@example.com',
-                  :subject => 'The Ruby SDK is awesome!',
-                  :text    => 'It is really easy to send a message!'}
+message_params =  {
+                   from: 'bob@example.com',
+                   to:   'sally@example.com',
+                   subject: 'The Ruby SDK is awesome!',
+                   text:    'It is really easy to send a message!'
+                  }
 
-result = mg_client.send_message("example.com", message_params).to_h!
+result = mg_client.send_message('example.com', message_params).to_h!
 
 message_id = result['id']
 message = result['message']
@@ -110,17 +124,19 @@ Go to http://bin.mailgun.net. The Postbin will generate a special URL. Save that
 
 **Step 2 - Instantiate the Mailgun client using Postbin.**
 
-*Tip: The bin id will be the URL part after bin.mailgun.net. It will be random generated letters and numbers. For example, the bin id in this URL, http://bin.mailgun.net/aecf68de, is "aecf68de".*
+*Tip: The bin id will be the URL part after bin.mailgun.net. It will be random generated letters and numbers.
+For example, the bin id in this URL, http://bin.mailgun.net/aecf68de, is "aecf68de".*
 
 ```ruby
 # First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new("your-api-key", "bin.mailgun.net", "aecf68de", ssl = false)
 
 # Define your message parameters
-message_params = {:from    => 'bob@sending_domain.com',
-                  :to      => 'sally@example.com',
-                  :subject => 'The Ruby SDK is awesome!',
-                  :text    => 'It is really easy to send a message!'}
+message_params = {  from: 'bob@sending_domain.com',
+                    to: 'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text: 'It is really easy to send a message!'
+                  }
 
 # Send your message through the client
 mg_client.send_message("sending_domain.com", message_params)
@@ -129,8 +145,13 @@ 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.
 
-This SDK includes a [Message Builder](Messages.md),
-[Batch Message](Messages.md), [Opt-In Handler](OptInHandler.md) and [Events](Events.md) component.
+This SDK includes the following components:
+- [Message Builder](Messages.md)
+- [Batch Message](Messages.md)
+- [Opt-In Handler](OptInHandler.md)
+- [Domains](Domains.md)
+- [Webhooks](Webhooks.md)
+- [Events](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.
@@ -138,11 +159,40 @@ Batch Message is an extension of Message Builder, and allows you to easily send
 a batch message job within a few seconds. The complexity of
 batch messaging is eliminated!
 
+Testing
+-------
+
+There are unit tests and integration tests. Unit tests do not require Mailgun account keys. Integration tests do.
+By default:
+```
+bundle exec rake spec
+```
+will run just unit tests. To run integration tests:
+```
+bundle exec rake spec:integration
+```
+will run just integration tests.
+```
+bundle exec rake spec:all
+```
+will run all both types.
+
+Integrations tests will run against [VCR](https://github.com/vcr/vcr) cassettes if they exist.
+If you'd like to run tests against your mailgun account, remove the cassettes.
+
+To set up Mailgun key information. See the example file: .ruby-env.yml.example.
+Rename this file to .ruby-env.yml and replace the items between the <> (including the <>) with the private
+and public keys, and sandbox domain. Alternatively use a different domain registered in Mailgun if you
+have one you want to test against.
+
+The MAILGUN_* variables in .ruby-env.yml(.example) can also be set as
+environment variables, if you'd like to do that instead.
+
 Support and Feedback
 --------------------
 
 Be sure to visit the Mailgun official
-[documentation website](http://documentation.mailgun.com/) for additional
+[documentation website](https://documentation.mailgun.com/) for additional
 information about our API.
 
 If you find a bug, please submit the issue in Github directly.