mailgun-ruby 1.1.1 → 1.1.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjI5MjJkMTdmNGY4M2Q0OTRkY2I4MjY5YzRmNjBhYzVhYmUyNzNkMQ==
-  data.tar.gz: !binary |-
-    MGViNjllYzBlODY3NzhhZjc3OTczYzAyNTc0YTgxMDg4ODU1ZTZjNw==
+SHA1:
+  metadata.gz: 7191c12a6dc2a08445f7cb623f10608e9208c9d2
+  data.tar.gz: 5033b5cd5eb92f6ce5c2d678222f8c7d9d118c78
 SHA512:
-  metadata.gz: !binary |-
-    YWNmMmRjZTU1OTZiNzA0NzMwM2QwN2E5ZGFiM2NkNjZmOWVkY2Q3MmQ3MjU5
-    MDQxMjU4NzI4YjZkOGQ1NzRhMGY4NGE3NjE0ZWFhNTMxNWZiM2Y4Y2U2NDM5
-    MWJkMTJhNmZiZTczZDZlM2JhNGIzNjg2YzAwNzQ2NTNlZjIzNmM=
-  data.tar.gz: !binary |-
-    YTg1M2UwNzdiMWIwNGZhMGVjYzJmY2FjMjhkMjJmMjljZWRkYzY5NGRmYmY3
-    MDcxY2Q4MzVkY2M2NGQ4OWE1Mzc4ZTQyZGUyYTE4NjE5NzJiMGNiMjRlNTNi
-    YWM1Y2VmODBlMWFiZTU1NmQ4ZmJkMmJmZjFiYzliOTBmOGJmOGI=
+  metadata.gz: 38dd19ded277a5566d738c88368b811607762ee258eaca48f7f1afe069b6fd84672bef1e6fb9637b028c06762c840dbd84b7a722ec2e6b7bd51828f99eedd406
+  data.tar.gz: a87aab066601ca346f897d551ff37165b862654d378c156df84b9443714c0795b9bb7299e16e0bce5666511d28900b0d0d7677ffe7ff826b2681d1d9c96ea7cc

data/MessageBuilder.md

@@ -23,20 +23,20 @@ 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.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.set_subject("A message from the Ruby SDK using Message Builder!");
+mb_obj.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.body_text("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>")
+mb_obj.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('')
+mb_obj.message_id(nil)
+mb_obj.message_id('')
 # Campaign and other headers.
 mb_obj.add_campaign_id("My-Awesome-Campaign");
 mb_obj.add_custom_parameter("h:Customer-Id", "12345");
@@ -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.delivery_at("tomorrow 8:00AM PST");
 
 # Finally, send your message using the client
 result = mg_client.send_message("sending_domain.com", mb_obj)
