mailgun-ruby 1.4.1 → 1.4.2

data/lib/mailgun/messages/message_builder.rb

@@ -1,12 +1,12 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::MessageBuilder object is used to create a valid payload
   # for the Mailgun API messages endpoint. If you prefer step by step message
   # generation through your code, this class is for you.
   #
   # See the Github documentation for full examples.
   class MessageBuilder
-
     attr_reader :message, :counters
 
     # Public: Creates a new MessageBuilder object.
@@ -28,13 +28,13 @@ module Mailgun
     # @param [Hash] variables A hash of the variables associated with the recipient. We recommend "first" and "last" at a minimum!
     # @return [void]
     def add_recipient(recipient_type, address, variables = nil)
-      if recipient_type == "h:reply-to"
+      if recipient_type == 'h:reply-to'
         warn 'DEPRECATION: "add_recipient("h:reply-to", ...)" is deprecated. Please use "reply_to" instead.'
         return reply_to(address, variables)
       end
 
       if (@counters[:recipients][recipient_type] || 0) >= Mailgun::Chains::MAX_RECIPIENTS
-        fail Mailgun::ParameterError, 'Too many recipients added to message.', address
+        raise Mailgun::ParameterError, 'Too many recipients added to message.', address
       end
 
       compiled_address = parse_address(address, variables)
@@ -68,7 +68,7 @@ module Mailgun
     # @return [void]
     def reply_to(address, variables = nil)
       compiled_address = parse_address(address, variables)
-      header("reply-to", compiled_address)
+      header('reply-to', compiled_address)
     end
 
     # Set a subject for the message object
@@ -180,7 +180,10 @@ module Mailgun
     # @param [String] campaign_id A defined campaign ID to add to the message.
     # @return [void]
     def add_campaign_id(campaign_id)
-      fail(Mailgun::ParameterError, 'Too many campaigns added to message.', campaign_id) if @counters[:attributes][:campaign_id] >= Mailgun::Chains::MAX_CAMPAIGN_IDS
+      if @counters[:attributes][:campaign_id] >= Mailgun::Chains::MAX_CAMPAIGN_IDS
+        raise(Mailgun::ParameterError, 'Too many campaigns added to message.',
+              campaign_id)
+      end
 
       set_multi_complex('o:campaign', campaign_id)
       @counters[:attributes][:campaign_id] += 1
@@ -192,8 +195,9 @@ module Mailgun
     # @return [void]
     def add_tag(tag)
       if @counters[:attributes][:tag] >= Mailgun::Chains::MAX_TAGS
-        fail Mailgun::ParameterError, 'Too many tags added to message.', tag
+        raise Mailgun::ParameterError, 'Too many tags added to message.', tag
       end
+
       set_multi_complex('o:tag', tag)
       @counters[:attributes][:tag] += 1
     end
@@ -255,7 +259,8 @@ module Mailgun
     # @param [Hash] data Either a hash or JSON string.
     # @return [void]
     def header(name, data)
-      fail(Mailgun::ParameterError, 'Header name for message must be specified') if name.to_s.empty?
+      raise(Mailgun::ParameterError, 'Header name for message must be specified') if name.to_s.empty?
+
       begin
         jsondata = make_json data
         set_single("h:#{name}", jsondata)
@@ -278,7 +283,8 @@ module Mailgun
     #                           can not be converted to JSON, ParameterError will be raised.
     # @return [void]
     def variable(name, data)
-      fail(Mailgun::ParameterError, 'Variable name must be specified') if name.to_s.empty?
+      raise(Mailgun::ParameterError, 'Variable name must be specified') if name.to_s.empty?
+
       begin
         jsondata = make_json data
         set_single("v:#{name}", jsondata)
@@ -308,6 +314,7 @@ module Mailgun
     def message_id(data = nil)
       key = 'h:Message-Id'
       return @message.delete(key) if data.to_s.empty?
+
       set_single(key, data)
     end
 
@@ -326,6 +333,7 @@ module Mailgun
     def template(template_name = nil)
       key = 'template'
       return @message.delete(key) if template_name.to_s.empty?
+
       set_single(key, template_name)
     end
 
@@ -337,6 +345,7 @@ module Mailgun
     def template_version(version = nil)
       key = 't:version'
       return @message.delete(key) if version.to_s.empty?
+
       set_single(key, version)
     end
 
@@ -358,7 +367,7 @@ module Mailgun
     # @param [String] value The value of the parameter.
     # @return [void]
     def set_single(parameter, value)
-      @message[parameter] = value ? value : ''
+      @message[parameter] = value || ''
     end
 
     # Sets values within the multidict, however, prevents
@@ -397,8 +406,9 @@ module Mailgun
     # @param [String] value The item to convert
     # @return [void]
     def bool_lookup(value)
-      return 'yes' if %w(true yes yep).include? value.to_s.downcase
-      return 'no' if %w(false no nope).include? value.to_s.downcase
+      return 'yes' if %w[true yes yep].include? value.to_s.downcase
+      return 'no' if %w[false no nope].include? value.to_s.downcase
+
       warn 'WARN: for bool type actions next values are preferred: true yes yep | false no nope | htmlonly'
       value
     end
@@ -409,7 +419,7 @@ module Mailgun
     # @return [void]
     def valid_json?(json_)
       JSON.parse(json_)
-      return true
+      true
     rescue JSON::ParserError
       false
     end
@@ -422,8 +432,9 @@ module Mailgun
     def make_json(obj)
       return JSON.parse(obj).to_json if obj.is_a?(String)
       return obj.to_json if obj.is_a?(Hash)
+
       JSON.generate(obj).to_json
-    rescue
+    rescue StandardError
       raise Mailgun::ParameterError, 'Provided data could not be made into JSON. Try a JSON string or Hash.', obj
     end
 
@@ -436,9 +447,9 @@ module Mailgun
     # @return [void]
     def parse_address(address, vars)
       return address unless vars.is_a? Hash
-      fail(Mailgun::ParameterError, 'Email address not specified') unless address.is_a? String
-      if vars['full_name'] != nil && (vars['first'] != nil || vars['last'] != nil)
-        fail(Mailgun::ParameterError, 'Must specify at most one of full_name or first/last. Vars passed: #{vars}')
+      raise(Mailgun::ParameterError, 'Email address not specified') unless address.is_a? String
+      if !vars['full_name'].nil? && (!vars['first'].nil? || !vars['last'].nil?)
+        raise(Mailgun::ParameterError, "Must specify at most one of full_name or first/last. Vars passed: #{vars}")
       end
 
       if vars['full_name']
@@ -448,6 +459,7 @@ module Mailgun
       end
 
       return "'#{full_name}' <#{address}>" if full_name
+
       address
     end
 
@@ -461,24 +473,24 @@ module Mailgun
     # Returns nothing
     def add_file(disposition, filedata, filename)
       attachment = File.open(filedata, 'r') if filedata.is_a?(String)
-      attachment = filedata.dup unless attachment
+      attachment ||= filedata.dup
 
-      fail(Mailgun::ParameterError,
-        'Unable to access attachment file object.'
-      ) unless attachment.respond_to?(:read)
+      unless attachment.respond_to?(:read)
+        raise(Mailgun::ParameterError,
+              'Unable to access attachment file object.')
+      end
 
       if attachment.respond_to?(:path) && !attachment.respond_to?(:content_type)
         mime_types = MiniMime.lookup_by_filename(attachment.path)
         content_type = mime_types.nil? ? 'application/octet-stream' : mime_types.content_type
-        attachment.instance_eval "def content_type; '#{content_type}'; end"
+        attachment.instance_eval "def content_type; '#{content_type}'; end", __FILE__, __LINE__
       end
 
       unless filename.nil?
         attachment.instance_variable_set :@original_filename, filename
-        attachment.instance_eval 'def original_filename; @original_filename; end'
+        attachment.instance_eval 'def original_filename; @original_filename; end', __FILE__, __LINE__
       end
       add_faraday_attachment(disposition, attachment, filename)
     end
   end
-
 end

data/lib/mailgun/metrics/metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailgun
   # A Mailgun::Metrics object is a simple interface to Mailgun Metrics.
   # Uses Mailgun
@@ -28,8 +30,8 @@ module Mailgun
     #     include_aggregates - [Boolean] Include top-level aggregate metrics.
     #
     # Returns [Hash] Metrics
-    def account_metrics(options={})
-      @client.post('analytics/metrics', options.to_json, { "Content-Type" => "application/json" }).to_h!
+    def account_metrics(options = {})
+      @client.post('analytics/metrics', options.to_json, { 'Content-Type' => 'application/json' }).to_h!
     end
 
     # Public: Post query to get account usage metrics
