mailtrap 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f1415f049fa2132b1716a70d48c1e6fd5650d4fa263b15fe2339c024053abd
-  data.tar.gz: e6a299b5d04aeeb2ed80c0b47bf3f1177d5934ef214d0499a9c8d4c8f17a5f7c
+  metadata.gz: c02915dc1ea123fb592af56b9c553cb97e6137f0555b98f965f3a8cf1dd1d229
+  data.tar.gz: 8e7da7be2313f3e3766512e5c4014f90d1f8f1ddb271cbd255494252b6eda161
 SHA512:
-  metadata.gz: b594f448ac1fee0581ebac86107572e69c7f77ec8acc558671977e1301b762bedb3e962514485cfba87089c5587c63475dd57e5744c2c6225da58a36525f3bad
-  data.tar.gz: 94692a8b8a05646ddf49f92a13cfb630ed5e79176bed7f7b48f2f914b092becfd422ba21c38c5dddb6e802261d235c6e8ac2f2cdb190a0e3bc4c1d6339156b72
+  metadata.gz: 962e1a2227a79b264bd637f643ffbf326c03d56ba1736a406869fda693eb67c5ffed3797cacd1862403e034ba543c44094829fe45ec36c6fcfa2e96ecdd554c3
+  data.tar.gz: b568ff9976cba7311ae02118bbbe5b825230743facd0094921fa3ac58d4fe4d8132c9b9bbc5dca4c6d60fc798fa18d8508149a871949de971e621af50c386177

data/.rubocop.yml

@@ -12,6 +12,9 @@ Layout/LineLength:
 Naming/MethodParameterName:
   MinNameLength: 2
 
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
 RSpec/MultipleExpectations:
   Max: 4
 

data/CHANGELOG.md

@@ -1,24 +1,31 @@
-## [1.0.0] - 2022-06-14
+## [1.2.2] - 2023-11-01
 
-- Initial release
+- Improved error handling
 
-## [1.0.1] - 2022-06-20
+## [1.2.1] - 2023-04-12
 
-- Update packed files list
+- Set custom user agent
+
+## [1.2.0] - 2023-01-27
+
+- Breaking changes:
+  - move `Mailtrap::Sending::Mail` class to `Mailtrap::Mail::Base`
+  - move `Mailtrap::Sending::Convert` to `Mailtrap::Mail`
+- Add mail gem 2.8 support
+- Add email template support
 
+## [1.1.1] - 2022-10-14
+
+- Fix custom port and host usage
 
 ## [1.1.0] - 2022-07-22
 
 - Add ActionMailer support
 
-## [1.1.1] - 2022-10-14
+## [1.0.1] - 2022-06-20
 
-- Fix custom port and host usage
+- Update packed files list
 
-## [1.2.0] - 2023-01-27
+## [1.0.0] - 2022-06-14
 
-- Breaking changes:
-  - move `Mailtrap::Sending::Mail` class to `Mailtrap::Mail::Base`
-  - move `Mailtrap::Sending::Convert` to `Mailtrap::Mail`
-- Add mail gem 2.8 support
-- Add email template support
+- Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (1.2.0)
+    mailtrap (1.2.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -130,6 +130,20 @@ mail(
 )
 ```
 
+#### Content-Transfer-Encoding
+
+`mailtrap` gem uses Mailtrap API to send emails. Mailtrap API does not try to
+replicate SMTP. That is why you should expect some limitations when it comes to 
+sending. For example, `/api/send` endpoint ignores `Content-Transfer-Encoding`
+(see `headers` in the [API documentation](https://railsware.stoplight.io/docs/mailtrap-api-docs/67f1d70aeb62c-send-email)).
+Meaning your recipients will receive emails only in the default encoding which 
+is `quoted-printable`, if you send with Mailtrap API.
+
+For those who does need to use `7bit` or any other encoding, SMTP provides 
+better flexibility in that regard. Go to your _Mailtrap account_ → _Email Sending_ 
+→ _Sending Domains_ → _Your domain_ → _SMTP/API Settings_ to find the SMTP 
+configuration example.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mailtrap/sending/client.rb

@@ -38,20 +38,31 @@ module Mailtrap
         request.body = body
         request['Authorization'] = "Bearer #{api_key}"
         request['Content-Type'] = 'application/json'
+        request['User-Agent'] = 'mailtrap-ruby (https://github.com/railsware/mailtrap-ruby)'
 
         request
       end
 
-      def handle_response(response)
-        case response.code
-        when '200'
+      def handle_response(response) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        case response
+        when Net::HTTPOK
           json_response(response.body)
-        when '400'
+        when Net::HTTPBadRequest
           raise Mailtrap::Sending::Error, json_response(response.body)[:errors]
-        when '401'
+        when Net::HTTPUnauthorized
           raise Mailtrap::Sending::AuthorizationError, json_response(response.body)[:errors]
-        else
+        when Net::HTTPForbidden
+          raise Mailtrap::Sending::RejectionError, json_response(response.body)[:errors]
+        when Net::HTTPPayloadTooLarge
+          raise Mailtrap::Sending::MailSizeError, ['message too large']
+        when Net::HTTPTooManyRequests
+          raise Mailtrap::Sending::RateLimitError, ['too many requests']
+        when Net::HTTPClientError
+          raise Mailtrap::Sending::Error, ['client error']
+        when Net::HTTPServerError
           raise Mailtrap::Sending::Error, ['server error']
+        else
+          raise Mailtrap::Sending::Error, ["unexpected status code=#{response.code}"]
         end
       end
 

data/lib/mailtrap/sending.rb

@@ -17,6 +17,21 @@ module Mailtrap
       end
     end
 
+    # AuthorizationError is raised when invalid token is used.
     class AuthorizationError < Error; end
+
+    # MailSizeError is raised when mail is too large.
+    class MailSizeError < Error; end
+
+    # RateLimitError is raised when client performing too many requests.
+    class RateLimitError < Error; end
+
+    # RejectionError is raised when server refuses to process the request. Use
+    # error message to debug the problem.
+    #
+    # *Some* possible reasons:
+    #   * Account is banned
+    #   * Domain is not verified
+    class RejectionError < Error; end
   end
 end

data/lib/mailtrap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailtrap
-  VERSION = '1.2.0'
+  VERSION = '1.2.2'
 end

data/mailtrap.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mailtrap/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mailtrap'
+  spec.version = Mailtrap::VERSION
+  spec.authors = ['Railsware Products Studio LLC']
+  spec.email = ['support@mailtrap.io']
+
+  spec.summary = 'Official mailtrap.io API client'
+  spec.description = 'Official mailtrap.io API client'
+  spec.homepage = 'https://github.com/railsware/mailtrap-ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/railsware/mailtrap-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/railsware/mailtrap-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|github|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Railsware Products Studio LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies: []
 description: Official mailtrap.io API client
 email:
@@ -39,6 +39,7 @@ files:
 - lib/mailtrap/sending/attachment.rb
 - lib/mailtrap/sending/client.rb
 - lib/mailtrap/version.rb
+- mailtrap.gemspec
 homepage: https://github.com/railsware/mailtrap-ruby
 licenses:
 - MIT