mailosaur 7.0.0 → 7.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ded354d904892b5edb18803695bda97a368a55bcf8bee8f1b3f7cc3d54223a8
-  data.tar.gz: 5e7e2e660129a7c4067d1ef74075f3f1be5e2ca8a78411199acb77b3c6b2352d
+  metadata.gz: 27d013e44169ed1c8b0881334b94ce03d76177c35b48202058683a271a7920a8
+  data.tar.gz: 3fd514240ac76ddfe02296e7a67b97f10b9d5fc711e1c7d321a1222cc1caef0a
 SHA512:
-  metadata.gz: c2217d5763f88bc5c4d8a5f769ab327c0a31e1e781300a8cff5fb264297568c05e664c4d431359b49cc401e1756b9a52e070d71a87489822da0069aaf3bf8d9c
-  data.tar.gz: a489db754706165b9c1a5637d73bd5fd5ab236c3fdfa81f6fe25e36d534b789425290e1c63d33107c0a79bc177e1eb20ee93101b3ab0dc8a18d7b99a6814b465
+  metadata.gz: 173665bfe6e3ac1b5eacc99f8e4e3b8bf6e7e9487e4852be057473468b56c00c9f53d38ac95218587fd07d86301efcf98b7ce04f234c93dff5df66aa6c8db402
+  data.tar.gz: 81b04fd97abcfaf0784973d7cf9e1b627d6f28664b1c38a43133f47a001f743a128102520d764d52fba0e7ca825625219b41121feb207b5f489eff569c1dac25

data/README.md

@@ -1,6 +1,6 @@
 # Mailosaur Ruby Client Library
 
