mailinator_client 1.0.3 → 1.0.5

data/lib/mailinator_client/authenticators.rb

@@ -0,0 +1,165 @@
+# The MIT License (MIT)
+#
+# 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "json"
+
+module MailinatorClient
+
+  # Class containing all the actions for the Authenticators Resource
+  class Authenticators
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Instant TOTP 2FA code
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} totpSecretKey - totp secret key
+    #
+    # Responses:
+    # *  Instant TOTP 2FA Code info (https://manybrain.github.io/m8rdocs/#instant-totp-2fa-code)
+    def instant_totp_2fa_code(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("totpSecretKey is required") unless params.has_key?(:totpSecretKey)
+
+      path = "/totp/#{params[:totpSecretKey]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetch Authenticators
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of passcodes (https://manybrain.github.io/m8rdocs/#fetch-authenticators)
+    def get_authenticators()
+      query_params = {}
+      headers = {}
+      body = nil
+
+      path = "/authenticators"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # Fetch the TOTP 2FA code from one of your saved Keys
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} id - authenticator id
+    #
+    # Responses:
+    # *  Authenticator (https://manybrain.github.io/m8rdocs/#fetch-authenticators-by-id)
+    def get_authenticators_by_id(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("id is required") unless params.has_key?(:id)
+
+      path = "/authenticators/#{params[:id]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+    # Fetch Authenticator
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Responses:
+    # *  Collection of passcodes (https://manybrain.github.io/m8rdocs/#fetch-authenticator)
+    def get_authenticator()
+      query_params = {}
+      headers = {}
+      body = nil
+
+      path = "/authenticator"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+
+    # Fetch Authenticator By Id
+    #
+    # Authentication:
+    # The client must be configured with a valid api
+    # access token to call this action.
+    #
+    # Parameters:
+    # *  {string} id - authenticator id
+    #
+    # Responses:
+    # *  Authenticator (https://manybrain.github.io/m8rdocs/#fetch-authenticator-by-id)
+    def get_authenticator_by_id(params = {})
+      query_params = {}
+      headers = {}
+      body = nil
+
+      raise ArgumentError.new("id is required") unless params.has_key?(:id)
+
+      path = "/authenticator/#{params[:id]}"
+
+      response = @client.request(
+        method: :get,
+        path: path,
+        query: query_params,
+        headers: headers,
+        body: body)
+    end
+    
+  end
+end

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