mailgun-ruby 1.4.1 → 1.4.3

data/lib/mailgun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require ruby dependencies
 require 'json'
 require 'openssl'
@@ -16,7 +18,7 @@ require 'mailgun/exceptions/exceptions'
 require 'mailgun/helpers/api_version_checker'
 
 # load zeitwerk
-Zeitwerk::Loader.for_gem.tap do |loader| # rubocop:disable Style/SymbolProc
+Zeitwerk::Loader.for_gem.tap do |loader|
   loader.ignore("#{__dir__}/mailgun-ruby.rb")
   loader.ignore("#{__dir__}/railgun.rb")
   loader.ignore("#{__dir__}/railgun")
@@ -41,7 +43,6 @@ end
 #
 # See the Github documentation for full examples.
 module Mailgun
-
   class << self
     attr_accessor :api_host,
                   :api_key,
@@ -56,7 +57,6 @@ module Mailgun
       yield self
       true
     end
-    alias_method :config, :configure
+    alias config configure
   end
-
 end

data/lib/railgun/attachment.rb

@@ -1,7 +1,7 @@
-module Railgun
+# frozen_string_literal: true
 
+module Railgun
   class Attachment < StringIO
-
     attr_reader :filename, :content_type, :path,
                 :original_filename, :overwritten_filename
 
@@ -9,17 +9,15 @@ module Railgun
       @path = ''
       @inline = args.detect { |opt| opt[:inline] }
 
-      if @inline
-        @filename = attachment.cid
-      else
-        @filename = attachment.filename
-      end
+      @filename = if @inline
+                    attachment.cid
+                  else
+                    attachment.filename
+                  end
 
       @original_filename = @filename
 
-      if args.detect { |opt| opt[:filename] }
-        @filename = opt[:filename]
-      end
+      @filename = opt[:filename] if args.detect { |opt| opt[:filename] }
 
       @overwritten_filename = @filename
 
@@ -32,7 +30,7 @@ module Railgun
       @inline
     end
 
-    def is_original_filename
+    def original_filename?
       @original_filename == @overwritten_filename
     end
 
@@ -40,17 +38,12 @@ module Railgun
       @filename
     end
 
-    def attach_to_message!(mb)
-      if mb.nil?
-        nil
-      end
-
+    def attach_to_message!(m_body)
       if inline?
-        mb.add_inline_image self, @filename
+        m_body.add_inline_image self, @filename
       else
-        mb.add_attachment self, @filename
+        m_body.add_attachment self, @filename
       end
     end
-
   end
 end

data/lib/railgun/errors.rb

@@ -1,7 +1,7 @@
-module Railgun
+# frozen_string_literal: true
 
+module Railgun
   class Error < StandardError
-
     attr_reader :object
 
     def initialize(message = nil, object = nil)
@@ -15,7 +15,6 @@ module Railgun
   end
 
   class InternalError < Error
-
     attr_reader :source_exception
 
     def initialize(source_exc, message = nil, object = nil)

data/lib/railgun/mailer.rb

@@ -1,11 +1,11 @@
-module Railgun
+# frozen_string_literal: true
 
+module Railgun
   # Railgun::Mailer is an ActionMailer provider for sending mail through
   # Mailgun.
   class Mailer
-
     # List of the headers that will be ignored when copying headers from `mail.header_fields`
-    IGNORED_HEADERS = %w[ to from subject reply-to mime-version template ]
+    IGNORED_HEADERS = %w[to from subject reply-to mime-version template].freeze
 
     # [Hash] config ->
     #   Requires *at least* `api_key` and `domain` keys.
@@ -17,15 +17,15 @@ module Railgun
     def initialize(config)
       @config = config
 
-      [:api_key, :domain].each do |k|
-        raise Railgun::ConfigurationError.new("Config requires `#{k}` key", @config) unless @config.has_key?(k)
+      %i[api_key domain].each do |k|
+        raise Railgun::ConfigurationError.new("Config requires `#{k}` key", @config) unless @config.key?(k)
       end
 
       @mg_client = Mailgun::Client.new(
         config[:api_key],
         config[:api_host] || 'api.mailgun.net',
         config[:api_version] || 'v3',
-        config[:api_ssl].nil? ? true : config[:api_ssl],
+        config[:api_ssl].nil? || config[:api_ssl],
         false,
         config[:timeout]
       )
@@ -34,14 +34,14 @@ module Railgun
       # To avoid exception in mail gem v2.6
       @settings = { return_response: true }
 
-      if (@config[:fake_message_send] || false)
-        Rails.logger.info "NOTE: fake message sending has been enabled for mailgun-ruby!"
-        @mg_client.enable_test_mode!
-      end
+      return unless @config[:fake_message_send] || false
+
+      Rails.logger.info 'NOTE: fake message sending has been enabled for mailgun-ruby!'
+      @mg_client.enable_test_mode!
     end
 
     def deliver!(mail)
-      @mg_domain = set_mg_domain(mail)
+      @mg_domain = mg_domain(mail)
       @mg_client.set_api_key(mail[:api_key].value) if mail[:api_key].present?
       @mg_client.set_subaccount(mail[:subaccount_id].value) if mail[:subaccount_id].present?
 
@@ -52,7 +52,7 @@ module Railgun
       mg_message = Railgun.transform_for_mailgun(mail)
       response = @mg_client.send_message(@mg_domain, mg_message)
 
-      if response.code == 200 then
+      if response.code == 200
         mg_id = response.to_h['id']
         mail.message_id = mg_id
       end
@@ -66,11 +66,11 @@ module Railgun
     private
 
     # Set @mg_domain from mail[:domain] header if present, then remove it to prevent being sent.
-    def set_mg_domain(mail)
+    def mg_domain(mail)
       return mail[:domain].value if mail[:domain]
+
       domain
     end
-
   end
 
   module_function
@@ -102,7 +102,7 @@ module Railgun
     # note: this will filter out parameters such as `from`, `to`, and so forth
     #       as they are accepted as POST parameters on the message endpoint.
 
-    msg_headers = Hash.new
+    msg_headers = {}
 
     # h:* attributes (headers)
 
@@ -111,11 +111,11 @@ module Railgun
     mail.headers(mail.mailgun_headers || {})
     mail.header_fields.each do |field|
       header = field.name.downcase
-      if msg_headers.include? header
-        msg_headers[header] = [msg_headers[header], field.value].flatten
-      else
-        msg_headers[header] = field.value
-      end
+      msg_headers[header] = if msg_headers.include? header
+                              [msg_headers[header], field.value].flatten
+                            else
+                              field.value
+                            end
     end
 
     msg_headers.each do |k, v|
@@ -140,7 +140,7 @@ module Railgun
     message['recipient-variables'] = mail.mailgun_recipient_variables.to_json if mail.mailgun_recipient_variables
 
     # reject blank values
-    message.delete_if do |k, v|
+    message.delete_if do |_k, v|
       next true if v.nil?
 
       # if it's an array remove empty elements
@@ -149,7 +149,7 @@ module Railgun
       v.respond_to?(:empty?) && v.empty?
     end
 
-    return message
+    message
   end
 
   # Acts on a Rails/ActionMailer message object and uses Mailgun::MessageBuilder
@@ -169,7 +169,7 @@ module Railgun
     mb.body_text extract_body_text(mail)
     mb.amp_html extract_amp_html(mail)
 
-    [:to, :cc, :bcc].each do |rcpt_type|
+    %i[to cc bcc].each do |rcpt_type|
       addrs = mail[rcpt_type] || nil
       case addrs
       when String
@@ -196,7 +196,7 @@ module Railgun
       attach.attach_to_message! mb
     end
 
-    return mb.message
+    mb.message
   end
 
   # Returns the decoded HTML body from the Mail::Message object if available,
@@ -206,11 +206,9 @@ module Railgun
   #
   # @return [String]
   def extract_body_html(mail)
-    begin
-      retrieve_html_part(mail).body.decoded || nil
-    rescue
-      nil
-    end
+    retrieve_html_part(mail).body.decoded || nil
+  rescue StandardError
+    nil
   end
 
   # Returns the decoded text body from the Mail::Message object if it is available,
@@ -220,11 +218,9 @@ module Railgun
   #
   # @return [String]
   def extract_body_text(mail)
-    begin
-      retrieve_text_part(mail).body.decoded || nil
-    rescue
-      nil
-    end
+    retrieve_text_part(mail).body.decoded || nil
+  rescue StandardError
+    nil
   end
 
   # Returns the decoded AMP HTML from the Mail::Message object if it is available,
@@ -234,11 +230,9 @@ module Railgun
   #
   # @return [String]
   def extract_amp_html(mail)
-    begin
-      retrieve_amp_part(mail).body.decoded || nil
-    rescue
-      nil
-    end
+    retrieve_amp_part(mail).body.decoded || nil
+  rescue StandardError
+    nil
   end
 
   # Returns the mail object from the Mail::Message object if text part exists,
