mailosaur 7.3.1 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e326500621113c758df3e3d9fbc06778a9799a73e9d825de967c85c4f905d5d
-  data.tar.gz: f3110a0807155e33a531c655eeaeb1f05397ab501ae8a273ec6cbeff40c4adc7
+  metadata.gz: c7fada04554f5062be36d26e90696358362e477f02a4342e3e41c4296a37cd05
+  data.tar.gz: b9d768ae07fd46bc9e0456b88963c473434f92772d3aed6d4d805f01d1b956fe
 SHA512:
-  metadata.gz: ff7ee803eb0cc60fa0bcf7ad2f94f0103f2ebd94a056512fdb093e84f28db9cf6a00d2d6f8640fd4d439e1c120b314a05af7f37b7efda3c9ccf8b3281652caab
-  data.tar.gz: e807b3f423236e619b15e8cf3a4d95399531648b18f99595d31e381bc20862a7aa13286ccb686a82df99a49ff3e6934026a91d95315e1d80fba62829e7ccb5a6
+  metadata.gz: f9e635870cc5e3102dcdeb1e247841ea2341cd8593cfe1f3fa0f084741dd73599c7c856f2f8756601389c83ba53eadbfe0efee60c43c90ae60fe6be97c521631
+  data.tar.gz: d71f6b94a70a7532e4727a6047a2d8f93b630b637d73f0a47664b3544edbbb9f736e9b37d8122ae41c156e510b87099c4da61cca3e8e9eb55e849a124a94bfb2

data/lib/Mailosaur/analysis.rb

@@ -22,7 +22,7 @@ module Mailosaur
     # @return [SpamAnalysisResult] operation results.
     #
     def spam(email)
-      response = conn.get 'api/analysis/spam/' + email
+      response = conn.get "api/analysis/spam/#{email}"
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::SpamAnalysisResult.new(model)

data/lib/Mailosaur/files.rb

@@ -23,7 +23,7 @@ module Mailosaur
     # @return [NOT_IMPLEMENTED] operation results.
     #
     def get_attachment(id)
-      response = conn.get 'api/files/attachments/' + id
+      response = conn.get "api/files/attachments/#{id}"
       @handle_http_error.call(response) unless response.status == 200
       response.body
     end
@@ -39,7 +39,7 @@ module Mailosaur
     # @return [NOT_IMPLEMENTED] operation results.
     #
     def get_email(id)
-      response = conn.get 'api/files/email/' + id
+      response = conn.get "api/files/email/#{id}"
       @handle_http_error.call(response) unless response.status == 200
       response.body
     end

data/lib/Mailosaur/mailosaur_error.rb

@@ -1,8 +1,6 @@
 module Mailosaur
   class MailosaurError < StandardError
-    attr_reader :error_type
-    attr_reader :http_status_code
-    attr_reader :http_response_body
+    attr_reader :error_type, :http_status_code, :http_response_body
 
     def initialize(message = '', error_type = '', http_status_code = nil, http_response_body = nil)
       super(message)

data/lib/Mailosaur/messages.rb

@@ -49,7 +49,7 @@ module Mailosaur
     # @return [Message] operation results.
     #
     def get_by_id(id)
-      response = conn.get 'api/messages/' + id
+      response = conn.get "api/messages/#{id}"
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Message.new(model)
@@ -64,7 +64,7 @@ module Mailosaur
     # @param id The identifier of the message to be deleted.
     #
     def delete(id)
-      response = conn.delete 'api/messages/' + id
+      response = conn.delete "api/messages/#{id}"
       @handle_http_error.call(response) unless response.status == 204
       nil
     end
@@ -87,10 +87,10 @@ module Mailosaur
     # @return [MessageListResult] operation results.
     #
     def list(server, page: nil, items_per_page: nil, received_after: nil)