@@ -64,11 +64,11 @@ 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.from("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.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.body_text("This is the text body of the message!");
 
 
 # Loop through all of your recipients

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.1.1'
+gem 'mailgun-ruby', '~>1.1.2'
 ```
 
 Usage
@@ -45,7 +45,7 @@ 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-secret-api-key'
 
 # Define the domain you wish to query
 domain = 'example.com'
@@ -60,7 +60,7 @@ Rails
 The library can be initialized with a Rails initializer containing similar:
 ```ruby
 Mailgun.configure do |config|
-  config.api_key = 'your-secret-key'
+  config.api_key = 'your-secret-api-key'
 end
 ```
 Or have the initializer read your environment setting if you perfer.

data/lib/mailgun/client.rb

@@ -12,13 +12,36 @@ module Mailgun
     def initialize(api_key = Mailgun.api_key,
                    api_host = 'api.mailgun.net',
                    api_version = 'v3',
-                   ssl = true)
+                   ssl = true,
+                   test_mode = false)
 
       endpoint = endpoint_generator(api_host, api_version, ssl)
       @http_client = RestClient::Resource.new(endpoint,
                                               user: 'api',
                                               password: api_key,
                                               user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}")
+      @test_mode = test_mode
+    end
+
+    # Enable test mode
+    #
+    # Prevents sending of any messages.
+    def enable_test_mode!
+      @test_mode = true
+    end
+
+    # Disable test mode
+    #
+    # Reverts the test_mode flag and allows the client to send messages.
+    def disable_test_mode!
+      @test_mode = false
+    end
+
+    # Client is in test mode?
+    #
+    # @return [Boolean] Is the client set in test mode?
+    def test_mode?
+      @test_mode
     end
 
     # Simple Message Sending
@@ -28,6 +51,15 @@ module Mailgun
     # containing required parameters for the requested resource.
     # @return [Mailgun::Response] A Mailgun::Response object.
     def send_message(working_domain, data)
+      if test_mode? then
+        return Response.from_hash(
+          {
+            :body => '{"id": "test-mode-mail@localhost", "message": "Queued. Thank you."}',
+            :code => 200,
+          }
+        )
+      end
+
       case data
       when Hash
         if data.key?(:message)

data/lib/mailgun/exceptions/exceptions.rb

@@ -37,16 +37,28 @@ module Mailgun
 
     # Public: initialization of new error given a message and/or object
     #
-    # message - a String detailing the error
-    # object  - a RestClient::Reponse object
+    # message  - a String detailing the error
+    # response - a RestClient::Response object
     #
-    def initialize(message = nil, object = nil)
-      @object = object
-      @code = object.http_code || NOCODE
-      super(JSON.parse(object.body)['message'])
+    def initialize(message = nil, response = nil)
+      @response = response
+      @code = response.code || NOCODE
+
+      begin
+        api_message = JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        api_message = response.body
+      rescue NoMethodError
+        api_message = "Unknown API error"
+      end
+
+      message = message || ''
+      message = message + ': ' + api_message
+
+      super(message, response)
     rescue NoMethodError, JSON::ParserError
       @code = NOCODE
-      super(message)
+      super(message, response)
     end
 
   end

data/lib/mailgun/response.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Mailgun
   # A Mailgun::Response object is instantiated for each response generated
   # by the Client request. The Response object supports deserialization of
@@ -10,6 +12,11 @@ module Mailgun
     #   slightly different
     attr_accessor :body, :code
 
+    def self.from_hash(h)
+      # Create a "fake" response object with the data passed from h
+      self.new OpenStruct.new(h)
+    end
+
     def initialize(response)
       @body = response.body
       @code = response.code

data/lib/mailgun/version.rb

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

data/spec/integration/mailgun_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'mailgun'
+require 'mailgun/exceptions/exceptions'
 
 vcr_opts = { :cassette_name => "instance" }
 
@@ -9,6 +10,30 @@ describe 'Mailgun instantiation', vcr: vcr_opts do
   end
 end
 
+vcr_opts = { :cassette_name => "exceptions" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'display useful error information' do
+    begin
+      @mg_obj.send_message("not-our-doma.in", {
+          :from => "sally@not-our-doma.in",
+          :to => "bob@#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to eq('404 Not Found: Domain not found: not-our-doma.in')
+    else
+      fail
+    end
+  end
+end
+
 vcr_opts = { :cassette_name => "send_message" }
 
 describe 'The method send_message()', vcr: vcr_opts do
@@ -16,7 +41,7 @@ describe 'The method send_message()', vcr: vcr_opts do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
   end
-  
+
   it 'sends a standard message in test mode.' do
     result = @mg_obj.send_message(@domain, {:from => "bob@#{@domain}",
                                     :to => "sally@#{@domain}",
@@ -29,6 +54,28 @@ describe 'The method send_message()', vcr: vcr_opts do
     expect(result.body).to include("id")
   end
 
+  it 'fakes message send while in *client* test mode' do
+    @mg_obj.enable_test_mode!
+
+    expect(@mg_obj.test_mode?).to eq(true)
+
+    data = { :from => "joe@#{@domain}",
+             :to => "bob@#{@domain}",
+             :subject => "Test",
+             :text => "Test Data" }
+
+    result = @mg_obj.send_message(@domain, data)
+
+    result.to_h!
+
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+
+    expect(result.code).to eq(200)
+    expect(result.body['id']).to eq("test-mode-mail@localhost")
+    expect(result.body['message']).to eq("Queued. Thank you.")
+  end
+
   it 'sends a message builder message in test mode.' do
     mb_obj = Mailgun::MessageBuilder.new()
     mb_obj.from("sender@#{@domain}", {'first' => 'Sending', 'last' => 'User'})

data/spec/unit/mailgun_spec.rb

@@ -25,9 +25,9 @@ describe 'The method send_message()' do
 
   it 'sends a message' do
     data = { 'from' => 'joe@test.com',
-                    'to' => 'bob@example.com',
-                    'subject' => 'Test',
-                    'text' => 'Test Data'}
+             'to' => 'bob@example.com',
+             'subject' => 'Test',
+             'text' => 'Test Data' }
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
@@ -42,7 +42,7 @@ describe 'The method send_message()' do
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
@@ -61,7 +61,7 @@ describe 'The method post()' do
     result = @mg_obj.post("#{@domain}/messages", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
@@ -81,7 +81,7 @@ describe 'The method put()' do
     result = @mg_obj.put("lists/#{@list_address}/members#{@member_address}", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("member")
     expect(result.body["member"]).to include("vars")
     expect(result.body["member"]["vars"]).to include("age")
@@ -104,7 +104,7 @@ describe 'The method get()' do
     result = @mg_obj.get("#{@domain}/bounces", query_string)
 
     result.to_h!
-    
+
     expect(result.body).to include("total_count")
     expect(result.body).to include("items")
   end
@@ -120,7 +120,7 @@ describe 'The method delete()' do
     result = @mg_obj.delete("#{@domain}/campaigns/ABC123")
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end

data/vcr_cassettes/exceptions.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/not-our-doma.in/messages
+    body:
+      encoding: UTF-8
+      string: from=sally%40not-our-doma.in&to=bob%40DOMAIN.TEST&subject=Exception+Integration+Test&text=INTEGRATION+TESTING
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.0 (linux-gnu x86_64) ruby/2.3.1p112
+      Content-Length:
+      - '149'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Host:
+      - api.mailgun.net
+  response:
+    status:
+      code: 404
+      message: NOT FOUND
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Wed, 02 Nov 2016 19:42:44 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '52'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "message": "Domain not found: not-our-doma.in"
+        }
+    http_version: 
+  recorded_at: Wed, 02 Nov 2016 19:43:40 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Mailgun
@@ -9,118 +9,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.22'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Mailgun's Official Ruby SDK for interacting with the Mailgun API.
@@ -129,11 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .rubocop_todo.yml
-- .ruby-env.yml.example
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-env.yml.example"
+- ".travis.yml"
 - Domains.md
 - Events.md
 - Gemfile
@@ -190,6 +190,7 @@ files:
 - vcr_cassettes/domains.yml
 - vcr_cassettes/email_validation.yml
 - vcr_cassettes/events.yml
+- vcr_cassettes/exceptions.yml
 - vcr_cassettes/list_members.yml
 - vcr_cassettes/mailing_list.todo.yml
 - vcr_cassettes/mailing_list.yml
@@ -208,12 +209,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []