mailgun-ruby 1.2.15 → 1.3.5

data/spec/integration/mailgun_spec.rb

@@ -15,7 +15,7 @@ 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
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'display useful error information' do
@@ -27,7 +27,7 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::CommunicationError => err
-      expect(err.message).to eq('404 Not Found: Domain not found: not-our-doma.in')
+      expect(err.message).to eq('the server responded with status 404')
     else
       fail
     end
@@ -39,7 +39,7 @@ vcr_opts = { :cassette_name => "exceptions-invalid-api-key" }
 describe 'Client exceptions', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'displays error information that API key is invalid' do
@@ -51,7 +51,7 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::Unauthorized => err
-      expect(err.message).to eq('401 Unauthorized - Invalid Domain or API key: Forbidden')
+      expect(err.message).to eq('the server responded with status 401 - Invalid Domain or API key')
     else
       fail
     end
@@ -63,7 +63,7 @@ vcr_opts = { :cassette_name => "exceptions-invalid-data" }
 describe 'Client exceptions', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'display useful error information' do
@@ -75,7 +75,7 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::BadRequest => err
-      expect(err.message).to eq('400 Bad Request: to parameter is not a valid address. please check documentation')
+      expect(err.message).to eq('the server responded with status 400')
     else
       fail
     end
@@ -87,7 +87,7 @@ vcr_opts = { :cassette_name => "exceptions-not-allowed" }
 describe 'Client exceptions', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'display useful error information' do
@@ -99,7 +99,7 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::CommunicationError => err
-      expect(err.message).to include('403 Forbidden')
+      expect(err.message).to include('403')
     else
       fail
     end
@@ -111,10 +111,11 @@ vcr_opts = { :cassette_name => "send_message" }
 describe 'The method send_message()', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'sends a standard message in test mode.' do
+    @mg_obj.enable_test_mode!
     result = @mg_obj.send_message(@domain, {:from => "bob@#{@domain}",
                                     :to => "sally@#{@domain}",
                                     :subject => 'Hash Integration Test',
@@ -183,7 +184,8 @@ Sender: me@samples.mailgun.org
 
 Testing some Mailgun awesomness!'
 
-    message_params = {:to => "sally@#{@domain}",
+    message_params = {:from => "bobby@#{@domain}",
+                      :to => "sally@#{@domain}",
                       :message => mime_string}
 
     result = @mg_obj.send_message(@domain, message_params)
@@ -192,7 +194,7 @@ Testing some Mailgun awesomness!'
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
-  
+
   it 'receives success response code' do
     @mg_obj.enable_test_mode!
 
@@ -205,7 +207,7 @@ Testing some Mailgun awesomness!'
 
     result = @mg_obj.send_message(@domain, data)
     result.to_h!
-    
+
     expect(result.success?).to be(true)
   end
 end

data/spec/integration/metrics_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { cassette_name: 'metrics' }
+
+describe Mailgun::Metrics, vcr: vcr_opts do
+  let(:metrics) { Mailgun::Metrics.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
+
+  describe '#account_metrics' do
+    let(:options) do
+      {
+        resolution: 'hour',
+        metrics: [
+          'accepted_count',
+          'delivered_count',
+          'clicked_rate',
+          'opened_rate'
+        ],
+        include_aggregates: true,
+        start: 'Tue, 26 Nov 2024 20:56:50 -0500',
+        duration: '1m',
+        filter: {
+          AND: [
+            {
+              attribute: 'domain',
+              comparator: '!=',
+              values: [
+                {
+                  label: 'example.com',
+                  value: 'example.com'
+                }
+              ]
+            }
+          ]
+        },
+        dimensions: ['time'],
+        end: 'Tue, 30 Nov 2024 20:56:50 -0500',
+        include_subaccounts: true
+      }
+    end
+
+    it 'responds with account metrics' do
+      expect(metrics.account_metrics(options)).to eq(
+        {
+          "start" => "Fri, 01 Nov 2024 01:00:00 +0000",
+          "end" => "Sun, 01 Dec 2024 01:00:00 +0000",
+          "resolution" => "hour",
+          "duration" => "1m",
+          "dimensions" => ["time"],
+          "pagination" => {
+            "sort" => "", "skip" => 0, "limit" => 1500, "total" => 3
+          },
+          "items" => [{
+              "dimensions" => [{
+                "dimension" => "time",
+                "value" => "Wed, 27 Nov 2024 12:00:00 +0000",
+                "display_value" => "Wed, 27 Nov 2024 12:00:00 +0000"
+              }],
+              "metrics" => {
+                "accepted_count" => 1, "delivered_count" => 1, "opened_rate" => "0.0000", "clicked_rate" => "0.0000"
+              }
+            },
+            {
+              "dimensions" => [{
+                "dimension" => "time",
+                "value" => "Wed, 27 Nov 2024 13:00:00 +0000",
+                "display_value" => "Wed, 27 Nov 2024 13:00:00 +0000"
+              }],
+              "metrics" => {
+                "accepted_count" => 1, "delivered_count" => 1, "opened_rate" => "0.0000", "clicked_rate" => "0.0000"
+              }
+            },
+            {
+              "dimensions" => [{
+                "dimension" => "time",
+                "value" => "Thu, 28 Nov 2024 15:00:00 +0000",
+                "display_value" => "Thu, 28 Nov 2024 15:00:00 +0000"
+              }],
+              "metrics" => {
+                "accepted_count" => 1, "delivered_count" => 1, "opened_rate" => "0.0000", "clicked_rate" => "0.0000"
+              }
+            }
+          ],
+          "aggregates" => {
+            "metrics" => {
+              "accepted_count" => 3, "delivered_count" => 3, "opened_rate" => "0.0000", "clicked_rate" => "0.0000"
+            }
+          }
+        }
+      )
+    end
+  end
+
+  describe '#account_usage_metrics' do
+    let(:options) do
+      {
+        resolution: 'hour',
+        metrics: [
+          'email_preview_count',
+          'email_preview_failed_count',
+          'email_validation_bulk_count',
+          'email_validation_count',
+          'email_validation_list_count',
+          'email_validation_mailgun_count',
+          'email_validation_mailjet_count',
+          'email_validation_public_count',
+          'email_validation_single_count',
+          'email_validation_valid_count',
+          'link_validation_count',
+          'link_validation_failed_count',
+          'processed_count',
+          'seed_test_count'
+        ],
+        include_aggregates: true,
+        start: 'Tue, 26 Nov 2024 20:56:50 -0500',
+        duration: '1m',
+        filter: {
+          AND: [
+            {
+              attribute: 'subaccount',
+              comparator: '!=',
+              values: [
+                {
+                  label: '12345',
+                  value: '12345'
+                }
+              ]
+            }
+          ]
+        },
+        dimensions: ['time'],
+        end: 'Tue, 28 Nov 2024 20:56:50 -0500',
+        include_subaccounts: true
+      }
+    end
+
+    it 'responds with account usage metrics' do
+      expect(metrics.account_usage_metrics(options)).to eq(
+        {
+          "start" => "Tue, 29 Oct 2024 01:00:00 +0000",
+          "end" => "Fri, 29 Nov 2024 01:00:00 +0000",
+          "resolution" => "hour",
+          "duration" => "1m",
+          "dimensions" => ["time"],
+          "pagination" => {
+            "sort" => "", "skip" => 0, "limit" => 1500, "total" => 2
+          },
+          "items" => [{
+              "dimensions" => [{
+                "dimension" => "time",
+                "value" => "Wed, 27 Nov 2024 00:00:00 +0000",
+                "display_value" => "Wed, 27 Nov 2024 00:00:00 +0000"
+              }],
+              "metrics" => {
+                "processed_count" => 2,
+                "email_validation_count" => 0,
+                "email_validation_public_count" => 0,
+                "email_validation_valid_count" => 0,
+                "email_validation_single_count" => 0,
+                "email_validation_bulk_count" => 0,
+                "email_validation_list_count" => 0,
+                "email_validation_mailgun_count" => 0,
+                "email_validation_mailjet_count" => 0,
+                "email_preview_count" => 0,
+                "email_preview_failed_count" => 0,
+                "link_validation_count" => 0,
+                "link_validation_failed_count" => 0,
+                "seed_test_count" => 0
+              }
+            },
+            {
+              "dimensions" => [{
+                "dimension" => "time",
+                "value" => "Thu, 28 Nov 2024 00:00:00 +0000",
+                "display_value" => "Thu, 28 Nov 2024 00:00:00 +0000"
+              }],
+              "metrics" => {
+                "processed_count" => 1,
+                "email_validation_count" => 0,
+                "email_validation_public_count" => 0,
+                "email_validation_valid_count" => 0,
+                "email_validation_single_count" => 0,
+                "email_validation_bulk_count" => 0,
+                "email_validation_list_count" => 0,
+                "email_validation_mailgun_count" => 0,
+                "email_validation_mailjet_count" => 0,
+                "email_preview_count" => 0,
+                "email_preview_failed_count" => 0,
+                "link_validation_count" => 0,
+                "link_validation_failed_count" => 0,
+                "seed_test_count" => 0
+              }
+            }
+          ],
+          "aggregates" => {
+            "metrics" => {
+              "permanent_failed_count" => 0,
+              "processed_count" => 3,
+              "email_validation_count" => 0,
+              "email_validation_public_count" => 0,
+              "email_validation_valid_count" => 0,
+              "email_validation_single_count" => 0,
+              "email_validation_bulk_count" => 0,
+              "email_validation_list_count" => 0,
+              "email_validation_mailgun_count" => 0,
+              "email_validation_mailjet_count" => 0,
+              "email_preview_count" => 0,
+              "email_preview_failed_count" => 0,
+              "link_validation_count" => 0,
+              "link_validation_failed_count" => 0,
+              "seed_test_count" => 0
+            }
+          }
+        }
+      )
+    end
+  end
+end

data/spec/integration/routes_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "routes" }
+vcr_opts = { :cassette_name => "routes", :match_requests_on => [:uri, :method, :body] }
 
 describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -25,6 +25,22 @@ describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
     expect(result.body["route"]["priority"]).to eq(10)
   end
 
+  it 'creates a route with multiple actions' do
+    result = @mg_obj.post("routes",  { priority: 10,
+                                       description: 'Integration Test Route',
+                                       expression: "match_recipient(\"#{@forward_to}\")",
+                                       action: ["forward(\"#{@recipient}\")", "stop()"] })
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been created")
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"].count).to eq 2
+    expect(result.body["route"]["actions"][0]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["actions"][1]).to include("stop()")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
+
   it 'gets a list of all routes.' do
     result = @mg_obj.get("routes", {:limit => 50})
 

data/spec/integration/stats_spec.rb

@@ -6,7 +6,7 @@ vcr_opts = { :cassette_name => "stats" }
 describe 'For the Stats endpoint', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'get some stats.' do

data/spec/integration/unsubscribes_spec.rb

@@ -6,8 +6,8 @@ vcr_opts = { :cassette_name => "unsubscribes" }
 describe 'For the Unsubscribes endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @email = "integration-test-email@#{TESTDOMAIN}"
+    @domain = TESTDOMAIN || 'DOMAIN.TEST'
+    @email = "integration-test-email@#{@domain}"
   end
 
   it 'adds an unsubscriber' do

data/spec/integration/webhook_spec.rb

@@ -6,7 +6,7 @@ vcr_opts = { :cassette_name => "webhooks" }
 describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
+    @domain = 'DOMAIN.TEST'
     @testhook = 'accepted'
     @testhookup = 'accepted'
   end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'mailgun'
 
 require 'vcr'
 require 'webmock/rspec'
+require 'rspec/its'
 
 #WebMock.disable_net_connect!(allow_localhost: true)
 require_relative 'unit/connection/test_client'

data/spec/unit/connection/test_client.rb

@@ -99,7 +99,7 @@ module Mailgun
         return Response.from_hash({ body: JSON.generate({"message" => "Queued. Thank you.", "id" => id}) })
       end
       if resource_endpoint == "bounces"
-        return Response.from_hash({ body: JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "code" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}}) })
+        return Response.from_hash({ body: JSON.generate({"total_count" => 1, "items" => {"created_at" => "Fri, 21 Oct 2011 11:02:55 GMT", "status" => 550, "address" => "baz@example.com", "error" => "Message was not accepted -- invalid mailbox. Local mailbox baz@example.com is unavailable: user not found"}}) })
       end
       if resource_endpoint == "lists"
         return Response.from_hash({ body: JSON.generate({"member" => {"vars" => {"age" => 26}, "name" => "Foo Bar", "subscribed" => false, "address" => "bar@example.com"}, "message" => "Mailing list member has been updated"}) })

