mailinator_client 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53dfb086987aa73902e4b5a513da720b17069e6fe0e376f5f7e39b5dc0e3ef08
-  data.tar.gz: 67c036c5ba409c62a1357f2e1f2217632b6bccf7087c2959fadda5bdb2793b4e
+  metadata.gz: a3e1ec11068d686d886639d80e6a17e17fd991341367ad61f929990d61724ffa
+  data.tar.gz: 07e57ad2cb1d9ebf07bcf785b5a61ee5e8627225eac1cff501d65767e5ad1edf
 SHA512:
-  metadata.gz: 9ba71db113ef295a23eee44d38e13470c9d7e2adc8fd85aa1dc2028f15455a9a5a283883666e9a32afe2d8fa583ec0cb0c0c833bf1da0f6073d1f9926b077da7
-  data.tar.gz: 12527e9e153589ee1a8909c0c9390cafff8b357715318a081a70dbb53d14b5c6a234824bc7ee7e6cdab6d481096e6d9ec050a5ca6bea9571ef9c69de0c7c1cc7
+  metadata.gz: 9900dcb42cd529cf13e37ebf6cec0a3f06a6a31d5efd712f460d39c243ac55606d40ba2b186d9a80d373142bef38e6e0400b61f58051f2755e2e4c716b528eff
+  data.tar.gz: b31c3de9304ed10adebb2e21a1693be58bc0141c79bf741538b235650e0a4b740dc69c029d4b3653088ea663870ed9c7d9ec58f9bfc38236ac8f25691351383f

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.6

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Manybrain, Inc.
+Copyright (c) 2024 Manybrain, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -45,6 +45,9 @@ The ``Client()`` initializer takes the following arguments:
 
 Each of the following is a method on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.
 