@@ -52,8 +54,8 @@ module Mailgun
     #     include_aggregates - [Boolean] Include top-level aggregate metrics.
     #
     # Returns [Hash] Metrics
-    def account_usage_metrics(options={})
-      @client.post('analytics/usage/metrics', options.to_json, { "Content-Type" => "application/json" }).to_h!
+    def account_usage_metrics(options = {})
+      @client.post('analytics/usage/metrics', options.to_json, { 'Content-Type' => 'application/json' }).to_h!
     end
   end
 end

data/lib/mailgun/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailgun
   # A Mailgun::Response object is instantiated for each response generated
   # by the Client request. The Response object supports deserialization of
@@ -13,7 +15,7 @@ module Mailgun
     ResponseHash = Struct.new(:body, :status)
     def self.from_hash(h)
       # Create a "fake" response object with the data passed from h
-      self.new ResponseHash.new(h[:body], h[:status])
+      new ResponseHash.new(h[:body], h[:status])
     end
 
     def initialize(response)
@@ -28,8 +30,8 @@ module Mailgun
 
     def to_h
       JSON.parse(@body)
-    rescue => err
-      raise ParseError.new(err), err
+    rescue StandardError => e
+      raise ParseError.new(e), e
     end
 
     # Replace @body with Ruby Hash
@@ -37,8 +39,8 @@ module Mailgun
     # @return [Hash] A standard Ruby Hash containing the HTTP result.
     def to_h!
       @body = JSON.parse(@body)
-    rescue => err
-      raise ParseError.new(err), err
+    rescue StandardError => e
+      raise ParseError.new(e), e
     end
 
     # Return response as Yaml
@@ -46,8 +48,8 @@ module Mailgun
     # @return [String] A string containing response as YAML
     def to_yaml
       YAML.dump(to_h)
-    rescue => err
-      raise ParseError.new(err), err
+    rescue StandardError => e
+      raise ParseError.new(e), e
     end
 
     # Replace @body with YAML
@@ -55,8 +57,8 @@ module Mailgun
     # @return [String] A string containing response as YAML
     def to_yaml!
       @body = YAML.dump(to_h)
-    rescue => err
-      raise ParseError.new(err), err
+    rescue StandardError => e
+      raise ParseError.new(e), e
     end
 
     # Returns true if response status is 2xx

data/lib/mailgun/subaccounts/subaccounts.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::Subaccounts object is a simple CRUD interface to Mailgun Subaccounts.
   # Uses Mailgun
   class Subaccounts
@@ -22,9 +23,9 @@ module Mailgun
     #
     # Returns [Array] A list of subaccounts (hash)
     def list(options = {})
-      client.get("accounts/subaccounts", options).to_h!
+      client.get('accounts/subaccounts', options).to_h!
     end
-    alias_method :get_subaccounts, :list
+    alias get_subaccounts list
 
     # Public: Get subaccount information
     #
@@ -35,7 +36,8 @@ module Mailgun
     #
     # Returns [Hash] Information on the requested subaccount.
     def info(subaccount_id, options = {})
-      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      raise(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+
       client.get("accounts/subaccounts/#{subaccount_id}", options).to_h!
     end
 
@@ -49,8 +51,9 @@ module Mailgun
     #
     # Returns [Hash] of created subaccount
     def create(name, options = {})
-      fail(ParameterError, 'No name given to create subaccount', caller) unless name
-      client.post("accounts/subaccounts", options.merge!(name: name)).to_h!
+      raise(ParameterError, 'No name given to create subaccount', caller) unless name
+
+      client.post('accounts/subaccounts', options.merge!(name: name)).to_h!
     end
 
     # Public: Disable a subaccount
@@ -62,7 +65,8 @@ module Mailgun
     #
     # Returns [Hash] Information on the requested subaccount.
     def disable(subaccount_id, options = {})
-      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      raise(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+
       client.post("accounts/subaccounts/#{subaccount_id}/disable", options).to_h!
     end
 
@@ -75,7 +79,8 @@ module Mailgun
     #
     # Returns [Hash] Information on the requested subaccount.
     def enable(subaccount_id, options = {})
-      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      raise(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+
       client.post("accounts/subaccounts/#{subaccount_id}/enable", options).to_h!
     end
   end

data/lib/mailgun/suppressions.rb

@@ -1,9 +1,9 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # The Mailgun::Suppressions object makes it easy to manage "suppressions"
   # attached to an account. "Suppressions" means bounces, unsubscribes, and complaints.
   class Suppressions
-
     # @param [Mailgun::Client] client API client to use for requests
     # @param [String] domain Domain name to use for the suppression endpoints.
     def initialize(client, domain)
@@ -60,12 +60,12 @@ module Mailgun
     def create_bounces(data)
       # `data` should be a list of hashes, with each hash containing *at least* an `address` key.
       split_return = []
-      if data.length >= 1000 then
-        resp, resp_l = create_bounces data[999..-1]
+      if data.length >= 1000
+        resp, resp_l = create_bounces data[999..]
         split_return.push(resp)
         split_return.concat(resp_l)
         data = data[0..998]
-      elsif data.length == 0 then
+      elsif data.empty?
         return nil, []
       end
 
@@ -74,25 +74,21 @@ module Mailgun
       # NOTE: `data` could potentially be very large (1000 elements) so it is
       # more efficient to pop from data and push into a different array as
       # opposed to possibly copying the entire array to another array.
-      while not data.empty? do
+      until data.empty?
         bounce = data.pop
         # Bounces MUST contain a `address` key.
-        if not bounce.include? :address then
-          raise Mailgun::ParameterError.new "Bounce MUST include a :address key: #{bounce}"
-        end
+        raise Mailgun::ParameterError, "Bounce MUST include a :address key: #{bounce}" unless bounce.include? :address
 
         bounce.each do |k, v|
           # Hash values MUST be strings.
-          if not v.is_a? String then
-            bounce[k] = v.to_s
-          end
+          bounce[k] = v.to_s unless v.is_a? String
         end
 
         valid.push bounce
       end
 
-      response = @client.post("#{@domain}/bounces", valid.to_json, { "Content-Type" => "application/json" })
-      return response, split_return
+      response = @client.post("#{@domain}/bounces", valid.to_json, { 'Content-Type' => 'application/json' })
+      [response, split_return]
     end
 
     def delete_bounce(address)
@@ -133,22 +129,22 @@ module Mailgun
     def create_unsubscribes(data)
       # `data` should be a list of hashes, with each hash containing *at least* an `address` key.
       split_return = []
-      if data.length >= 1000 then
-        resp, resp_l = create_unsubscribes data[999..-1]
+      if data.length >= 1000
+        resp, resp_l = create_unsubscribes data[999..]
         split_return.push(resp)
         split_return.concat(resp_l)
         data = data[0..998]
-      elsif data.length == 0 then
+      elsif data.empty?
         return nil, []
       end
 
       valid = []
       # Validate the unsubscribes given
-      while not data.empty? do
+      until data.empty?
         unsubscribe = data.pop
         # unsubscribes MUST contain a `address` key.
-        if not unsubscribe.include? :address then
-          raise Mailgun::ParameterError.new "Unsubscribe MUST include a :address key: #{unsubscribe}"
+        unless unsubscribe.include? :address
+          raise Mailgun::ParameterError, "Unsubscribe MUST include a :address key: #{unsubscribe}"
         end
 
         unsubscribe.each do |k, v|
@@ -164,11 +160,11 @@ module Mailgun
         valid.push unsubscribe
       end
 
-      response = @client.post("#{@domain}/unsubscribes", valid.to_json, { "Content-Type" => "application/json" })
-      return response, split_return
+      response = @client.post("#{@domain}/unsubscribes", valid.to_json, { 'Content-Type' => 'application/json' })
+      [response, split_return]
     end
 
-    def delete_unsubscribe(address, params = {})
+    def delete_unsubscribe(address, _params = {})
       @client.delete("#{@domain}/unsubscribes/#{escape_address(address)}")
     end
 
@@ -202,36 +198,34 @@ module Mailgun
     def create_complaints(data)
       # `data` should be a list of hashes, with each hash containing *at least* an `address` key.
       split_return = []
-      if data.length >= 1000 then
-        resp, resp_l = create_complaints data[999..-1]
+      if data.length >= 1000
+        resp, resp_l = create_complaints data[999..]
         split_return.push(resp)
         split_return.concat(resp_l)
         data = data[0..998]
-      elsif data.length == 0 then
+      elsif data.empty?
         return nil, []
       end
 
       valid = []
       # Validate the complaints given
-      while not data.empty? do
+      until data.empty?
         complaint = data.pop
         # complaints MUST contain a `address` key.
-        if not complaint.include? :address then
-          raise Mailgun::ParameterError.new "Complaint MUST include a :address key: #{complaint}"
+        unless complaint.include? :address
+          raise Mailgun::ParameterError, "Complaint MUST include a :address key: #{complaint}"
         end
 
         complaint.each do |k, v|
           # Hash values MUST be strings.
-          if not v.is_a? String then
-            complaint[k] = v.to_s
-          end
+          complaint[k] = v.to_s unless v.is_a? String
         end
 
         valid.push complaint
       end
 
-      response = @client.post("#{@domain}/complaints", valid.to_json, { "Content-Type" => "application/json" })
-      return response, split_return
+      response = @client.post("#{@domain}/complaints", valid.to_json, { 'Content-Type' => 'application/json' })
+      [response, split_return]
     end
 
     def delete_complaint(address)
@@ -250,24 +244,23 @@ module Mailgun
 
     def extract_paging(response)
       rhash = response.to_h
-      return nil unless rhash.include? "paging"
+      return nil unless rhash.include? 'paging'
 
-      page_info = rhash["paging"]
+      page_info = rhash['paging']
 
       # Build the `next` endpoint
-      page_next = URI.parse(page_info["next"])
+      page_next = URI.parse(page_info['next'])
       @paging_next = {
-        :path => page_next.path[/\/v[\d]\/(.+)/, 1],
-        :params => Hash[URI.decode_www_form page_next.query],
+        path: page_next.path[%r{/v\d/(.+)}, 1],
+        params: Hash[URI.decode_www_form page_next.query]
       }
 
       # Build the `prev` endpoint
-      page_prev = URI.parse(page_info["previous"])
+      page_prev = URI.parse(page_info['previous'])
       @paging_prev = {
-        :path => page_prev.path[/\/v[\d]\/(.+)/, 1],
-        :params => Hash[URI.decode_www_form page_prev.query],
+        path: page_prev.path[%r{/v\d/(.+)}, 1],
+        params: Hash[URI.decode_www_form page_prev.query]
       }
     end
-
   end
 end

data/lib/mailgun/tags/analytics_tags.rb

@@ -1,5 +1,6 @@
-module Mailgun
+# frozen_string_literal: true
 
+module Mailgun
   # A Mailgun::AnalyticsTags object is a simple CRUD interface to Mailgun Tags.
   # Uses Mailgun
   class AnalyticsTags
@@ -11,18 +12,48 @@ module Mailgun
       @client = client
     end
 
+    # Public: Update account tag
+    #
+    # tag - [String] The tag to update.
+    # description - [String] The updated tag description.
+    #
+    # Returns [Boolean] true or false
     def update(tag, description)
-      @client.put('analytics/tags', { tag: tag, description: description }, body_params: true ).to_h['message'] == 'Tag updated'
+      @client.put('analytics/tags', { tag: tag, description: description }.to_json,
+                  { 'Content-Type' => 'application/json' }).to_h['message'] == 'Tag updated'
     end
 
+    # Public: Post query to list account tags or search for single tag
+    #
+    # options - [Hash] of
+    #     include_subaccounts  - [Boolean] Boolean indicating whether or not to include data from all subaccounts. Default false.
+    #     include_metrics      - [Boolean] Boolean indicating whether or not to include metrics for tags. Default false. When true max limit is 20.
+    #     tag                  - [string] The tag or tag prefix.
+    #     pagination           - [Object]
+    #         sort          - [String] Colon-separated value indicating column name and sort direction e.g. 'timestamp:desc'.
+    #         skip          - [Integer] The number of items to skip over when satisfying the request.
+    #         limit         - [Integer] The maximum number of items returned (100 max).
+    #         total         - [Integer] The total number of tags matching the search criteria.
+    #         include_total - [Boolean] Boolean indicating whether or not to include total number of items. Default false.
+
+    #
+    # Returns [Hash] Information on the requested tags.
     def list(options = {})
       @client.post('analytics/tags', options).to_h['items']
     end
 
+    # Public: Delete account tag
+    #
+    # tag - [String] The tag to delete.
+    #
+    # Returns [Boolean] true or false
     def remove(tag)
       @client.delete('analytics/tags', { tag: tag }, body_params: true).to_h['message'] == 'Tag deleted'
     end
 
+    # Public: Get account tag limit information
+    #
+    # Returns [Hash] Information on the tag limits.
     def limits
       @client.get('analytics/tags/limits').to_h
     end