mailosaur 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 674d6a0fc698cb9f2e2e94de63b60ebd2e7af23b676b285e939f7128277ed815
-  data.tar.gz: e32afa6f593799fb13873b8c4e1c53b6aaaa2803b9a9269f42680b1308b5665f
+  metadata.gz: 3f9e68987fc63770ca61c94a5091b02ea932bb765ea6dfa1d2d3ca8603e58867
+  data.tar.gz: 8683c7bb7ffe561fc491867bb2000437cd3b0541cec1c738d9733c649c6c2d1d
 SHA512:
-  metadata.gz: fe6f0bdaff74715b4f2ca3962673036e23f406aa06d990b471f9617c7ce99b63ac26ffc5adaa1a34c4c8b908045b7ab8a4aff3cae156b9679c3b69fd03bbdb98
-  data.tar.gz: 7204f062d34fa6c35f4219f293a6cfa5b50f03fecd31d9cc54da5dedda1e91c653dd0da19f9f87f5121ca5bd7cd6e27986517db7e999d7391c9038cdb01cd19b
+  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/version.rb

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

data/lib/mailosaur.rb

@@ -65,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
 

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Mailosaur
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -201,6 +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:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,7 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: The Mailosaur Ruby library
 test_files: []