+* [authenticators](docs/authenticators.md)  
+  Contains all of the actions that can be performed against the set of [Authenticators](https://manybrain.github.io/m8rdocs/#authenticators-api) that the currently authenticated user has access to - such as listing the authenticators.
+
 * [domains](docs/domains.md)  
   Contains all of the actions that can be performed against the set of [Domains](https://manybrain.github.io/m8rdocs/#domains-api) that the currently authenticated user has access to - such as listing the domains.
 
@@ -56,6 +59,9 @@ Each of the following is a method on the client object, and returns a wrapper fo
 
 * [messages](docs/messages.md)  
   Contains all of the actions that can be performed against the set of [Messages](https://manybrain.github.io/m8rdocs/#message-api) that the currently authenticated user has access to - such as listing the messages or injecting a new message.
+  
+* [webhooks](docs/webhooks.md)  
+  Contains all of the actions that can be performed against the set of [Webhooks](https://manybrain.github.io/m8rdocs/#webhooks-api) that the currently user has access to - such as listing the webhooks.
 
 <br/>
 
@@ -92,10 +98,16 @@ Most of the tests require env variables with valid values. Visit tests source co
 * `MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
 * `MAILINATOR_TEST_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
 * `MAILINATOR_TEST_DELETE_DOMAIN` - don't use it unless you are 100% sure what you are doing
+* `MAILINATOR_TEST_WEBHOOKTOKEN_PRIVATEDOMAIN` - private domain for webhook token
+* `MAILINATOR_TEST_WEBHOOKTOKEN_CUSTOMSERVICE` - custom service for webhook token
+* `MAILINATOR_TEST_AUTH_SECRET` - authenticator secret
+* `MAILINATOR_TEST_AUTH_ID` - authenticator id
+* `MAILINATOR_TEST_WEBHOOK_INBOX` - inbox for webhook
+* `MAILINATOR_TEST_WEBHOOK_CUSTOMSERVICE` - custom service for webhook
 
 
 *****
 
-Copyright (c) 2020 Manybrain, Inc
+Copyright (c) 2024 Manybrain, Inc
 
 <https://www.mailinator.com/>

data/docs/domains.md

@@ -6,6 +6,8 @@ Details on the various actions that can be performed on the Domains resource, in
 
 *   [GetDomains](#getdomains)
 *   [GetDomain](#getdomain)
+*   [CreateDomain](#createdomain)
+*   [DeleteDomain](#deletedomain)
 
 <br/>
 
@@ -30,3 +32,27 @@ result = client.domains.get_domain(domainId: my_domain_id)
 
 puts result
 ```
+
+<br/>
+
+## CreateDomain
+
+This endpoint creates a private domain attached to your account. Note, the domain must be unique to the system and you must have not reached your maximum number of Private Domains.
+
+```ruby
+result = client.domains.create_domain(domainId: my_domain_id)
+
+puts result
+```
+
+<br/>
+
+## DeleteDomain
+
+This endpoint deletes a Private Domain
+
+```ruby
+result = client.domains.delete_domain(domainId: my_domain_id)
+
+puts result
+```

data/docs/messages.md

@@ -5,15 +5,25 @@ Details on the various actions that can be performed on the Messages resource, i
 ##### Contents
 
 *   [FetchInbox](#fetchinbox)
+*   [FetchInboxMessage](#fetchinboxmessage)
 *   [FetchMessage](#fetchmessage)
 *   [FetchSMSMessage](#fetchsmsmessage)
-*   [FetchAttachments](#fetchattachments)
-*   [FetchAttachment](#fetchattachment)
+*   [FetchInboxMessageAttachments](#fetchinboxmessageattachments)
+*   [FetchMessageAttachments](#fetchmessageattachments)
+*   [FetchInboxMessageAttachment](#fetchinboxmessageattachment)
+*   [FetchMessageAttachment](#fetchmessageattachment)
 *   [FetchMessageLinks](#fetchmessagelinks)
+*   [FetchInboxMessageLinks](#fetchinboxmessagelinks)
 *   [DeleteAllDomainMessages](#deletealldomainmessages)
 *   [DeleteAllInboxMessages](#deleteallinboxmessages)
 *   [DeleteMessage](#deletemessage)
-*   [InjectMessage](#injectmessage)
+*   [PostMessage](#postmessage)
+*   [FetchMessageSmtpLog](#fetchmessagesmtplog)
+*   [FetchInboxMessageSmtpLog](#fetchinboxmessagesmtplog)
+*   [FetchMessageRaw](#fetchmessageraw)
+*   [FetchInboxMessageRaw](#fetchinboxmessageraw)
+*   [FetchLatestMessages](#fetchlatestmessages)
+*   [FetchLatestInboxMessages](#fetchlatestinboxmessages)
 
 <br/>
 
@@ -35,12 +45,12 @@ puts result
 
 <br/>
 
-## FetchMessage
+## FetchInboxMessage
 
-Retrieves a specific message by id
+Retrieves a specific message by id for specific inbox
 
 ```ruby
-result = client.messages.fetch_inbox(
+result = client.messages.fetch_inbox_message(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -50,6 +60,19 @@ puts result
 
 <br/>
 
+## FetchMessage
+
+Retrieves a specific message by id
+
+```ruby
+result = client.messages.fetch_message(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
 
 ## FetchSMSMessage
 
@@ -67,12 +90,12 @@ puts result
 <br/>
 
 
-## FetchAttachments
+## FetchInboxMessageAttachments
 
-Retrieves a list of attachments for a message
+Retrieves a list of attachments for a message for specific inbox
 
 ```ruby
-result = client.messages.fetch_attachments(
+result = client.messages.fetch_inbox_message_attachments(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -82,13 +105,27 @@ puts result
 
 <br/>
 
+## FetchMessageAttachments
 
-## FetchAttachment
+Retrieves a list of attachments for a message
 
-Retrieves a specific attachment
+```ruby
+result = client.messages.fetch_message_attachments(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchInboxMessageAttachment
+
+Retrieves a specific attachment for specific inbox
 
 ```ruby
-result = client.messages.fetch_attachment(
+result = client.messages.fetch_inbox_message_attachment(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id
@@ -99,6 +136,21 @@ puts result
 
 <br/>
 
+## FetchMessageAttachment
+
+Retrieves a specific attachment
+
+```ruby
+result = client.messages.fetch_message_attachment(
+  domainId: my_domain_id
+  messageId: my_message_id
+  attachmentId: my_attachment_id)
+
+puts result
+```
+
+<br/>
+
 
 ## FetchMessageLinks
 
@@ -106,6 +158,20 @@ Retrieves all links found within a given email
 
 ```ruby
 result = client.messages.fetch_message_links(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageLinks
+
+Retrieves all links found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_links(
   domainId: my_domain_id
   inbox: my_inbox
   messageId: my_message_id)
@@ -162,15 +228,105 @@ puts result
 <br/>
 
 
-## InjectMessage
+## PostMessage
 
 Deliver a JSON message into your private domain
 
 ```ruby
-result = client.messages.inject_message(
+result = client.messages.post_message(
   domainId: my_domain_id
   inbox: my_inbox
   messageToPost: my_message_to_post)
 
 puts result
 ```
+
+<br/>
+
+
+## FetchMessageSmtpLog
+
+Retrieves all smtp log found within a given email
+
+```ruby
+result = client.messages.fetch_message_smtp_log(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageSmtpLog
+
+Retrieves all smtp log found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_smtp_log(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchMessageRaw
+
+Retrieves all raw data found within a given email
+
+```ruby
+result = client.messages.fetch_message_raw(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchInboxMessageLinks
+
+Retrieves all raw data found within a given email for specific inbox
+
+```ruby
+result = client.messages.fetch_inbox_message_raw(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchLatestMessages
+
+That fetches the latest 5 FULL messages
+
+```ruby
+result = client.messages.fetch_latest_messages(
+  domainId: my_domain_id
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+## FetchLatestInboxMessages
+
+That fetches the latest 5 FULL messages for specific inbox
+
+```ruby
+result = client.messages.fetch_latest_inbox_messages(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```

data/lib/mailinator_client/client.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# Copyright (c) 2024 Manybrain, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -23,6 +23,7 @@
 require "httparty"
 
 module MailinatorClient
+  require_relative 'version'
   # Mailinator API
   #
   # User API for accessing Mailinator data
@@ -31,7 +32,11 @@ module MailinatorClient
 
     def initialize(options = {})
       @auth_token = options.fetch(:auth_token, nil)
-      @url        = "https://mailinator.com/api/v2"
+      @url        = "https://api.mailinator.com/api/v2"
+    end
+
+    def authenticators
+      @authenticators ||= Authenticators.new(self)
     end
 
     def domains
@@ -50,12 +55,17 @@ module MailinatorClient
       @rules ||= Rules.new(self)
     end
 
+    def webhooks
+      @webhooks ||= Webhooks.new(self)
+    end
+
     def request(options = {})
       headers = options.fetch(:headers, {})
       method  = options.fetch(:method, :get)
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
+      headers["User-Agent"]   = "Mailinator SDK - Ruby V#{MailinatorClient::VERSION}"
       headers["Authorization"]  = @auth_token if @auth_token
       path = @url + options.fetch(:path, "")
 

data/lib/mailinator_client/domains.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# Copyright (c) 2024 Manybrain, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -83,5 +83,64 @@ module MailinatorClient
         body: body)
     end
 
+    # This endpoint creates a private domain attached to your account. 
+    # Note, the domain must be unique to the system and you must have not reached your maximum number of Private Domains.
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#create-domain)
+    def create_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+
+      path = "/domains/#{params[:domainId]}"
+
+      @client.request(
+        method: :post,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # This endpoint deletes a Private Domain
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} domainId - The Domain name or the Domain id
+    #
+    # Responses:
+    # *  Status (https://manybrain.github.io/m8rdocs/#delete-domain)
+    def delete_domain(params = {})
+      params = Utils.symbolize_hash_keys(params)
+      query_params = { }
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("domain id is required") unless params.has_key?(:domainId)
+
+      path = "/domains/#{params[:domainId]}"
+
+      @client.request(
+        method: :delete,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
   end
 end

data/lib/mailinator_client/error.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2020 Manybrain, Inc.
+# Copyright (c) 2024 Manybrain, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal