mslm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8931aea001b95a0bc54f8d00a791a0e8f1a4380307c6168183ca6df9ceecbeb9
+  data.tar.gz: 4e24e41c3d2044f3d53a1f8c54f13f919c75db982389b7c796829c55642fcd75
+SHA512:
+  metadata.gz: 8c0f758fb53468f12def53aafb623e2bed4241904cbd9cfefaa2ec1d6bb32fb50af44ee308b75d0bf1e181160367c5d693f8fc88e884855af35574138153cbbf
+  data.tar.gz: 6d11265f3409d30ce8ec10db4359f41bba31ba4c455e9346f75f6bac40fdf98766546a8514453467d027175785cea9d13326aed2b3eb557f7fb48f0d5f7d166e

data/CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# 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/LICENSE

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

@@ -0,0 +1,59 @@
+# Mslm Ruby SDK
+
+The official Ruby SDK for Mslm APIs.
+
+## Requirements
+
+...
+
+## 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
+
+...
+
+## Usage
+
+...
+
+## 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/)

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: mslm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sahal Abdullah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-11 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
+  into Ruby applications with ease.
+email:
+- sahal.abdullah@mslm.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+homepage: https://github.com/mslmio/sdk-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mslmio/sdk-ruby
+  source_code_uri: https://github.com/mslmio/sdk-ruby
+  changelog_uri: https://github.com/mslmio/sdk-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Provides functionalities for email verification and OTP (One-Time Password)
+  generation and verification.
+test_files: []