@@ -250,7 +244,8 @@ module Railgun
   # @return [Mail::Message] mail message with its content-type = text/plain
   def retrieve_text_part(mail)
     return mail.text_part if mail.multipart?
-    (mail.mime_type =~ /^text\/plain$/i) && mail
+
+    (mail.mime_type =~ %r{^text/plain$}i) && mail
   end
 
   # Returns the mail object from the Mail::Message object if html part exists,
@@ -262,7 +257,8 @@ module Railgun
   # @return [Mail::Message] mail message with its content-type = text/html
   def retrieve_html_part(mail)
     return mail.html_part if mail.multipart?
-    (mail.mime_type =~ /^text\/html$/i) && mail
+
+    (mail.mime_type =~ %r{^text/html$}i) && mail
   end
 
   # Returns the mail object from the Mail::Message object if AMP part exists,

data/lib/railgun/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Railgun
   class Railtie < ::Rails::Railtie
     ActiveSupport.on_load(:action_mailer) do

data/lib/railgun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require ruby dependencies
 require 'json'
 

data/mailgun.gemspec

@@ -1,10 +1,10 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mailgun/version'
 
 Gem::Specification.new do |spec|
-
   spec.name             = 'mailgun-ruby'
   spec.version          = Mailgun::VERSION
   spec.homepage         = 'https://www.mailgun.com/'
@@ -23,21 +23,25 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_development_dependency 'bundler', '>= 1.16.2'
+  spec.add_development_dependency 'pry', '~> 0.16.0'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rake', '~> 13.3.1'
   spec.add_development_dependency 'rspec', '~> 3.13.0'
   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.16.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-json'
   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_development_dependency 'webmock', '~> 3.7'
+  spec.add_dependency 'faraday', '~> 2.1'
   spec.add_dependency 'faraday-multipart', '< 2'
+  spec.add_dependency 'mini_mime'
   spec.add_dependency 'zeitwerk'
 end

data/spec/integration/analytics_tags_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { cassette_name: 'analytics_tags' }
+
+describe 'AnalyticsTags', vcr: vcr_opts do
+  let(:api_version) { APIVERSION }
+  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
+  let(:mg_obj) { Mailgun::AnalyticsTags.new(mg_client) }
+  let(:api_version) { 'v1' }
+
+  describe '#update' do
+    it 'updates a tag' do
+      response = mg_obj.update('test1', 'test_description')
+
+      expect(response).to be_truthy
+    end
+  end
+
+  describe '#list' do
+    it 'returns a list of tags' do
+      response = mg_obj.list(
+        {
+          pagination: {
+            sort: 'lastseen:desc',
+            limit: 10
+          },
+          include_subaccounts: true
+        }
+      )
+
+      expect(response[0]['account_id']).to eq('test')
+      expect(response[0]['tag']).to eq('test1')
+    end
+  end
+
+  describe '#remove' do
+    it 'removes a tag' do
+      response = mg_obj.remove('test1')
+
+      expect(response).to be_truthy
+    end
+  end
+
+  describe '#limits' do
+    it 'returns limits' do
+      response = mg_obj.limits
+
+      expect(response['limit']).to eq(100_000)
+    end
+  end
+end

data/spec/integration/bounces_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "bounces" }
+vcr_opts = { cassette_name: 'bounces' }
 
 describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -12,33 +14,32 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
 
   it 'creates a bounce' do
     @result = @mg_obj.post("#{@domain}/bounces",
-                           {:address => @email,
-                            :code => 550,
-                            :error => "Integration Test"})
+                           { address: @email,
+                             code: 550,
+                             error: 'Integration Test' })
 
     @result.to_h!
-    expect(@result.body["message"]).to eq("Address has been added to the bounces table")
-    expect(@result.body["address"]).to eq(@email)
+    expect(@result.body['message']).to eq('Address has been added to the bounces table')
+    expect(@result.body['address']).to eq(@email)
   end
 
   it 'get a bounce.' do
     result = @mg_obj.get("#{@domain}/bounces/#{CGI.escape(@email)}")
 
     result.to_h!
-    expect(result.body["code"]).to eq("550")
-    expect(result.body["address"]).to eq(@email)
-    expect(result.body["error"]).to eq("Integration Test")
+    expect(result.body['code']).to eq('550')
+    expect(result.body['address']).to eq(@email)
+    expect(result.body['error']).to eq('Integration Test')
   end
 
   it 'gets a list of bounces.' do
     result = @mg_obj.get("#{@domain}/bounces")
 
     result.to_h!
