mslm 2.2.4 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c36e8dda6b4d3606e0108e0c87b5dbba260a9a032daf246b6d4468d9ef3a12
-  data.tar.gz: 150a1b6af2365d14b05d4a5e7eb7d76a9b3d6cdb36becfa8172019ba3964b982
+  metadata.gz: 4cbaebc5d95ab0d0bc3735105da04d7d0e087d3777b6fbe6e3f28de363decf66
+  data.tar.gz: 53ac68812e798111f9d9ef2cb1de184c99a696758be8652f99d7555b55e3d36e
 SHA512:
-  metadata.gz: 8b56b440b888ac432d67a555f328f7453f831c2974df0ed8178c8aac9fded1cd047d47c755f40357fe58c7704950107404da6af1a07aac160d94d460da04c42d
-  data.tar.gz: e4ff21bcda23fdeadff7fa3da75b187024e5d9675d8273687dcc6d5f1f9344d2f942f572283b20e67a977821dfae5f7141b6e036dacfa6816773ac563d7a52a6
+  metadata.gz: cd75ecb51e47cde473bc40e7346b58a7c689f25c254c283f7a585ee2d028e302b44c9f2d830cc660cbbed5081cdf6beb6e38bb77f51f1ae68ada06b54eb48626
+  data.tar.gz: 909f92dafd63f0409711dfc5267a4fcd315d509e98f4faa3741a2ea1048d3a96939e78c68e142b81aa2e3c4acdc96b0d8152fd00ce334e2d6e50cc26cbf6d60a

data/lib/mslm/response.rb

@@ -0,0 +1,14 @@
+class Response
+    attr_reader :all
+
+    def initialize(response)
+        @all = response
+
+        @all.each do |name, value|
+            instance_variable_set("@#{name}", value)
+
+            c = class << self; self end
+            c.send(:attr_accessor, name)
+        end
+    end
+end

data/lib/mslm/version.rb

@@ -1,3 +1,3 @@
 module Mslm
-    VERSION = "2.2.4"
+    VERSION = "2.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mslm
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.2.5
 platform: ruby
 authors:
 - Sahal Abdullah
@@ -19,26 +19,14 @@ 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/req_opts.rb
-- lib/mslm/version.rb
-- mslm.gemspec
-- test/email_verify_test.rb
-- test/otp_send_test.rb
-- test/otp_verify_test.rb
+- "./lib/mslm.rb"
+- "./lib/mslm/email_verify.rb"
+- "./lib/mslm/lib.rb"
+- "./lib/mslm/mslm_errors.rb"
+- "./lib/mslm/otp.rb"
+- "./lib/mslm/req_opts.rb"
+- "./lib/mslm/response.rb"
+- "./lib/mslm/version.rb"
 homepage: https://github.com/mslmio/sdk-ruby
 licenses:
 - MIT

data/CONTRIBUTING.md

