howitzer 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe051b3bfe068d7fe68f999882f1aac432ee24dd558438e3e0b6f195c7123885
-  data.tar.gz: '09dca8df71b0ed83c4f0cf6f49679330628d92934f4e2e36bd861ddeb3ff2427'
+  metadata.gz: 1044884bf6fe39dc63128f59f930a0d75ae80297a946d34d2464f47a30fe17fe
+  data.tar.gz: b5501960e801914414fc6569996a9cc219e601ea78dfea1dac28c7db9d582ac7
 SHA512:
-  metadata.gz: 5265ec269dba8e334e2c1223ac788c2a65b331f2374d9007ae78a3c0b5fc1aa79a9ce65ccfff713efeec3a7e6531cf42fc413eeb722c908f916b7fd5efc8f34d
-  data.tar.gz: 72948920c6c1cd9b437e766dc89bc205b12837c86e98a225ff05d853d17f16a4b833cbcc9febeeafd4b5ed3f60be915c0a67e779dd5d9967175c6b9e62cfc9f5
+  metadata.gz: 450f74b4dec7185673b2faa9138c8afb4b9568be8680f38718728105ad5893a5e1abfb1d908e759a021fcd3af13093e67775537b3a109219b065b00c30a7f293
+  data.tar.gz: 0bc01379c520937ec1bd004fffcc44b9c558ff9c1c5eea1a292067d65f5d1661f9f5aaf806c5b0183d34e46c2591fc3bd9b71a0cc8288fc7e12b56d9946478d0

data/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 ### Bug-fixes
 
+## [2.5.0](https://github.com/strongqa/howitzer/compare/v2.4.0...v2.5.0) (2022-08-16)
+
+
+### Features
+
+* 1secMail integration ([#316](https://github.com/strongqa/howitzer/issues/316)) ([6850758](https://github.com/strongqa/howitzer/commit/6850758370bd293d241f95c2a3cc0163c6fb3062))
+* testmail.app integration ([#314](https://github.com/strongqa/howitzer/issues/314)) ([7f62bae](https://github.com/strongqa/howitzer/commit/7f62bae2e7e91200e02ed98acded9070726f3fc1))
+
+
+### Bug Fixes
+
+* mailtrap integration update ([#313](https://github.com/strongqa/howitzer/issues/313)) ([49e7390](https://github.com/strongqa/howitzer/commit/49e73909f7033d2986b0f5713bbbcbea7231ade0))
+
 ## [2.4.0](https://github.com/strongqa/howitzer/compare/v2.3.0...v2.4.0) (2022-07-22)
 
 

data/generators/config/templates/default.yml

@@ -120,3 +120,10 @@
 # -Gmail-
  gmail_login: gmail_address
  gmail_password: gmail_password
+
+# -testmail.app-
+ testmail_api_key: testmail_api_key
+ testmail_namespace: testmail_namespace
+
+# 1secMail
+ onesecmail_domain: 1secmail.com

data/lib/howitzer/mail_adapters/mailtrap.rb

@@ -24,19 +24,19 @@ module Howitzer
       # @return [String] plain text body of the email message
 
       def plain_text_body
-        message['text_body']
+        Howitzer::MailtrapApi::Client.new.get_txt_body(message)
       end
 
       # @return [String] html body of the email message
 
       def html_body
-        message['html_body']
+        Howitzer::MailtrapApi::Client.new.get_html_body(message)
       end
 
       # @return [String] stripped text
 
       def text
-        message['text_body']
+        Howitzer::MailtrapApi::Client.new.get_raw_body(message)
       end
 
       # @return [String] an email address specified in `From` field

data/lib/howitzer/mail_adapters/onesecmail.rb

@@ -0,0 +1,80 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/onesecmail_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents 1secMail mail adapter
+    class Onesecmail < Abstract
+      # Finds an email in storage
+      # @param recipient [String] an email
+      # @param subject [String]
+      # @param wait [Integer] how much time is required to wait an email
+      # @raise [EmailNotFoundError] if blank message
+
+      def self.find(recipient, subject, wait:)
+        message = {}
+        retryable(find_retry_params(wait)) { message = retrieve_message(recipient, subject) }
+        return new(message) if message.present?
+
+        raise Howitzer::EmailNotFoundError,
+              "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
+      end
+
+      # @return [String] plain text body of the email message
+
+      def plain_text_body
+        message['body']
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message['htmlBody']
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message['textBody']
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        message['from']
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message['date']).to_s
+      end
+
+      # @return [String] a real sender email address
+
+      def sender_email
+        message['from']
+      end
+
+      def self.find_retry_params(wait)
+        {
+          timeout: wait,
+          sleep: Howitzer.mail_sleep_time,
+          silent: true,
+          logger: Howitzer::Log,
+          on: Howitzer::EmailNotFoundError
+        }
+      end
+      private_class_method :find_retry_params
+
+      def self.retrieve_message(recipient, subject)
+        message = Howitzer::OnesecmailApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+
+        message
+      end
+      private_class_method :retrieve_message
+    end
+  end
+end

data/lib/howitzer/mail_adapters/testmail.rb

@@ -0,0 +1,102 @@
+require 'howitzer/exceptions'
+require 'howitzer/mail_adapters/abstract'
+require 'howitzer/testmail_api/client'
+
+module Howitzer
+  module MailAdapters
+    # This class represents testmail.app mail adapter
+    class Testmail < Abstract
+      # Finds an email in storage
+      # @param recipient [String] an email
+      # @param subject [String]
+      # @param wait [Integer] how much time is required to wait an email
+      # @raise [EmailNotFoundError] if blank message
+
+      def self.find(recipient, subject, wait:)
+        message = {}
+        retryable(find_retry_params(wait)) { message = retrieve_message(recipient, subject) }
+        return new(message) if message.present?
+
+        raise Howitzer::EmailNotFoundError,
+              "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
+      end
+
+      # @return [String] plain text body of the email message
+
+      def plain_text_body
+        message['text']
+      end
+
+      # @return [String] html body of the email message
+
+      def html_body
+        message['html']
+      end
+
+      # @return [String] stripped text
+
+      def text
+        message['text']
+      end
+
+      # @return [String] an email address specified in `From` field
+
+      def mail_from
+        message['from']
+      end
+
+      # @return [String] recipient emails separated with `, `
+
+      def recipients
+        message['to'].split ', '
+      end
+
+      # @return [String] when email was received
+
+      def received_time
+        Time.parse(message['timestamp']).to_s
+      end
+
+      # @return [String] a real sender email address
+
+      def sender_email
+        message['from']
+      end
+
+      # @return [Array] attachments
+
+      def mime_part
+        message['attachments']
+      end
+
+      # @raise [NoAttachmentsError] if no attachments present
+      # @return [Array] attachments
+
+      def mime_part!
+        files = mime_part
+        return files if files.present?
+
+        raise Howitzer::NoAttachmentsError, 'No attachments were found.'
+      end
+
+      def self.find_retry_params(wait)
+        {
+          timeout: wait,
+          sleep: Howitzer.mail_sleep_time,
+          silent: true,
+          logger: Howitzer::Log,
+          on: Howitzer::EmailNotFoundError
+        }
+      end
+      private_class_method :find_retry_params
+
+      def self.retrieve_message(recipient, subject)
+        message = Howitzer::TestmailApi::Client.new.find_message(recipient, subject)
+        raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+
+        message
+      end
+      private_class_method :retrieve_message
+    end
+  end
+end

data/lib/howitzer/mailtrap_api/client.rb

@@ -32,6 +32,24 @@ module Howitzer
         JSON.parse(RestClient.get("#{BASE_URL}/messages/#{message['id']}/attachments", 'Api-Token' => @api_token))
       end
 
+      def get_html_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.html", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
+      def get_txt_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.txt", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
+      def get_raw_body(message)
+        RestClient.get("#{BASE_URL}/messages/#{message['id']}/body.raw", 'Api-Token' => @api_token).body
+      rescue => e
+        raise Howitzer::CommunicationError, e.message
+      end
+
       private
 
       def messages(recipient)

data/lib/howitzer/onesecmail_api/client.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'rest-client'
+
+module Howitzer
+  module OnesecmailApi
+    # A Onesecmail::Client object is used to communicate with the 1secMail API.
+    class Client
+      BASE_URL = 'https://www.1secmail.com/api/v1/'.freeze # :nodoc:
+
+      # Finds message according to given parameters
+      #
+      # @param recipient [String] this is recipient mail address for message filtering
+      # @param subject [String] this is subject of the message to filter particular message
+      # @return [Hash] json message parsed to ruby hash
+
+      def find_message(recipient, subject)
+        messages = filter_by_subject(recipient[/[^@]+/], subject)
+        latest_message(messages)
+      end
+
+      private
+
+      def messages(recipient_name)
+        JSON.parse(RestClient.get("#{BASE_URL}?action=getMessages&login=#{recipient_name}" \
+                                  "&domain=#{Howitzer.onesecmail_domain}"))
+      end
+
+      def latest_message(messages)
+        messages[0]
+      end
+
+      def filter_by_subject(recipient_name, subject)
+        result_messages = []
+        messages(recipient_name).each do |msg|
+          if msg['subject'] == subject
+            result_messages << JSON.parse(RestClient.get("#{BASE_URL}?action=readMessage&login=#{recipient_name}" \
+                                                         "&domain=#{Howitzer.onesecmail_domain}&id=#{msg['id']}"))
+          end
+        end
+        result_messages
+      end
+    end
+  end
+end

data/lib/howitzer/onesecmail_api.rb

@@ -0,0 +1,7 @@
+module Howitzer
+  # This module holds simple implementation of 1secMail api client
+  module OnesecmailApi
+  end
+end
+
+require 'howitzer/onesecmail_api/client'

data/lib/howitzer/testmail_api/client.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'rest-client'
+
+module Howitzer
+  module TestmailApi
+    # A Testmail::Client object is used to communicate with the testmail.app API.
+    class Client
+      BASE_URL = "https://api.testmail.app/api/json?apikey=#{Howitzer.testmail_api_key}" \
+                 "&namespace=#{Howitzer.testmail_namespace}".freeze # :nodoc:
+
+      def initialize
+        @api_token = Howitzer.testmail_api_key
+      end
+
+      # Finds message according to given parameters
+      #
+      # @param recipient [String] this is recipient mail address for message filtering
+      # @param subject [String] this is subject of the message to filter particular message
+      # @return [Hash] json message parsed to ruby hash
+
+      def find_message(recipient, subject)
+        recipient = recipient.gsub(/.*\.([^@]+)@.*/, '\1')
+        messages = filter_by_subject(messages(recipient), subject)
+        latest_message(messages)
+      end
+
+      private
+
+      def messages(recipient)
+        JSON.parse(RestClient.get("#{BASE_URL}&tag=#{recipient}"))
+      end
+
+      def latest_message(messages)
+        messages[0]
+      end
+
+      def filter_by_subject(messages, subject)
+        result_messages = []
+        messages['emails'].each { |msg| result_messages << msg if msg['subject'] == subject }
+        result_messages
+      end
+    end
+  end
+end

data/lib/howitzer/testmail_api.rb

@@ -0,0 +1,7 @@
+module Howitzer
+  # This module holds simple implementation of testmail.app api client
+  module TestmailApi
+  end
+end
+
+require 'howitzer/testmail_api/client'

data/lib/howitzer/version.rb

@@ -1,4 +1,4 @@
 # This module holds howitzer version
 module Howitzer
-  VERSION = '2.4.0'.freeze # :nodoc:
+  VERSION = '2.5.0'.freeze # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: howitzer
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Roman Parashchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -302,6 +302,8 @@ files:
 - lib/howitzer/mail_adapters/gmail.rb
 - lib/howitzer/mail_adapters/mailgun.rb
 - lib/howitzer/mail_adapters/mailtrap.rb
+- lib/howitzer/mail_adapters/onesecmail.rb
+- lib/howitzer/mail_adapters/testmail.rb
 - lib/howitzer/mailgun_api.rb
 - lib/howitzer/mailgun_api/client.rb
 - lib/howitzer/mailgun_api/connector.rb
@@ -314,7 +316,11 @@ files:
 - lib/howitzer/meta/entry.rb
 - lib/howitzer/meta/iframe.rb
 - lib/howitzer/meta/section.rb
+- lib/howitzer/onesecmail_api.rb
+- lib/howitzer/onesecmail_api/client.rb
 - lib/howitzer/tasks/framework.rake
+- lib/howitzer/testmail_api.rb
+- lib/howitzer/testmail_api/client.rb
 - lib/howitzer/utils.rb
 - lib/howitzer/utils/string_extensions.rb
 - lib/howitzer/version.rb
@@ -336,7 +342,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/strongqa/howitzer/issues
   changelog_uri: https://github.com/strongqa/howitzer/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/howitzer/2.4.0
+  documentation_uri: https://www.rubydoc.info/gems/howitzer/2.5.0
   source_code_uri: https://github.com/strongqa/howitzer
   rubygems_mfa_required: 'false'
 post_install_message: