mslm 2.2.2 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d01d3592e141bd862ab98967232140481c3c702ffda34b72bdb1b201f587f92
-  data.tar.gz: 2008e73c205721e440db10def0fc785fc5b8621baa53ddb2292d673001f66b2f
+  metadata.gz: f4c36e8dda6b4d3606e0108e0c87b5dbba260a9a032daf246b6d4468d9ef3a12
+  data.tar.gz: 150a1b6af2365d14b05d4a5e7eb7d76a9b3d6cdb36becfa8172019ba3964b982
 SHA512:
-  metadata.gz: 951a533a249f3a2e5a422f97f1f6b12b721a9d29a4b2574b813e2381b747af2607ec69659ff74e588a9415f35127ccfb582460c34eb2c861ca48fdd8f90f5d9c
-  data.tar.gz: b6f9c6214c0820caa3852ec4fb6b7e165ff345b99cd02a7d72ea70c543d7b09aaa66252d86f61dda8a6e14d490ec1fd98647592b44026347b6717139a95e9f23
+  metadata.gz: 8b56b440b888ac432d67a555f328f7453f831c2974df0ed8178c8aac9fded1cd047d47c755f40357fe58c7704950107404da6af1a07aac160d94d460da04c42d
+  data.tar.gz: e4ff21bcda23fdeadff7fa3da75b187024e5d9675d8273687dcc6d5f1f9344d2f942f572283b20e67a977821dfae5f7141b6e036dacfa6816773ac563d7a52a6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mslm.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -1,9 +1,15 @@
 # Mslm Ruby SDK
 
