mailgun-ruby 1.4.1 → 1.4.3

data/spec/unit/mailgun_spec.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Mailgun instantiation' do
   it 'instantiates an HttpClient object' do
-    expect {@mg_obj = Mailgun::UnitClient.new("messages")}.not_to raise_error
+    expect { @mg_obj = Mailgun::UnitClient.new('messages') }.not_to raise_error
   end
 end
 
 describe 'The method send_message()' do
-  before(:each) do
-    @mg_obj = Mailgun::UnitClient.new("messages")
-    @domain = "test.com"
-    @list_address = "mylist@test.com"
-    @member_address = "subscribee@test.com"
+  before do
+    @mg_obj = Mailgun::UnitClient.new('messages')
+    @domain = 'test.com'
+    @list_address = 'mylist@test.com'
+    @member_address = 'subscribee@test.com'
   end
 
   it 'accepts only specific data types' do
-    @mb_obj = Mailgun::MessageBuilder.new()
+    @mb_obj = Mailgun::MessageBuilder.new
     @mh_obj = {}
 
-    expect {@mg_obj.send_message("test.com", "incorrect data")}.to raise_error Mailgun::ParameterError
-    expect {@mg_obj.send_message("test.com", @mb_obj)}.not_to raise_error
-    expect {@mg_obj.send_message("test.com", @mh_obj)}.not_to raise_error
+    expect { @mg_obj.send_message('test.com', 'incorrect data') }.to raise_error Mailgun::ParameterError
+    expect { @mg_obj.send_message('test.com', @mb_obj) }.not_to raise_error
+    expect { @mg_obj.send_message('test.com', @mh_obj) }.not_to raise_error
   end
 
   it 'sends a message' do
@@ -28,12 +30,12 @@ describe 'The method send_message()' do
              'to' => 'bob@example.com',
              'subject' => 'Test',
              'text' => 'Test Data' }
-    result = @mg_obj.send_message("testdomain.com", data)
+    result = @mg_obj.send_message('testdomain.com', data)
 
     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 'opens the message MIME and sends the MIME message.' do
@@ -42,119 +44,120 @@ describe 'The method send_message()' do
       'message' => 'Sample Data/mime.txt',
       'from' => 'joe@test.com'
     }
-    result = @mg_obj.send_message("testdomain.com", data)
+    result = @mg_obj.send_message('testdomain.com', data)
 
     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
 
   context 'when domain is missing' do
     it 'shows failure message' do
-      expect(@mg_obj).to receive(:fail)
+      expect(@mg_obj).to receive(:raise)
       @mg_obj.send_message(nil, {})
     end
   end
 
   context 'when to is missing' do
     it 'shows failure message' do
-    data = {
-      'to' => '',
-      'message' => 'Sample Data/mime.txt',
-      'from' => 'joe@test.com'
-    }
-    expect(@mg_obj).to receive(:fail)
-    @mg_obj.send_message("testdomain.com", data)
+      data = {
+        'to' => '',
+        'message' => 'Sample Data/mime.txt',
+        'from' => 'joe@test.com'
+      }
+      expect(@mg_obj).to receive(:raise)
+      @mg_obj.send_message('testdomain.com', data)
     end
   end
 end
 
 describe 'The method post()' do
-  before(:each) do
-    @mg_obj = Mailgun::UnitClient.new("messages")
-    @domain = "test.com"
+  before do
+    @mg_obj = Mailgun::UnitClient.new('messages')
+    @domain = 'test.com'
   end
+
   it 'in this case, sends a simple message.' do
-    data = {'from' => 'joe@test.com',
-                    'to' => 'bob@example.com',
-                    'subject' => 'Test',
-                    'text' => 'Test Data'}
+    data = { 'from' => 'joe@test.com',
+             'to' => 'bob@example.com',
+             'subject' => 'Test',
+             'text' => 'Test Data' }
     result = @mg_obj.post("#{@domain}/messages", data)
 
     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
 
   context 'when Unknown API error is raised' do
     before do
