gettestmail 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4295033a8ba3b2b4703cc7be78766e180eeac5d13d38ef09971b89a7533f7df3
-  data.tar.gz: d5df117c7bccb60623b51fdadcc6e045dd24f69c8391da747f6ac52cd8aee919
+  metadata.gz: a4c995c040bc6afe8feff85a2ffbe83664c1e156b4ceffa401e27409f292ff39
+  data.tar.gz: 04dd8d859497d7c323a00b2f3e24cf228ffa01391104a9561db7a369c57c41c2
 SHA512:
-  metadata.gz: '049ed152470173ebd6f460c98f9d23d2b356eaf2a1a3661f0de38c2b7b9ed0e2233d9054ee0a996a2e68e7f794899c347b2573c9575118423b9aff2a15d48959'
-  data.tar.gz: a9971a16f0cd03cdbbc74904c10dc4af5169a1a4b42e2b361e4c56f397fe094befed38eeeb3c2a9ea1d36b447c54fa039545d236d33cea9838e936a46419eef6
+  metadata.gz: 0f5b6feb878a02573d9f9fb3d807ef050bc4ca138e6358130dfe972fcf11aaeaf8bf58d1dd8cdaa0707b165c9afb9c18a00124ced22898259a1fadb9f2827150
+  data.tar.gz: dabd6f5ffdc8cee4127b687838135c19fe8827cef871cd1466836a77c893658f78316e3624d838792c60ee5cfbcd7b0963adb555e9cc53fa7862f2d8123386f7

data/README.md

@@ -1,2 +1,95 @@
 # ruby-sdk
-Ruby SDK for GetTestMail
+
+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
+
+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. To get an API key, sign up for a free [account](https://gettestmail.com).
+
+```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:
+
+```ruby
+message = client.wait_for_message(get_test_mail.id)
+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:
+
+* 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 received by the email address. It has the following attributes:
+
+* 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 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
+
+
+## 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).

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.0
+  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
@@ -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