data/spec/unit/events/events_spec.rb

@@ -20,7 +20,7 @@ describe 'Pagination' do
     json = JSON.parse(result.body)
     expect(json).to include("paging")
     expect(json["paging"]).to include("next")
-    expect(json["paging"]).to include{"previous"}
+    expect(json["paging"]).to include("previous")
   end
 
   it 'should calculate proper next-page url' do

data/spec/unit/exceptions/exceptions_spec.rb

@@ -5,13 +5,13 @@ RSpec.describe Mailgun::CommunicationError do
     context "when the Response body doesn't have a `message` property" do
       it "doesn't raise an error" do
         expect do
-          described_class.new('Boom!', Mailgun::Response.from_hash({ code: 401, body: '{}' }))
+          described_class.new('Boom!', Mailgun::Response.from_hash({ status: 401, body: '{}' }))
         end.not_to raise_error
       end
 
       context "when the Response body has an `Error` property" do
         it "uses the `Error` property as the API message" do
-          subject = described_class.new('Boom!', Mailgun::Response.from_hash({ code: 401, body: '{"Error":"unauthorized"}' }))
+          subject = described_class.new('Boom!', Mailgun::Response.from_hash({ status: 401, body: '{"Error":"unauthorized"}' }))
 
           expect(subject.message).to eq("Boom!: unauthorized")
         end
@@ -19,7 +19,7 @@ RSpec.describe Mailgun::CommunicationError do
 
       context "when the Response body has an `error` property" do
         it "uses the `Error` property as the API message" do
-          subject = described_class.new('Boom!', Mailgun::Response.from_hash({ code: 401, body: '{"error":"not found"}' }))
+          subject = described_class.new('Boom!', Mailgun::Response.from_hash({ status: 401, body: '{"error":"not found"}' }))
 
           expect(subject.message).to eq("Boom!: not found")
         end

data/spec/unit/messages/message_builder_spec.rb

@@ -262,10 +262,11 @@ describe 'The method add_attachment' do
     io = StringIO.new
     io << File.binread(File.dirname(__FILE__) + "/sample_data/mailgun_icon.png")
 
-    @mb_obj.add_attachment io, 'mailgun_icon.png'
+    @mb_obj.add_attachment io, 'cool_attachment.png'
 
     expect(@mb_obj.message[:attachment].length).to eq(1)
-    expect(@mb_obj.message[:attachment].first.original_filename).to eq 'mailgun_icon.png'
+    expect(@mb_obj.message[:attachment].first.io.original_filename).to eq 'cool_attachment.png'
+    expect(@mb_obj.message[:attachment].first.original_filename).to eq 'cool_attachment.png'
   end
 
   context 'when attachment has unknown type' do
@@ -450,7 +451,7 @@ describe 'The method add_tag' do
   end
   it 'adds too many tags to the message' do
     expect{
-      10.times do
+      12.times do
         @mb_obj.add_tag('My-Tag')
     end }.to raise_error(Mailgun::ParameterError)
   end