mailgun-ruby 1.4.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7b6ece85b0a809a90ea79e6836b55bc5a97cfe8cd036c1567acff92b8053c5
-  data.tar.gz: 277f0def30a104f86beef2c8ef3012b877fa94e35e415a9beff328cc76247280
+  metadata.gz: e4ebcbb3e9a3ff18a06515ffca7027ffa893d0250ad4f6491cd896a78e035428
+  data.tar.gz: 27750827e497452d5ea7276601a01621164d9a4decfb3e6f43b1d32c51b7aa62
 SHA512:
-  metadata.gz: 3a419c6c2c8fbb7efa2ed08ad51da87441befe54e00e3a70db6626b82f353932827c5ebdd933f32edfe06ba043ea2dcba99cacd93a445f078ff089ad58af96ea
-  data.tar.gz: c910105de443193207c67c5afaa24b2d423dfb7b7e995466a95b8192d967f244f36e45142d78f97a46fb893809a633e793d75366ea206f83338b8f138a4ed3af
+  metadata.gz: 7432da86b0a9b20ddaea5e0cb049c0fac6b7f8e37cc907d79bbcd5aa642550a8c8067bdd40e3c87f49679306d662906ede13c9bdbb4fd70ea19498f4325c9d92
+  data.tar.gz: 8691eac12d6cd590d8735a60965376ee7f751fe700c6533dc61cab987917292ef21d03e22d0c35c2c58584288602396b5201b8d5b55bdf9834693819a10185cc

data/.github/workflows/ci.yml

@@ -11,17 +11,39 @@ permissions:
 
 jobs:
   test:
+    permissions: write-all
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version: [ '3.0', '3.1', '3.2', '3.3', '3.4', '4.0' ]
 
     steps:
-    - uses: actions/checkout@v6
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true 
-    - name: Run tests
-      run: bundle exec rake spec:all
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake spec:all
+      - uses: joshmfrankel/simplecov-check-action@main
+        with:
+          minimum_suite_coverage: 95
+          minimum_file_coverage: 80
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+        if: matrix.ruby-version == '4.0'
+
+  rubocop:
+    permissions: write-all
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - name: Run rubocop
+        run: |
+          bundle exec rubocop --format github

data/.rubocop.yml

@@ -1,8 +1,68 @@
-inherit_from: .rubocop_todo.yml
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
 
-Metrics/LineLength:
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+# temporary disable main codebase errors
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Lint/MissingSuper:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - 'lib/mailgun-ruby.rb'
+
+# temporary disable rspec errors
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/InstanceVariable:
+  Enabled: false
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+RSpec/StubbedMock:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/NoExpectationExample:
+  Enabled: false
+RSpec/RepeatedDescription:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/MultipleDescribes:
+  Enabled: false
+RSpec/BeforeAfterAll:
   Enabled: false
-Style/EmptyLinesAroundModuleBody:
+RSpec/SpecFilePathFormat:
   Enabled: false
-Style/EmptyLinesAroundClassBody:
+RSpec/ContextWording:
   Enabled: false
+RSpec/OverwritingSetup:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.4.1'
+gem 'mailgun-ruby', '~>1.4.3'
 ```
 
 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,19 +19,14 @@ 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
 
 task default: 'spec:unit'
-task spec: 'spec:unit'
-
-task :console do
-  sh 'pry --gem'
-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)
 
@@ -49,14 +50,18 @@ module Mailgun
     end
 
     # Change API key
+    # rubocop:disable Naming/AccessorMethodName
     def set_api_key(api_key)
       @http_client.set_basic_auth('api', api_key)
     end
+    # rubocop:enable Naming/AccessorMethodName
 
     # Add subaccount id to headers
+    # rubocop:disable Naming/AccessorMethodName
     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
+    # rubocop:enable Naming/AccessorMethodName
 
     # Reset subaccount for primary usage
     def reset_subaccount
@@ -71,15 +76,13 @@ 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.
     #
     # @return [Hash]
     def self.deliveries
-      @@deliveries ||= []
+      @deliveries ||= []
     end
 
     # Simple Message Sending
@@ -91,12 +94,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 +109,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 +122,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 +137,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 +154,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 +165,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 +191,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 +224,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
@@ -240,31 +235,36 @@ module Mailgun
     # Raises CommunicationError and stores response in it if present
     #
     # @param [StandardException] e upstream exception object
-    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
+    def communication_error(error)
+      if error.respond_to?(:response) && error.response
+        return case error.response_status
+               when Unauthorized::CODE
+                 Unauthorized.new(error.message, error.response)
+               when BadRequest::CODE
+                 BadRequest.new(error.message, error.response)
+               else
+                 CommunicationError.new(error.message, error.response)
+               end
       end
-      CommunicationError.new(e.message)
+      CommunicationError.new(error.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.
@@ -197,7 +197,8 @@ module Mailgun
     #
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
-    #   active  - [Boolean] yes or no. If set to yes, links will be overwritten and pointed to our servers so we can track clicks.
+    #   active  - [Boolean] yes or no. If set to yes, links will be overwritten and pointed to our servers
+    #                       so we can track clicks.
     #
     # Returns [Hash] Information on the tracking click settings
     def update_domain_tracking_click_settings(domain, options = {})
@@ -209,7 +210,8 @@ module Mailgun
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
     #   active  - [Boolean] yes or no. If set to yes, a tracking pixel will be inserted below your HTML content.
-    #   place_at_the_top  - [Boolean] yes or no. If set to yes, tracking pixel will be moved to top of your HTML content.
+    #   place_at_the_top  - [Boolean] yes or no. If set to yes, tracking pixel will be moved
+    #                                 to top of your HTML content.
     #
     # Returns [Hash] Information on the tracking open settings
     def update_domain_tracking_open_settings(domain, options = {})
@@ -258,7 +260,6 @@ module Mailgun
 
     # ==== End of Domain::Tracking methods ====
 
-
     # ==== Domain::DKIM_Security methods ====
 
     # Public: Tracking Certificate: Generate
@@ -338,13 +339,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