Merge pull request #4 from infobip-community/add-sms

Add SMS channel and basic SDK structure and documentation.

Author: strosek

CODE_OF_CONDUCT.md

@@ -0,0 +1,80 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -0,0 +1,155 @@
+# Contributing to Infobip Community
+
+✨✨ First off, thanks for taking the time to contribute! ✨✨
+
+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating,
+you are expected to uphold this code. Please report unacceptable behavior to [email protected].
+
+The following is a set of guidelines for contributing to Infobip's SDKs or any other projects
+hosted in the [Infobip Organization](https://github.com/infobip-community) on GitHub.
+These are mostly guidelines, not rules. Use your best judgment,
+and feel free to propose changes to this document in a pull request.
+
+## 🚩 Issues
+How to report a bug?
+
+Bugs are tracked as [GitHub issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues). After you've determined which repository your bug is related to,
+create an issue on that repository and provide the following information by filling in comment section.
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**.
+* **Describe the behavior you observed after following the steps**
+* **Explain which behavior you expected to see instead and why.**
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+## ℹ️ Asking for General Help
+
+The [Infobip website](https://www.infobip.com/docs/api) has a list of resources for getting programming help and more.
+For any question contributors are available at [[email protected]](mailto:[email protected]).
+Please use the issue tracker for bugs only!
+
+## ⬇️ Pull request
+
+### 🍴 Step 1: Fork
+Fork the project on GitHub and clone your fork locally.
+Example for Python SDK repository:
+```bash
+git clone https://github.com/<your username>/infobip-api-go-sdk.git
+cd infobip-api-go-sdk
+git remote add upstream https://github.com/infobip-community/infobip-api-go-sdk.git
+git fetch upstream
+```
+### 🛠️ Step 2: Build
+Please run all the tests in the repository, all tests should pass.
+You can manually test by calling the included script from the root of the project:
+```bash
+bash scripts/run_tests.sh
+```
+
+### 🌱 Step 3: Branch
+To keep your development environment organized, create local branches to hold your work.
+These should be branched directly off of the main branch.
+
+```bash
+git checkout -b my-branch -t upstream/main
+```
+
+### 💻 Step 4: Code
+Please follow code structure and naming structure that is already in the repository.
+Please make sure that all tests and linters pass for all changes. You can check for that in the [GitHub Actions.](https://github.com/infobip-community/infobip-api-rust-sdk/actions)
+We mostly adhere to the [Rust API Guidelines Checklist](https://rust-lang.github.io/api-guidelines/checklist.html) for style and best practices.
+We use `rustfmt` to keep the code well-formatted.
+
+### ✅ Step 5: Commit
+It is recommended to keep your changes grouped logically within individual commits.
+Many contributors find it easier to review changes that are split across multiple commits.
+There is no limit to the number of commits in a pull request.
+
+```bash
+git add my/changed/files
+git commit
+```
+
+Note that multiple commits get squashed when they are landed.
+A good commit message should describe what changed and why.
+Commit message should:
+
+* Contain a short description of the change (preferably 50 characters or less, and no more than 72 characters)
+* First letter should be capital and rest entirely in lowercase with the exception of proper nouns, acronyms,
+  and the words that refer to code, like function/variable names
+
+#### ⚠️ Breaking Changes
+
+When a commit has a breaking change first line of commit text should be BREAKING CHANGE.
+Please take a look at [Cargo's guide on Semantic Versioning](https://doc.rust-lang.org/cargo/reference/semver.html) for more information.
+
+### 📌 Step 6: Rebase
+Once you have committed your changes, it is a good idea to use git rebase (not git merge) to synchronize your work with the main repository.
+```bash
+git fetch upstream
+git rebase upstream/main
+```
+
+### 🧪 Step 7: Tests
+Bug fixes and features should always come with tests. Look at other tests to see how they should be structured.
+Before submitting your changes in a pull request, always run the full test suite
+```bash
+cargo test
+cargo fmt --check
+cargo clippy
+```
+Make sure that no check reports issues and that all tests pass. Please do not submit patches that fail either check.
+
+### 🚀 Step 8: Push
+Once your commits are ready to go -- with passing tests and linting -- begin the process of opening a pull request by pushing your working branch to your fork on GitHub.
+```bash
+git push origin my-branch
+```
+
+### 📬 Step 9: Opening the Pull Request
+From within GitHub, open new pull request. Add repository admins as reviewers.
+Your PR may be delayed in being merged as maintainers seek more information or clarify ambiguities.
+
+### 🤼 Step 10: Discuss and update
+You will probably get feedback or requests for changes to your pull request.
+This is a big part of the submission process so don't be discouraged!
+Some contributors may sign off on the pull request right away.
+Others may have detailed comments or feedback.
+This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
+
+To make changes to an existing pull request, make the changes to your local branch,
+add a new commit with those changes, and push those to your fork. GitHub will automatically update the pull request.
+
+```bash
+git add my/changed/files
+git commit
+git push origin my-branch
+```
+
+Feel free to post a comment in the pull request to ping reviewers if you are awaiting an answer on something.
+
+### 🌍 Step 11: Landing
+
+In order to land, a pull request needs to be reviewed and approved by at least one repository Owner and pass CI.
+After that, if there are no objections from other contributors, the pull request can be merged.
+
+🎉🎊 Congratulations and thanks for your contribution! 🎊🎉
+
+Every pull request is tested on the Continuous Integration (CI) system to confirm that it works.
+Ideally, the pull request will pass ("be green") on all of CI's tests.
+This means that all tests pass and there are no linting errors.
+However, it is not uncommon for the CI infrastructure itself to fail on specific platforms or for so-called "flaky" tests to fail ("be red").
+Each CI failure must be manually inspected to determine the cause.
+
+## 📜 Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+## 📚 Further Reading
+
+For more in-depth guides on developing SDKs, see
+[Readme](README.md) and [Infobip's website](https://www.infobip.com/docs/api).

Cargo.toml

@@ -1,25 +1,29 @@
 [package]
+authors = ["Infobip DevRel [email protected]"]
+description = "Client SDK to use the Infobip API with pure Rust."
+documentation = "https://www.infobip.com/docs/api"
+edition = "2021"
+homepage = "https://www.infobip.com/"
+license = "MIT OR Apache-2.0"
 name = "infobip_sdk"
+repository = "https://github.com/infobip-community/infobip-api-rust-sdk"
 version = "0.1.0"
-edition = "2021"
-license = "MIT"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-derive_builder = "*"
-lazy_static = "*"
-regex = "*"
-reqwest = { version = "*", features = ["blocking", "json", "multipart"] }
-serde = { version = "*", features = ["derive"] }
-serde_derive = "*"
-serde_json = "*"
-thiserror = "*"
-tokio = { version = "*", features = ["full"] }
-validator = { version = "*", features = ["derive"] }
+lazy_static = "1.4"
+regex = "1.6"
+reqwest = { version = "0.11", features = ["blocking", "json", "multipart"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_derive = "1.0"
+serde_json = "1.0"
+thiserror = "1.0"
+tokio = { version = "1.20", features = ["full"] }
+validator = { version = "0.16", features = ["derive"] }
 
 [dev-dependencies]
-httpmock = "*"
+httpmock = "0.6"
 
 [features]
 default = ["sms"]