mailgun-ruby 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7b6ece85b0a809a90ea79e6836b55bc5a97cfe8cd036c1567acff92b8053c5
-  data.tar.gz: 277f0def30a104f86beef2c8ef3012b877fa94e35e415a9beff328cc76247280
+  metadata.gz: 45aed85ba39b57f41a049e86f7e4aa86e04092c2fc04c86f4a948857cea182c1
+  data.tar.gz: 4588e70de8bf2836028858adc294e1c1f1b5a8d07de6623a14a1c9797049eecd
 SHA512:
-  metadata.gz: 3a419c6c2c8fbb7efa2ed08ad51da87441befe54e00e3a70db6626b82f353932827c5ebdd933f32edfe06ba043ea2dcba99cacd93a445f078ff089ad58af96ea
-  data.tar.gz: c910105de443193207c67c5afaa24b2d423dfb7b7e995466a95b8192d967f244f36e45142d78f97a46fb893809a633e793d75366ea206f83338b8f138a4ed3af
+  metadata.gz: 346f281a71259601f0215f33a2e7e65d2c76f5f90601522ecf06ff5f9c8c25daff473b1d8a8fc6a71474fdf6ac37c8c89c815831c74b9d1e09238392be139db7
+  data.tar.gz: 3e00ab15f716a2381735b12a792c6ddc333d32f1574c3d7b50640e293ca4c1f5a60b796c241d3e7c1447cb7b455a162a179c4167d8020bec11f21b6fa03920f1

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mailgun.gemspec
 gemspec
 
-gem 'mini_mime'
 gem 'json', '~> 2.1', platform: :mri_19
+gem 'mini_mime'

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.4.1'
+gem 'mailgun-ruby', '~>1.4.2'
 ```
 
 Usage

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake'
 require 'rspec/core/rake_task'
@@ -9,7 +11,7 @@ end
 
 desc 'Run unit specs'
 RSpec::Core::RakeTask.new('spec:unit') do |t|
-  t.rspec_opts = %w(--colour --format documentation)
+  t.rspec_opts = %w[--colour --format documentation]
   t.pattern = 'spec/unit/*_spec.rb', 'spec/unit/*/*_spec.rb'
 end
 
@@ -17,13 +19,13 @@ desc 'Run integration specs'
 # Before running integration tests, you need to specify
 # a valid API KEY in the spec/spec_helper.rb file.
 RSpec::Core::RakeTask.new('spec:integration') do |t|
-  t.rspec_opts = %w(--colour --format documentation)
+  t.rspec_opts = %w[--colour --format documentation]
   t.pattern = 'spec/integration/*_spec.rb'
 end
 
 desc 'Run all tests'
 RSpec::Core::RakeTask.new('spec:all') do |t|
-  t.rspec_opts = %w(--colour --format documentation)
+  t.rspec_opts = %w[--colour --format documentation]
   t.pattern = 'spec/**/*_spec.rb'
 end
 

data/docs/AnalyticsTags.md

@@ -0,0 +1,63 @@
+Mailgun - Analytics Tags
+====================
+
+This is the Mailgun Ruby *Analytics Tags* utilities.
+
+The below assumes you've already installed the Mailgun Ruby SDK in to your
+project. If not, go back to the master README for instructions. It currently supports
+all calls except credentials.
+
+---
+
+Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint.
+
+You can view additional samples in the [analytics_tags_spec.rb](/spec/integration/analytics_tags_spec.rb)
+or the Analytics Tags client API in [analytics_tags.rb](/lib/mailgun/tags/analytics_tags.rb).
+
+Usage
+-----
+
+To get an instance of the Analytics Tags client:
+
+```ruby
+require 'mailgun'
+
+mg_client = Mailgun::Client.new('your-api-key', 'mailgun-api-host', 'v1')
+tags = Mailgun::AnalyticsTags.new(mg_client)
+````
+---
+Update account tag:
+```ruby
+tags.update('name-of-tag-to-update', 'updated tag description')
+```
+---
+
+Post query to list account tags or search for single tag:
+```ruby
+options = {
+  pagination: {
+    sort: 'lastseen:desc',
+    limit: 10
+  },
+  include_subaccounts: true
+}
+
+tags.list(options)
+```
+
+Delete account tag:
+```ruby
+tags.remove('name-of-tag-to-remove')
+```
+
+Get account tag limit information:
+```ruby
+tags.limits
+```
+
+---
+
+More Documentation
+------------------
+See the official [Mailgun Tags New Docs](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new)
+for more information

data/lib/mailgun/address.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # Mailgun::Address is a simple interface to the Email Validation API.
   class Address
     def initialize(api_key = Mailgun.api_key, api_host = Mailgun.api_host)
@@ -10,12 +11,11 @@ module Mailgun
     #
     # @param [String] address Email address to validate (max 512 chars.)
     def validate(address, mailbox_verification = false)
-      params = {address:  address}
+      params = { address: address }
       params[:mailbox_verification] = true if mailbox_verification
 
-      res = @client.get "address/validate", params
-      return res.to_h!
+      res = @client.get 'address/validate', params
+      res.to_h!
     end
   end
-
 end

data/lib/mailgun/chains.rb

@@ -1,8 +1,8 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # Public constants used throughout
   class Chains
-
     # maximum campaign ids per message
     MAX_CAMPAIGN_IDS = 3
 
@@ -11,6 +11,5 @@ module Mailgun
 
     # maximum recipients per message or batch
     MAX_RECIPIENTS = 1000
-
   end
 end

data/lib/mailgun/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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
@@ -5,28 +7,27 @@ module Mailgun
   #
   # See the Github documentation for full examples.
   class Client
-    SUBACCOUNT_HEADER = 'X-Mailgun-On-Behalf-Of'.freeze
+    SUBACCOUNT_HEADER = 'X-Mailgun-On-Behalf-Of'
 
     def initialize(api_key = Mailgun.api_key,
                    api_host = Mailgun.api_host || 'api.mailgun.net',
-                   api_version = Mailgun.api_version  || 'v3',
+                   api_version = Mailgun.api_version || 'v3',
                    ssl = true,
-                   test_mode = !!Mailgun.test_mode,
+                   test_mode = !Mailgun.test_mode.nil?,
                    timeout = nil,
                    proxy_url = Mailgun.proxy_url)
-
       endpoint = endpoint_generator(api_host, api_version, ssl)
 
       request_options = {
         url: endpoint,
         proxy: proxy_url,
-        ssl: {verify: ssl},
+        ssl: { verify: ssl },
         headers: {
-                   'User-Agent' => "mailgun-sdk-ruby/#{Mailgun::VERSION}",
-                   'Accept' =>'*/*'
-                  }
+          'User-Agent' => "mailgun-sdk-ruby/#{Mailgun::VERSION}",
+          'Accept' => '*/*'
+        }
       }
-      request_options.merge!(request: {timeout: timeout}) if timeout
+      request_options.merge!(request: { timeout: timeout }) if timeout
 
       @http_client = build_http_client(api_key, request_options)
 
@@ -55,7 +56,7 @@ module Mailgun
 
     # Add subaccount id to headers
     def set_subaccount(subaccount_id)
-      @http_client.headers = @http_client.headers.merge!({ SUBACCOUNT_HEADER => subaccount_id })
+      @http_client.headers.merge!({ SUBACCOUNT_HEADER => subaccount_id })
     end
 
     # Reset subaccount for primary usage
@@ -71,9 +72,7 @@ module Mailgun
     end
 
     # @return [String] client api version
-    def api_version
-      @api_version
-    end
+    attr_reader :api_version
 
     # Provides a store of all the emails sent in test mode so you can check them.
     #
@@ -91,12 +90,12 @@ module Mailgun
     def send_message(working_domain, data)
       perform_data_validation(working_domain, data)
 
-      if test_mode? then
+      if test_mode?
         Mailgun::Client.deliveries << data.dup
         return Response.from_hash(
           {
-            :body => "{\"id\": \"test-mode-mail-#{SecureRandom.uuid}@localhost\", \"message\": \"Queued. Thank you.\"}",
-            :status => 200,
+            body: "{\"id\": \"test-mode-mail-#{SecureRandom.uuid}@localhost\", \"message\": \"Queued. Thank you.\"}",
+            status: 200
           }
         )
       end
@@ -106,7 +105,7 @@ module Mailgun
         # Remove nil values from the data hash
         # Submitting nils to the API will likely cause an error.
         #  See also: https://github.com/mailgun/mailgun-ruby/issues/32
-        data = data.select { |k, v| v != nil }
+        data = data.reject { |_k, v| v.nil? }
 
         if data.key?(:message)
           if data[:message].is_a?(String)
@@ -119,7 +118,7 @@ module Mailgun
       when MessageBuilder
         post("#{working_domain}/messages", data.message)
       else
-        fail ParameterError.new('Unknown data type for data parameter.', data)
+        raise ParameterError.new('Unknown data type for data parameter.', data)
       end
     end
 
@@ -134,8 +133,8 @@ module Mailgun
     def post(resource_path, data, headers = {})
       response = @http_client.post(resource_path, data, headers)
       Response.new(response)
-    rescue => err
-      raise communication_error err
+    rescue StandardError => e
+      raise communication_error e
     end
 
     # Generic Mailgun GET Handler
@@ -151,8 +150,8 @@ module Mailgun
       response = @http_client.get(resource_path, params, headers)
 
       Response.new(response)
-    rescue => err
-      raise communication_error(err)
+    rescue StandardError => e
+      raise communication_error(e)
     end
 
     # Generic Mailgun PUT Handler
@@ -162,19 +161,11 @@ module Mailgun
     # @param [Hash] data This should be a standard Hash
     # containing required parameters for the requested resource.
     # @return [Mailgun::Response] A Mailgun::Response object.
-    def put(resource_path, params, body_params = false)
-      response =
-        if body_params
-          @http_client.put(resource_path) do |request|
-            request['Content-Type'] = 'application/json'
-            request.params = params.to_json
-          end
-        else
-          @http_client.put(resource_path, params)
-        end
+    def put(resource_path, data, headers = {})
+      response = @http_client.put(resource_path, data, headers)
       Response.new(response)
-    rescue => err
-      raise communication_error err
+    rescue StandardError => e
+      raise communication_error e
     end
 
     # Generic Mailgun DELETE Handler
@@ -196,8 +187,8 @@ module Mailgun
           @http_client.delete(resource_path)
         end
       Response.new(response)
-    rescue => err
-      raise communication_error err
+    rescue StandardError => e
+      raise communication_error e
     end
 
     # Constructs a Suppressions client for the given domain.
@@ -229,7 +220,7 @@ module Mailgun
     # @param [Boolean] ssl True, SSL. False, No SSL.
     # @return [string] concatenated URL string
     def endpoint_generator(api_host, api_version, ssl)
-      ssl ? scheme = 'https' : scheme = 'http'
+      scheme = ssl ? 'https' : 'http'
       if api_version
         "#{scheme}://#{api_host}/#{api_version}"
       else
@@ -243,28 +234,33 @@ module Mailgun
     def communication_error(e)
       if e.respond_to?(:response) && e.response
         return case e.response_status
-        when Unauthorized::CODE
-          Unauthorized.new(e.message, e.response)
-        when BadRequest::CODE
-          BadRequest.new(e.message, e.response)
-        else
-          CommunicationError.new(e.message, e.response)
-        end
+               when Unauthorized::CODE
+                 Unauthorized.new(e.message, e.response)
+               when BadRequest::CODE
+                 BadRequest.new(e.message, e.response)
+               else
+                 CommunicationError.new(e.message, e.response)
+               end
       end
       CommunicationError.new(e.message)
     end
 
     def perform_data_validation(working_domain, data)
       message = data.respond_to?(:message) ? data.message : data
