mailgun-ruby 1.4.1 → 1.4.3

data/spec/integration/mailgun_spec.rb

@@ -1,105 +1,99 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 require 'mailgun/exceptions/exceptions'
 
-describe 'Mailgun instantiation', vcr: { :cassette_name => "instance" } do
+describe 'Mailgun instantiation', vcr: { cassette_name: 'instance' } do
   it 'instantiates an HttpClient object' do
-    expect {@mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)}.not_to raise_error
+    expect { @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL) }.not_to raise_error
   end
 end
 
-describe 'Client exceptions', vcr: { :cassette_name => "exceptions" } do
+describe 'Client exceptions', vcr: { cassette_name: 'exceptions' } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
   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 include('404')
-      expect(err.message).to include('Domain not found: not-our-doma.in')
-    else
-      fail
-    end
+    @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 => e
+    expect(e.message).to include('404')
+    expect(e.message).to include('Domain not found: not-our-doma.in')
+  else
+    raise
   end
 end
 
-describe 'Client exceptions', vcr: { :cassette_name => "exceptions-invalid-api-key" } do
+describe 'Client exceptions', vcr: { cassette_name: 'exceptions-invalid-api-key' } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'displays error information that API key is invalid' do
-    begin
-      @mg_obj.send_message(@domain, {
-          :from => "sally@#{@domain}",
-          :to => "sally@#{@domain}",
-          :subject => 'Exception Integration Test',
-          :text => 'INTEGRATION TESTING'
-      })
-    rescue Mailgun::Unauthorized => err
-      expect(err.message).to include('401')
-      expect(err.message).to include('Invalid Domain or API key')
-    else
-      fail
-    end
+    @mg_obj.send_message(@domain, {
+                           from: "sally@#{@domain}",
+                           to: "sally@#{@domain}",
+                           subject: 'Exception Integration Test',
+                           text: 'INTEGRATION TESTING'
+                         })
+  rescue Mailgun::Unauthorized => e
+    expect(e.message).to include('401')
+    expect(e.message).to include('Invalid Domain or API key')
+  else
+    raise
   end
 end
 
-describe 'Client exceptions', vcr: { :cassette_name => "exceptions-invalid-data" } do
+describe 'Client exceptions', vcr: { cassette_name: 'exceptions-invalid-data' } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'display useful error information' do
-    begin
-      @mg_obj.send_message(@domain, {
-          :from => "sally@#{@domain}",
-          :to => "sally#{@domain}",
-          :subject => 'Exception Integration Test',
-          :text => 'INTEGRATION TESTING'
-      })
-    rescue Mailgun::BadRequest => err
-      expect(err.message).to include('400')
-      expect(err.message).to include('to parameter is not a valid address. please check documentation')
-    else
-      fail
-    end
+    @mg_obj.send_message(@domain, {
+                           from: "sally@#{@domain}",
+                           to: "sally#{@domain}",
+                           subject: 'Exception Integration Test',
+                           text: 'INTEGRATION TESTING'
+                         })
+  rescue Mailgun::BadRequest => e
+    expect(e.message).to include('400')
+    expect(e.message).to include('to parameter is not a valid address. please check documentation')
+  else
+    raise
   end
 end
 
-describe 'Client exceptions', vcr: { :cassette_name => "exceptions-not-allowed" } do
+describe 'Client exceptions', vcr: { cassette_name: 'exceptions-not-allowed' } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
   end
 
   it 'display useful error information' do
-    begin
-      @mg_obj.send_message(@domain, {
-          :from => "invalid@#{@domain}",
-          :to => "invalid#{@domain}",
-          :subject => 'Exception Integration Test',
-          :text => 'INTEGRATION TESTING'
-      })
-    rescue Mailgun::CommunicationError => err
-      expect(err.message).to include('403')
-    else
-      fail
-    end
+    @mg_obj.send_message(@domain, {
+                           from: "invalid@#{@domain}",
+                           to: "invalid#{@domain}",
+                           subject: 'Exception Integration Test',
+                           text: 'INTEGRATION TESTING'
+                         })
+  rescue Mailgun::CommunicationError => e
+    expect(e.message).to include('403')
+  else
+    raise
   end
 end
 
-describe 'The method send_message()', vcr: { :cassette_name => "send_message" } do
+describe 'The method send_message()', vcr: { cassette_name: 'send_message' } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
@@ -107,26 +101,26 @@ describe 'The method send_message()', vcr: { :cassette_name => "send_message" }
 
   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',
-                                    :text => 'INTEGRATION TESTING',
-                                    'o:testmode' => true}
-                                  )
+    result = @mg_obj.send_message(@domain, { :from => "bob@#{@domain}",
+                                             :to => "sally@#{@domain}",
+                                             :subject => 'Hash Integration Test',
+                                             :text => 'INTEGRATION TESTING',
+                                             'o:testmode' => true })
     result.to_h!
