mailgun-ruby 1.1.6 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e16b23def5c2076ebf90803c69e67c11275dd4cf
-  data.tar.gz: 538a0a0aa99f037d0ef044fc9d427483eb4073b1
+  metadata.gz: 03bb73706b0d179b3f48cfa58f68acc8b0d716e7
+  data.tar.gz: 3fc860e152511f367033a5954ba95720a474fd01
 SHA512:
-  metadata.gz: 4c76cf234af827e8280e5eaa466d961817d30c3875345f4c481871ac8ca5083f11d4257ab06531c12dd693eab09e70910e6feaa13576766cd689caa32653c1f6
-  data.tar.gz: 305a1d5edc83fef3006682c884d9abee4ecf190e40919008b8985e6a86e5dd4f1506c3344a7641f67a435a5a3f510f1e350fb63daccb25fbcdec5cbfc1a20617
+  metadata.gz: 0d1f7e536083087eb9c2423c8cb3cd54624b5d0a7fbfb96eb8740b06c2947c14d94542e6ef22439d0f0711d9627b5219e09b9ccab7408b454e20ad1531a07d56
+  data.tar.gz: 9e03a0244f385c15497856fe9c421d3d330a38309798313c88f3139a86b6fc163cf6234654e15a1c1faceca40b70ad590ff5caf02c3cefc2d225a4eb3bc2b852

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p0

data/README.md

@@ -27,7 +27,7 @@ Usage
 Here's how to send a message using the library:
 
 ```ruby
-require 'mailgun' 
+require 'mailgun'
 
 # First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new 'your-api-key'
@@ -65,9 +65,9 @@ Mailgun.configure do |config|
   config.api_key = 'your-secret-api-key'
 end
 ```
-Or have the initializer read your environment setting if you perfer.
+Or have the initializer read your environment setting if you prefer.
 
-To use as the ActionMailer delivery method, add this to your `config/environments/whatever.yml`
+To use as the ActionMailer delivery method, add this to your `config/environments/whatever.rb`
 and replace `api-myapikey` and `mydomain.com` with your secret API key and domain, respectively:
 ```ruby
   config.action_mailer.delivery_method = :mailgun
@@ -77,6 +77,14 @@ and replace `api-myapikey` and `mydomain.com` with your secret API key and domai
   }
 ```
 
+To get the Mailgun `message_id` after ActionMailer has successfully delivered the email:
+
+```ruby
+  mailer = UserNotifier.welcome_email(current_user)
+  mailer_response = mailer.deliver_now
+  mailgun_message_id = mailer_response.message_id
+```
+
 Response
 --------
 

data/docs/MessageBuilder.md

@@ -44,6 +44,9 @@ mb_obj.message_id("<20141014000000.11111.11111@example.com>")
 mb_obj.message_id(nil)
 mb_obj.message_id('')
 
+# Set the Message-tags at most 3.
+mb_obj.add_tag("You can track mails as tag-units!")
+
 # Campaigns and headers.
 mb_obj.add_campaign_id("My-Awesome-Campaign");
 mb_obj.header("Customer-Id", "12345");

data/lib/mailgun/address.rb

@@ -18,8 +18,11 @@ module Mailgun
     # Given an arbitrary address, validates it based on defined checks.
     #
     # @param [String] address Email address to validate (max 512 chars.)
-    def validate(address)
-      res = @client.get "address/validate", {:address => address}
+    def validate(address, mailbox_verification = false)
+      params = {:address => address}
+      params[:mailbox_verification] = true if mailbox_verification
+
+      res = @client.get "address/validate", params
       return res.to_h!
     end
 

data/lib/mailgun/events/events.rb

@@ -87,12 +87,23 @@ module Mailgun
     #
     # Return is irrelevant.
     def extract_paging(response)
-      # This is pretty hackish. But the URL will never change in API v2.
-      @paging_next = response.to_h['paging']['next'].split('/')[6]
-      @paging_previous = response.to_h['paging']['previous'].split('/')[6]
-    rescue
-      @paging_next = nil
-      @paging_previous = nil
+      paging            = response.to_h['paging']
+      next_page_url     = paging && paging['next']      # gives nil when any one of the keys doens't exist
+      previous_page_url = paging && paging['previous']  # can be replaced with Hash#dig for ruby >= 2.3.0
+      @paging_next      = extract_endpoint_from(next_page_url)
+      @paging_previous  = extract_endpoint_from(previous_page_url)
+    end
+
+    # Internal: given a paging URL, extract the endpoint
+    #
+    # response - the endpoint for the previous/next page
+    #
+    # Returns a String of the partial URI if the given url follows the regular API format
+    # Returns nil in other cases (e.g. when given nil, or an irrelevant url)
+    def extract_endpoint_from(url = nil)
+      URI.parse(url).path[/api.mailgun.net\/v[\d]\/#{@domain}\/events\/(.+)/,1]
+    rescue URI::InvalidURIError
+      nil
     end
 
     # Internal: construct the event path to be used by the client

data/lib/mailgun/version.rb

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

data/lib/mailgun/webhooks/webhooks.rb

@@ -46,7 +46,7 @@ module Mailgun
     # Returns a Boolean of whether the webhook was created
     def create(domain, action, url = '')
       res = @client.post("domains/#{domain}/webhooks", id: action, url: url)
-      res.to_h['webhook'] == url && res.to_h[message] == 'Webhook has been created'
+      res.to_h['webhook']['url'] == url && res.to_h[message] == 'Webhook has been created'
     end
     alias_method :add, :create
     alias_method :add_webhook, :create

data/lib/railgun/mailer.rb

@@ -11,7 +11,7 @@ module Railgun
 
     # [Hash] config ->
     #   Requires *at least* `api_key` and `domain` keys.
-    attr_accessor :config, :domain
+    attr_accessor :config, :domain, :settings
 
     # Initialize the Railgun mailer.
     #
@@ -26,6 +26,9 @@ module Railgun
       @mg_client = Mailgun::Client.new(config[:api_key])
       @domain = @config[:domain]
 
+      # To avoid exception in mail gem v2.6
+      @settings = { return_response: true }
+
       if (@config[:fake_message_send] || false)
         Rails.logger.info "NOTE: fake message sending has been enabled for mailgun-ruby!"
         @mg_client.enable_test_mode!
@@ -37,7 +40,7 @@ module Railgun
       response = @mg_client.send_message(@domain, mg_message)
 
       if response.code == 200 then
-        mg_id = response.body['id']
+        mg_id = response.to_h['id']
         mail.message_id = mg_id
       end
       response

data/spec/integration/email_validation_spec.rb

@@ -38,6 +38,12 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     expect(res).to eq(expected)
   end
 
+  it 'performs mailbox validation for alice@mailgun.net' do
+    res = @mg_obj.validate("alice@mailgun.net", true)
+
+    expect(res["mailbox_verification"]).to eq("true")
+  end
+
   it 'fails to validate example.org' do
     res = @mg_obj.validate("example.org")
 

data/vcr_cassettes/email_validation.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/parse?addresses=Alice%20%3Calice@example.com%3E%3Bbob@example.com%3Bexample.org&syntax_only=true
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/parse?addresses=Alice%20%3Calice@example.com%3E%3Bbob@example.com%3Bexample.org&syntax_only=true
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -33,7 +33,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -56,13 +56,13 @@ http_interactions:
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -87,7 +87,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -111,13 +111,13 @@ http_interactions:
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/validate?address=example.org
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=example.org
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -142,7 +142,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -164,4 +164,52 @@ http_interactions:
         }
     http_version: 
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
+- request:
+    method: get
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net&mailbox_verification=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin16.7.0 x86_64) ruby/2.0.0p0
+      Host:
+      - api.mailgun.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Max-Age:
+      - '600'
+      Content-Disposition:
+      - inline
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 12 Sep 2017 16:55:09 GMT
+      Server:
+      - nginx
+      Content-Length:
+      - '243'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"address": "alice@mailgun.net", "did_you_mean": null, "is_disposable_address":
+        false, "is_role_address": false, "is_valid": true, "mailbox_verification":
+        "true", "parts": {"display_name": null, "domain": "mailgun.net", "local_part":
+        "alice"}}'
+    http_version: 
+  recorded_at: Tue, 12 Sep 2017 16:55:09 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.6
+  version: 1.1.8
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-env.yml.example"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -229,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Mailgun's Official Ruby SDK