-      fail ParameterError.new('Missing working domain', working_domain) unless working_domain
-      fail ParameterError.new(
-        'Missing `to` recipient, message should contain at least 1 recipient',
-        working_domain
-      ) if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
-      fail ParameterError.new(
+      raise ParameterError.new('Missing working domain', working_domain) unless working_domain
+
+      if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
+        raise ParameterError.new(
+          'Missing `to` recipient, message should contain at least 1 recipient',
+          working_domain
+        )
+      end
+      return unless message.fetch('from', []).empty? && message.fetch(:from, []).empty?
+
+      raise ParameterError.new(
         'Missing a `from` sender, message should contain at least 1 `from` sender',
         working_domain
-      ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
+      )
     end
 
     def build_http_client(api_key, request_options)

data/lib/mailgun/domains/domains.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::Domains object is a simple CRUD interface to Mailgun Domains.
   # Uses Mailgun
   class Domains
@@ -67,7 +68,6 @@ module Mailgun
       @client.put("domains/#{domain}", options).to_h
     end
 
-
     # Public: Verify domain
     #
     # domain - [String] Domain name
@@ -101,7 +101,7 @@ module Mailgun
     #
     # Returns [Hash] with message key
     def list_domain_keys(options = {})
-      @client.get("dkim/keys", options).to_h
+      @client.get('dkim/keys', options).to_h
     end
 
     # Public: Create a domain key
@@ -114,7 +114,7 @@ module Mailgun
     #
     # Returns [Hash] with message key
     def create_domain_key(options = {})
-      @client.post("dkim/keys", options).to_h
+      @client.post('dkim/keys', options).to_h
     end
 
     # Public: Delete a domain key.
@@ -125,7 +125,7 @@ module Mailgun
     #
     # Returns [Hash] with message key
     def delete_domain_key(options = {})
-      @client.delete("dkim/keys", options).to_h
+      @client.delete('dkim/keys', options).to_h
     end
 
     # Public: Activate a domain key for a specified authority and selector.
@@ -258,7 +258,6 @@ module Mailgun
 
     # ==== End of Domain::Tracking methods ====
 
-
     # ==== Domain::DKIM_Security methods ====
 
     # Public: Tracking Certificate: Generate
@@ -338,13 +337,13 @@ module Mailgun
     #
     # Returns [Array] A list of domains (hash)
     def get_domain_stats(domain, options = {})
-      fail(ParameterError, 'No domain given to list stats on Mailgun', caller) unless domain
+      raise(ParameterError, 'No domain given to list stats on Mailgun', caller) unless domain
+
       @client.get("#{domain}/stats/total", options).to_h
     end
 
     # ==== End of Reporting::Stats methods ====
 
-
     enforces_api_version 'v1', :list_domain_keys, :create_domain_key, :delete_domain_key, :dkim_rotation,
                          :dkim_rotate
     enforces_api_version 'v2', :get_domain_tracking_certificate, :regenerate_domain_tracking_certificate,

data/lib/mailgun/events/events.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::Events object makes it really simple to consume
   #   Mailgun's events from the Events endpoint.
   #
@@ -100,7 +101,7 @@ module Mailgun
     # Returns a String of the partial URI if the given url follows the regular API format
     # Returns nil in other cases (e.g. when given nil, or an irrelevant url)
     def extract_endpoint_from(url = nil)
-      URI.parse(url).path[/\/v[\d]\/#{@domain}\/events\/(.+)/,1]
+      URI.parse(url).path[%r{/v\d/#{@domain}/events/(.+)}, 1]
     rescue URI::InvalidURIError
       nil
     end
@@ -112,8 +113,8 @@ module Mailgun
     # Returns a String of the partial URI
     def construct_url(paging = nil)
       return "#{@domain}/events/#{paging}" if paging
+
       "#{@domain}/events"
     end
-
   end
 end

data/lib/mailgun/exceptions/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailgun
   module Exceptions
   end
@@ -6,7 +8,6 @@ module Mailgun
   # Inherits from StandardError (previously RuntimeError) as not all errors are
   # runtime errors.
   class Error < StandardError
-
     # Public: get an object an error is instantiated with
     attr_reader :object
 
@@ -35,7 +36,7 @@ module Mailgun
     attr_reader :status
 
     # Public: fallback if there is no response status on the object
-    NOCODE = 000
+    NOCODE = 0o00
     FORBIDDEN = 'Forbidden'
 
     # Public: initialization of new error given a message and/or object
@@ -46,10 +47,10 @@ module Mailgun
     def initialize(message = nil, response = nil)
       @response = response
       @status = if response.nil?
-                NOCODE
-              else
-                response[:status]
-              end
+                  NOCODE
+                else
+                  response[:status]
+                end
 
       begin
         json = JSON.parse(response[:body])
@@ -57,13 +58,13 @@ module Mailgun
       rescue JSON::ParserError
         api_message = response.response_body
       rescue NoMethodError
-        api_message = "Unknown API error"
-      rescue
+        api_message = 'Unknown API error'
+      rescue StandardError
         api_message = 'Unknown API error'
       end
 
-      message = message || ''
-      message = message + ': ' + (api_message || "")
+      message ||= ''
+      message = "#{message}: #{api_message || ''}"
 
       super(message, response)
     rescue NoMethodError, JSON::ParserError
@@ -78,7 +79,7 @@ module Mailgun
     CODE = 401
 
     def initialize(error_message, response)
-      error_message = error_message + ' - Invalid Domain or API key'
+      error_message += ' - Invalid Domain or API key'
       super(error_message, response)
     end
   end
@@ -87,9 +88,5 @@ module Mailgun
   # Inherits from Mailgun::CommunicationError
   class BadRequest < CommunicationError
     CODE = 400
-
-    def initialize(error_message, response)
-      super(error_message, response)
-    end
   end
 end

data/lib/mailgun/helpers/api_version_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailgun
   module ApiVersionChecker
     def self.included(base)
@@ -35,7 +37,10 @@ module Mailgun
     end
 
     def require_api_version(expected_version)
-      fail(ParameterError, "Client api version must be #{expected_version}", caller) unless @client.api_version == expected_version
+      return if @client.api_version == expected_version
+
+      raise(ParameterError, "Client api version must be #{expected_version}",
+            caller)
     end
   end
 end

data/lib/mailgun/lists/opt_in_handler.rb

@@ -1,11 +1,11 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # Public: Provides methods for creating and handling opt-in URLs,
   #   particularlly for mailing lists.
   #
   # See: https://github.com/mailgun/mailgun-ruby/blob/master/OptInHandler.md
   class OptInHandler
-
     # Generates a hash that can be used to validate opt-in recipients. Encodes
     # all the necessary data in the URL.
     #
@@ -46,6 +46,7 @@ module Mailgun
       if generated_hash == hash_provided
         return { 'recipient_address' => inner_payload['r'], 'mailing_list' => inner_payload['l'] }
       end
+
       false
     end
 
@@ -58,13 +59,10 @@ module Mailgun
     def self.base64_decode(input)
       # TODO: Condition can be droped if Ruby >= 2.4.0
       if input.respond_to?(:unpack1)
-        input.unpack1('m')
-      else
-        input.unpack('m').first
       end
+      input.unpack1('m')
     end
 
     private_class_method :base64_encode, :base64_decode
   end
-
 end

data/lib/mailgun/logs/logs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailgun
   # A Mailgun::Logs object is a simple interface to Mailgun Logs.
   # Uses Mailgun
@@ -30,8 +32,8 @@ module Mailgun
     #         limit - [Integer] The maximum number of items returned (100 max).
     #
     # Returns [Hash] Logs
-    def account_logs(options={})
-      @client.post('analytics/logs', options.to_json, { "Content-Type" => "application/json" }).to_h!
+    def account_logs(options = {})
+      @client.post('analytics/logs', options.to_json, { 'Content-Type' => 'application/json' }).to_h!
     end
   end
 end

data/lib/mailgun/messages/batch_message.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::BatchMessage object is used to create a valid payload
   # for Batch Sending. Batch Sending can be difficult to implement, therefore
   # this code makes it dead simple to send millions of messages in batches of
@@ -18,7 +19,6 @@ module Mailgun
   #
   # See the Github documentation for full examples.
   class BatchMessage < MessageBuilder
-
     attr_reader :message_ids, :domain, :recipient_variables
 
     # Public: Creates a new BatchMessage object.
@@ -68,9 +68,10 @@ module Mailgun
     #
     # @return [Boolean]
     def any_recipients_left?
-      return true if @counters[:recipients][:to] > 0
-      return true if @counters[:recipients][:cc] > 0
-      return true if @counters[:recipients][:bcc] > 0
+      return true if @counters[:recipients][:to].positive?
+      return true if @counters[:recipients][:cc].positive?
+      return true if @counters[:recipients][:bcc].positive?
+
       false
     end
 
@@ -86,7 +87,7 @@ module Mailgun
       @message[rkey] = @message[rkey].first if @message.key?(rkey)
 
       response = @client.send_message(@domain, @message).to_h!
-      message_id = response['id'].gsub(/\>|\</, '')
+      message_id = response['id'].gsub(/>|</, '')
       @message_ids[message_id] = count_recipients
       reset_message
     end
@@ -94,7 +95,7 @@ module Mailgun
     # This method stores recipient variables for each recipient added, if
     # variables exist.
     def store_recipient_variables(recipient_type, address, variables)
-      variables = { id: @counters[:recipients][recipient_type] } unless variables
+      variables ||= { id: @counters[:recipients][recipient_type] }
       @recipient_variables[address] = variables
     end
 
@@ -118,7 +119,5 @@ module Mailgun
       @counters[:recipients][:cc] = 0
       @counters[:recipients][:bcc] = 0
     end
-
   end
-
 end