Deprecate Mailtrap::Mail::FromTemplate

Author: i7an

lib/mailtrap/client.rb

@@ -54,14 +54,11 @@ def initialize( # rubocop:disable Metrics/ParameterLists
     end
 
     # Sends an email
-    # @param mail [Mail::Base] The email to send
-    # @return [Hash, nil] The JSON response
+    # @param mail [#to_json] The email to send
+    # @return [Hash] The JSON response
     # @!macro api_errors
     # @raise [Mailtrap::MailSizeError] If the message is too large
-    # @raise [ArgumentError] If the mail is not a Mail::Base object
     def send(mail)
-      raise ArgumentError, 'should be Mailtrap::Mail::Base object' unless mail.is_a? Mail::Base
-
       perform_request(:post, api_host, send_path, mail)
     end
 

lib/mailtrap/mail/base.rb

@@ -5,7 +5,8 @@
 module Mailtrap
   module Mail
     class Base
-      attr_accessor :from, :to, :reply_to, :cc, :bcc, :headers, :custom_variables, :subject, :text, :html, :category
+      attr_accessor :from, :to, :reply_to, :cc, :bcc, :headers, :custom_variables, :subject, :text, :html, :category,
+                    :template_uuid, :template_variables
       attr_reader :attachments
 
       def initialize( # rubocop:disable Metrics/ParameterLists
@@ -20,7 +21,9 @@ def initialize( # rubocop:disable Metrics/ParameterLists
         attachments: [],
         headers: {},
         custom_variables: {},
-        category: nil
+        category: nil,
+        template_uuid: nil,
+        template_variables: nil
       )
         @from = from
         @to = to
@@ -34,6 +37,8 @@ def initialize( # rubocop:disable Metrics/ParameterLists
         @headers = headers
         @custom_variables = custom_variables
         @category = category
+        @template_uuid = template_uuid
+        @template_variables = template_variables
       end
 
       def as_json
@@ -50,7 +55,9 @@ def as_json
           # TODO: update headers and custom_variables with as_json method
           'headers' => headers,
           'custom_variables' => custom_variables,
-          'category' => category
+          'category' => category,
+          'template_uuid' => template_uuid,
+          'template_variables' => template_variables
         }.compact
       end
 

lib/mailtrap/mail/from_template.rb

@@ -2,9 +2,8 @@
 
 module Mailtrap
   module Mail
+    # @deprecated Use Mailtrap::Mail::Base
     class FromTemplate < Base
-      attr_accessor :template_uuid, :template_variables
-
       def initialize( # rubocop:disable Metrics/ParameterLists
         from: nil,
         to: [],
@@ -17,27 +16,7 @@ def initialize( # rubocop:disable Metrics/ParameterLists
         template_uuid: nil,
         template_variables: {}
       )
-        super(
-          from:,
-          to:,
-          reply_to:,
-          cc:,
-          bcc:,
-          attachments:,
-          headers:,
-          custom_variables:
-        )
-        @template_uuid = template_uuid
-        @template_variables = template_variables
-      end
-
-      def as_json
-        super.merge(
-          {
-            'template_uuid' => template_uuid,
-            'template_variables' => template_variables
-          }
-        ).compact
+        super
       end
     end
   end

spec/fixtures/vcr_cassettes/Mailtrap_Client/_send/when_mail_is_hash/sends_an_email.yml

@@ -57,12 +57,6 @@
         end
       end
 
-      context 'when mail object is not a Mailtrap::Mail::Base' do
-        let(:mail) { 'it-a-string' }
-
-        it { expect { send }.to raise_error(ArgumentError, 'should be Mailtrap::Mail::Base object') }
-      end
-
       context 'with an alternative host' do
         let(:client) do
           described_class.new(api_key:, api_host: 'alternative.host.mailtrap.io', api_port: 8080)
@@ -120,6 +114,27 @@
       end
     end
 
+    context 'when mail is hash' do
+      let(:mail) do
+        {
+          from: { email: '[email protected]', name: 'Mailtrap Test' },
+          to: [
+            { email: '[email protected]' }
+          ],
+          subject: 'You are awesome!',
+          text: 'Congrats for sending test email with Mailtrap!',
+          category: 'Integration Test',
+          attachments: [
+            { content: Base64.strict_encode64("hello world"), filename: 'attachment.txt' }
+          ]
+        }
+      end
+
+      it 'sends an email' do
+        expect(send).to eq({ message_ids: ['4c2446b6-e0f9-11ec-9487-0a58a9feac02'], success: true })
+      end
+    end
+
     context 'when template' do
       let(:mail) do
         Mailtrap::Mail::FromTemplate.new(