-    expect(result.body).to include("message")
-    expect(result.body).to include("id")
+    expect(result.body).to include('message')
+    expect(result.body).to include('id')
+    expect(Mailgun::Client.deliveries.size).to eq(1)
   end
 
   it 'fakes message send while in *client* test mode' do
     @mg_obj.enable_test_mode!
 
-    expect(@mg_obj.test_mode?).to eq(true)
+    expect(@mg_obj.test_mode?).to be(true)
 
-    data = { :from => "joe@#{@domain}",
-             :to => "bob@#{@domain}",
-             :subject => "Test",
-             :text => "Test Data" }
+    data = { from: "joe@#{@domain}",
+             to: "bob@#{@domain}",
+             subject: 'Test',
+             text: 'Test Data' }
     uuid = 'uuid'
 
     allow(SecureRandom).to receive(:uuid).and_return(uuid)
@@ -135,27 +129,27 @@ describe 'The method send_message()', vcr: { :cassette_name => "send_message" }
 
     result.to_h!
 
-    expect(result.body).to include("message")
-    expect(result.body).to include("id")
+    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-#{uuid}@localhost")
-    expect(result.body['message']).to eq("Queued. Thank you.")
+    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'})
-    mb_obj.add_recipient(:to, "recipient@#{@domain}", {'first' => 'Recipient', 'last' => 'User'})
-    mb_obj.subject("Message Builder Integration Test")
-    mb_obj.body_text("This is the text body.")
+    mb_obj = Mailgun::MessageBuilder.new
+    mb_obj.from("sender@#{@domain}", { 'first' => 'Sending', 'last' => 'User' })
+    mb_obj.add_recipient(:to, "recipient@#{@domain}", { 'first' => 'Recipient', 'last' => 'User' })
+    mb_obj.subject('Message Builder Integration Test')
+    mb_obj.body_text('This is the text body.')
     mb_obj.test_mode(true)
 
     result = @mg_obj.send_message(@domain, mb_obj)
 
     result.to_h!
-    expect(result.body).to include("message")
-    expect(result.body).to include("id")
+    expect(result.body).to include('message')
+    expect(result.body).to include('id')
   end
 
   it 'sends a custom MIME message in test mode.' do
@@ -175,26 +169,26 @@ Sender: me@samples.mailgun.org
 
 Testing some Mailgun awesomness!'
 
-    message_params = {:from => "bobby@#{@domain}",
-                      :to => "sally@#{@domain}",
-                      :message => mime_string}
+    message_params = { from: "bobby@#{@domain}",
+                       to: "sally@#{@domain}",
+                       message: mime_string }
 
     result = @mg_obj.send_message(@domain, message_params)
 
     result.to_h!
-    expect(result.body).to include("message")
-    expect(result.body).to include("id")
+    expect(result.body).to include('message')
+    expect(result.body).to include('id')
   end
 
   it 'receives success response code' do
     @mg_obj.enable_test_mode!
 
-    expect(@mg_obj.test_mode?).to eq(true)
+    expect(@mg_obj.test_mode?).to be(true)
 
-    data = { :from => "joe@#{@domain}",
-             :to => "bob@#{@domain}",
-             :subject => "Test",
-             :text => "Test Data" }
+    data = { from: "joe@#{@domain}",
+             to: "bob@#{@domain}",
+             subject: 'Test',
+             text: 'Test Data' }
 
     result = @mg_obj.send_message(@domain, data)
     result.to_h!
@@ -202,4 +196,3 @@ Testing some Mailgun awesomness!'
     expect(result.success?).to be(true)
   end
 end
-

data/spec/integration/metrics_spec.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 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')) }
+  let(:metrics) { described_class.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'
+        metrics: %w[
+          accepted_count
+          delivered_count
+          clicked_rate
+          opened_rate
         ],
         include_aggregates: true,
         start: 'Tue, 26 Nov 2024 20:56:50 -0500',
@@ -42,48 +44,53 @@ describe Mailgun::Metrics, vcr: vcr_opts do
     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
+          '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"
-              }
+          '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'
             }
-          ],
-          "aggregates" => {
-            "metrics" => {
-              "accepted_count" => 3, "delivered_count" => 3, "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'
             }
           }
         }
@@ -95,21 +102,21 @@ describe Mailgun::Metrics, vcr: vcr_opts 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'
+        metrics: %w[
+          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',
@@ -137,78 +144,77 @@ describe Mailgun::Metrics, vcr: vcr_opts do
     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
+          '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
-              }
+          '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
             }
-          ],
-          "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
+          },
+                      {
+                        '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
             }
           }
         }