Use zeitwerk to load gem (#370)

* Extract call to Faraday.new in #build_http_client private method

So users have a chance to configure Faraday logger

* Use zeitwerk to load gem

---------

Co-authored-by: Alex Lebedev <6421109+alex-leb@users.noreply.github.com>

Author: n-rodriguez

lib/mailgun-ruby.rb

@@ -1,2 +1,2 @@
-require 'mailgun'
-require 'railgun' if defined?(Rails) && defined?(ActionMailer)
+require_relative 'mailgun'
+require_relative 'railgun' if defined?(Rails) && defined?(ActionMailer)

lib/mailgun.rb

@@ -1,26 +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/tags/analytics_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.
 #

lib/mailgun/address.rb

@@ -1,5 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
 
   # Mailgun::Address is a simple interface to the Email Validation API.

lib/mailgun/client.rb

@@ -1,7 +1,3 @@
-require 'mailgun/chains'
-require 'mailgun/suppressions'
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
   # A Mailgun::Client object is used to communicate with the Mailgun API. It is a
   # wrapper around Faraday so you don't have to worry about the HTTP aspect
@@ -32,14 +28,7 @@ def initialize(api_key = Mailgun.api_key,
       }
       request_options.merge!(request: {timeout: timeout}) if timeout
 
-      @http_client =  Faraday.new(request_options) do |conn|
-        conn.request :multipart
-        conn.request :authorization, :basic, 'api', api_key
-        conn.request :url_encoded
-        conn.response :raise_error, include_request: true
-        conn.adapter Faraday.default_adapter
-        conn.options.params_encoder = Faraday::FlatParamsEncoder
-      end
+      @http_client = build_http_client(api_key, request_options)
 
       @test_mode = test_mode
       @api_version = api_version
@@ -277,5 +266,16 @@ def perform_data_validation(working_domain, data)
         working_domain
       ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
     end
+
+    def build_http_client(api_key, request_options)
+      Faraday.new(request_options) do |conn|
+        conn.request :multipart
+        conn.request :authorization, :basic, 'api', api_key
+        conn.request :url_encoded
+        conn.response :raise_error, include_request: true
+        conn.adapter Faraday.default_adapter
+        conn.options.params_encoder = Faraday::FlatParamsEncoder
+      end
+    end
   end
 end

lib/mailgun/domains/domains.rb

@@ -1,6 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-require 'mailgun/helpers/api_version_checker'
-
 module Mailgun
 
   # A Mailgun::Domains object is a simple CRUD interface to Mailgun Domains.

lib/mailgun/events/events.rb

@@ -1,5 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
 
   # A Mailgun::Events object makes it really simple to consume

lib/mailgun/exceptions/exceptions.rb

@@ -1,4 +1,6 @@
 module Mailgun
+  module Exceptions
+  end
 
   # Public: A basic class for mananging errors.
   # Inherits from StandardError (previously RuntimeError) as not all errors are

lib/mailgun/lists/opt_in_handler.rb

@@ -1,6 +1,3 @@
-require 'uri'
-require 'openssl'
-
 module Mailgun
 
   # Public: Provides methods for creating and handling opt-in URLs,

lib/mailgun/logs/logs.rb

@@ -1,5 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
   # A Mailgun::Logs object is a simple interface to Mailgun Logs.
   # Uses Mailgun

lib/mailgun/messages/batch_message.rb

@@ -1,5 +1,3 @@
-require 'mailgun/messages/message_builder'
-
 module Mailgun
 
   # A Mailgun::BatchMessage object is used to create a valid payload