-      url = 'api/messages?server=' + server
-      url += page ? '&page=' + page.to_s : ''
-      url += items_per_page ? '&itemsPerPage=' + items_per_page.to_s : ''
-      url += received_after ? '&receivedAfter=' + CGI.escape(received_after.iso8601) : ''
+      url = "api/messages?server=#{server}"
+      url += page ? "&page=#{page}" : ''
+      url += items_per_page ? "&itemsPerPage=#{items_per_page}" : ''
+      url += received_after ? "&receivedAfter=#{CGI.escape(received_after.iso8601)}" : ''
 
       response = conn.get url
 
@@ -109,7 +109,7 @@ module Mailosaur
     # @param server [String] The identifier of the server to be emptied.
     #
     def delete_all(server)
-      response = conn.delete 'api/messages?server=' + server
+      response = conn.delete "api/messages?server=#{server}"
       @handle_http_error.call(response) unless response.status == 204
       nil
     end
@@ -138,10 +138,10 @@ module Mailosaur
     # @return [MessageListResult] operation results.
     #
     def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true) # rubocop:disable all
-      url = 'api/messages/search?server=' + server
-      url += page ? '&page=' + page.to_s : ''
-      url += items_per_page ? '&itemsPerPage=' + items_per_page.to_s : ''
-      url += received_after ? '&receivedAfter=' + CGI.escape(received_after.iso8601) : ''
+      url = "api/messages/search?server=#{server}"
+      url += page ? "&page=#{page}" : ''
+      url += items_per_page ? "&itemsPerPage=#{items_per_page}" : ''
+      url += received_after ? "&receivedAfter=#{CGI.escape(received_after.iso8601)}" : ''
 
       poll_count = 0
       start_time = Time.now.to_f
@@ -170,5 +170,61 @@ module Mailosaur
         sleep(delay / 1000)
       end
     end
+
+    #
+    # Create a message.
+    #
+    # Creates a new message that can be sent to a verified email address. This is
+    # useful in scenarios where you want an email to trigger a workflow in your
+    # product
+    #
+    # @param server [String] The identifier of the server to create the message in.
+    # @param options [MessageCreateOptions] The options with which to create the message.
+    #
+    # @return [Message] operation result.
+    #
+    def create(server, message_create_options)
+      response = conn.post "api/messages?server=#{server}", message_create_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
+
+    #
+    # Forward an email.
+    #
+    # Forwards the specified email to a verified email address.
+    #
+    # @param id [String] The identifier of the email to forward.
+    # @param options [MessageForwardOptions] The options with which to forward the email.
+    # against.
+    #
+    # @return [Message] operation result.
+    #
+    def forward(id, message_forward_options)
+      response = conn.post "api/messages/#{id}/forward", message_forward_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
+
+    #
+    # Reply to an email.
+    #
+    # Sends a reply to the specified email. This is useful for when simulating a user
+    # replying to one of your emails.
+    #
+    # @param id [String] The identifier of the email to reply to.
+    # @param options [MessageReplyOptions] The options with which to reply to the email.
+    # against.
+    #
+    # @return [Message] operation result.
+    #
+    def reply(id, message_reply_options)
+      response = conn.post "api/messages/#{id}/reply", message_reply_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::Message.new(model)
+    end
   end
 end

data/lib/Mailosaur/models/attachment.rb

@@ -5,6 +5,7 @@ module Mailosaur
         @id = data['id']
         @content_type = data['contentType']
         @file_name = data['fileName']
+        @content = data['content']
         @content_id = data['contentId']
         @length = data['length']
         @url = data['url']
@@ -19,6 +20,9 @@ module Mailosaur
       # @return [String]
       attr_accessor :file_name
 
+      # @return [String]
+      attr_accessor :content
+
       # @return [String]
       attr_accessor :content_id
 

data/lib/Mailosaur/models/message_create_options.rb

