magic-admin 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c1a049902f60fd9063eab8b5246ee187ca6a02dde1770d77383a4736db2c95b
-  data.tar.gz: ad5b0066c91233c33cf38d8dc8eb2a6bc2df6574af2f2cf08b975c7d993920cc
+  metadata.gz: 623f1dec3237ad8a1e3e380c057426b518e477295b5bad40ec4736fee99e0ddb
+  data.tar.gz: ebc06d06cdf25d95bed3fede31f18c8b7b8e21246b5104ed137ec208af7b30fa
 SHA512:
-  metadata.gz: c6b1f7c63a2fae1a4b90e1a5abf71f0234704e5f3eb0a2ad3edc6c95a7993ee303f4016f236b06d5b63265ee557bfabcde7dd4d83271e4f8aabb103dc53766d3
-  data.tar.gz: 91ca209147e632c529c6077aade1e11a5e33d143bc8d017c5cfced91b009be9bb2f199a81c438e3b2024935a110793e01e2ac256a7826160c27b85900ad7e030
+  metadata.gz: a5a645a3964a5e3d34671993ddc49a75d7c76311457a2f86a612ac2a8b040faceebac65f42d4c1f28bf455a76cfa703a0f0c7211a8805e8abead99eb53c1a280
+  data.tar.gz: a8da9649524f9cb17d209b0e13c3c60d0b3fc14b5e541c90efb948cb3d5d6c18f3c2a97f34629e12988bb406168264f3aa5721835e7f57149b49e550dc9e0c19

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug Report
+about: Use this template to report a bug.
+title: "[DESCRIPTIVE BUG NAME]"
+labels: 🐛 Bug Report, 🔍 Needs Triage
+---
+
+### ✅ Prerequisites
+
+- [ ] Did you perform a cursory search of open issues? Is this bug already reported elsewhere?
+- [ ] Are you running the latest SDK version?
+- [ ] Are you reporting to the correct repository (`magic-admin-ruby`)?
+
+### 🐛 Description
+
+[Description of the bug.]
+
+### 🧩 Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+### 🤔 Expected behavior
+
+[What you expected to happen?]
+
+### 😮 Actual behavior
+
+[What actually happened? Please include any error stack traces you encounter.]
+
+### 💻 Code Sample
+
+[If possible, please provide a code repository, gist, code snippet or sample files to reproduce the issue.]
+
+### 🌎 Environment
+
+| Software            | Version(s) |
+| ------------------- | ---------- |
+| `magic-admin-ruby`  |            |
+| `ruby`              |            |
+| Operating System    |            |

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature Request
+about: Use this template to request a new feature.
+title: "[DESCRIPTIVE FEATURE NAME]"
+labels: ✨Feature Request
+---
+
+### ✅ Prerequisites
+
+- [ ] Did you perform a cursory search of open issues? Is this feature already requested elsewhere?
+- [ ] Are you reporting to the correct repository (`magic-admin-ruby`)?
+
+### ✨ Feature Request
+
+[Description of the feature.]
+
+## 🧩 Context
+
+[Explain any additional context or rationale for this feature. What are you trying to accomplish?]
+
+## 💻 Examples
+
+[Do you have any example(s) for the requested feature? If so, describe/demonstrate your example(s) here.]

data/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,23 @@
+---
+name: Question
+about: Use this template to request help or ask a question.
+title: "[WHAT'S YOUR QUESTION?]"
+labels: ❓Question
+---
+
+### ✅ Prerequisites
+
+- [ ] Did you perform a cursory search of open issues? Is this question already asked elsewhere?
+- [ ] Are you reporting to the correct repository (`magic-admin-ruby`)?
+
+### ❓ Question
+
+[Ask your question here, please be as detailed as possible!]
+
+### 🌎 Environment
+
+| Software            | Version(s) |
+| ------------------- | ---------- |
+| `magic-admin-ruby`  |            |
+| `ruby`              |            |
+| Operating System    |            |

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+### 📦 Pull Request
+
+[Provide a general summary of the pull request here.]
+
+### 🗜 Versioning
+
+(Check _one!_)
+
+- [ ] Patch: Bug Fix?
+- [ ] Minor: New Feature?
+- [ ] Major: Breaking Change?
+
+### ✅ Fixed Issues
+
+- [List any fixed issues here like: Fixes #XXXX]
+
+### 🚨 Test instructions
+
+[Describe any additional context required to test the PR/feature/bug fix.]
+
+### ⚠️ Update `CHANGELOG.md`
+
+- [ ] I have updated the `Upcoming Changes` section of `CHANGELOG.md` with context related to this Pull Request.

data/.gitignore

@@ -0,0 +1,7 @@
+magic-admin-*.gem
+Gemfile.lock
+.rvmrc
+.ruby-version
+.byebug_history
+coverage/*
+

data/.rspec

@@ -0,0 +1,6 @@
+--default-path test
+--require spec_helper
+--pattern '**{,/*/**}/*_test.rb'
+--color
+
+

data/.rubocop.yml

@@ -0,0 +1,45 @@
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*.rb"
+
+Naming/FileName:
+  Exclude:
+    - "lib/magic-admin.rb"
+
+Style/Documentation:
+  Exclude:
+    - "lib/magic-admin/config.rb"
+    - "lib/magic-admin/util.rb"

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## Upcoming Changes
+
+#### Fixed
+
+- <PR-#ISSUE> ...
+
+#### Changed
+
+- <PR-#ISSUE> ...
+
+#### Added
+
+- <PR-#ISSUE> ...
+
+#### Changed
+
+- <PR-#ISSUE> ...

data/CONTRIBUTING.md

@@ -0,0 +1,142 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via an **issue**. This can be a feature request or a bug report. After a maintainer has triaged your issue, you are welcome to collaborate on a pull request. If your change is small or uncomplicated, you are welcome to open an issue and pull request simultaneously.
+
+Please note we have a **code of conduct**, please follow it in all your interactions with the project.
+
+## Setting up for Local Development
+
+1. Fork this repostiory.
+2. Clone your fork.
+3. Create a new branch in your local repository with the following pattern:
+
+- For bug fixes: `bug/#[issue_number]/[descriptive_bug_name]`
+- For features: `feature/#[issue_number]/[descriptive_feature_name]`
+- For chores/the rest: `chore/[descriptive_chore_name]`
+
+## Opening a Pull Request
+
+1. Update the **`Upcoming Changes`** section of [`CHANGELOG.md`](./CHANGELOG.md) with your fixes, changes, or additions. A maintainer will label your changes with a version number and release date once they are published.
+2. Open a pull request from your fork/branch to the upstream `master` branch of _this_ repository.
+3. A maintainer will review your code changes and offer feedback or suggestions if necessary. Once your changes are approved, a maintainer will merge the pull request for you and publish a release.
+
+## 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
+- 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 [support@magic.link](mailto:support@magic.link).
+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](https://www.contributor-covenant.org),
+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).
+
+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.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Magic Labs Inc.
+
+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,73 @@
+# Magic Admin Ruby SDK
+
+The Magic Admin Ruby SDK provides convenient ways for developers to interact with Magic API endpoints and an array of utilities to handle [DID Token](https://docs.magic.link/tutorials/decentralized-id).
+
+## Table of Contents
+
+* [Documentation](#documentation)
+* [Quick Start](#quick-start)
+* [Changelog](#changelog)
+* [License](#license)
+
+## Documentation
+See the [Magic doc](https://docs.magic.link/admin-sdk/ruby)!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'magic-admin'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install magic-admin
+```
+
+### Prerequisites
+
+- Ruby 2.5+
+
+## Quick Start
+Before you start, you will need an API secret key. You can get one from the [Magic Dashboard](https://dashboard.magic.link/). Once you have the API secret key, you can instantiate a Magic object.
+
+```ruby
+require 'magic-admin'
+
+magic = Magic.new(api_secret_key: '<YOUR_API_SECRET_KEY>')
+
+magic.token.validate('DID_TOKEN')
+
+# Read the docs to learn more! 🚀
+```
+
+Optionally if you would like, you can load the API secret key from the environment variable, `MAGIC_API_SECRET_KEY`.
+
+```ruby
+# Set the env variable `MAGIC_API_SECRET_KEY`.
+
+magic = Magic.new
+```
+
+**Note**: The arguments passed to the `Magic` object takes precedence over the environment variables.
+
+### Configure Network Strategy
+The `Magic` object also takes in `retries`, `timeout` and `backoff` as optional arguments at the object instantiation time so you can override those values for your application setup.
+
+```ruby
+magic = Magic.new(retries: 5, timeout: 10, backoff: 0.03)
+
+```
+
+## Changelog
+See [Changelog](CHANGELOG.md)
+
+## License
+See [License](LICENSE.txt)