mslm 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef29e7107da0fc04c7853ede27bb2a9ddd1c5dfb31cb9551a00844f0dfa0f702
-  data.tar.gz: 7cdccfd1a89b0d6f6031eb1175c2c3b5f088ea64ac55985a7ab1f635039c413b
+  metadata.gz: 2d94f857bd5851ae64057c5bbec4cbc08c3d0a6fc8d2604e81f6a060be3d6048
+  data.tar.gz: bd315b955fef052d9d9f07f08afc41443fe7dd62b76e3cea0b7e874b947938fd
 SHA512:
-  metadata.gz: 668881352faa56001656c49981ffa973c3dc00d36c532011fef21eaa6961d6c2a9a1db2628b3eaecc702f35515be9e71b45316dbaa792a4313decc2977efe1c4
-  data.tar.gz: 70d04cacb05f8762e2cf1abbfaab5aa21fd9594de3ff196bb0000780517438d31701386cda1b401806d4e9f99e04fa0130ea0df68697f8944d7e09c3293d482b
+  metadata.gz: a8103350a873165f4a36d2a2b637e732188bb5ac773619f8550e0664d25201f691af650fd79c0bf7482f8c30a55c33a72b2d27ce83f65dc6ccf928f1c06cb373
+  data.tar.gz: '06628bbf04c38b2a15838a02cfde5ad0bfd7fb01de8e69801f9e19bb6742eefd38678c7a20af16a781d717dca6f62ff6df3e849b86689f47abdebc235a06d071'

data/lib/mslm/email_verify.rb

@@ -0,0 +1,80 @@
+
+
+require 'json'
+require_relative 'lib'
+require_relative 'req_opts'
+require_relative 'mslm_errors'
+require_relative 'single_verify_resp'
+
+module Mslm
+  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)
+    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
+
+    # Performs a single email verification with optional request options.
+    def single_verify(email, 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 = { '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 
+    end
+  end
+end

data/lib/mslm/lib.rb

@@ -0,0 +1,80 @@
+require 'json'
+require 'uri'
+require 'net/http'
+
+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('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)
+
+    qp['apikey'] = opt.api_key
+
+    t_url = @base_url.dup
+    t_url.path = url_path
+
+    qp_str = URI.encode_www_form(qp)
+    t_url.query = if t_url.query
+                    "#{t_url.query}&#{qp_str}"
+                  else
+                    qp_str
+                  end
+
+    t_url
+  end
+
+  # Makes an HTTP request and returns the response.
+  def req_and_resp(t_url, opt, method = 'GET', data = nil)
+
+    uri = URI.parse(t_url)
+    @http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.scheme == 'https'
+    headers = {}
+
+    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.'
+    end
+
+    response
+  end
+end

data/lib/mslm/mslm_errors.rb

@@ -0,0 +1,25 @@
+
+# Base class for errors     
+class MslmError < StandardError
+  attr_reader :code, :message
+
+  # 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
+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
+end

data/lib/mslm/otp.rb

@@ -1,52 +1,111 @@
-
-require_relative '../mslm'
-require_relative './constants/constants.rb'
+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
-    module Otp
-    include Constants
 
-        class SingleVerifyReqOpts
-            attr_accessor :disable_url_encode
-            attr_accessor :api_key
+    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
 
-        class Otp_send_verify
+        # 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
 
-            def send_otp(otp_send_req, opts = nil)
+            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']
+            }
 
-                opt = SingleVerifyReqOpts.new
-                opt = opts.last unless opts.nil? || opts.empty?
-                qp ={}
-                if Mslm.api_key || opt.api_key
-                    api_key = opt.api_key || Mslm.api_key
-                    qp['apikey'] = api_key
-                end
 
-                t_url = Mslm::Constants.prepare_url(Mslm::EmailVerification::BASE_URL + 'api/otp/v1/send', qp, opt)
+            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']
 
-                otp_send_resp = Mslm::Constants.req_and_resp('POST', t_url, otp_send_req, opt)
-                return otp_send_resp
+            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
 
-            def verify(otp_token_verify_req, opts = nil)
-                opt = SingleVerifyReqOpts.new
-                opt = opts.last unless opts.nil? || opts.empty?
-                opt.disable_url_encode = true if opt.disable_url_encode.nil?
+            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"]
+            }
 
-                qp = {}
-                if Mslm.api_key || opt.api_key
-                    api_key = opt.api_key || Mslm.api_key
-                    qp['apikey'] = api_key
-                end
+            t_url = @lib.prepare_url('/api/otp/v1/token_verify', {}, opt)
 
-                t_url = Mslm::Constants.prepare_url(Mslm::EmailVerification::BASE_URL + 'api/otp/v1/token_verify', qp, 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']
 
-                otp_token_verify_resp = Mslm::Constants.req_and_resp('POST', t_url, otp_token_verify_req, opt)
-                return otp_token_verify_resp
+            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
     end
-end
+end
+
+

data/lib/mslm/otp_resp.rb

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,10 @@
+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/req_opts.rb

@@ -0,0 +1,57 @@
+require 'uri'
+require 'net/http'
+
+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
+    end
+
+    # Builds and returns an instance of ReqOpts.
+    def build
+      @opts
+    end
+  end
+end

data/lib/mslm/single_verify_resp.rb

@@ -0,0 +1,33 @@
+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
+    "SingleVerifyResp{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

@@ -0,0 +1,26 @@
+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

data/lib/mslm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mslm
-  VERSION = "2.1.1"
+  VERSION = "2.2.1"
 end

data/lib/mslm.rb

@@ -1,13 +1,14 @@
+require_relative './mslm/otp'
 require_relative './mslm/email_verify'
-# require_relative './mslm/otp'
+
 
 module Mslm
   class << self
-    attr_reader :email_verify, :otp
+    attr_accessor :email_verify, :otp
 
     def initialize(api_key)
       @email_verify = EmailVerify.new(api_key)
-      # @otp = Otp.new(api_key)
+      @otp = Otp.new(api_key)
     end
   end
 end

data/mslm.gemspec

@@ -19,21 +19,11 @@ Gem::Specification.new do |spec|
   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/constants/constants.rb",
-    "lib/mslm/email_verification.rb",
-    "sig/mslm.rbs",
-    "test/email_verification_test.rb",
-    "CODE_OF_CONDUCT.md"
-  ]
-
-
   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])
-        excluded_files.include?(f)
+        # excluded_files.include?(f)
     end
   end
   spec.bindir = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mslm
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Sahal Abdullah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-04-23 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,20 +19,24 @@ 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/otp_verification_test.rb
 homepage: https://github.com/mslmio/sdk-ruby
 licenses:
 - MIT

data/Gemfile

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

data/bin/console

@@ -1,11 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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/test/otp_verification_test.rb

@@ -1,40 +0,0 @@
-
-
-require 'minitest/autorun'
-require_relative '../lib/mslm/otp'
-
-class OtpTest < Minitest::Test
-  def setup
-    @otp= Mslm::Otp::Otp_send_verify.new
-
-  end
-
-  def test_valid_otp_send
-    c = Mslm.init("YOUR_API_KEY")
-    expected_response = {
-    "code" => 1000,
-    "msg"=> "Successfully sent SMS."
-    }
-    phone_number = "+92334455112"
-    otp_send_req = {
-      "phone" => phone_number,
-      "tmpl_sms" => "Your verification code is {112233}",
-      "token_len" => 6,
-      "expire_seconds" => 300
-    }
-    response = @otp.send_otp(otp_send_req)
-    assert_equal expected_response, response  
-  end
-
-  def test_valid_otp_verification
-    phone_number = "+92334455112"
-    otp_verify_req = {
-      "phone" => phone_number,
-      "token" => "123456",  # Replace with actual OTP received
-      "consume" => true
-    }
-    response = @otp.verify(otp_verify_req)
-    assert_equal "expected_response", response  
-  end
-
-end