-The official Ruby SDK for Mslm APIs.
+# [<img src="https://avatars.githubusercontent.com/u/50307970?s=200&v=4" alt="Mslm" width="24"/>](https://mslm.io/) IPinfo Ruby Client Library
+
+The official Ruby SDK for Mslm APIs [Mslm.io](https://mslm.io) that enables you to verify email addresses and perform other actions related to email verification, sending and verifying otp.
 
 ## Requirements
 
+Before you start using the Mslm Ruby SDK, ensure that you have the following:
+
+- **Ruby:** The SDK is compatible with Ruby version >= 3.0.0.
+
 ## Authentication
 
 Mslm's APIs require an API key. If you don't have one, please read
@@ -12,73 +18,86 @@ get an API key before continuing.
 
 ## Installation
 
-To install the gem, add the following line to your application's Gemfile:
-
-    $ gem install 'mslm'
+To install the main library, use the following command:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+gem install mslm
+```
 
-    $ bundle nstall
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+require 'mslm'
 
-    $ gem install mslm
+# Initialize the Mslm object with your API key.
+client = Mslm::Mslm.new('api_key')
+```
 
-## Usage
+#### Email Verify
 
-To use the Single Email Verification and otp gem require it in your Ruby code:
+- Single Verify
 
-require 'mslm'
+```ruby
+    response = client.verify_email("fakefake@mslm.io")
 
-## Additional Resources
+    response.status       //fake
+    response.domain       //mslm.io
+    response.malformed    //false
+    response.has_mailbox  //false
+    response.disposable   //false
 
-See the official [API Reference Documentation](https://mslm.io/docs/api) for
-details on each API's actual interface, which is implemented by this SDK.
+```
 
-## Development
+#### OTP
 
-Then, create an instance of the Mslm::EmailVerification::SingleVerifyEmail.new class and use its single_verify method to verify a single email address:
+- Sending an OTP.
 
-c = Mslm.init("YOUR_API_KEY")
+```ruby
+    otp_send_req = {
+        "phone" => "+923214444444",
+        "tmpl_sms" => "Your verification code is {token}",
+        "token_len" => 4,
+        "expire_seconds" => 300,
+    }
 
-verifier = Mslm::EmailVerification::SingleVerifyEmail.new
+    response = client.send_otp(otp_send_req)
 
-response = verifier.single_verify("email@example.com")
+    response.code   //1000
+    respnse.msg     //Successfully sent SMS.
 
-client_test.test_single_verify
+```
 
-With this modification, users can provide their API key either during initialization or after instantiation using the set_api_key method. This gives them the flexibility to use their MSL cloud API key for unlimited hits.
+- Verifying a token.
 
-Sending and Verifying OTPs
+```ruby
+    otp_token_verify_request = {
+        "phone" => "+923214444444",
+        "token" => "123456",
+        "consume" => True,
+    }
 
-# Instantiate the Otp
+    otp_verify_resp = client.verify_otp(otp_verify_req)
 
-otp = Mslm::Otp::Otp_send_verify.new
+    response.code   //1000
+    response.msg    //Successfully verified.
+```
 
-# Sending OTP
+### Error Handling
 
-otp_send_req = {
-"phone" => "+921123454456",
-"tmpl_sms" => "Your verification code is {112233}",
-"token_len" => 4, # Hown much length is required
-"expire_seconds" => 300,
-}
+We expose the following error types in the SDK:
 
-# Verifying OTP
+#### Common Errors
 
-otp_send_resp = otp.send_otp(otp_send_req)
+- `MslmError`: The base error type.
 
-otp_verify_req = {
-"phone" => "+921123454456",
-"token" => "Recieved Token",
-"consume" => true,
-}
+#### Quota-Related Errors
 
-otp_verify_resp = otp.verify(otp_verify_req)
+- `RequestQuotaExceededError`: The request quota has been exceeded.
 
-client = EmailVerification::Client.new
+## Additional Resources
 
-Feel free to incorporate these methods into your Ruby applications for email verification and OTP functionalities.
+See the official [API Reference Documentation](https://mslm.io/docs/api) for
+details on each API's actual interface, which is implemented by this SDK.
 
 ## Contributing
 

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mslm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mslm/email_verify.rb

@@ -1,80 +1,44 @@
-
-
-require 'json'
 require_relative 'lib'
 require_relative 'req_opts'
-require_relative 'mslm_errors'
-require_relative 'single_verify_resp'
-
-module Mslm
-  class EmailVerify
 
+class EmailVerify
     # Class for performing email verification using an API.
     attr_reader :lib
 
     # Initializes an EmailVerify object with an API key.
     def initialize(api_key)
-      @lib = Lib.new(api_key)
+        @lib = Lib.new(api_key)
     end
 
     # Sets the HTTP client to be used for making requests.
     def set_http_client(http_client)
-      @lib.set_http_client(http_client)
+        @lib.set_http_client(http_client)
     end
 
     # Sets the user agent to be used in HTTP requests.
     def set_user_agent(user_agent)
-      @lib.set_user_agent(user_agent)
+        @lib.set_user_agent(user_agent)
     end
 
     # Sets the API key for authentication.
     def set_api_key(api_key)
-      @lib.set_api_key(api_key)
+        @lib.set_api_key(api_key)
     end
 
     # Performs a single email verification with optional request options.
     def single_verify(email, opts = nil)
-      opt = ReqOpts::Builder.new
+        opt = ReqOpts::Builder.new
                             .with_api_key(@lib.api_key)
                             .with_base_url(@lib.base_url)
                             .with_http_client(@lib.http)
                             .with_user_agent(@lib.user_agent)
                             .build
 
+        opt = opts if opts
+        query_params = { 'email' => email }
+        target_url = @lib.prepare_url('/api/sv/v1', query_params, opt)
 
-      opt = opts if opts
-      qp = { 'email' => email }
-
-      t_url = @lib.prepare_url('/api/sv/v1', qp, opt)
-
-      resp = @lib.req_and_resp(t_url, opt)
-      resp_data = JSON.parse(resp.body)
-    
-      email = resp_data['email']
-      username = resp_data['username']
-      domain = resp_data['domain']
-      malformed = resp_data['malformed']
-      suggestion = resp_data['suggestion']
-      status = resp_data['status']
-      has_mailbox = resp_data['has_mailbox']
-      accept_all = resp_data['accept_all']
-      disposable = resp_data['disposable']
-      free = resp_data['free']
-      role = resp_data['role']
-      mx = resp_data['mx']
-
-      status_code = resp.code.to_i
-
-      if status_code == 429
-          return nil, RequestQuotaExceededError.new 
-      elsif status_code != 200
-          return nil, MslmError.new(status_code, 'API request failed')
-      end
-
-      single_verify_resp = SingleVerifyResp.new(email, username, domain, malformed, suggestion, status,
-                                            has_mailbox, accept_all, disposable, free, role, mx)
-
-      single_verify_resp 
+        resp = @lib.req_and_resp(target_url, opt)
+        resp
     end
-  end
 end

data/lib/mslm/lib.rb

@@ -1,80 +1,79 @@
-require 'json'
 require 'uri'
 require 'net/http'
+require_relative 'version'
+require_relative '../mslm'
 
 class Lib
+    # Generic utility class for handling HTTP requests and responses.
+    attr_accessor :api_key, :http, :base_url, :user_agent
+
+    # Initializes a Lib object with an optional API key.
+    def initialize(api_key = "")
+        @api_key = api_key
+        @http = nil
+        @base_url = URI.parse(Mslm::Mslm::BASE_URL)
+        @user_agent = self.class.get_user_agent('mslm')
+    end
 
-  # Generic utility class for handling HTTP requests and responses.
-  attr_accessor :api_key, :http, :base_url, :user_agent
-
-  # Initializes a Lib object with an optional API key.
-  def initialize(api_key = "")
-    @api_key = api_key
-    @http = nil
-    @base_url = URI.parse('https://mslm.io')
-    @user_agent = self.class.get_user_agent('mslm')
-  end
-
-  # Sets the HTTP client for making requests.
-  def set_http_client(http_client)
-    @http = http_client
-  end
-
-  # Sets the base URL for API requests.
-  def set_base_url(base_url_str)
-    @base_url = URI.parse(base_url_str)
-  end
-
-  # Sets the user agent for HTTP requests.
-  def set_user_agent(user_agent)
-    @user_agent = user_agent
-  end
-
-  # Sets the API key for authentication.
-  def set_api_key(api_key)
-    @api_key = api_key
-  end
-
-  # Static method to generate a user agent string.
-  def self.get_user_agent(pkg)
-    "#{pkg}/ruby/2.2.1"
-  end
-
-  # Prepares the URL for making a request.
-  def prepare_url(url_path, qp, opt)
+    # Sets the HTTP client for making requests.
+    def set_http_client(http_client)
+        @http = http_client
+    end
 
-    qp['apikey'] = opt.api_key
+    # Sets the base URL for API requests.
+    def set_base_url(base_url_str)
+        @base_url = URI.parse(base_url_str)
+    end
 
-    t_url = @base_url.dup
-    t_url.path = url_path
+    # Sets the user agent for HTTP requests.
+    def set_user_agent(user_agent)
+        @user_agent = user_agent
+    end
 
-    qp_str = URI.encode_www_form(qp)
-    t_url.query = if t_url.query
-                    "#{t_url.query}&#{qp_str}"
-                  else
-                    qp_str
-                  end
+    # Sets the API key for authentication.
+    def set_api_key(api_key)
+        @api_key = api_key
+    end
 
-    t_url
-  end
+    # Static method to generate a user agent string.
+    def self.get_user_agent(pkg)
+        "#{pkg}/ruby/#{Mslm::VERSION}"
+    end
 
-  # Makes an HTTP request and returns the response.
-  def req_and_resp(t_url, opt, method = 'GET', data = nil)
+    # Prepares the URL for making a request.
+    def prepare_url(url_path, query_params, opt)
+        query_params['apikey'] = opt.api_key
 
-    uri = URI.parse(t_url)
-    @http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true if uri.scheme == 'https'
-    headers = {}
+        target_url = @base_url.dup
+        target_url.path = url_path
+        query_params_str = URI.encode_www_form(query_params)
 
-    if method.upcase == 'GET'
-      response = @http.get(uri.request_uri)
-    elsif method.upcase == 'POST'
-      headers['Content-Type'] = 'application/json'
-      response = @http.post(uri.request_uri,data,headers)
-    else
-      raise ArgumentError, 'Invalid HTTP method. Supported methods are GET and POST.'
+        target_url.query = if target_url.query
+                        "#{target_url.query}&#{query_params_str}"
+                    else
+                        query_params_str
+                    end
+        target_url
     end
 
-    response
-  end
+    # Makes an HTTP request and returns the response.
+    def req_and_resp(target_url, opt, method = 'GET', data = nil)
+        uri = URI.parse(target_url)
+        @http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == 'https'
+        headers = {
+            'User-Agent' => @user_agent,
+        }
+        
+        if method.upcase == 'GET'
+        response = @http.get(uri.request_uri,headers)
+        elsif method.upcase == 'POST'
+        headers['Content-Type'] = 'application/json'
+        response = @http.post(uri.request_uri,data,headers)
+        else
+        raise ArgumentError, 'Invalid HTTP method. Supported methods are GET and POST.'
+        end
+
+        response
+    end
 end

data/lib/mslm/mslm_errors.rb

@@ -1,25 +1,22 @@
-
-# Base class for errors     
 class MslmError < StandardError
-  attr_reader :code, :message
+    attr_reader :code, :message
 
-  # Initializes a new MslmError object with a code and a message
-  def initialize(code, message)
-    @code = code
-    @message = message
-  end
+    # Initializes a new MslmError object with a code and a message
+    def initialize(code, message)
+        @code = code
+        @message = message
+    end
 
-  # Returns a string representation of the error
-  def to_s
-    "Error: code: #{@code}, message: #{@message}"
-  end
+    # Returns a string representation of the error
+    def to_str
+        "Error: code: #{@code}, message: #{@message}"
+    end
 end
 
 # Error raised when the request quota for the API key has been exceeded
-class RequestQuotaExceededError < MslmError
-    
-  # Initializes a new RequestQuotaExceededError object with a default message and code
-  def initialize(message = "Request quota for API key has been exceeded.")
-    super(429, message)
-  end
+class RequestQuotaExceededError < MslmError 
+    # Initializes a new RequestQuotaExceededError object with a default message and code
+    def initialize(message = "Request quota for API key has been exceeded.")
+        super(429, message)
+    end
 end

data/lib/mslm/otp.rb

@@ -1,111 +1,75 @@
-require 'json'
 require_relative 'lib'
 require_relative 'req_opts'
-require_relative 'mslm_errors'
-require_relative 'otp_send_req'
-require_relative 'otp_resp'
-require_relative 'otp_token_verify_req'
-
-module Mslm
-
-    class Otp
-
-        # Class for performing otp using an API.
-        attr_reader :lib
-
-        # Initializes an object with an API key.
-        def initialize(api_key)
-            @lib = Lib.new(api_key)
-        end
-
-        # Sets the HTTP client to be used for making requests.
-        def set_http_client(http_client)
-            @lib.set_http_client(http_client)
-        end
-
-        # Sets the user agent to be used in HTTP requests.
-        def set_user_agent(user_agent)
-            @lib.set_user_agent(user_agent)
-        end
-
-        # Sets the API key for authentication.
-        def set_api_key(api_key)
-            @lib.set_api_key(api_key)
-        end
-
-        # Sends an OTP to the specified phone number with the provided options.
-        def send(otp_req, opts = nil)
-            opt = ReqOpts::Builder.new
-                                .with_api_key(@lib.api_key)
-                                .with_base_url(@lib.base_url)
-                                .with_http_client(@lib.http)
-                                .with_user_agent(@lib.user_agent)
-                                .build
-
-            opt = opts if opts
-            qp = {
-                'phone' => otp_req['phone'],
-                'tmpl_sms' => otp_req['tmpl_sms'],
-                'token_len' => otp_req['token_len'],
-                'expire_seconds' => otp_req['expire_seconds']
-            }
-
-
-            t_url = @lib.prepare_url('/api/otp/v1/send', {}, opt)
-            resp = @lib.req_and_resp(t_url, opt, 'POST', qp.to_json)
-            resp_data = JSON.parse(resp.body)
-
-            code = resp_data['code']
-            msg = resp_data['msg']
-
-            status_code = resp.code.to_i
-
-            if status_code == 429
-                return nil, RequestQuotaExceededError.new
-            elsif status_code != 200
-                return nil, MslmError.new(status_code, resp_data['msg'] || 'API request failed')
-            end
-
-            otp_send_resp = OtpSendResp.new(code,msg)
-            otp_send_resp
-        end
-
-        # Verifies an OTP token for the specified phone number with the provided options.
-        def verify(otp_token_req, opts = nil)
-            opt = ReqOpts::Builder.new
-                                .with_api_key(@lib.api_key)
-                                .with_base_url(@lib.base_url)
-                                .with_http_client(@lib.http)
-                                .with_user_agent(@lib.user_agent)
-                                .build
-
-            opt = opts if opts
-            qp = {
-                'phone' => otp_token_req["phone"],
-                'token' => otp_token_req["token"],
-                'consume' => otp_token_req["consume"]
-            }
-
-            t_url = @lib.prepare_url('/api/otp/v1/token_verify', {}, opt)
-
-            resp = @lib.req_and_resp(t_url, opt, 'POST', qp.to_json)
-            resp_data = JSON.parse(resp.body)
-
-            code = resp_data['code']
-            msg = resp_data['msg']
-
-            status_code = resp.code.to_i
-
-            if status_code == 429
-                return nil, RequestQuotaExceededError.new
-            elsif status_code != 200
-                return nil, MslmError.new(status_code, resp_data['msg'] || 'API request failed')
-            end
-
-            otp_verify_resp = OtpTokenVerifyResp.new(code,msg)
-            otp_verify_resp
-        end
+
+class Otp
+    # Class for performing otp using an API.
+    attr_reader :lib
+
+    # Initializes an object with an API key.
+    def initialize(api_key)
+        @lib = Lib.new(api_key)
+    end
+
+    # Sets the HTTP client to be used for making requests.
+    def set_http_client(http_client)
+        @lib.set_http_client(http_client)
+    end
+
+    # Sets the user agent to be used in HTTP requests.
+    def set_user_agent(user_agent)
+        @lib.set_user_agent(user_agent)
+    end
+
+    # Sets the API key for authentication.
+    def set_api_key(api_key)
+        @lib.set_api_key(api_key)
+    end
+
+    # Sends an OTP to the specified phone number with the provided options.
+    def send(otp_req, opts = nil)
+        opt = ReqOpts::Builder.new
+                            .with_api_key(@lib.api_key)
+                            .with_base_url(@lib.base_url)
+                            .with_http_client(@lib.http)
+                            .with_user_agent(@lib.user_agent)
+                            .build
+
+        opt = opts if opts
+        query_params = {
+            'phone' => otp_req['phone'],
+            'tmpl_sms' => otp_req['tmpl_sms'],
+            'token_len' => otp_req['token_len'],
+            'expire_seconds' => otp_req['expire_seconds']
+        }
+
+        target_url = @lib.prepare_url('/api/otp/v1/send', {}, opt)
+
+        resp = @lib.req_and_resp(target_url, opt, 'POST', query_params.to_json)
+        resp
+    end
+
+    # Verifies an OTP token for the specified phone number with the provided options.
+    def verify(otp_token_req, opts = nil)
+        opt = ReqOpts::Builder.new
+                            .with_api_key(@lib.api_key)
+                            .with_base_url(@lib.base_url)
+                            .with_http_client(@lib.http)
+                            .with_user_agent(@lib.user_agent)
+                            .build
+
+        opt = opts if opts
+        query_params = {
+            'phone' => otp_token_req["phone"],
+            'token' => otp_token_req["token"],
+            'consume' => otp_token_req["consume"]
+        }
+
+        target_url = @lib.prepare_url('/api/otp/v1/token_verify', {}, opt)
+
+        resp = @lib.req_and_resp(target_url, opt, 'POST', query_params.to_json)
+        resp
     end
 end
 
 
+

data/lib/mslm/req_opts.rb

@@ -1,57 +1,54 @@
 require 'uri'
-require 'net/http'
+require_relative '../mslm'
 
 class ReqOpts
-
-  # Request options class for configuring HTTP requests.
-  attr_accessor :api_key, :http, :base_url, :user_agent
-
-  # Initializes a ReqOpts object with default or provided values.
-  def initialize(api_key: "", http: nil, base_url: "https://mslm.io", user_agent: "mslm")
-    
-    @api_key = api_key
-    @http = http
-    @base_url = URI.parse(base_url)
-    @user_agent = user_agent
-  end
-
-  # Nested builder class for constructing instances of ReqOpts.
-  class Builder
-
-    # Builder class for constructing instances of ReqOpts.
-    attr_reader :opts
-
-    def initialize
-      @opts = ReqOpts.new
-    end
-
-    # Sets the API key.
-    def with_api_key(api_key)
-      @opts.api_key = api_key
-      self
-    end
-
-    # Sets the HTTP client.
-    def with_http_client(http)
-      @opts.http = http
-      self
-    end
-
-    # Sets the base URL.
-    def with_base_url(base_url)
-      @opts.base_url = URI.parse(base_url)
-      self
-    end
-
-    # Sets the user agent.
-    def with_user_agent(user_agent)
-      @opts.user_agent = user_agent
-      self
+    # Request options class for configuring HTTP requests.
+    attr_accessor :api_key, :http, :base_url, :user_agent
+
+    # Initializes a ReqOpts object with default or provided values.
+    def initialize(api_key: "", http: nil, base_url: Mslm::Mslm::BASE_URL, user_agent: "mslm")
+        @api_key = api_key
+        @http = http
+        @base_url = URI.parse(base_url)
+        @user_agent = user_agent
     end
 
-    # Builds and returns an instance of ReqOpts.
-    def build
-      @opts
+    # Nested builder class for constructing instances of ReqOpts.
+    class Builder
+        # Builder class for constructing instances of ReqOpts.
+        attr_reader :opts
+
+        def initialize
+            @opts = ReqOpts.new
+        end
+
+        # Sets the API key.
+        def with_api_key(api_key)
+            @opts.api_key = api_key
+            self
+        end
+
+        # Sets the HTTP client.
+        def with_http_client(http)
+            @opts.http = http
+            self
+        end
+
+        # Sets the base URL.
+        def with_base_url(base_url)
+            @opts.base_url = URI.parse(base_url)
+            self
+        end
+
+        # Sets the user agent.
+        def with_user_agent(user_agent)
+            @opts.user_agent = user_agent
+            self
+        end
+
+        # Builds and returns an instance of ReqOpts.
+        def build
+            @opts
+        end
     end
-  end
 end

data/lib/mslm/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Mslm
-  VERSION = "2.2.2"
+    VERSION = "2.2.4"
 end

data/lib/mslm.rb

@@ -1,14 +1,48 @@
+require 'json'
 require_relative './mslm/otp'
 require_relative './mslm/email_verify'
-
+require_relative './mslm/mslm_errors'
+require_relative './mslm/response'
 
 module Mslm
-  class << self
-    attr_accessor :email_verify, :otp
+    class Mslm
+        BASE_URL = "https://mslm.io".freeze
+        attr_accessor :email_verify, :otp
+
+        def initialize(api_key)
+            @email_verify = EmailVerify.new(api_key)
+            @otp = Otp.new(api_key)
+        end
+
+        def verify_email(email, opts = nil)
+            resp = @email_verify.single_verify(email, opts)
+
+            handle_response(resp)  
+        end
+
+        def send_otp(otp_req, opts = nil)
+            resp = @otp.send(otp_req, opts)
+
+            handle_response(resp)  
+        end
+
+        def verify_otp(otp_token_req, opts = nil)
+            resp = @otp.verify(otp_token_req, opts)
+
+            handle_response(resp)  
+        end
+
+        def handle_response(resp)
+            resp_data = JSON.parse(resp.body)
+            status_code = resp.code.to_i
+
+            if status_code == 429
+                return nil, RequestQuotaExceededError.new()
+            elsif status_code != 200
+                return nil, MslmError.new(status_code, 'API request failed')
+            end
 
-    def initialize(api_key)
-      @email_verify = EmailVerify.new(api_key)
-      @otp = Otp.new(api_key)
+            Response.new(resp_data)
+        end
     end
-  end
-end
+end

data/mslm.gemspec

@@ -1,5 +1,3 @@
-
-
 require_relative "lib/mslm/version"
 
 Gem::Specification.new do |spec|
@@ -14,17 +12,24 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/mslmio/sdk-ruby"
   spec.metadata["changelog_uri"] = "https://github.com/mslmio/sdk-ruby/blob/main/CHANGELOG.md"
 
+  EXCLUDED_FILES = [
+  "lib/mslm/otp_resp.rb",
+  "lib/mslm/otp_send_req.rb",
+  "lib/mslm/otp_token_verify_req.rb",
+  "lib/mslm/single_verify_resp.rb",
+  "lib/mslm/single_verify_resp_mx.rb"
+]
+
+
   spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
-    end
+    all_files = `git ls-files -z`.split("\x0")
+    all_files.reject { |file| EXCLUDED_FILES.include?(file) }
   end
+
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/test/email_verify_test.rb

@@ -0,0 +1,82 @@
+require 'minitest/autorun'
+require_relative '../lib/mslm'
+
+class TestEmailVerification < Minitest::Test
+    TEST_EMAIL_REAL = 'support@mslm.io'
+    TEST_EMAIL_FAKE = 'fakefakefake@mslm.io'
+    TEST_EMAIL_DISPOSABLE = 'asdfasdf@temp-mail.org'
+
+    def setup
+        @api_key = 'api_key'
+        @email_verify = Mslm::Mslm.new(@api_key)
+    end
+
+    def test_email_verify_sv_fake
+        resp, _ = @email_verify.verify_email(TEST_EMAIL_REAL)
+        assert_email_verify_sv_REAL(resp)
+    end
+
+    def assert_email_verify_sv_REAL(resp)
+        assert_equal(resp.email, TEST_EMAIL_REAL)
+        assert_equal(resp.username, 'support')
+        assert_equal(resp.domain, 'mslm.io')
+        assert_equal(resp.malformed, false)
+        assert_equal(resp.suggestion, '')
+        assert_equal(resp.status, 'real')
+        assert_equal(resp.has_mailbox, true)
+        assert_equal(resp.accept_all, false)
+        assert_equal(resp.disposable, false)
+        assert_equal(resp.free, false)
+        assert_equal(resp.role, true)
+        assert_equal(resp.mx, [[{"host"=>"mx.yandex.net.", "pref"=>10}]])
+    end
+
+    def test_email_verify_sv_fake
+        resp, _ = @email_verify.verify_email(TEST_EMAIL_FAKE)
+        assert_email_verify_sv_fake(resp)
+    end
+
+    def assert_email_verify_sv_fake(resp)
+        assert_equal(resp.email, TEST_EMAIL_FAKE)
+        assert_equal(resp.username, 'fakefakefake')
+        assert_equal(resp.domain, 'mslm.io')
+        assert_equal(resp.malformed, false)
+        assert_equal(resp.suggestion, '')
+        assert_equal(resp.status, 'fake')
+        assert_equal(resp.has_mailbox, false)
+        assert_equal(resp.accept_all, false)
+        assert_equal(resp.disposable, false)
+        assert_equal(resp.free, false)
+        assert_equal(resp.role, false)
+        assert_equal(resp.mx, [
+                    {"host"=>"ASPMX.L.GOOGLE.COM.", "pref"=>1}, 
+                    {"host"=>"ALT2.ASPMX.L.GOOGLE.COM.", "pref"=>5}, 
+                    {"host"=>"ALT1.ASPMX.L.GOOGLE.COM.", "pref"=>5}, 
+                    {"host"=>"ALT4.ASPMX.L.GOOGLE.COM.", "pref"=>10}, 
+                    {"host"=>"ALT3.ASPMX.L.GOOGLE.COM.", "pref"=>10}
+        ])
+    end
+
+    def test_email_verify_sv_disposable
+        resp, _ = @email_verify.verify_email(TEST_EMAIL_DISPOSABLE)
+        assert_email_verify_sv_disposable(resp)
+    end
+
+    def assert_email_verify_sv_disposable(resp)
+        assert_equal(resp.email, TEST_EMAIL_DISPOSABLE)
+        assert_equal(resp.username, 'asdfasdf')
+        assert_equal(resp.domain, 'temp-mail.org')
+        assert_equal(resp.malformed, false)
+        assert_equal(resp.suggestion, '')
+        assert_equal(resp.status, 'disposable')
+        assert_equal(resp.has_mailbox, true)
+        assert_equal(resp.accept_all, true)
+        assert_equal(resp.disposable, true)
+        assert_equal(resp.free, true)
+        assert_equal(resp.role, false)
+        assert_equal(resp.mx, [{"host"=>"mx.yandex.net.", "pref"=>10}])
+    end
+end
+
+
+

data/test/otp_send_test.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require_relative '../lib/mslm'
+
+class TestOtp < Minitest::Test
+
+    def setup
+        @api_key = 'api_key'
+        @otp = Mslm::Mslm.new(@api_key)
+        @phone_number = '+923214444444'
+    end
+
+    def test_otp_send_success
+        otp_send_req = {
+            "phone" => @phone_number,
+            "tmpl_sms" => "Your verification code is {token}",
+            "token_len" => 4,
+            "expire_seconds" => 300,
+        }
+
+        otp_send_resp = @otp.send_otp(otp_send_req)
+        
+        assert_equal(1000, otp_send_resp.code)
+        assert_equal("Successfully sent SMS.", otp_send_resp.msg)
+    end
+end

data/test/otp_verify_test.rb

@@ -0,0 +1,27 @@
+require 'minitest/autorun'
+require_relative '../lib/mslm'
+
+class TestOtp < Minitest::Test
+
+    def setup
+        @api_key = 'api_key'
+        @otp = Mslm::Mslm.new(@api_key)
+        @phone_number = '+923214444444'
+    end
+
+    def test_otp_verify_success
+        otp_code = '9842'
+        
+        otp_verify_req = {
+            "phone" => @phone_number,
+            "token" => otp_code,
+            "consume" => true,
+        }
+
+        otp_verify_resp = @otp.verify_otp(otp_verify_req)
+        
+        assert_equal(1000, otp_verify_resp.code)
+        assert_equal("Successfully verified.", otp_verify_resp.msg)
+    end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mslm
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.4
 platform: ruby
 authors:
 - Sahal Abdullah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-02 00:00:00.000000000 Z
 dependencies: []
 description: RubyGem offering email verification and OTP (One-Time Password) generation
   and verification capabilities. Seamlessly integrate email verification and OTP functionality
@@ -19,24 +19,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/mslm.rb
 - lib/mslm/email_verify.rb
 - lib/mslm/lib.rb
 - lib/mslm/mslm_errors.rb
 - lib/mslm/otp.rb
-- lib/mslm/otp_resp.rb
-- lib/mslm/otp_send_req.rb
-- lib/mslm/otp_token_verify_req.rb
 - lib/mslm/req_opts.rb
-- lib/mslm/single_verify_resp.rb
-- lib/mslm/single_verify_resp_mx.rb
 - lib/mslm/version.rb
 - mslm.gemspec
+- test/email_verify_test.rb
+- test/otp_send_test.rb
+- test/otp_verify_test.rb
 homepage: https://github.com/mslmio/sdk-ruby
 licenses:
 - MIT

data/lib/mslm/otp_resp.rb

@@ -1,30 +0,0 @@
-class OtpResp
-  attr_reader :code, :msg
-
-  # Constructor method to initialize OtpResp object.
-  def initialize(code, msg)
-    @code = code
-    @msg = msg
-  end
-
-  # String representation of OtpResp object.
-  def to_s
-    "{code='#{@code}', message='#{@msg}'}"
-  end
-end
-
-class OtpSendResp < OtpResp
-
-  # String representation of OtpSendResp object.
-  def to_s
-    "{code='#{@code}', message='#{@msg}'}"
-  end
-end
-
-class OtpTokenVerifyResp < OtpResp
-    
-  # String representation of OtpTokenVerifyResp object.
-  def to_s
-    "{code='#{@code}', message='#{@msg}'}"
-  end
-end

data/lib/mslm/otp_send_req.rb

@@ -1,11 +0,0 @@
-class OtpSendReq
-  attr_reader :phone, :tmpl_sms, :token_len, :expire_seconds
-
-  # Constructor method to initialize OtpSendReq object.
-  def initialize(phone, tmpl_sms, token_len, expire_seconds)
-    @phone = phone
-    @tmpl_sms = tmpl_sms
-    @token_len = token_len
-    @expire_seconds = expire_seconds
-  end
-end

data/lib/mslm/otp_token_verify_req.rb

@@ -1,10 +0,0 @@
-class OtpTokenVerifyReq
-    attr_reader :phone, :token, :consume
-
-    # Constructor method to initialize OtpTokenVerifyReq object.
-    def initialize(phone, token, consume)
-        @phone = phone
-        @token = token
-        @consume = consume
-    end
-end

data/lib/mslm/single_verify_resp.rb

@@ -1,33 +0,0 @@
-require_relative 'single_verify_resp_mx'
-
-class SingleVerifyResp
-  # Data class representing the response of a single email verification.
-
-  attr_reader :email, :username, :domain, :malformed, :suggestion, :status,
-              :has_mailbox, :accept_all, :disposable, :free, :role, :mx
-
-  # Initializes a SingleVerifyResp object with provided attributes.
-  def initialize(email, username, domain, malformed, suggestion, status, has_mailbox,
-                 accept_all, disposable, free, role, mx)
-    @email = email
-    @username = username
-    @domain = domain
-    @malformed = malformed
-    @suggestion = suggestion
-    @status = status
-    @has_mailbox = has_mailbox
-    @accept_all = accept_all
-    @disposable = disposable
-    @free = free
-    @role = role
-    @mx = mx
-  end
-
-  # Returns a string representation of the SingleVerifyResp object.
-  def to_s
-    "{email='#{@email}', username='#{@username}', domain='#{@domain}', " \
-    "malformed=#{@malformed}, suggestion='#{@suggestion}', status='#{@status}', " \
-    "has_mailbox=#{@has_mailbox}, accept_all=#{@accept_all}, disposable=#{@disposable}, " \
-    "free=#{@free}, role=#{@role}, mx=#{@mx}}"
-  end
-end

data/lib/mslm/single_verify_resp_mx.rb

@@ -1,26 +0,0 @@
-class SingleVerifyRespMx
-  # Data class representing Mail Exchange (MX) records in the response of a single email verification.
-
-  attr_reader :host, :pref
-
-  # Initializes a SingleVerifyRespMx object with host and preference values.
-  def initialize(host, pref)
-    @host = host
-    @pref = pref
-  end
-
-  # Returns a string representation of the SingleVerifyRespMx object.
-  def to_s
-    "{host='#{@host}', pref=#{@pref}}"
-  end
-
-  # Returns the host or domain name of the mail server.
-  def get_host
-    @host
-  end
-
-  # Returns the preference value indicating the priority of the mail server.
-  def get_pref
-    @pref
-  end
-end