@@ -0,0 +1,35 @@
+module Mailosaur
+  module Models
+    class MessageCreateOptions < BaseModel
+      def initialize(data = {})
+        @to = data['to']
+        @send = data['send']
+        @subject = data['subject']
+        @text = data['text']
+        @html = data['html']
+        @attachments = data['attachments']
+      end
+
+      # @return [String] The email address to which the email will be sent.
+      # Must be a verified email address.
+      attr_accessor :to
+
+      # @return [Boolean] If true, email will be sent upon creation.
+      attr_accessor :send
+
+      # @return [String] The email subject line.
+      attr_accessor :subject
+
+      # @return [String] The plain text body of the email. Note that only
+      # text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] The HTML body of the email. Note that only text
+      # or html can be supplied, not both.
+      attr_accessor :html
+
+      # @return [Array<Attachment>] Any message attachments.
+      attr_accessor :attachments
+    end
+  end
+end

data/lib/Mailosaur/models/message_forward_options.rb

@@ -0,0 +1,23 @@
+module Mailosaur
+  module Models
+    class MessageForwardOptions < BaseModel
+      def initialize(data = {})
+        @to = data['to']
+        @text = data['text']
+        @html = data['html']
+      end
+
+      # @return [String] The email address to which the email will be sent.
+      # Must be a verified email address.
+      attr_accessor :to
+
+      # @return [String] Any additional plain text content to forward the
+      # email with. Note that only text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] Any additional HTML content to forward the email
+      # with. Note that only html or text can be supplied, not both.
+      attr_accessor :html
+    end
+  end
+end

data/lib/Mailosaur/models/message_reply_options.rb

@@ -0,0 +1,22 @@
+module Mailosaur
+  module Models
+    class MessageReplyOptions < BaseModel
+      def initialize(data = {})
+        @text = data['text']
+        @html = data['html']
+        @attachments = data['attachments']
+      end
+
+      # @return [String] Any additional plain text content to include in
+      # the reply. Note that only text or html can be supplied, not both.
+      attr_accessor :text
+
+      # @return [String] Any additional HTML content to include in the
+      # reply. Note that only html or text can be supplied, not both.
+      attr_accessor :html
+
+      # @return [Array<Attachment>] Any message attachments.
+      attr_accessor :attachments
+    end
+  end
+end

data/lib/Mailosaur/models/message_summary.rb

@@ -4,8 +4,6 @@ module Mailosaur
       def initialize(data = {})
         @id = data['id']
         @server = data['server']
-        @rcpt = []
-        (data['rcpt'] || []).each do |i| @rcpt << Mailosaur::Models::MessageAddress.new(i) end
         @from = []
         (data['from'] || []).each do |i| @from << Mailosaur::Models::MessageAddress.new(i) end
         @to = []
@@ -26,9 +24,6 @@ module Mailosaur
       # @return [String]
       attr_accessor :server
 
-      # @return [Array<MessageAddress>]
-      attr_accessor :rcpt
-
       # @return [Array<MessageAddress>]
       attr_accessor :from
 

data/lib/Mailosaur/models/metadata.rb

@@ -4,10 +4,33 @@ module Mailosaur
       def initialize(data = {})
         @headers = []
         (data['headers'] || []).each do |i| @headers << Mailosaur::Models::MessageHeader.new(i) end
+
+        @ehlo = data['ehlo']
+
+        @mail_from = data['mailFrom']
+
+        @rcpt_to = []
+        (data['rcptTo'] || []).each do |i| @rcpt_to << Mailosaur::Models::MessageAddress.new(i) end
       end
 
       # @return [Array<MessageHeader>] Email headers.
       attr_accessor :headers
+
+      # @return [String] The fully-qualified domain name or IP address that was provided with the
+      # Extended HELLO (EHLO) or HELLO (HELO) command. This value is generally
+      # used to identify the SMTP client.
+      # https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.1.1
+      attr_accessor :ehlo
+
+      # @return [String] The source mailbox/email address, referred to as the 'reverse-path',
+      # provided via the MAIL command during the SMTP transaction.
+      # https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.1.2
+      attr_accessor :mail_from
+
+      # @return [Array<MessageAddress>] The recipient email addresses, each referred to as a 'forward-path',
+      # provided via the RCPT command during the SMTP transaction.
+      # https://datatracker.ietf.org/doc/html/rfc5321#section-4.1.1.3
+      attr_accessor :rcpt_to
     end
   end
 end

data/lib/Mailosaur/servers.rb

@@ -54,7 +54,7 @@ module Mailosaur
     # @return [Server] operation results.
     #
     def get(id)
-      response = conn.get 'api/servers/' + id
+      response = conn.get "api/servers/#{id}"
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Server.new(model)
@@ -71,7 +71,7 @@ module Mailosaur
     # @return [String] Server password.
     #
     def get_password(id)
-      response = conn.get 'api/servers/' + id + '/password'
+      response = conn.get "api/servers/#{id}/password"
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       model['value']
@@ -88,7 +88,7 @@ module Mailosaur
     # @return [Server] operation results.
     #
     def update(id, server)
-      response = conn.put 'api/servers/' + id, server.to_json
+      response = conn.put "api/servers/#{id}", server.to_json
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Server.new(model)
@@ -103,7 +103,7 @@ module Mailosaur
     # @param id [String] The identifier of the server to be deleted.
     #
     def delete(id)
-      response = conn.delete 'api/servers/' + id
+      response = conn.delete "api/servers/#{id}"
       @handle_http_error.call(response) unless response.status == 204
       nil
     end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.3.1'.freeze
+    VERSION = '7.6.0'.freeze
 end

data/lib/mailosaur.rb

@@ -26,6 +26,9 @@ module Mailosaur
     autoload :MessageSummary,                                     'Mailosaur/models/message_summary.rb'
     autoload :Image,                                              'Mailosaur/models/image.rb'
     autoload :MessageListResult,                                  'Mailosaur/models/message_list_result.rb'
+    autoload :MessageCreateOptions,                               'Mailosaur/models/message_create_options.rb'
+    autoload :MessageForwardOptions,                              'Mailosaur/models/message_forward_options.rb'
+    autoload :MessageReplyOptions,                                'Mailosaur/models/message_reply_options.rb'
     autoload :Attachment,                                         'Mailosaur/models/attachment.rb'
     autoload :SearchCriteria,                                     'Mailosaur/models/search_criteria.rb'
     autoload :MessageContent,                                     'Mailosaur/models/message_content.rb'
@@ -83,9 +86,9 @@ module Mailosaur
       Faraday.new(@base_url, {
         headers: {
           content_type: 'application/json; charset=utf-8',
-          user_agent: 'mailosaur-ruby/' + Mailosaur::VERSION
+          user_agent: "mailosaur-ruby/#{Mailosaur::VERSION}"
         }
-      }).tap { |conn| conn.basic_auth(@api_key, '') }
+      }).tap { |conn| conn.request(:basic_auth, @api_key, '') }
     end
 
     def handle_http_error(response)

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.3.1
+  version: 7.6.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -76,34 +76,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.0
+        version: 1.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.68.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
@@ -164,8 +158,11 @@ files:
 - lib/Mailosaur/models/message.rb
 - lib/Mailosaur/models/message_address.rb
 - lib/Mailosaur/models/message_content.rb
+- lib/Mailosaur/models/message_create_options.rb
+- lib/Mailosaur/models/message_forward_options.rb
 - lib/Mailosaur/models/message_header.rb
 - lib/Mailosaur/models/message_list_result.rb
+- lib/Mailosaur/models/message_reply_options.rb
 - lib/Mailosaur/models/message_summary.rb
 - lib/Mailosaur/models/metadata.rb
 - lib/Mailosaur/models/search_criteria.rb
@@ -201,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library