mailgun-ruby 1.4.0 → 1.4.1

data/lib/mailgun.rb

@@ -1,25 +1,41 @@
+# require ruby dependencies
+require 'json'
+require 'openssl'
 require 'tempfile'
-require 'faraday'
+require 'time'
+require 'uri'
 require 'yaml'
-require 'json'
 
-require 'mailgun/version'
-require 'mailgun/client'
-require 'mailgun/response'
-require 'mailgun/chains'
-require 'mailgun/address'
-require 'mailgun/lists/opt_in_handler'
-require 'mailgun/messages/batch_message'
-require 'mailgun/messages/message_builder'
-require 'mailgun/events/events'
+# require external dependencies
+require 'faraday'
+require 'faraday/multipart'
+require 'mini_mime'
+require 'zeitwerk'
+
 require 'mailgun/exceptions/exceptions'
-require 'mailgun/domains/domains'
-require 'mailgun/webhooks/webhooks'
-require 'mailgun/templates/templates'
-require 'mailgun/subaccounts/subaccounts'
-require 'mailgun/tags/tags'
-require 'mailgun/metrics/metrics'
-require 'mailgun/logs/logs'
+require 'mailgun/helpers/api_version_checker'
+
+# load zeitwerk
+Zeitwerk::Loader.for_gem.tap do |loader| # rubocop:disable Style/SymbolProc
+  loader.ignore("#{__dir__}/mailgun-ruby.rb")
+  loader.ignore("#{__dir__}/railgun.rb")
+  loader.ignore("#{__dir__}/railgun")
+
+  loader.collapse("#{__dir__}/mailgun/analytics_tags")
+  loader.collapse("#{__dir__}/mailgun/domains")
+  loader.collapse("#{__dir__}/mailgun/events")
+  loader.collapse("#{__dir__}/mailgun/exceptions")
+  loader.collapse("#{__dir__}/mailgun/helpers")
+  loader.collapse("#{__dir__}/mailgun/lists")
+  loader.collapse("#{__dir__}/mailgun/logs")
+  loader.collapse("#{__dir__}/mailgun/messages")
+  loader.collapse("#{__dir__}/mailgun/metrics")
+  loader.collapse("#{__dir__}/mailgun/subaccounts")
+  loader.collapse("#{__dir__}/mailgun/tags")
+  loader.collapse("#{__dir__}/mailgun/templates")
+  loader.collapse("#{__dir__}/mailgun/webhooks")
+  loader.setup
+end
 
 # Module for interacting with the sweet Mailgun API.
 #

data/lib/railgun/mailer.rb

@@ -1,9 +1,3 @@
-require 'action_mailer'
-require 'json'
-require 'mailgun'
-require 'rails'
-require 'railgun/errors'
-
 module Railgun
 
   # Railgun::Mailer is an ActionMailer provider for sending mail through

data/lib/railgun/railtie.rb

@@ -1,8 +1,15 @@
-require 'railgun/mailer'
-
 module Railgun
   class Railtie < ::Rails::Railtie
     ActiveSupport.on_load(:action_mailer) do
+      Mail::Message.class_eval do
+        # Attributes to hold Mailgun-specific information
+        attr_accessor :mailgun_variables,
+                      :mailgun_options,
+                      :mailgun_recipient_variables,
+                      :mailgun_headers,
+                      :mailgun_template_variables
+      end
+
       add_delivery_method :mailgun, Railgun::Mailer
       ActiveSupport.run_load_hooks(:mailgun_mailer, Railgun::Mailer)
     end

data/lib/railgun.rb

@@ -1,8 +1,15 @@
-require 'railgun/railtie'
-require 'railgun/attachment'
-require 'railgun/errors'
-require 'railgun/mailer'
-require 'railgun/message'
+# require ruby dependencies
+require 'json'
+
+# require external dependencies
+require 'action_mailer'
+require 'mail'
+require 'mailgun'
+require 'rails'
 
 module Railgun
+  require_relative 'railgun/attachment'
+  require_relative 'railgun/errors'
+  require_relative 'railgun/mailer'
+  require_relative 'railgun/railtie'
 end

data/mailgun.gemspec

@@ -25,19 +25,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.6.10'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_development_dependency 'bundler', '>= 1.16.2'
   spec.add_development_dependency 'rspec', '~> 3.13.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.3.1'
-  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'rspec-its', '~> 2.0.0'
+  spec.add_development_dependency 'rake', '~> 13.3.1'
   spec.add_development_dependency 'webmock', '~> 3.7'
-  spec.add_development_dependency 'pry', '~> 0.15.2'
-  spec.add_development_dependency 'vcr', '~> 3.0.3'
+  spec.add_development_dependency 'pry', '~> 0.16.0'
+  spec.add_development_dependency 'vcr', '~> 6.4.0'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'rails'
   spec.add_dependency 'mini_mime'
   spec.add_dependency 'faraday', "~> 2.1"
-  spec.add_dependency 'faraday-multipart', '~> 1.1.0'
-
+  spec.add_dependency 'faraday-multipart', '< 2'
+  spec.add_dependency 'zeitwerk'
 end

data/spec/integration/domains_spec.rb

@@ -9,276 +9,302 @@ describe 'For the domains endpoint', vcr: vcr_opts do
   let(:mg_obj) { Mailgun::Domains.new(mg_client) }
   let(:domain) { 'integration-test.domain.invalid' }
 
-  describe '#add_domain' do
-    let(:api_version) { 'v4' }
+  context 'Core Domains methods' do
+    describe '#list' do
+      let(:api_version) { 'v4' }
 
-    it 'creates a domain' do
-      response = mg_obj.add_domain(domain, { spam_action: 'tag' })
+      it 'returns a list of domains' do
+        response = mg_obj.list
 
-      expect(response['domain']['name']).to eq(domain)
-      expect(response['domain']['spam_action']).to eq('tag')
+        expect(response.size).to be > 0
+      end
     end
-  end
 
-  describe '#get' do
-    let(:api_version) { 'v4' }
+    describe '#create' do
+      let(:api_version) { 'v4' }
 
-    it 'returns the domain' do
-      response = mg_obj.get(domain)
+      it 'creates a domain' do
+        response = mg_obj.create(domain, { spam_action: 'tag' })
 
-      expect(response).to include('domain')
-      expect(response['domain']['name']).to eq(domain)
+        expect(response['domain']['name']).to eq(domain)
+        expect(response['domain']['spam_action']).to eq('tag')
+      end
     end
-  end
 
-  describe '#get_domains' do
-    let(:api_version) { 'v4' }
+    describe '#get' do
+      let(:api_version) { 'v4' }
 
-    it 'returns a list of domains' do
-      response = mg_obj.get_domains
+      it 'returns the domain' do
+        response = mg_obj.get(domain)
 
-      expect(response.size).to be > 0
+        expect(response).to include('domain')
+        expect(response['domain']['name']).to eq(domain)
+      end
     end
-  end
 
-  context '#update' do
-    let(:api_version) { 'v4' }
+    context '#update' do
+      let(:api_version) { 'v4' }
 
-    it 'updates the domain' do
-      response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
+      it 'updates the domain' do
+        response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
 
-      expect(response['domain']['spam_action']).to eq('block')
-      expect(response['domain']['web_scheme']).to eq('https')
-      expect(response['domain']['wildcard']).to eq(true)
+        expect(response['domain']['spam_action']).to eq('block')
+        expect(response['domain']['web_scheme']).to eq('https')
+        expect(response['domain']['wildcard']).to eq(true)
+      end
     end
-  end
-
-  context 'delete a domain' do
-    subject(:response) { mg_obj.delete(domain) }
 
-    it { is_expected.to be_falsey }
-  end
+    context '#verify' do
+      let(:api_version) { 'v4' }
 
-  describe '#create_smtp_credentials' do
-    it 'creates smtp credentials for domain' do
-      result = mg_obj.create_smtp_credentials(
-        domain,
-        {
-          login: 'test_login'
-        }
-      )
+      it 'verifies the domain' do
+        response = mg_obj.verify(domain)
 
-      expect(result['message']).to eq("Created 1 credentials pair(s)")
+        expect(response['message']).to eq('Domain DNS records have been updated')
+      end
     end
-  end
 
-  describe '#update_smtp_credentials' do
-    it 'updates smtp credentials for domain' do
-      result = mg_obj.update_smtp_credentials(
-        domain,
-        'test_login',
-        {
-          spec: 'abc'
-        }
-      )
-
-      expect(result['message']).to eq('Password changed')
+    context 'delete a domain' do
+      subject(:response) { mg_obj.remove(domain) }
+
+      it { is_expected.to be_falsey }
     end
   end
 
-  describe '#delete_smtp_credentials' do
-    it 'deletes smtp credentials for domain' do
-      result = mg_obj.delete_smtp_credentials(
-        domain,
-        'test_login'
-      )
 
-      expect(result['message']).to eq('Credentials have been deleted')
-    end
-  end
+  context 'Domain::Keys methods' do
+    describe '#list_domain_keys' do
+      let(:api_version) { 'v1' }
 
-  describe '#get_domain_connection_settings' do
-    it 'returns delivery connection settings for the defined domain' do
-      result = mg_obj.get_domain_connection_settings(
-        domain
-      )
+      it 'lists all domain keys' do
+        result = mg_obj.list_domain_keys(
+          {
+            signing_domain: domain
+          }
+        )
 
-      expect(result).to include(
-        'require_tls' => false,
-        'skip_verification' => false
-      )
+        expect(result).to include('items')
+        expect(result['items'].first['selector']).to eq('k1')
+      end
     end
-  end
 
-  describe '#update_domain_connection_settings' do
-    it 'updates the specified delivery connection settings' do
-      result = mg_obj.update_domain_connection_settings(
-        domain,
-        {
-          require_tls: true,
-          skip_verification: true
-        }
-      )
-
-      expect(result).to include(
-        'require_tls' => true,
-        'skip_verification' => true
-      )
-    end
-  end
+    describe '#create_domain_key' do
+      let(:api_version) { 'v1' }
 
-  describe '#get_domain_tracking_settings' do
-    it 'returns tracking settings for the defined domain' do
-      result = mg_obj.get_domain_tracking_settings(
-        domain
-      )
+      it 'creates a domain key' do
+        result = mg_obj.create_domain_key(
+          {
+            signing_domain: domain,
+            selector: 'test'
+          }
+        )
 
-      expect(result).to include('tracking')
-      expect(result['tracking']['click']['active']).to eq(false)
+        expect(result['signing_domain']).to eq(domain)
+        expect(result['selector']).to eq('test')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_open_settings' do
-    it 'updates the specified tracking open settings' do
-      result = mg_obj.update_domain_tracking_open_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#delete_domain_key' do
+      let(:api_version) { 'v1' }
+
+      it 'deletes a domain key' do
+        result = mg_obj.delete_domain_key(
+          {
+            signing_domain: domain,
+            selector: 'test'
+          }
+        )
 
-      expect(result['open']['active']).to eq(false)
+        expect(result['message']).to eq('success')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_click_settings' do
-    it 'updates the specified tracking click settings' do
-      result = mg_obj.update_domain_tracking_click_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#activate_domain_key' do
+      let(:api_version) { 'v4' }
 
-      expect(result['click']['active']).to eq(false)
+      it 'activates a domain key' do
+
+        result = mg_obj.activate_domain_key(
+          domain,
+          'mailo1'
+        )
+
+        expect(result['message']).to eq('domain key activated')
+      end
     end
-  end
 
-  describe '#update_domain_tracking_unsubscribe_settings' do
-    it 'updates the specified tracking unsubscribe settings' do
-      result = mg_obj.update_domain_tracking_unsubscribe_settings(
-        domain,
-        {
-          active: false
-        }
-      )
+    describe '#get_domain_keys' do
+      let(:api_version) { 'v4' }
+
+      it 'lists the domain keys for a specified signing domain' do
+        result = mg_obj.get_domain_keys(
+          domain
+        )
 
-      expect(result['unsubscribe']['active']).to eq(false)
+        expect(result).to include('items')
+        expect(result['items'].first['selector']).to eq('mailo1')
+      end
     end
-  end
 
-  describe '#update_domain_dkim_authority' do
-    it 'updates the DKIM authority for a domain' do
-      result = mg_obj.update_domain_dkim_authority(
-        domain,
-        {
-          self: true
-        }
-      )
+    describe '#deactivate_domain_key' do
+      let(:api_version) { 'v4' }
 
-      expect(result['message']).to eq('Domain DKIM authority has not been changed')
+      it 'deactivates a domain key' do
+        result = mg_obj.deactivate_domain_key(
+          domain,
+          'tetetet'
+        )
+
+        expect(result['message']).to eq('domain key deactivated')
+      end
     end
-  end
 
-  describe '#update_domain_dkim_selector' do
-    it 'updates the DKIM selector for a domain' do
-      result = mg_obj.update_domain_dkim_selector(
-        domain,
-        {
-          dkim_selector: 'mailo1'
-        }
-      )
+    describe '#update_domain_dkim_authority' do
+      it 'updates the DKIM authority for a domain' do
+        result = mg_obj.update_domain_dkim_authority(
+          domain,
+          {
+            self: true
+          }
+        )
 
-      expect(result['message']).to eq('DKIM selector changed')
+        expect(result['message']).to eq('Domain DKIM authority has not been changed')
+      end
     end
-  end
 
-  describe '#update_domain_web_prefix' do
-    it 'updates the the CNAME used for tracking opens and clicks' do
-      result = mg_obj.update_domain_web_prefix(
-        domain,
-        {
-          web_prefix: 'email'
-        }
-      )
+    describe '#update_domain_dkim_selector' do
+      it 'updates the DKIM selector for a domain' do
+        result = mg_obj.update_domain_dkim_selector(
+          domain,
+          {
+            dkim_selector: 'mailo1'
+          }
+        )
 
