mailgun-ruby 1.4.2 → 1.4.3

data/spec/unit/helpers/api_version_checker_spec.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'mailgun'
+require 'mailgun/helpers/api_version_checker'
+
+describe Mailgun::ApiVersionChecker do
+  # Build a minimal host class that includes the module, with a controllable
+  # @client so we can set api_version per example.
+  subject(:instance) { host_class.new(client) }
+
+  let(:client) { double(:client) }
+
+  let(:host_class) do
+    Class.new do
+      include Mailgun::ApiVersionChecker
+
+      attr_reader :result
+
+      def initialize(client)
+        @client = client
+      end
+
+      def do_something(arg = nil)
+        @result = arg || :called
+      end
+    end
+  end
+
+  # ──────────────────────────────────────────────────────────────────────────
+  # .included / module structure
+  # ──────────────────────────────────────────────────────────────────────────
+
+  describe '.included' do
+    it 'extends the including class with ClassMethods' do
+      expect(host_class).to respond_to(:requires_api_version)
+      expect(host_class).to respond_to(:enforces_api_version)
+    end
+
+    it 'does not expose ClassMethods as instance methods' do
+      expect(instance).not_to respond_to(:requires_api_version)
+      expect(instance).not_to respond_to(:enforces_api_version)
+    end
+  end
+
+  # ──────────────────────────────────────────────────────────────────────────
+  # .requires_api_version  (warns but still calls through)
+  # ──────────────────────────────────────────────────────────────────────────
+
+  describe '.requires_api_version' do
+    before { host_class.requires_api_version('v3', :do_something) }
+
+    context 'when the client is on the expected version' do
+      before { allow(client).to receive(:api_version).and_return('v3') }
+
+      it 'does not emit a warning' do
+        expect { instance.do_something }.not_to output.to_stderr
+      end
+
+      it 'still calls the original method' do
+        instance.do_something(:payload)
+        expect(instance.result).to eq(:payload)
+      end
+
+      it 'forwards all arguments to the original method' do
+        instance.do_something(:forwarded_arg)
+        expect(instance.result).to eq(:forwarded_arg)
+      end
+    end
+
+    context 'when the client is on a different version' do
+      before { allow(client).to receive(:api_version).and_return('v4') }
+
+      it 'emits a warning to stderr' do
+        expect { instance.do_something }
+          .to output(/WARN: Client api version must be v3/).to_stderr
+      end
+
+      it 'still calls the original method despite the warning' do
+        instance.do_something(:payload)
+        expect(instance.result).to eq(:payload)
+      end
+
+      it 'warning message includes the expected version' do
+        expect { instance.do_something }
+          .to output(/v3/).to_stderr
+      end
+    end
+
+    it 'wraps multiple methods when given a list' do
+      host_class.class_eval { def do_other = @result = :other }
+      host_class.requires_api_version('v3', :do_something, :do_other)
+
+      allow(client).to receive(:api_version).and_return('v4')
+
+      expect { instance.do_something }.to output(/v3/).to_stderr
+      expect { instance.do_other }.to output(/v3/).to_stderr
+    end
+
+    it 'wraps only the listed methods, leaving others unwrapped' do
+      host_class.class_eval { def unwrapped = @result = :unwrapped }
+      host_class.requires_api_version('v3', :do_something)
+
+      allow(client).to receive(:api_version).and_return('v4')
+
+      # unwrapped should not warn
+      expect { instance.unwrapped }.not_to output.to_stderr
+    end
+  end
+
+  # ──────────────────────────────────────────────────────────────────────────
+  # .enforces_api_version  (raises on version mismatch)
+  # ──────────────────────────────────────────────────────────────────────────
+
+  describe '.enforces_api_version' do
+    before { host_class.enforces_api_version('v3', :do_something) }
+
+    context 'when the client is on the expected version' do
+      before { allow(client).to receive(:api_version).and_return('v3') }
+
+      it 'does not raise' do
+        expect { instance.do_something }.not_to raise_error
+      end
+
+      it 'calls the original method' do
+        instance.do_something(:payload)
+        expect(instance.result).to eq(:payload)
+      end
+
+      it 'forwards all arguments to the original method' do
+        instance.do_something(:forwarded_arg)
+        expect(instance.result).to eq(:forwarded_arg)
+      end
+    end
+
+    context 'when the client is on a different version' do
+      before { allow(client).to receive(:api_version).and_return('v4') }
+
+      it 'raises Mailgun::ParameterError' do
+        expect { instance.do_something }
+          .to raise_error(Mailgun::ParameterError)
+      end
+
+      it 'raises with a message including the expected version' do
+        expect { instance.do_something }
+          .to raise_error(Mailgun::ParameterError, /v3/)
+      end
+
+      it 'does not call the original method' do
+        begin
+          instance.do_something
+        rescue StandardError
+          nil
+        end
+        expect(instance.result).to be_nil
+      end
+    end
+
+    it 'wraps multiple methods when given a list' do
+      host_class.class_eval { def do_other = @result = :other }
+      host_class.enforces_api_version('v3', :do_something, :do_other)
+
+      allow(client).to receive(:api_version).and_return('v4')
+
+      expect { instance.do_something }.to raise_error(Mailgun::ParameterError)
+      expect { instance.do_other }.to raise_error(Mailgun::ParameterError)
+    end
+
+    it 'wraps only the listed methods, leaving others unwrapped' do
+      host_class.class_eval { def unwrapped = @result = :unwrapped }
+      host_class.enforces_api_version('v3', :do_something)
+
+      allow(client).to receive(:api_version).and_return('v4')
+
+      expect { instance.unwrapped }.not_to raise_error
+    end
+  end
+
+  # ──────────────────────────────────────────────────────────────────────────
+  # requires vs enforces contrast
+  # ──────────────────────────────────────────────────────────────────────────
+
+  describe 'requires_api_version vs enforces_api_version' do
+    before do
+      host_class.class_eval do
+        def soft_method = @result = :soft
+        def hard_method = @result = :hard
+      end
+      host_class.requires_api_version('v3', :soft_method)
+      host_class.enforces_api_version('v3', :hard_method)
+
+      allow(client).to receive(:api_version).and_return('v4')
+    end
+
+    it 'requires_api_version warns but does not raise' do
+      expect { instance.soft_method }.to output(/v3/).to_stderr
+      expect(instance.result).to eq(:soft)
+    end
+
+    it 'enforces_api_version raises and does not call through' do
+      expect { instance.hard_method }.to raise_error(Mailgun::ParameterError)
+      expect(instance.result).not_to eq(:hard)
+    end
+  end
+end