@@ -1,154 +0,0 @@
-# Contributing
-
-Thanks for taking the time to contribute!
-
-All types of contributions are encouraged and valued. Please try to read the
-relevant sections in this document before making your contribution. It will
-make it a lot easier for us maintainers and smooth out the experience for all
-involved. The community looks forward to your contributions.
-
-> And if you like the project, but just don't have time to contribute, that's
-> fine. There are other easy ways to support the project and show your
-> appreciation, which we would also be very happy about:
-> - Star the project
-> - Post about it on social media
-> - Refer this project in your own project's README
-> - Mention the project at local meetups and tell your friends/colleagues
-
-## I Have a Question
-
-> Please ensure you've already read the available
-> [Documentation](https://mslm.io/docs/api/libraries/ruby), which may have
-> answered your question.
-
-Before you ask a question, it is best to search for existing
-[Issues](https://github.com/mslmio/sdk-ruby/issues) that might help you. In
-case you have found a suitable issue and still need clarification, you can
-write your question in this issue. It is also advisable to search the internet
-for answers first.
-
-If you then still feel the need to ask a question and need clarification, we
-recommend the following:
-
-- Open an [Issue](https://github.com/mslmio/sdk-ruby/issues/new).
-- Provide as much context as you can about what you're running into.
-- Provide project and platform versions (nodejs, npm, etc), depending on what
-  seems relevant.
-
-We will then take care of the issue as soon as possible.
-
-## I Want To Contribute
-
-> ### Legal Notice
->
-> When contributing to this project, you must agree that you have authored 100%
-> of the content, that you have the necessary rights to the content and that
-> the content you contribute may be provided under the project licence.
-
-### Reporting Bugs
-
-#### Before Submitting a Bug Report
-
-A good bug report shouldn't leave others needing to chase you up for more
-information. Therefore, we ask you to investigate carefully, collect
-information and describe the issue in detail in your report. Please complete
-the following steps in advance to help us fix any potential bug as fast as
-possible.
-
-- Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g.
-  using incompatible environment components/versions (Make sure that you have
-  read the
-  [documentation](https://mslm.io/docs/api/libraries/ruby). If you
-  are looking for support, you might want to check [this
-  section](#i-have-a-question)).
-- To see if other users have experienced (and potentially already solved) the
-  same issue you are having, check if there is not already a bug report
-  existing for your bug or error in the [bug
-  tracker](https://github.com/mslmio/sdk-ruby/issues?q=label%3Abug).
-- Also make sure to search the internet (including Stack Overflow) to see if
-  users outside of the GitHub community have discussed the issue.
-- Collect information about the bug:
-- Stack trace (Traceback)
-- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
-- Version of the interpreter, compiler, SDK, runtime environment, package
-  manager, depending on what seems relevant.
-- Possibly your input and the output
-- Can you reliably reproduce the issue? And can you also reproduce it with
-  older versions?
-
-#### How Do I Submit a Good Bug Report?
-
-> You must never report security related issues, vulnerabilities or bugs
-> including sensitive information to the issue tracker, or elsewhere in public.
-> Instead sensitive bugs must be sent by email to .
-
-We use GitHub issues to track bugs and errors. If you run into an issue with the project:
-
-- Open an [Issue](https://github.com/mslmio/sdk-ruby/issues/new). (Since we
-  can't be sure at this point whether it is a bug or not, we ask you not to
-  talk about a bug yet and not to label the issue.)
-- Explain the behavior you would expect and the actual behavior.
-- Please provide as much context as possible and describe the *reproduction
-  steps* that someone else can follow to recreate the issue on their own. This
-  usually includes your code. For good bug reports you should isolate the
-  problem and create a reduced test case.
-- Provide the information you collected in the previous section.
-
-Once it's filed:
-
-- The project team will label the issue accordingly.
-- A team member will try to reproduce the issue with your provided steps. If
-  there are no reproduction steps or no obvious way to reproduce the issue, the
-  team will ask you for those steps and mark the issue as `needs-repro`. Bugs
-  with the `needs-repro` tag will not be addressed until they are reproduced.
-- If the team is able to reproduce the issue, it will be marked `needs-fix`, as
-  well as possibly other tags (such as `critical`), and the issue will be left
-  to be [implemented by someone](#your-first-code-contribution).
-
-### Suggesting Enhancements
-
-This section guides you through submitting an enhancement suggestion,
-**including completely new features and minor improvements to existing
-functionality**. Following these guidelines will help maintainers and the
-community to understand your suggestion and find related suggestions.
-
-#### Before Submitting an Enhancement
-
-- Make sure that you are using the latest version.
-- Read the [documentation](https://mslm.io/docs/api/libraries/ruby) carefully and
-  find out if the functionality is already covered, maybe by an individual
-  configuration.
-- Perform a [search](https://github.com/mslmio/sdk-ruby/issues) to see if
-  the enhancement has already been suggested. If it has, add a comment to the
-  existing issue instead of opening a new one.
-- Find out whether your idea fits with the scope and aims of the project. It's
-  up to you to make a strong case to convince the project's developers of the
-  merits of this feature. Keep in mind that we want features that will be
-  useful to the majority of our users and not just a small subset. If you're
-  just targeting a minority of users, consider writing an add-on/plugin
-  library.
-
-#### How Do I Submit a Good Enhancement Suggestion?
-
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/mslmio/sdk-ruby/issues).
-
-- Use a **clear and descriptive title** for the issue to identify the
-  suggestion.
-- Provide a **step-by-step description of the suggested enhancement** in as
-  many details as possible.
-- **Describe the current behavior** and **explain which behavior you expected
-  to see instead** and why. At this point you can also tell which alternatives
-  do not work for you.
-- You may want to **include screenshots or screen recordings** which help you
-  demonstrate the steps or point out the part which the suggestion is related
-  to.
-- **Explain why this enhancement would be useful** to most users. You may also
-  want to point out the other projects that solved it better and which could
-  serve as inspiration.
-
-## Security Issue Notifications
-
-If you discover a potential security issue in this project we ask that you
-notify Mslm Security via [security@mslm.io](mailto:security@mslm.io). Please do
-not create a public github issue.

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/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022-now Mslm
-
-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.

data/README.md

@@ -1,133 +0,0 @@
-# Mslm Ruby SDK
-
-# [<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
-[Authentication](https://mslm.io/docs/api/authentication) to understand how to
-get an API key before continuing.
-
-## Installation
-
-To install the main library, use the following command:
-
-```bash
-gem install mslm
-```
-
-## Usage
-
-```ruby
-require 'mslm'
-
-# Initialize the Mslm object with your API key.
-client = Mslm::Mslm.new('api_key')
-```
-
-#### Email Verify
-
-- Single Verify
-
-```ruby
-    response = client.verify_email("fakefake@mslm.io")
-
-    response.status       //fake
-    response.domain       //mslm.io
-    response.malformed    //false
-    response.has_mailbox  //false
-    response.disposable   //false
-
-```
-
-#### OTP
-
-- Sending an OTP.
-
-```ruby
-    otp_send_req = {
-        "phone" => "+923214444444",
-        "tmpl_sms" => "Your verification code is {token}",
-        "token_len" => 4,
-        "expire_seconds" => 300,
-    }
-
-    response = client.send_otp(otp_send_req)
-
-    response.code   //1000
-    respnse.msg     //Successfully sent SMS.
-
-```
-
-- Verifying a token.
-
-```ruby
-    otp_token_verify_request = {
-        "phone" => "+923214444444",
-        "token" => "123456",
-        "consume" => True,
-    }
-
-    otp_verify_resp = client.verify_otp(otp_verify_req)
-
-    response.code   //1000
-    response.msg    //Successfully verified.
-```
-
-### Error Handling
-
-We expose the following error types in the SDK:
-
-#### Common Errors
-
-- `MslmError`: The base error type.
-
-#### Quota-Related Errors
-
-- `RequestQuotaExceededError`: The request quota has been exceeded.
-
-## Additional Resources
-
-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
-
-See [CONTRIBUTING](CONTRIBUTING.md) for more information.
-
-## Security
-
-See [Security Issue
-Notifications](CONTRIBUTING.md#security-issue-notifications) for more
-information.
-
-## License
-
-This project is licensed under the [MIT License](LICENSE).
-
-## About Mslm
-
-At Mslm, we're all about making things better. Where others see norm, we see
-opportunity.
-
-We build world-class solutions to the toughest problems. Excellence is a core
-value that defines our approach from top to bottom.
-
-We're all about creating positive value for ourselves, our partners and our
-societies.
-
-We do it by focusing on quality and the long-term, while intelligently
-maneuvering the complex realities of day-to-day business.
-
-Our partners share our perspective, and we jointly produce truly world-class
-solutions to the toughest problems.
-
-[![image](https://avatars.githubusercontent.com/u/50307970?s=200&v=4)](https://mslm.io/)

data/Rakefile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-task default: %i[]

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/mslm.gemspec

@@ -1,43 +0,0 @@
-require_relative "lib/mslm/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "mslm"
-  spec.version = Mslm::VERSION
-  spec.authors = ["Sahal Abdullah"]
-  spec.email = ["sahal.abdullah@mslm.io"]
-
-  spec.summary = "Provides functionalities for email verification and OTP (One-Time Password) generation and verification."
-  spec.description = "RubyGem offering email verification and OTP (One-Time Password) generation and verification capabilities. Seamlessly integrate email verification and OTP functionality into Ruby applications with ease."
-  spec.homepage = "https://github.com/mslmio/sdk-ruby"
-  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
-    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"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end
-

data/test/email_verify_test.rb

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

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

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