-      expect(result['message']).to eq('Domain web prefix updated')
+        expect(result['message']).to eq('DKIM selector changed')
+      end
     end
   end
 
-  describe 'V4' do
-    let(:api_version) { 'v4' }
+  context 'Domain::Tracking methods' do
+    # TODO add missing:
+    # get_domain_tracking_certificate
+    # regenerate_domain_tracking_certificate
+    # generate_domain_tracking_certificate
 
-    describe '#get_domain_keys' do
-      it 'lists the domain keys for a specified signing domain' do
-        result = mg_obj.get_domain_keys(
+    describe '#get_domain_tracking_settings' do
+      it 'returns tracking settings for the defined domain' do
+        result = mg_obj.get_domain_tracking_settings(
           domain
         )
 
-        expect(result).to include('items')
-        expect(result['items'].first['selector']).to eq('mailo1')
+        expect(result).to include('tracking')
+        expect(result['tracking']['click']['active']).to eq(false)
       end
     end
 
-    describe '#activate_domain_key' do
-      it 'activates a domain key' do
+    describe '#update_domain_tracking_click_settings' do
+      it 'updates the specified tracking click settings' do
+        result = mg_obj.update_domain_tracking_click_settings(
+          domain,
+          {
+            active: false
+          }
+        )
 
-        result = mg_obj.activate_domain_key(
+        expect(result['click']['active']).to eq(false)
+      end
+    end
+
+    describe '#update_domain_tracking_open_settings' do
+      it 'updates the specified tracking open settings' do
+        result = mg_obj.update_domain_tracking_open_settings(
           domain,
-          'mailo1'
+          {
+            active: false
+          }
         )
 
-       expect(result['message']).to eq('domain key activated')
+        expect(result['open']['active']).to eq(false)
       end
     end
 
-    describe '#deactivate_domain_key' do
-      it 'deactivates a domain key' do
-        result = mg_obj.deactivate_domain_key(
+    describe '#update_domain_tracking_unsubscribe_settings' do
+      it 'updates the specified tracking unsubscribe settings' do
+        result = mg_obj.update_domain_tracking_unsubscribe_settings(
           domain,
-          'tetetet'
+          {
+            active: false
+          }
         )
 
-       expect(result['message']).to eq('domain key deactivated')
+        expect(result['unsubscribe']['active']).to eq(false)
       end
     end
   end
 
-  describe '#delete_domain_key' do
-    let(:api_version) { 'v1' }
+  context 'Domain::DKIM_Security methods' do
+    # TODO add missing:
+    # dkim_rotation
+    # dkim_rotate
+  end
 
-    it 'deletes a domain key' do
-      result = mg_obj.delete_domain_key(
-        {
-          signing_domain: domain,
-          selector: 'test'
-        }
-      )
+  context 'Credentials methods' do
+    # TODO: to be moved to the dedicated module
 
-     expect(result['message']).to eq('success')
+    describe '#create_smtp_credentials' do
+      it 'creates smtp credentials for domain' do
+        result = mg_obj.create_smtp_credentials(
+          domain,
+          {
+            login: 'test_login'
+          }
+        )
+
+        expect(result['message']).to eq("Created 1 credentials pair(s)")
+      end
+    end
+
+    describe '#update_smtp_credentials' do
+      it 'updates smtp credentials for domain' do
+        result = mg_obj.update_smtp_credentials(
+          domain,
+          'test_login',
+          {
+            spec: 'abc'
+          }
+        )
+
+        expect(result['message']).to eq('Password changed')
+      end
+    end
+
+    describe '#delete_smtp_credentials' do
+      it 'deletes smtp credentials for domain' do
+        result = mg_obj.delete_smtp_credentials(
+          domain,
+          'test_login'
+        )
+
+        expect(result['message']).to eq('Credentials have been deleted')
+      end
     end
   end
 
-  describe '#get_domain_stats' do
-    it 'returns total stats for a given domain' do
-      result = mg_obj.get_domain_stats(
-        domain,
-        {
-          event: 'clicked'
-        }
-      )
+  context 'Reporting::Stat methods' do
+    # TODO: to be moved to the dedicated module
+
+    describe '#get_domain_stats' do
+      it 'returns total stats for a given domain' do
+        result = mg_obj.get_domain_stats(
+          domain,
+          {
+            event: 'clicked'
+          }
+        )
 
-     expect(result).to include('stats')
+        expect(result).to include('stats')
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -1,9 +1,5 @@
-require 'rubygems'
-require 'bundler'
-require 'bundler/setup'
-Bundler.setup(:development)
-
 require 'simplecov'
+
 SimpleCov.start do
   add_filter "/spec/"
 end