-[Mailosaur](https://mailosaur.com) allows you to automate tests involving email. Allowing you to perform end-to-end automated and functional email testing.
+[Mailosaur](https://mailosaur.com) lets you automate email and SMS tests, like account verification and password resets, and integrate these into your CI/CD pipeline.
 
 [![](https://github.com/mailosaur/mailosaur-ruby/workflows/CI/badge.svg)](https://github.com/mailosaur/mailosaur-ruby/actions)
 
@@ -10,29 +10,52 @@
 gem install mailosaur
 ```
 
-## Documentation and usage examples
+## Documentation
 
-[Mailosaur's documentation](https://mailosaur.com/docs) includes all the information and usage examples you'll need.
+Please see the [Ruby client reference](https://mailosaur.com/docs/email-testing/ruby/client-reference/) for the most up-to-date documentation.
 
-## Running tests
+## Usage
 
-Once you've cloned this repository locally, you can simply run:
+example.rb
 
+```ruby
+require "mailosaur"
+mailosaur = Mailosaur::MailosaurClient.new("YOUR_API_KEY")
+
+result = mailosaur.servers.list()
+
+print("You have a server called: " + result.items[0].name)
 ```
+
+## Development
+
+You must have the following prerequisites installed:
+
+* [Bundler](https://bundler.io/)
+
+Install all development dependencies:
+
+```sh
 bundle install
+```
+
+The test suite requires the following environment variables to be set:
 
+```sh
+export MAILOSAUR_BASE_URL=https://mailosaur.com/
 export MAILOSAUR_API_KEY=your_api_key
 export MAILOSAUR_SERVER=server_id
+```
+
+Run all tests:
 
+```sh
 bundle exec rake test
 ```
 
-## Linting code
+Lint code (via Rubocop):
 
-Simply run Rubocop:
-
-```
-bundle install
+```sh
 bundle exec rubocop
 ```
 

data/lib/Mailosaur/messages.rb

@@ -34,7 +34,7 @@ module Mailosaur
       # Defaults timeout to 10s, receivedAfter to 1h
       raise Mailosaur::MailosaurError.new('Must provide a valid Server ID.', 'invalid_request') if server.length != 8
 
-      result = search(server, criteria, timeout: timeout, received_after: received_after)
+      result = search(server, criteria, page: 0, items_per_page: 1, timeout: timeout, received_after: received_after)
       get_by_id(result.items[0].id)
     end
 
@@ -132,10 +132,12 @@ module Mailosaur
     # (in milliseconds).
     # @param received_after [DateTime] Limits results to only messages received
     # after this date/time.
+    # @param error_on_timeout [Boolean] When set to false, an error will not be
+    # throw if timeout is reached (default: true).
     #
     # @return [MessageListResult] operation results.
     #
-    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil) # rubocop:disable all
+    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 : ''
@@ -160,6 +162,8 @@ module Mailosaur
 
         ## Stop if timeout will be exceeded
         if ((1000 * (Time.now.to_f - start_time).to_i) + delay) > timeout
+          return Mailosaur::Models::MessageListResult.new(model) unless error_on_timeout
+
           raise Mailosaur::MailosaurError.new('No matching messages found in time. By default, only messages received in the last hour are checked (use receivedAfter to override this).', 'search_timeout')
         end
 

data/lib/Mailosaur/models/search_criteria.rb

@@ -2,11 +2,17 @@ module Mailosaur
   module Models
     class SearchCriteria < BaseModel
       def initialize(data = {})
+        @sent_from = data['sentFrom']
         @sent_to = data['sentTo']
         @subject = data['subject']
         @body = data['body']
+        @match = data['match'] || 'ALL'
       end
 
+      # @return [String] The full email address from which the target email was
+      # sent.
+      attr_accessor :sent_from
+
       # @return [String] The full email address to which the target email was
       # sent.
       attr_accessor :sent_to
@@ -18,6 +24,11 @@ module Mailosaur
       # @return [String] The value to seek within the target email's HTML or
       # text body.
       attr_accessor :body
+
+      # @return [String] If set to ALL (default), then only results that match all
+      # specified criteria will be returned. If set to ANY, results that match any of the
+      # specified criteria will be returned.
+      attr_accessor :match
     end
   end
 end

data/lib/Mailosaur/models/server.rb

@@ -3,21 +3,15 @@ module Mailosaur
     class Server < BaseModel
       def initialize(data = {})
         @id = data['id']
-        @password = data['password']
         @name = data['name']
         @users = data['users']
         @messages = data['messages']
-        @forwarding_rules = []
-        (data['forwardingRules'] || []).each do |i| @forwarding_rules << Mailosaur::Models::ForwardingRule.new(i) end
       end
 
       # @return [String] Unique identifier for the server. Used as username for
       # SMTP/POP3 authentication.
       attr_accessor :id
 
-      # @return [String] SMTP/POP3 password.
-      attr_accessor :password
-
       # @return [String] A name used to identify the server.
       attr_accessor :name
 
@@ -26,10 +20,6 @@ module Mailosaur
 
       # @return [Integer] The number of messages currently in the server.
       attr_accessor :messages
-
-      # @return [Array<ForwardingRule>] The rules used to manage email
-      # forwarding for this server.
-      attr_accessor :forwarding_rules
     end
   end
 end

data/lib/Mailosaur/servers.rb

@@ -60,6 +60,23 @@ module Mailosaur
       Mailosaur::Models::Server.new(model)
     end
 
+    #
+    # Retrieve server password
+    #
+    # Retrieves the password for use with SMTP and POP3 for a single server.
+    # Simply supply the unique identifier for the required server.
+    #
+    # @param id [String] The identifier of the server.
+    #
+    # @return [String] Server password.
+    #
+    def get_password(id)
+      response = conn.get 'api/servers/' + id + '/password'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      model['value']
+    end
+
     #
     # Update a server
     #
@@ -92,8 +109,8 @@ module Mailosaur
     end
 
     def generate_email_address(server)
-      host = ENV['MAILOSAUR_SMTP_HOST'] || 'mailosaur.io'
-      '%s.%s@%s' % [SecureRandom.hex(3), server, host]
+      host = ENV['MAILOSAUR_SMTP_HOST'] || 'mailosaur.net'
+      '%s@%s.%s' % [SecureRandom.hex(3), server, host]
     end
   end
 end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.0.0'.freeze
+    VERSION = '7.2.1'.freeze
 end

data/lib/mailosaur.rb

@@ -27,7 +27,6 @@ module Mailosaur
     autoload :MessageListResult,                                  'Mailosaur/models/message_list_result.rb'
     autoload :Attachment,                                         'Mailosaur/models/attachment.rb'
     autoload :SearchCriteria,                                     'Mailosaur/models/search_criteria.rb'
-    autoload :ForwardingRule,                                     'Mailosaur/models/forwarding_rule.rb'
     autoload :MessageContent,                                     'Mailosaur/models/message_content.rb'
     autoload :Server,                                             'Mailosaur/models/server.rb'
     autoload :Link,                                               'Mailosaur/models/link.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.2.1
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-15 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,7 +159,6 @@ files:
 - lib/Mailosaur/messages.rb
 - lib/Mailosaur/models/attachment.rb
 - lib/Mailosaur/models/base_model.rb
-- lib/Mailosaur/models/forwarding_rule.rb
 - lib/Mailosaur/models/image.rb
 - lib/Mailosaur/models/link.rb
 - lib/Mailosaur/models/message.rb
@@ -204,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library

data/lib/Mailosaur/models/forwarding_rule.rb

@@ -1,25 +0,0 @@
-module Mailosaur
-  module Models
-    class ForwardingRule < BaseModel
-      def initialize(data = {})
-        @field = data['field']
-        @operator = data['operator']
-        @value = data['value']
-        @forward_to = data['forwardTo']
-      end
-
-      # @return [Enum] Possible values include: 'from', 'to', 'subject'
-      attr_accessor :field
-
-      # @return [Enum] Possible values include: 'endsWith', 'startsWith',
-      # 'contains'
-      attr_accessor :operator
-
-      # @return [String]
-      attr_accessor :value
-
-      # @return [String]
-      attr_accessor :forward_to
-    end
-  end
-end