mailtrap 0.2.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd604b5702f48dbaa0cf3fb294c3d000af11891ca3e0d6453af0763c1aa0abd4
+  data.tar.gz: 66baa71b1a5cb26cbd4012f6b6a4ab10fd585850f93792ffc9b2776bde9019ae
+SHA512:
+  metadata.gz: 853e6421d2d5d3c02bd0b090b4810383b5b30e6b8bfc178379ea602e56eb44ba1b298a2bb8e87575abfd0a37bc110a5bb8c8d14ca78d3c75729974cf389b2fd6
+  data.tar.gz: b9ca3ed482f8077a35151237a6078ef88ce2cdc58f1f097f72730f6fe71eb7367235559ebbbeba24b1622a06af10f31c728deb93ee6ef4207d6091543e5944bb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Naming/MethodParameterName:
+  MinNameLength: 2
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [1.0.0] - 2022-06-14
+
+- Initial release
+
+## [1.0.1] - 2022-06-20
+
+- Update packed files list
+
+
+## [1.1.0] - 2022-07-22
+
+- Add ActionMailer support

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,81 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at support@mailtrap.io. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'mail'
+gem 'net-smtp'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rspec-its'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rspec', require: false
+gem 'vcr'
+gem 'webmock'

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    mailtrap (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.1.2)
+    net-smtp (0.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    vcr (6.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mail
+  mailtrap!
+  net-smtp
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-its
+  rubocop (~> 1.21)
+  rubocop-rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Railsware Products Studio, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+[![test](https://github.com/railsware/mailtrap-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/railsware/mailtrap-ruby/actions/workflows/main.yml)
+
+# Official Mailtrap Ruby client
+
+This Ruby gem offers integration with the [official API](https://api-docs.mailtrap.io/) for [Mailtrap](https://mailtrap.io).
+
+Quickly add email sending functionality to your Ruby application with Mailtrap.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mailtrap'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mailtrap
+
+## Usage
+
+### Minimal
+
+```ruby
+require 'mailtrap'
+
+# create mail object
+mail = Mailtrap::Sending::Mail.new(
+  from: { email: 'mailtrap@example.com', name: 'Mailtrap Test' },
+  to: [
+    { email: 'your@email.com' }
+  ],
+  subject: 'You are awesome!',
+  text: "Congrats for sending test email with Mailtrap!"
+)
+
+# create client and send
+client = Mailtrap::Sending::Client.new(api_key: 'your-api-key')
+client.send(mail)
+```
+
+### Full
+
+```ruby
+require 'mailtrap'
+require 'base64'
+
+mail = Mailtrap::Sending::Mail.new(
+  from: { email: 'mailtrap@example.com', name: 'Mailtrap Test' },
+  to: [
+    { email: 'your@email.com', name: 'Your name' }
+  ],
+  cc: [
+    { email: 'cc@email.com', name: 'Copy To' }
+  ],
+  bcc: [
+    { email: 'bcc@email.com', name: 'Hidden Recipient' }
+  ],
+  subject: 'You are awesome!',
+  text: "Congrats for sending test email with Mailtrap!",
+  category: "Integration Test",
+  attachments: [
+    {
+      content: Base64.encode64('Attachment content'), # base64 encoded content or IO string
+      filename: 'attachment.txt'
+    }
+  ],
+  headers: {
+    'X-MT-Header': 'Custom header'
+  },
+  custom_variables: {
+    year: 2022
+  }
+)
+
+data = File.open('/path/to/image.jpg').read
+encoded = Base64.encode64(data).gsub(/\n/,"")
+
+mail.add_attachment(content: encoded, filename: 'image.png')
+
+client = Mailtrap::Sending::Client.new(api_key: 'your-api-key')
+client.send(mail)
+```
+
+### ActionMailer
+
+This gem also adds ActionMailer delivery method. To configure it, add following to your ActionMailer configuration (in Rails projects located in `config/$ENVIRONMENT.rb`):
+```ruby
+config.action_mailer.delivery_method = :mailtrap
+config.action_mailer.mailtrap_settings = {
+  api_key: ENV.fetch('MAILTRAP_API_KEY')
+}
+```
+And continue to use ActionMailer as usual.
+
+To add `category` and `custom_variables`, add them to the mail generation:
+```ruby
+mail(
+  to: 'your@email.com',
+  subject: 'You are awesome!',
+  category: 'Test category',
+  custom_variables: { test_variable: 'abc' }
+)
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/railsware/mailtrap-ruby). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,20 +1,12 @@
-# -*- ruby -*-
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'hoe'
-require './lib/mailtrap.rb'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-Hoe.new('mailtrap', Mailtrap::VERSION ) do |p|
-  p.rubyforge_name = 'rubymatt'
-  p.author = 'Matt Mower'
-  p.email = 'self@mattmower.com'
-  p.summary = 'Mailtrap is a mock SMTP server for use in Rails development'
-  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.remote_rdoc_dir = 'mailtrap'
-  p.extra_deps << ['daemons','>= 1.0.8'] 
-  p.extra_deps << ['trollop','>= 1.7']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-# vim: syntax=Ruby
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/mailtrap/action_mailer/delivery_method.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module ActionMailer
+    class DeliveryMethod
+      attr_accessor :settings
+
+      def initialize(settings)
+        self.settings = settings
+      end
+
+      def deliver!(message)
+        mail = Mailtrap::Sending::Convert.from_message(message)
+
+        client.send(mail)
+      end
+
+      private
+
+      def client
+        @client ||= Mailtrap::Sending::Client.new(**settings.slice(:api_key, :api_host, :api_port))
+      end
+    end
+  end
+end

data/lib/mailtrap/action_mailer/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module ActionMailer
+    class Railtie < Rails::Railtie
+      initializer 'mailtrap_action_mailer.add_delivery_method', before: 'action_mailer.set_configs' do
+        ActiveSupport.on_load(:action_mailer) do
+          ::ActionMailer::Base.add_delivery_method(:mailtrap, Mailtrap::ActionMailer::DeliveryMethod)
+        end
+      end
+    end
+  end
+end

data/lib/mailtrap/action_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'action_mailer/delivery_method'
+require_relative 'action_mailer/railtie' if defined? Rails
+
+module Mailtrap
+  module ActionMailer; end
+end

data/lib/mailtrap/sending/attachment.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+
+module Mailtrap
+  module Sending
+    class Attachment
+      attr_accessor :type, :filename, :disposition, :content_id
+      attr_reader :content
+
+      def initialize(content:, filename:, type: nil, disposition: nil, content_id: nil)
+        self.content = content
+        @type = type
+        @filename = filename
+        @disposition = disposition
+        @content_id = content_id
+      end
+
+      def as_json
+        {
+          'content' => content,
+          'type' => type,
+          'filename' => filename,
+          'disposition' => disposition,
+          'content_id' => content_id
+        }.compact
+      end
+
+      def content=(content)
+        if content.respond_to?(:read)
+          @content = encode(content)
+        else
+          raise AttachmentContentError unless base64?(content)
+
+          @content = content
+        end
+      end
+
+      private
+
+      def encode(io)
+        string = io.read.encode('UTF-8') unless io.respond_to?(:binmode?) && io.binmode?
+        Base64.encode64(string).gsub(/\n/, '')
+      end
+
+      def base64?(string)
+        string.is_a?(String) && Base64.strict_encode64(Base64.decode64(string)) == string
+      end
+    end
+  end
+end

data/lib/mailtrap/sending/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Mailtrap
+  module Sending
+    class Client
+      API_HOST = 'send.api.mailtrap.io'
+      API_PORT = 443
+
+      attr_reader :api_key, :api_host, :api_port
+
+      def initialize(api_key: ENV.fetch('MAILTRAP_API_KEY'), api_host: API_HOST, api_port: API_PORT)
+        @api_key = api_key
+        @api_host = api_host
+        @api_port = api_port
+      end
+
+      def send(mail)
+        raise ArgumentError, 'should be Mailtrap::Sending::Mail object' unless mail.is_a? Mailtrap::Sending::Mail
+
+        request = post_request('/api/send', mail.to_json)
+        response = http_client.request(request)
+
+        handle_response(response)
+      end
+
+      private
+
+      def http_client
+        @http_client ||= Net::HTTP.new(API_HOST, API_PORT).tap { |client| client.use_ssl = true }
+      end
+
+      def post_request(path, body)
+        request = Net::HTTP::Post.new(path)
+        request.body = body
+        request['Authorization'] = "Bearer #{api_key}"
+        request['Content-Type'] = 'application/json'
+
+        request
+      end
+
+      def handle_response(response)
+        case response.code
+        when '200'
+          json_response(response.body)
+        when '400'
+          raise Mailtrap::Sending::Error, json_response(response.body)[:errors]
+        when '401'
+          raise Mailtrap::Sending::AuthorizationError, json_response(response.body)[:errors]
+        else
+          raise Mailtrap::Sending::Error, ['server error']
+        end
+      end
+
+      def json_response(body)
+        JSON.parse(body, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/mailtrap/sending/convert.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Mailtrap
+  module Sending
+    module Convert
+      class << self
+        def from_message(message) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          Mailtrap::Sending::Mail.new(
+            from: prepare_address(message['from']&.address_list&.addresses&.first),
+            to: prepare_addresses(message['to']&.address_list&.addresses),
+            cc: prepare_addresses(message['cc']&.address_list&.addresses),
+            bcc: prepare_addresses(message['bcc']&.address_list&.addresses),
+            subject: message.subject,
+            text: prepare_text_part(message),
+            html: prepare_html_part(message),
+            headers: prepare_headers(message),
+            attachments: prepare_attachments(message.attachments),
+            category: message['category']&.unparsed_value,
+            custom_variables: message['custom_variables']&.unparsed_value
+          )
+        end
+
+        private
+
+        PROCESSED_HEADERS = %w[
+          from
+          to
+          cc
+          bcc
+          subject
+          category
+          customvariables
+          contenttype
+        ].freeze
+
+        def prepare_addresses(addresses)
+          Array(addresses).map { |address| prepare_address(address) }
+        end
+
+        def prepare_headers(message)
+          message
+            .header_fields
+            .reject { |header| PROCESSED_HEADERS.include?(header.name.downcase.delete('-')) }
+            .to_h { |header| [header.name, header.value] }
+            .compact
+        end
+
+        def prepare_address(address)
+          {
+            email: address.address,
+            name: address.display_name
+          }.compact
+        end
+
+        def prepare_attachments(attachments_list = [])
+          attachments_list.map do |attachment|
+            {
+              content: Base64.strict_encode64(attachment.body.decoded),
+              type: attachment.mime_type,
+              filename: attachment.filename,
+              disposition: attachment.header[:content_disposition]&.disposition_type,
+              content_id: attachment.header[:content_id]&.field&.content_id
+            }.compact
+          end
+        end
+
+        def prepare_html_part(message)
+          return message.body.decoded if message.mime_type == 'text/html'
+
+          message.html_part&.decoded
+        end
+
+        def prepare_text_part(message)
+          return message.body.decoded if message.mime_type == 'text/plain' || message.mime_type.nil?
+
+          message.text_part&.decoded
+        end
+      end
+    end
+  end
+end

data/lib/mailtrap/sending/mail.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Mailtrap
+  module Sending
+    class Mail
+      attr_accessor :from, :to, :cc, :bcc, :subject, :text, :html, :headers, :category, :custom_variables
+      attr_reader :attachments
+
+      def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+        from: nil,
+        to: [],
+        cc: [],
+        bcc: [],
+        subject: nil,
+        text: nil,
+        html: nil,
+        attachments: [],
+        headers: {},
+        category: nil,
+        custom_variables: {}
+      )
+        @from = from
+        @to = to
+        @cc = cc
+        @bcc = bcc
+        @subject = subject
+        @text = text
+        @html = html
+        self.attachments = attachments
+        @headers = headers
+        @category = category
+        @custom_variables = custom_variables
+      end
+
+      def as_json # rubocop:disable Metrics/MethodLength
+        {
+          'to' => to,
+          'from' => from,
+          'cc' => cc,
+          'bcc' => bcc,
+          'subject' => subject,
+          'html' => html,
+          'text' => text,
+          'attachments' => attachments.map(&:as_json),
+          # TODO: update headers and custom_variables with as_json method
+          'headers' => headers,
+          'category' => category,
+          'custom_variables' => custom_variables
+        }.compact
+      end
+
+      def to_json(*args)
+        JSON.generate(
+          as_json,
+          *args
+        )
+      end
+
+      def attachments=(attachments)
+        @attachments = attachments.map { |attachment| Mailtrap::Sending::Attachment.new(**attachment) }
+      end
+
+      def add_attachment(content:, filename:, type: nil, disposition: nil, content_id: nil)
+        attachment = Mailtrap::Sending::Attachment.new(
+          content: content,
+          filename: filename,
+          type: type,
+          disposition: disposition,
+          content_id: content_id
+        )
+        attachments << attachment
+
+        attachment
+      end
+    end
+  end
+end

data/lib/mailtrap/sending.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'sending/attachment'
+require_relative 'sending/client'
+require_relative 'sending/convert'
+require_relative 'sending/mail'
+
+module Mailtrap
+  module Sending
+    class AttachmentContentError < StandardError; end
+
+    class Error < StandardError
+      attr_reader :messages
+
+      def initialize(messages)
+        @messages = messages
+
+        super(messages.join(', '))
+      end
+    end
+
+    class AuthorizationError < Error; end
+  end
+end

data/lib/mailtrap/version.rb

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

data/lib/mailtrap.rb

@@ -1,130 +1,7 @@
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'daemons'
-require 'socket'
-require 'trollop'
+require_relative 'mailtrap/action_mailer' if defined? ActionMailer
+require_relative 'mailtrap/sending'
+require_relative 'mailtrap/version'
 
-#
-# Mailtrap creates a TCP server that listens on a specified port for SMTP
-# clients. Accepts the connection and talks just enough of the SMTP protocol
-# for them to deliver a message which it writes to disk.
-#
-class Mailtrap
-  VERSION = '0.2.1'
-  
-  # Create a new Mailtrap on the specified host:port. If once it true it
-  # will listen for one message then exit. Specify the msgdir where messages
-  # are written.
-  def initialize( host, port, once, msgfile )
-    @host = host
-    @port = port
-    @once = once
-    @msgfile = msgfile
-    
-    File.open( @msgfile, "a" ) do |file|
-      file.puts "\n* Mailtrap started at #{@host}:#{port}\n"
-    end
-    
-    service = TCPServer.new( @host, @port )
-    accept( service )
-  end
-  
-  # Service one or more SMTP client connections
-  def accept( service )
-    while session = service.accept
-      
-      class << session
-        def get_line
-          line = gets
-          line.chomp! unless line.nil?
-          line          
-        end
-      end
-      
-      begin
-        serve( session )
-      rescue Exception => e
-        puts "Erk! #{e.message}"        
-      end
-      
-      break if @once
-    end    
-  end
-  
-  # Write a plain text dump of the incoming email to a text
-  # file. The file will be in the @msgdir folder and will
-  # be called smtp0001.msg, smtp0002.msg, and so on.
-  def write( from, to_list, message )
-    
-    # Strip SMTP commands from To: and From:
-    from.gsub!( /MAIL FROM:\s*/, "" )
-    to_list = to_list.map { |to| to.gsub( /RCPT TO:\s*/, "" ) }
-    
-    # Append to the end of the messages file
-    File.open( @msgfile, "a" ) do |file|
-      file.puts "* Message begins"
-      file.puts "From: #{from}"
-      file.puts "To: #{to_list.join(", ")}"
-      file.puts "Body:"
-      file.puts message
-      file.puts "\n* Message ends"
-    end
-
-  end
-  
-  # Talk pidgeon-SMTP to the client to get them to hand over the message
-  # and go away.
-  def serve( connection )
-    connection.puts( "220 #{@host} MailTrap ready ESTMP" )
-    helo = connection.get_line # whoever they are
-    puts "Helo: #{helo}"
-    
-    if helo =~ /^EHLO\s+/
-      puts "Seen an EHLO"
-      connection.puts "250-#{@host} offers just ONE extension my pretty"
-      connection.puts "250 HELP"
-    end
-    
-    # Accept MAIL FROM:
-    from = connection.get_line
-    connection.puts( "250 OK" )
-    puts "From: #{from}"
-    
-    to_list = []
-    
-    # Accept RCPT TO: until we see DATA
-    loop do
-      to = connection.get_line
-      break if to.nil?
-
-      if to =~ /^DATA/
-        connection.puts( "354 Start your message" )
-        break
-      else
-        puts "To: #{to}"
-        to_list << to
-        connection.puts( "250 OK" )
-      end
-    end
-    
-    # Capture the message body terminated by <CR>.<CR>
-    lines = []
-    loop do
-      line = connection.get_line
-      break if line.nil? || line == "."
-      lines << line
-      puts "+ #{line}"
-    end
-
-    # We expect the client will go away now
-    connection.puts( "250 OK" )
-    connection.gets # Quit
-    connection.puts "221 Seeya"
-    connection.close
-    puts "And we're done with that bozo!"
-
-    write( from, to_list, lines.join( "\n" ) )
-    
-  end
-  
-end
+module Mailtrap; 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, Inc.']
+  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,102 +1,68 @@
---- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
+--- !ruby/object:Gem::Specification
 name: mailtrap
-version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-10-12 00:00:00 +01:00
-summary: Mailtrap is a mock SMTP server for use in Rails development
-require_paths: 
-- lib
-email: self@mattmower.com
-homepage: "    by Matt Mower <self@mattmower.com>"
-rubyforge_project: rubymatt
-description: "Mailtrap is a mock SMTP server for use in Rails development.  Mailtrap waits on your choosen port for a client to connect and talks _just enough_ SMTP protocol for ActionMailer to successfully deliver its message.  Mailtrap makes *no* attempt to actually deliver messages and, instead, writes them into a file (hence the name \tMail_trap_). Handy tip: use tail -f to see emails being received.  You can configure the hostname (default: localhost) and port (default: 2525) for the server and also where the messages get written (default: /var/tmp/mailtrap.log).  == FEATURES/PROBLEMS:"
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Railsware Products Studio, Inc.
 autorequire: 
-default_executable: 
 bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ0wCwYDVQQDDARzZWxm
-  MRkwFwYKCZImiZPyLGQBGRYJbWF0dG1vd2VyMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTA3MTAwMzIzMjkwN1oXDTA4MTAwMjIzMjkwN1owPzENMAsGA1UEAwwEc2Vs
-  ZjEZMBcGCgmSJomT8ixkARkWCW1hdHRtb3dlcjETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMVQejbmmtJD6FfTwc9+
-  QsWEqNFgNL8+tbrpxUuT8J2j0O0Pvkhw3wGT3tzMdXlnaz+OwUz8qU6HGwDAiK/3
-  zWAGuBRApkIAooTryRWLYmkZfnZidG8A2msmRwQd84Rkzn6Vgad+46o6jQfJSgy1
-  pDsZVfsRcUZ0dWetp+ll7Lq/4HyecdNgRfmrQh6pmKwIUmh5cj91iBX3NEqx5TN6
-  AKkYIOBMuOnBMNrXvApH10ruvus1d/PiJIjAavvbgSih+vyB8NTXTF4kOhKXnF0w
-  Zx3CF5asJejopRGNUcY9Vmjr7WiRHhUnFjc8hs385MlQNKEdAirVwIIgWfkQwJO+
-  GQ0CAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFL99
-  Fuw4VZwExQog/QSr8zIFfj1WMA0GCSqGSIb3DQEBBQUAA4IBAQATHmiqgSFKeJQM
-  QZjefTiRH6q1TgnJEt0/ylb9gNUCBpIFC1QOtuf68NAt90n6q1CZ51W3EreOPmi2
-  k2UxzfnPH6av2HQxmC1Xwv+X/eKF65shy/D75XWeCKLwynlXbA0cSjkV8/jSDB9I
-  pPXX1PjTNmzS2oNGSBroG567Uod41eAjlFA2FQTSWu/lDaYvLBjupGzz59/lZfkl
-  oCvK+OORDtfJ/a8CdYuD7PltGIEGV9srqdsEsmcrXGHaZt+jGRLYi60h5ZEd7lOm
-  1WEvMXOXF3ofp87Yw1MSpG7yQyr0i5DW6VM3v6AP0ABxoM4p80JDHhwAmKWRWWQk
-  yMQ/kUco
-  -----END CERTIFICATE-----
-
-post_install_message: 
-authors: 
-- Matt Mower
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
+cert_chain: []
+date: 2022-08-01 00:00:00.000000000 Z
+dependencies: []
+description: Official mailtrap.io API client
+email:
+- support@mailtrap.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - Rakefile
-- bin/mailtrap
 - lib/mailtrap.rb
-test_files: 
-- test/test_mailtrap.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-executables: 
-- mailtrap
-extensions: []
-
+- lib/mailtrap/action_mailer.rb
+- lib/mailtrap/action_mailer/delivery_method.rb
+- lib/mailtrap/action_mailer/railtie.rb
+- lib/mailtrap/sending.rb
+- lib/mailtrap/sending/attachment.rb
+- lib/mailtrap/sending/client.rb
+- lib/mailtrap/sending/convert.rb
+- lib/mailtrap/sending/mail.rb
+- lib/mailtrap/version.rb
+- mailtrap.gemspec
+homepage: https://github.com/railsware/mailtrap-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/railsware/mailtrap-ruby
+  source_code_uri: https://github.com/railsware/mailtrap-ruby
+  changelog_uri: https://github.com/railsware/mailtrap-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: daemons
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.8
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: trollop
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.7"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: 
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Official mailtrap.io API client
+test_files: []

data/History.txt

@@ -1,5 +0,0 @@
-== 1.0.0 / 2007-10-03
-
-* 1 major enhancement
-  * Birthday!
-

data/Manifest.txt

@@ -1,6 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-bin/mailtrap
-lib/mailtrap.rb

data/README.txt

@@ -1,75 +0,0 @@
-mailtrap
-    by Matt Mower <self@mattmower.com>
-    http://matt.blogs.it/
-
-== DESCRIPTION:
-
-Mailtrap is a mock SMTP server for use in Rails development.
-
-Mailtrap waits on your choosen port for a client to connect and talks _just enough_ SMTP protocol for ActionMailer to successfully deliver its message.
-
-Mailtrap makes *no* attempt to actually deliver messages and, instead, writes them into a file (hence the name 	Mail_trap_). Handy tip: use tail -f to see emails being received.
-
-You can configure the hostname (default: localhost) and port (default: 2525) for the server and also where the messages get written (default: /var/tmp/mailtrap.log).
-	
-== FEATURES/PROBLEMS:
-
-* Lightweight, no setup
-* Runs as a daemon with start, stop, etc..
-* Tested with ActionMailer's SMTP delivery method
-* Very, very, dumb ... might not work with an arbitrary SMTP client
-
-== SYNOPSIS:
-
-To use the defaults host:localhost, port:2525, file:/var/log/mailtrap.log
-
-* mailtrap start
-
-Customise startup:
-
-* sudo mailtrap start --host my.host --port 25 --once --file=/var/log/messages.txt
-
-(sudo because you want to use restricted port 25)
-
-For more info:
-
-* mailtrap --help (to see Daemonization options)
-* mailtrap start --help (to see Mailtrap options)
-
-== REQUIREMENTS:
-
-* Hoe rubygem
-* Rubygems rubygem
-* Daemons rubygem
-* Trollop rubygem
-
-All these are automatically installed if you use gem install -y
-
-== INSTALL:
-
-* sudo gem install -y mailtrap
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2007 Matt Mower, Software Heretics
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/mailtrap

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Run the mailtrap server
-#
-
-require 'rubygems'
-require 'daemons'
-require 'mailtrap'
-
-opts = Trollop::options do
-  opt :host, "The host SMTP clients will connect to", :default => 'localhost'
-  opt :port, "The port SMTP clients will connect to", :default => 2525
-  opt :once, "Whether to terminate after serving the first client", :default => false
-  opt :file, "File where messages get written", :default => "/var/tmp/mailtrap.log"
-end
-
-options = {
-  :dir_mode => :normal,
-  :dir => '/var/tmp',
-  :multiple => true,
-  :mode => :exec,
-  :backtrace => true,
-  :log_output => true
-}
-
-Daemons.run_proc( 'mailtrap', options ) do
-  Mailtrap.new( opts[:host], opts[:port], opts[:once], opts[:file] )
-end