mailslurp_client 15.18.2 → 15.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5255743fd450eceae87f42ad09b8758fce3cd85ca84de746a77a8b371c6f4b44
-  data.tar.gz: 8996b74ae80c52a355d5a27a2795993174f750c8c60c57d4aa404874571f56b5
+  metadata.gz: ed313a19e0624c0e3a672c95efd493057e607db56e8d5431160f7ac8de3526f8
+  data.tar.gz: 5f37dedf55ec71aaf7a7b25123fd4b31d6254a2349a19a363e26c708e4a608ba
 SHA512:
-  metadata.gz: 6a8a7547db8be6dba2652699febc4fcc6703c4fe89c4af264423256ca36fef8f2580d63a5e6fe7ce775c6a01f1110b1605d957e635ecaffa18e16b350eb2687e
-  data.tar.gz: aeaff3674c1df832e0029e97f324e0d7576458ce542c58fc899c2716bf65e53bdbba692219b5dd85185d63266b5eb13c9fa24c00db4045fe8524887462c28b2b
+  metadata.gz: 1de0d33b238d1c01d094ca5ae4f14cbad29b66197cafb404412e1d050e210cfa33ce091dab1adacb1047e6bdda970ae8a6d842471232c775196ecc37f4f1bf21
+  data.tar.gz: 23b68015f53717f1983db6ee6a3b3eef6b0a42d71190b1d2b45c328a382dcd373b44f39db59a066094b794999a5927a7b8b04a140569516136aa5e5224bf5c0d

data/README.md

@@ -50,7 +50,12 @@ gem install mailslurp_client
 
 Or in your `Gemfile`:
 
-{{<gen_ruby_ruby_minitest_gemspec>}}
+```ruby
+source "https://rubygems.org"
+
+gem 'mailslurp_client'
+gem 'typhoeus'
+```
 
 And then run bundler install:
 
@@ -67,15 +72,22 @@ You may need to install `typhoeus` if you encounter libcurl errors.
 gem 'typhoeus'
 ```
 
-
 ### Configure the client
 
-{{<gen_ruby_ruby_minitest_configure>}}
+```ruby
+require 'mailslurp_client'
+
+MailSlurpClient.configure do |config|
+  config.api_key['x-api-key'] = ENV['API_KEY']
+end
+```
 
 ### Create controllers
 To call the API create a controller like this:
 
-{{<gen_ruby_ruby_minitest_create_controller>}}
+```ruby
+inbox_controller = MailSlurpClient::InboxControllerApi.new
+```
 
 ## Common uses
 
@@ -87,7 +99,14 @@ Here are some common uses:
 
 To use MailSlurp you need to create inboxes. These are email accounts that have an ID and a real email address. See methods on the [inbox controller](https://ruby.mailslurp.com/MailSlurpClient/InboxControllerApi.html) for more information.
 
-{{<gen_ruby_ruby_minitest_create_inbox>}}
+```ruby
+options = {
+  name: "My test inbox",
+  inboxType: "SMTP_INBOX"
+}
+inbox = inbox_controller.create_inbox_with_options(options)
+assert_match /@mailslurp/, inbox.email_address
+```
 
 In a test:
 
@@ -199,7 +218,13 @@ end
 
 You can send HTML emails easily with the inbox controller. First create an inbox then use its ID with the `send_email` method.
 
-{{<gen_ruby_ruby_minitest_send_email>}}
+```ruby
+inbox_controller.send_email(inbox.id, {
+  to: [inbox.email_address],
+  subject: "Hello",
+  body: "Welcome. Your code is: 123456",
+})
+```
 
 To send attachments see the [Method Documentation](https://ruby.mailslurp.com/).
 
@@ -242,7 +267,27 @@ inbox_controller.send_email(inbox_1.id, opts)
 
 ### Send with SMTP
 
-{{<gen_ruby_ruby_minitest_smtp_send>}}
+```ruby
+    require 'net/smtp'
+    access_details = inbox_controller.get_imap_smtp_access(inbox_id: inbox.id)
+    Net::SMTP.start(
+      address= access_details.secure_smtp_server_host,
+      port= access_details.secure_smtp_server_port,
+      helo= inbox.email_address.match(/@(.+)/)[1],
+      user= access_details.secure_smtp_username,
+      secret= access_details.secure_smtp_password,
+      authtype= :plain
+    ) do |smtp|
+      message = <<EOF
+Subject: SMTP test
+
+This is my body
+EOF
+      smtp.send_message message, inbox.email_address, inbox.email_address
+      smtp.finish
+    end
+    
+```
 
 ### Receive emails
 
@@ -250,11 +295,23 @@ To read already existing emails use the [Email Controller](https://ruby.mailslur
 You can use MailSlurp to wait for at least 1 unread email in an inbox and return it.
 If a timeout is exceeded it will throw an error instead:
 
-{{<gen_ruby_ruby_minitest_receive_email>}}
+```ruby
+wait_for_controller = MailSlurpClient::WaitForControllerApi.new
+wait_options = {
+  inbox_id: inbox.id,
+  timeout: 120000,
+  unread_only: true
+}
+email = wait_for_controller.wait_for_latest_email(wait_options)
+assert_match /Welcome/, email.body
+```
 
 ### Extract email content
 
-{{<gen_ruby_ruby_minitest_extract_code>}}
+```ruby
+code = email.body.match(/Your code is: ([0-9]{6})/)[1]
+assert_equal code, '123456'
+```
 
 To parse an email and extract content use regex patterns like so:
 

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '15.18.2'
+  VERSION = '15.18.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 15.18.2
+  version: 15.18.4
 platform: ruby
 authors:
 - mailslurp