-    expect(result.body["items"].length).to be > 0
+    expect(result.body['items'].length).to be > 0
   end
 
   it 'deletes a bounce' do
     @mg_obj.delete("#{@domain}/bounces/#{CGI.escape(@email)}")
   end
-
 end

data/spec/integration/campaign_spec.rb

@@ -1,57 +1,59 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "campaigns" }
+vcr_opts = { cassette_name: 'campaigns' }
 
 describe 'For the campaigns endpoint', vcr: vcr_opts do
   before(:all) do
     skip 'pending removal'
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
-    @campaign_id = "integration_test_campaign"
+    @campaign_id = 'integration_test_campaign'
   end
 
   it 'creates a campaign' do
-    result = @mg_obj.post("#{@domain}/campaigns", {:name => 'My Campaign',
-                                                   :id => @campaign_id})
+    result = @mg_obj.post("#{@domain}/campaigns", { name: 'My Campaign',
+                                                    id: @campaign_id })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Campaign created")
-    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
-    expect(result.body["campaign"]["name"]).to eq('My Campaign')
+    expect(result.body['message']).to eq('Campaign created')
+    expect(result.body['campaign']['id']).to eq(@campaign_id)
+    expect(result.body['campaign']['name']).to eq('My Campaign')
   end
 
   it 'get a campaign.' do
     result = @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}")
 
     result.to_h!
-    expect(result.body["id"]).to eq(@campaign_id)
-    expect(result.body["name"]).to eq('My Campaign')
+    expect(result.body['id']).to eq(@campaign_id)
+    expect(result.body['name']).to eq('My Campaign')
   end
 
   it 'gets a list of all campaigns.' do
-    result = @mg_obj.get("#{@domain}/campaigns", {:limit => 50})
+    result = @mg_obj.get("#{@domain}/campaigns", { limit: 50 })
 
     result.to_h!
-    expect(result.body["total_count"]).to be > 0
+    expect(result.body['total_count']).to be > 0
   end
 
   it 'update a campaign.' do
-    result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", {:name => 'My Updated Campaign',
-                                                                  :id => @campaign_id})
+    result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", { name: 'My Updated Campaign',
+                                                                   id: @campaign_id })
 
     result.to_h!
-    expect(result.body["message"]).to eq("Campaign updated")
-    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
-    expect(result.body["campaign"]["name"]).to eq('My Updated Campaign')
+    expect(result.body['message']).to eq('Campaign updated')
+    expect(result.body['campaign']['id']).to eq(@campaign_id)
+    expect(result.body['campaign']['name']).to eq('My Updated Campaign')
   end
 
   it 'get campaign events.' do
-    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/events", {:groupby => "clicked"})}.not_to raise_error
+    expect { @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/events", { groupby: 'clicked' }) }.not_to raise_error
   end
 
   it 'get campaign stats.' do
-    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", {:groupby => "domain"})}.not_to raise_error
+    expect { @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", { groupby: 'domain' }) }.not_to raise_error
   end
 
   it 'removes a campaign' do

data/spec/integration/complaints_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'mailgun'
 
-vcr_opts = { :cassette_name => "complaints" }
+vcr_opts = { cassette_name: 'complaints' }
 
 describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -11,25 +13,25 @@ describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'creates a complaint' do
-    @result = @mg_obj.post("#{@domain}/complaints", {:address => @email})
+    @result = @mg_obj.post("#{@domain}/complaints", { address: @email })
 
     @result.to_h!
-    expect(@result.body["message"]).to eq("Address has been added to the complaints table")
-    expect(@result.body["address"]).to eq(@email)
+    expect(@result.body['message']).to eq('Address has been added to the complaints table')
+    expect(@result.body['address']).to eq(@email)
   end
 
   it 'get a complaint.' do
     result = @mg_obj.get("#{@domain}/complaints/#{@email}")
 
     result.to_h!
-    expect(result.body["address"]).to eq(@email)
+    expect(result.body['address']).to eq(@email)
   end
 
   it 'gets a list of complaints.' do
     result = @mg_obj.get("#{@domain}/complaints")
 
     result.to_h!
-    expect(result.body["items"].length).to be > 0
+    expect(result.body['items'].length).to be > 0
   end
 
   it 'removes a complaint' do