https://github.com/rewindio/omniauth-miro
Authenticate using the Miro OAuth2 API.
https://github.com/rewindio/omniauth-miro
Last synced: over 1 year ago
JSON representation
Authenticate using the Miro OAuth2 API.
- Host: GitHub
- URL: https://github.com/rewindio/omniauth-miro
- Owner: rewindio
- License: mit
- Created: 2024-03-19T01:11:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T18:45:03.000Z (over 2 years ago)
- Last Synced: 2024-04-25T16:44:59.556Z (about 2 years ago)
- Language: Ruby
- Homepage:
- Size: 7.61 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# OmniAuth Miro Strategy
OmniAuth Miro is a Ruby gem that provides authentication for your Ruby applications via the Miro OAuth 2.0 authentication system.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'omniauth-miro'
```
And then execute:
```bash
bundle install
```
## Usage
1. Register your application with Miro to obtain the `MIRO_CLIENT_ID` and `MIRO_CLIENT_SECRET` credentials.
2. In your application configuration, add the following line to use the Miro OmniAuth strategy:
```ruby
provider :miro, ENV['MIRO_CLIENT_ID'], ENV['MIRO_CLIENT_SECRET'], scope: 'vso.auditlog etc...', callback_path: '/link/miro/oauth_callback'
```
Replace `ENV['MIRO_CLIENT_ID']` and `ENV['MIRO_CLIENT_SECRET']` with your Miro client credentials.
3. Implement the necessary routes and views to initiate the authentication process and handle the callback.
4. When users access the authentication route, they will be redirected to Miro for authentication. After successful authentication, Miro will redirect them back to your specified callback URL.
5. Access user information and tokens as needed in your application by utilizing the OmniAuth authentication data.
## Running Tests
You can run the test suite using the following command:
```bash
rake spec
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the spec. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/rewindio/omniauth-miro](https://github.com/rewindio/omniauth-miro). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
## License
This gem is available as open-source software under the [MIT License](https://opensource.org/licenses/MIT).