-      allow(Mailgun::Response).to receive(:new).and_raise(StandardError, "message")
+      allow(Mailgun::Response).to receive(:new).and_raise(StandardError, 'message')
       allow(JSON).to receive(:parse).and_raise('Unknown')
     end
 
     it 'adds Unknown API error to message' do
-      data = {'from' => 'joe@test.com',
-                    'to' => 'bob@example.com',
-                    'subject' => 'Test',
-                    'text' => 'Test Data'}
+      data = { 'from' => 'joe@test.com',
+               'to' => 'bob@example.com',
+               'subject' => 'Test',
+               'text' => 'Test Data' }
       @mg_obj.post("#{@domain}/messages", data)
-    rescue Mailgun::CommunicationError => err
-      expect(err.message).to eq('message: Unknown API error')
+    rescue Mailgun::CommunicationError => e
+      expect(e.message).to eq('message: Unknown API error')
     else
-      fail
+      raise
     end
   end
 end
 
 describe 'The method put()' do
-  before(:each) do
-    @mg_obj = Mailgun::UnitClient.new("lists")
-    @domain = "test.com"
-    @list_address = "mylist@test.com"
-    @member_address = "subscribee@test.com"
+  before do
+    @mg_obj = Mailgun::UnitClient.new('lists')
+    @domain = 'test.com'
+    @list_address = 'mylist@test.com'
+    @member_address = 'subscribee@test.com'
   end
 
   it 'in this case, updates a member with the attributes in data.' do
-    data = {'subscribed' => false,
-                    'name' => 'Foo Bar'}
+    data = { 'subscribed' => false,
+             'name' => 'Foo Bar' }
     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")
-    expect(result.body["member"]).to include("name")
-    expect(result.body["member"]).to include("subscribed")
-    expect(result.body["member"]).to include("address")
-    expect(result.body).to include("message")
+    expect(result.body).to include('member')
+    expect(result.body['member']).to include('vars')
+    expect(result.body['member']['vars']).to include('age')
+    expect(result.body['member']).to include('name')
+    expect(result.body['member']).to include('subscribed')
+    expect(result.body['member']).to include('address')
+    expect(result.body).to include('message')
   end
-
 end
 
 describe 'The method get()' do
-  before(:each) do
-    @mg_obj = Mailgun::UnitClient.new("bounces")
-    @domain = "test.com"
+  before do
+    @mg_obj = Mailgun::UnitClient.new('bounces')
+    @domain = 'test.com'
   end
+
   it 'in this case, obtains a list of bounces for the domain, limit of 5, skipping the first 10.' do
-    query_string = {'skip' => '10',
-                    'limit' => '5'}
+    query_string = { 'skip' => '10',
+                     'limit' => '5' }
     result = @mg_obj.get("#{@domain}/bounces", query_string)
 
     result.to_h!
 
-    expect(result.body).to include("total_count")
-    expect(result.body).to include("items")
+    expect(result.body).to include('total_count')
+    expect(result.body).to include('items')
   end
 end
 
 describe 'The method delete()' do
-  before(:each) do
-    @mg_obj = Mailgun::UnitClient.new("campaigns")
-    @domain = "test.com"
+  before do
+    @mg_obj = Mailgun::UnitClient.new('campaigns')
+    @domain = 'test.com'
   end
 
   it 'issues a generic delete request.' do
@@ -162,7 +165,7 @@ describe 'The method delete()' do
 
     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
 end

data/spec/unit/messages/batch_message_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'BatchMessage attribute readers' do
-  it 'should be readable' do
-    @mb_client = Mailgun::UnitClient.new("messages")
-    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+  it 'is readable' do
+    @mb_client = Mailgun::UnitClient.new('messages')
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
 
     expect(@mb_obj).to respond_to(:message_ids)
     expect(@mb_obj).to respond_to(:message)
@@ -14,10 +16,9 @@ describe 'BatchMessage attribute readers' do
 end
 
 describe 'The instantiation of Batch Message' do
-
-  before(:each) do
-    @mb_client = Mailgun::UnitClient.new("messages")
-    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
+  before do
+    @mb_client = Mailgun::UnitClient.new('messages')
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
   end
 
   it 'contains Message, which should be of type Hash and empty' do
@@ -62,38 +63,39 @@ describe 'The instantiation of Batch Message' do
 end
 
 describe 'The method add_recipient' do
-  before(:each) do
-    @mb_client = Mailgun::UnitClient.new("messages")
-    @mb_obj = Mailgun::BatchMessage.new(@mb_client, "example.com")
-    @address_1   = 'jane@example.com'
-    @variables_1 = {'first' => 'Jane', 'last' => 'Doe', 'tracking' => 'ABC123'}
-    @address_2   = 'bob@example.com'
-    @variables_2 = {'first' => 'Bob', 'last' => 'Doe', 'tracking' => 'DEF123'}
-    @address_3   = 'sam@example.com'
-    @variables_3 = {'first' => 'Sam', 'last' => 'Doe', 'tracking' => 'GHI123'}
+  before do
+    @mb_client = Mailgun::UnitClient.new('messages')
+    @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
+    @address1   = 'jane@example.com'
+    @variables1 = { 'first' => 'Jane', 'last' => 'Doe', 'tracking' => 'ABC123' }
+    @address2   = 'bob@example.com'
+    @variables2 = { 'first' => 'Bob', 'last' => 'Doe', 'tracking' => 'DEF123' }
+    @address3   = 'sam@example.com'
+    @variables3 = { 'first' => 'Sam', 'last' => 'Doe', 'tracking' => 'GHI123' }
   end
+
   context 'when from is present' do
-    before(:each) do
+    before do
       @mb_obj.from('example@email.com')
     end
 
     it 'adds 1,000 recipients to the message body and validates counter is incremented then reset' do
       recipient_type = :to
       1000.times do
-        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+        @mb_obj.add_recipient(recipient_type, @address1, @variables1)
       end
 
       expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
-      
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
-      
+
+      @mb_obj.add_recipient(recipient_type, @address1, @variables1)
+
       expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
     end
 
     it 'adds recipients to the message, calls finalize, and cleans up' do
       recipient_type = :to
       1000.times do
-        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+        @mb_obj.add_recipient(recipient_type, @address1, @variables1)
       end
 
       expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
@@ -108,7 +110,7 @@ describe 'The method add_recipient' do
     it 'adds 5,005 recipients to the message body and validates we receive message_ids back' do
       recipient_type = :to
       5005.times do
-        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+        @mb_obj.add_recipient(recipient_type, @address1, @variables1)
       end
       @mb_obj.finalize
 
@@ -117,31 +119,30 @@ describe 'The method add_recipient' do
 
     it 'sets recipient-variables, for batch expansion' do
       recipient_type = :to
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      @mb_obj.add_recipient(recipient_type, @address1, @variables1)
 
-      expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
+      expect(@mb_obj.recipient_variables[@address1]).to eq(@variables1)
     end
 
     it 'sets multiple recipient-variables, for batch expansion' do
       recipient_type = :to
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
-      @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
-      @mb_obj.add_recipient(recipient_type, @address_3, @variables_3)
-      
-      expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
-      expect(@mb_obj.recipient_variables[@address_2]).to eq(@variables_2)
-      expect(@mb_obj.recipient_variables[@address_3]).to eq(@variables_3)
+      @mb_obj.add_recipient(recipient_type, @address1, @variables1)
+      @mb_obj.add_recipient(recipient_type, @address2, @variables2)
+      @mb_obj.add_recipient(recipient_type, @address3, @variables3)
+
+      expect(@mb_obj.recipient_variables[@address1]).to eq(@variables1)
+      expect(@mb_obj.recipient_variables[@address2]).to eq(@variables2)
+      expect(@mb_obj.recipient_variables[@address3]).to eq(@variables3)
     end
   end
 
   context 'when from is empty' do
     it 'shows error message' do
       recipient_type = :to
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
-      @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
-      expect(@mb_client).to receive(:fail)
+      @mb_obj.add_recipient(recipient_type, @address1, @variables1)
+      @mb_obj.add_recipient(recipient_type, @address2, @variables2)
+      expect(@mb_client).to receive(:raise)
       @mb_obj.finalize
     end
   end
-
 end