mailgun-ruby 1.3.10 → 1.4.1

data/lib/mailgun/tags/analytics_tags.rb

@@ -0,0 +1,32 @@
+module Mailgun
+
+  # A Mailgun::AnalyticsTags object is a simple CRUD interface to Mailgun Tags.
+  # Uses Mailgun
+  class AnalyticsTags
+    include ApiVersionChecker
+
+    # Public: creates a new Mailgun::AnalyticsTags instance.
+    # Defaults to Mailgun::Client
+    def initialize(client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v1'))
+      @client = client
+    end
+
+    def update(tag, description)
+      @client.put('analytics/tags', { tag: tag, description: description }, body_params: true ).to_h['message'] == 'Tag updated'
+    end
+
+    def list(options = {})
+      @client.post('analytics/tags', options).to_h['items']
+    end
+
+    def remove(tag)
+      @client.delete('analytics/tags', { tag: tag }, body_params: true).to_h['message'] == 'Tag deleted'
+    end
+
+    def limits
+      @client.get('analytics/tags/limits').to_h
+    end
+
+    enforces_api_version 'v1', :update, :list, :remove, :limits
+  end
+end

data/lib/mailgun/tags/tags.rb

@@ -1,5 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
 
   # A Mailgun::Tags object is a simple CRUD interface to Mailgun Tags.
@@ -12,6 +10,9 @@ module Mailgun
       @client = client
     end
 
+    ### Deprecated Tags ###
+    # TODO: remove in v 1.5
+
     # Public: Get Tags
     #
     # domain - [String] Domain name where tag is stored
@@ -20,6 +21,7 @@ module Mailgun
     #
     # Returns [Array] A list of tags (hash)
     def get_tags(domain, options = {})
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to store template on', caller) unless domain
       @client.get("#{domain}/tags", options).to_h['items']
     end
@@ -31,6 +33,7 @@ module Mailgun
     #
     # Returns [Hash] Information on the requested tag.
     def get_tag(domain, tag)
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.get("#{domain}/tags/#{tag}").to_h!
@@ -45,6 +48,7 @@ module Mailgun
     #
     # Returns [Boolean] if successful or not
     def update(domain, tag, options = {})
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.put("#{domain}/tags/#{tag}", options).to_h['message'] == 'Tag updated'
@@ -63,6 +67,7 @@ module Mailgun
     #
     # Returns [Hash] of tag stats info
     def get_tag_stats(domain, tag, options = {})
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.get("#{domain}/tags/#{tag}/stats", options).to_h
@@ -76,6 +81,7 @@ module Mailgun
     #
     # Returns [Boolean] if successful or not
     def remove(domain, tag)
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to remove on Mailgun', caller) unless domain
       fail(ParameterError, 'No template name given to find on provided domain', caller) unless tag
       @client.delete("#{domain}/tags/#{tag}").to_h['message'] == 'Tag deleted'
@@ -88,6 +94,7 @@ module Mailgun
     #
     # Returns [Hash] of countries of origin for a given domain
     def get_countries_aggregated_stats(domain, tag)
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.get("#{domain}/tags/#{tag}/stats/aggregates/countries").to_h
@@ -100,6 +107,7 @@ module Mailgun
     #
     # Returns [Hash] of email providers for a given domain
     def get_providers_aggregated_stats(domain, tag)
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.get("#{domain}/tags/#{tag}/stats/aggregates/providers").to_h
@@ -112,6 +120,7 @@ module Mailgun
     #
     # Returns [Hash] of devices for a given domain
     def get_devices_aggregated_stats(domain, tag)
+      warn('This API is deprecated in favor of our new analytics Tags API')
       fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
       fail(ParameterError, 'No tag name given to find on provided domain', caller) unless tag
       @client.get("#{domain}/tags/#{tag}/stats/aggregates/devices").to_h

data/lib/mailgun/templates/templates.rb

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

data/lib/mailgun/version.rb

@@ -1,4 +1,4 @@
 # It's the version. Yeay!
 module Mailgun
-  VERSION = '1.3.10'
+  VERSION = '1.4.1'
 end

data/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)

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