data/spec/unit/lists/opt_in_handler_spec.rb

@@ -3,11 +3,13 @@
 require 'spec_helper'
 
 describe 'The method generate_hash' do
-  before(:each) do
+  before do
     @mailing_list = 'mylist@example.com'
     @secret_app_id = 'mysupersecretpassword'
     @recipient_address = 'bob@example.com'
-    @precalculated_hash = 'eyJoIjoiMmY3ZmY1MzFlOGJmMjA0OWNhMTI3ZmU4ZTQyNjZkOTljYzhkMTdk%0AMiIsInAiOiJleUpzSWpvaWJYbHNhWE4wUUdWNFlXMXdiR1V1WTI5dElpd2lj%0AaUk2SW1KdllrQmxlR0Z0Y0d4bExtTnZcbmJTSjlcbiJ9%0A'
+    @precalculated_hash =
+      "eyJoIjoiMmY3ZmY1MzFlOGJmMjA0OWNhMTI3ZmU4ZTQyNjZkOTljYzhkMTdk%0AMiIsInAiOiJleUpzSWpv\
+aWJYbHNhWE4wUUdWNFlXMXdiR1V1WTI5dElpd2lj%0AaUk2SW1KdllrQmxlR0Z0Y0d4bExtTnZcbmJTSjlcbiJ9%0A"
   end
 
   it 'generates a web safe hash for the recipient wishing to subscribe' do

data/spec/unit/mailgun_spec.rb

@@ -9,7 +9,7 @@ describe 'Mailgun instantiation' do
 end
 
 describe 'The method send_message()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('messages')
     @domain = 'test.com'
     @list_address = 'mylist@test.com'
@@ -73,10 +73,11 @@ describe 'The method send_message()' do
 end
 
 describe 'The method post()' do
-  before(:each) do
+  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',
@@ -111,7 +112,7 @@ describe 'The method post()' do
 end
 
 describe 'The method put()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('lists')
     @domain = 'test.com'
     @list_address = 'mylist@test.com'
@@ -136,10 +137,11 @@ describe 'The method put()' do
 end
 
 describe 'The method get()' do
-  before(:each) do
+  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' }
@@ -153,7 +155,7 @@ describe 'The method get()' do
 end
 
 describe 'The method delete()' do
-  before(:each) do
+  before do
     @mg_obj = Mailgun::UnitClient.new('campaigns')
     @domain = 'test.com'
   end

data/spec/unit/messages/batch_message_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe 'BatchMessage attribute readers' do
-  it 'should be readable' do
+  it 'is readable' do
     @mb_client = Mailgun::UnitClient.new('messages')
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
 
@@ -16,7 +16,7 @@ describe 'BatchMessage attribute readers' do
 end
 
 describe 'The instantiation of Batch Message' do
-  before(:each) do
+  before do
     @mb_client = Mailgun::UnitClient.new('messages')
     @mb_obj = Mailgun::BatchMessage.new(@mb_client, 'example.com')
   end
@@ -63,30 +63,31 @@ describe 'The instantiation of Batch Message' do
 end
 
 describe 'The method add_recipient' do
-  before(:each) do
+  before 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' }
+    @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
@@ -94,7 +95,7 @@ describe 'The method add_recipient' do
     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)
@@ -109,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
 
@@ -118,28 +119,28 @@ 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)
+      @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[@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)
+      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)
+      @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