gettestmail 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 694141f1056032b4e20b962abc3e4828e7cae8e9f863015a1f825edf643eb460
-  data.tar.gz: b32e03e36edad77422f9209a389f4cb38002f2a51b3cffbc834382789a3bde11
+  metadata.gz: a4c995c040bc6afe8feff85a2ffbe83664c1e156b4ceffa401e27409f292ff39
+  data.tar.gz: 04dd8d859497d7c323a00b2f3e24cf228ffa01391104a9561db7a369c57c41c2
 SHA512:
-  metadata.gz: 06f520cbb20a02f459fc7eb9ccdefa27c75182b2488e41cbc68be2cf15573831a5013195f1f583b657ca91310034ba10d8bc64aa657309cd769fb4bd92fba1ca
-  data.tar.gz: cc5ceb0bfee07c9fd4ebd3fa53aaa70f0fc67f9ba1a5115f33a3200b98216ad020a4003abfc9c97c3ef382be69867483638b42ae6e9665d671d6926e5085da38
+  metadata.gz: 0f5b6feb878a02573d9f9fb3d807ef050bc4ca138e6358130dfe972fcf11aaeaf8bf58d1dd8cdaa0707b165c9afb9c18a00124ced22898259a1fadb9f2827150
+  data.tar.gz: dabd6f5ffdc8cee4127b687838135c19fe8827cef871cd1466836a77c893658f78316e3624d838792c60ee5cfbcd7b0963adb555e9cc53fa7862f2d8123386f7

data/README.md

@@ -1,6 +1,6 @@
 # ruby-sdk
 
-A Ruby client for interacting with the GetTestMail API, which allows you to create disposable email addresses for testing purposes.
+A Ruby client for interacting with the GetTestMail API, which provides a simple way to create temporary email addresses and receive messages sent to them.
 
 ## Installation
 
@@ -23,8 +23,8 @@ $ gem install gettestmail
 
 ## Usage
 
-Creating a New Client
-To create a new GetTestMail API client, you need to instantiate the GetTestMailClient class with your API key:
+### Creating a New Client
+To create a new GetTestMail API client, you need to instantiate the GetTestMailClient class with your API key. To get an API key, sign up for a free [account](https://gettestmail.com).
 
 ```ruby
 require 'gettestmailclient'
@@ -33,17 +33,20 @@ api_key = 'your-api-key'
 client = GetTestMailClient.new(api_key)
 ```
 
-Creating a New GetTestMail Instance
+### Creating a New GetTestMail Instance
 To create a new GetTestMail instance, call the create_new method on the client:
 
 ```ruby
 get_test_mail = client.create_new
 puts "Email address: #{get_test_mail.email_address}"
 puts "Expires at: #{get_test_mail.expires_at}"
-# Waiting for a Message
-# To wait for a message, call the wait_for_message method with the email address:
+```
+
+### Waiting for a Message
+To wait for a message, call the wait_for_message method with the email address:
 
-message = client.wait_for_message(get_test_mail.email_address)
+```ruby
+message = client.wait_for_message(get_test_mail.id)
 puts "Message from: #{message.from}"
 puts "Message subject: #{message.subject}"
 puts "Message: #{message}"
@@ -55,34 +58,31 @@ puts "Message: #{message}"
 
 The GetTestMail model represents a disposable email address. It has the following attributes:
 
-```
-email_address: The disposable email address.
-expires_at: The expiration time of the email address.
-```
+* id - The id of the email address
+* emailAddress - The email address
+* expiresAt - The time at which the email address will expire
+* message - The message received by the email address
 
 ### Message
 
-The Message model represents an email message. It has the following attributes:
+The Message received by the email address. It has the following attributes:
 
-```
-id: The unique identifier of the message.
-from: The sender's email address.
-to: The recipient's email address.
-subject: The subject of the email.
-text: The plain text version of the email.
-html: The HTML version of the email.
-attachments: An array of Attachment objects.
-```
+* id - The id of the message
+* from - The sender of the message
+* to - The recipient of the message
+* subject - The subject of the message
+* text - Text representation of the message
+* html - HTML representation of the message
+* attachments - List of attachments
 
 ### Attachment
 
-The Attachment model represents an email attachment. It has the following attributes:
+The Attachment received by the email address. It has the following attributes:
+
+* filename - The filename of the attachment
+* mimeType - The mime type of the attachment
+* content - The content of the attachment
 
-```
-filename: The name of the attached file.
-mime_type: The MIME type of the attached file.
-content: The content of the attached file.
-```
 
 ## Error Handling
 

data/lib/models/attachment.rb

@@ -1,11 +1,11 @@
 class Attachment
-  attr_accessor :filename, :mime_type, :content
+  attr_accessor :filename, :mimeType, :content
 
   def initialize(json)
     json.each { |key, value| instance_variable_set("@#{key}", value) }
   end
 
   def to_s
-    "Name: #{filename}, Mime-Type: #{mime_type}"
+    "Name: #{filename}, Mime-Type: #{mimeType}"
   end
 end

data/lib/models/get_test_mail.rb

@@ -2,7 +2,7 @@ require_relative 'base_dto'
 require_relative 'message'
 
 class GetTestMail < BaseDTO
-  attr_accessor :emailAddress, :expiresAt, :message
+  attr_accessor :id, :emailAddress, :expiresAt, :message
 
   def initialize(json)
     super(json)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gettestmail
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Bobby Donchev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty