gettestmail 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4295033a8ba3b2b4703cc7be78766e180eeac5d13d38ef09971b89a7533f7df3
-  data.tar.gz: d5df117c7bccb60623b51fdadcc6e045dd24f69c8391da747f6ac52cd8aee919
+  metadata.gz: 694141f1056032b4e20b962abc3e4828e7cae8e9f863015a1f825edf643eb460
+  data.tar.gz: b32e03e36edad77422f9209a389f4cb38002f2a51b3cffbc834382789a3bde11
 SHA512:
-  metadata.gz: '049ed152470173ebd6f460c98f9d23d2b356eaf2a1a3661f0de38c2b7b9ed0e2233d9054ee0a996a2e68e7f794899c347b2573c9575118423b9aff2a15d48959'
-  data.tar.gz: a9971a16f0cd03cdbbc74904c10dc4af5169a1a4b42e2b361e4c56f397fe094befed38eeeb3c2a9ea1d36b447c54fa039545d236d33cea9838e936a46419eef6
+  metadata.gz: 06f520cbb20a02f459fc7eb9ccdefa27c75182b2488e41cbc68be2cf15573831a5013195f1f583b657ca91310034ba10d8bc64aa657309cd769fb4bd92fba1ca
+  data.tar.gz: cc5ceb0bfee07c9fd4ebd3fa53aaa70f0fc67f9ba1a5115f33a3200b98216ad020a4003abfc9c97c3ef382be69867483638b42ae6e9665d671d6926e5085da38

data/README.md

@@ -1,2 +1,95 @@
 # ruby-sdk
-Ruby SDK for GetTestMail
+
+A Ruby client for interacting with the GetTestMail API, which allows you to create disposable email addresses for testing purposes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+gem 'gettestmail'
+
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ 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:
+
+```ruby
+require 'gettestmailclient'
+
+api_key = 'your-api-key'
+client = GetTestMailClient.new(api_key)
+```
+
+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:
+
+message = client.wait_for_message(get_test_mail.email_address)
+puts "Message from: #{message.from}"
+puts "Message subject: #{message.subject}"
+puts "Message: #{message}"
+```
+
+## Models
+
+### GetTestMail
+
+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.
+```
+
+### Message
+
+The Message model represents an email message. 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.
+```
+
+### Attachment
+
+The Attachment model represents an email attachment. It has the following attributes:
+
+```
+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
+
+
+If the API returns an error, the client will raise an ApiError exception with a ProblemDTO object containing error details.
+
+
+License
+
+This gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gettestmail
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bobby Donchev
@@ -36,7 +36,7 @@ files:
 - LICENSE
 - README.md
 - lib/api_error.rb
-- lib/client.rb
+- lib/gettestmailclient.rb
 - lib/models/attachment.rb
 - lib/models/base_dto.rb
 - lib/models/get_test_mail.rb