mailosaur 7.17.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4e9715da4f69e6078392f4846fe8f85228b1cb0c8efd32f75ab5262ad0b7510
-  data.tar.gz: 42afb8a6023e449b90e4cb5c185ba02564b307460cdac6082edac492250ebc07
+  metadata.gz: 3f9e68987fc63770ca61c94a5091b02ea932bb765ea6dfa1d2d3ca8603e58867
+  data.tar.gz: 8683c7bb7ffe561fc491867bb2000437cd3b0541cec1c738d9733c649c6c2d1d
 SHA512:
-  metadata.gz: 4d439710cbb8ee21bc8956f6f9b14222e76ab9132e0826bfd4fb612934f3e45059ef3bdadead642c7689af76e3af8849f5f3ed2d4ba4c562e21967d7951f2c0b
-  data.tar.gz: 9300b227579346522080db84cfa5483f8662af6f288bed790025e0f50e5e4d547a58984132c0d9742f6e3ecbe8a9d75723a1a115e13e1e72fa4b18480a05588b
+  metadata.gz: abb3db223ad672d31099e11284a928679c3a3c9db15b9e727c2fbd68119a23fe424bd75116b54b35c6a1b25ce9edb47f7a956baf444835b626a9acf904824bf0
+  data.tar.gz: 7a556665627605e074ce413a02be0d839032454445e5592de4367ee1d05707c193205726940a20545edd752926b277da7801e6b1dac9db14b0f738402110a065

data/README.md

@@ -11,6 +11,10 @@ Mailosaur lets you automate email and SMS tests as part of software development
 This guide provides several key sections:
 
   - [Get Started](#get-started)
+  - [Installation](#installation)
+  - [Set your API key](#set-your-api-key)
+  - [Create your code](#create-your-code)
+  - [API Reference](#api-reference)
   - [Creating an account](#creating-an-account)
   - [Test email addresses with Mailosaur](#test-email-addresses-with-mailosaur)
   - [Find an email](#find-an-email)
@@ -32,11 +36,21 @@ If you get stuck, just contact us at support@mailosaur.com.
 gem install mailosaur
 ```
 
-Then import the library into your code. The value for `YOUR_API_KEY` is covered in the next step ([creating an account](#creating-an-account)):
+### Set your API key
+
+Get your API key from the Mailosaur Dashboard and set it as an environment variable:
+
+```sh
+export MAILOSAUR_API_KEY='your-api-key-here'
+```
+
+### Create your code
+
+Then import the library into your code:
 
 ```ruby
 require 'mailosaur'
-mailosaur = Mailosaur::MailosaurClient.new("YOUR_API_KEY")
+mailosaur = Mailosaur::MailosaurClient.new()
 ```
 
 ### API Reference
@@ -79,7 +93,7 @@ In automated tests you will want to wait for a new email to arrive. This library
 ```ruby
 require 'mailosaur'
 
-mailosaur = Mailosaur::MailosaurClient.new("API_KEY")
+mailosaur = Mailosaur::MailosaurClient.new()
 
 # See https://mailosaur.com/app/project/api
 server_id = "abc123"
@@ -95,7 +109,7 @@ puts(email.subject) # "Hello world!"
 
 ### What is this code doing?
 
-1. Sets up an instance of `MailosaurClient` with your API key.
+1. Sets up an instance of `MailosaurClient` using the `MAILOSAUR_API_KEY` environment variable.
 2. Waits for an email to arrive at the server with ID `abc123`.
 3. Outputs the subject line of the email.
 
@@ -108,7 +122,7 @@ If your account has [SMS testing](https://mailosaur.com/sms-testing/) enabled, y
 ```ruby
 require 'mailosaur'
 
-mailosaur = Mailosaur::MailosaurClient.new("API_KEY")
+mailosaur = Mailosaur::MailosaurClient.new()
 
 server_id = "abc123"
 

data/lib/Mailosaur/files.rb

@@ -55,9 +55,31 @@ module Mailosaur
     # @return [NOT_IMPLEMENTED] operation results.
     #
     def get_preview(id)
-      response = conn.get "api/files/previews/#{id}"
-      @handle_http_error.call(response) unless response.status == 200
-      response.body
+      timeout = 120_000
+      poll_count = 0
+      start_time = Time.now.to_f
+
+      loop do
+        response = conn.get "api/files/screenshots/#{id}"
+
+        return response.body if response.status == 200
+
+        @handle_http_error.call(response) unless response.status == 202
+
+        delay_pattern = (response.headers['x-ms-delay'] || '1000').split(',').map(&:to_i)
+
+        delay = poll_count >= delay_pattern.length ? delay_pattern[delay_pattern.length - 1] : delay_pattern[poll_count]
+
+        poll_count += 1
+
+        ## Stop if timeout will be exceeded
+        if ((1000 * (Time.now.to_f - start_time).to_i) + delay) > timeout
+          msg = format('An email preview was not generated in time. The email client may not be available, or the preview ID [%s] may be incorrect.', id)
+          raise Mailosaur::MailosaurError.new(msg, 'preview_timeout')
+        end
+
+        sleep(delay / 1000.0)
+      end
     end
   end
 end

data/lib/Mailosaur/messages.rb

@@ -248,7 +248,7 @@ module Mailosaur
     # @return [PreviewListResult] operation result.
     #
     def generate_previews(id, options)
-      response = conn.post "api/messages/#{id}/previews", options.to_json
+      response = conn.post "api/messages/#{id}/screenshots", options.to_json
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.parse(response.body)
       Mailosaur::Models::PreviewListResult.new(model)

data/lib/Mailosaur/models/email_client.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class EmailClient < BaseModel
+      def initialize(data = {})
+        @label = data['label']
+        @name = data['name']
+      end
+
+      # @return [String] The unique email client label. Used when generating email preview requests.
+      attr_accessor :label
+
+      # @return [String] The display name of the email client.
+      attr_accessor :name
+    end
+  end
+end

data/lib/Mailosaur/models/email_client_list_result.rb

@@ -0,0 +1,13 @@
+module Mailosaur
+  module Models
+    class EmailClientListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::EmailClient.new(i) }
+      end
+
+      # @return [Array<EmailClient>] A list of available email clients with which to generate email previews.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/preview_request_options.rb

@@ -1,12 +1,12 @@
 module Mailosaur
   module Models
     class PreviewRequestOptions < BaseModel
-      def initialize(previews)
-        @previews = previews
+      def initialize(email_clients)
+        @email_clients = email_clients
       end
 
-      # @return [PreviewRequest] The list of email preview requests.
-      attr_accessor :previews
+      # @return [Array<String>] The list email clients to generate previews with.
+      attr_accessor :email_clients
     end
   end
 end

data/lib/Mailosaur/previews.rb

@@ -17,13 +17,13 @@ module Mailosaur
     #
     # Returns a list of available email clients.
     #
-    # @return [PreviewEmailClientListResult] operation results.
+    # @return [EmailClientListResult] operation results.
     #
     def list_email_clients
-      response = conn.get 'api/previews/clients'
+      response = conn.get 'api/screenshots/clients'
       @handle_http_error.call(response) unless response.status == 200
       model = JSON.parse(response.body)
-      Mailosaur::Models::PreviewEmailClientListResult.new(model)
+      Mailosaur::Models::EmailClientListResult.new(model)
     end
   end
 end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.17.0'.freeze
+    VERSION = '8.1.0'.freeze
 end

data/lib/mailosaur.rb

@@ -55,10 +55,9 @@ module Mailosaur
     autoload :DeviceCreateOptions,                                'Mailosaur/models/device_create_options.rb'
     autoload :OtpResult,                                          'Mailosaur/models/otp_result.rb'
     autoload :Preview,                                            'Mailosaur/models/preview.rb'
-    autoload :PreviewEmailClient,                                 'Mailosaur/models/preview_email_client.rb'
-    autoload :PreviewEmailClientListResult,                       'Mailosaur/models/preview_email_client_list_result.rb'
+    autoload :EmailClient,                                        'Mailosaur/models/email_client.rb'
+    autoload :EmailClientListResult,                              'Mailosaur/models/email_client_list_result.rb'
     autoload :PreviewListResult,                                  'Mailosaur/models/preview_list_result.rb'
-    autoload :PreviewRequest,                                     'Mailosaur/models/preview_request.rb'
     autoload :PreviewRequestOptions,                              'Mailosaur/models/preview_request_options.rb'
     autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
@@ -66,11 +65,15 @@ module Mailosaur
   class MailosaurClient
     #
     # Creates initializes a new instance of the MailosaurClient class.
-    # @param api_key [String] your Mailosaur API key.
+    # @param api_key [String] Optional API key. Overrides the MAILOSAUR_API_KEY environment variable if set.
     # @param base_url [String] the base URI of the service.
     #
-    def initialize(api_key, base_url = 'https://mailosaur.com/')
-      @api_key = api_key
+    def initialize(api_key = nil, base_url: 'https://mailosaur.com/')
+      resolved_api_key = api_key || ENV['MAILOSAUR_API_KEY']
+
+      raise ArgumentError, "'api_key' must be set. Set the MAILOSAUR_API_KEY environment variable or pass it to the MailosaurClient constructor." unless resolved_api_key
+
+      @api_key = resolved_api_key
       @base_url = base_url
     end
 
@@ -148,6 +151,8 @@ module Mailosaur
         raise Mailosaur::MailosaurError.new('Insufficient permission to perform that task.', 'permission_error', response.status, response.body)
       when 404
         raise Mailosaur::MailosaurError.new('Not found, check input parameters.', 'invalid_request', response.status, response.body)
+      when 410
+        raise Mailosaur::MailosaurError.new('Permanently expired or deleted.', 'gone', response.status, response.body)
       else
         raise Mailosaur::MailosaurError.new('An API error occurred, see httpResponse for further information.', 'api_error', response.status, response.body)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.17.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Mailosaur
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,6 +157,8 @@ files:
 - lib/Mailosaur/models/device_list_result.rb
 - lib/Mailosaur/models/dns_records.rb
 - lib/Mailosaur/models/email_authentication_result.rb
+- lib/Mailosaur/models/email_client.rb
+- lib/Mailosaur/models/email_client_list_result.rb
 - lib/Mailosaur/models/image.rb
 - lib/Mailosaur/models/link.rb
 - lib/Mailosaur/models/message.rb
@@ -171,10 +173,7 @@ files:
 - lib/Mailosaur/models/metadata.rb
 - lib/Mailosaur/models/otp_result.rb
 - lib/Mailosaur/models/preview.rb
-- lib/Mailosaur/models/preview_email_client.rb
-- lib/Mailosaur/models/preview_email_client_list_result.rb
 - lib/Mailosaur/models/preview_list_result.rb
-- lib/Mailosaur/models/preview_request.rb
 - lib/Mailosaur/models/preview_request_options.rb
 - lib/Mailosaur/models/search_criteria.rb
 - lib/Mailosaur/models/server.rb
@@ -203,7 +202,7 @@ metadata:
   github_repo: ssh://github.com/mailosaur/mailosaur-ruby
   homepage_uri: https://mailosaur.com/
   source_code_uri: https://github.com/mailosaur/mailosaur-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -218,8 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: The Mailosaur Ruby library
 test_files: []

data/lib/Mailosaur/models/preview_email_client.rb

@@ -1,36 +0,0 @@
-module Mailosaur
-  module Models
-    class PreviewEmailClient < BaseModel
-      def initialize(data = {})
-        @id = data['id']
-        @name = data['name']
-        @platform_group = data['platformGroup']
-        @platform_type = data['platformType']
-        @platform_version = data['platformVersion']
-        @can_disable_images = data['canDisableImages']
-        @status = data['status']
-      end
-
-      # @return [String] Unique identifier for the email preview.
-      attr_accessor :id
-
-      # @return [String] The display name of the email client.
-      attr_accessor :name
-
-      # @return [String] Whether the platform is desktop, mobile, or web-based.
-      attr_accessor :platform_group
-
-      # @return [String] The type of platform on which the email client is running.
-      attr_accessor :platform_type
-
-      # @return [String] The platform version number.
-      attr_accessor :platform_version
-
-      # @return [Boolean] If true, images can be disabled when generating previews.
-      attr_accessor :can_disable_images
-
-      # @return [String] The current status of the email client.
-      attr_accessor :status
-    end
-  end
-end

data/lib/Mailosaur/models/preview_email_client_list_result.rb

@@ -1,14 +0,0 @@
-module Mailosaur
-  module Models
-    class PreviewEmailClientListResult < BaseModel
-      def initialize(data = {})
-        @items = []
-        (data['items'] || []).each { |i| @items << Mailosaur::Models::PreviewEmailClient.new(i) }
-      end
-
-      # @return [Array<PreviewEmailClient>] A list of available email clients with which to generate email previews.
-      # A list of available email clients.
-      attr_accessor :items
-    end
-  end
-end

data/lib/Mailosaur/models/preview_request.rb

@@ -1,16 +0,0 @@
-module Mailosaur
-  module Models
-    class PreviewRequest < BaseModel
-      def initialize(email_client, disable_images: false)
-        @email_client = email_client
-        @disable_images = disable_images
-      end
-
-      # @return [String] The email client the preview was generated with.
-      attr_accessor :email_client
-
-      # @return [Boolean] True if images were disabled in the preview.
-      attr_accessor :disable_images
-    end
-  end
-end