Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nbulaj/doorkeeper-sequel
Doorkeeper Sequel ORM
https://github.com/nbulaj/doorkeeper-sequel
doorkeeper oauth2-provider orm ruby ruby-on-rails sequel
Last synced: 7 days ago
JSON representation
Doorkeeper Sequel ORM
- Host: GitHub
- URL: https://github.com/nbulaj/doorkeeper-sequel
- Owner: nbulaj
- License: mit
- Created: 2016-04-18T15:56:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-11T08:20:01.000Z (over 3 years ago)
- Last Synced: 2024-10-15T19:41:02.737Z (about 1 month ago)
- Topics: doorkeeper, oauth2-provider, orm, ruby, ruby-on-rails, sequel
- Language: Ruby
- Size: 205 KB
- Stars: 12
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Doorkeeper Sequel ORM extension
[](https://rubygems.org/gems/doorkeeper-sequel)
[](https://travis-ci.org/nbulaj/doorkeeper-sequel)
[](https://codeclimate.com/github/nbulaj/doorkeeper-sequel)
[](#license)
`doorkeeper-sequel` provides [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) support to [Sequel](https://github.com/jeremyevans/sequel) database toolkit.
## Requirements
* Doorkeeper >= 4.0
* Rails >= 4.2 (Doorkeeper 4 dropped support of lower versions)
* Sequel >= 4
## Installation
To start using the Doorkeeper Sequel ORM, add to your Gemfile:
``` ruby
# For Doorkeeper 4.x
gem 'doorkeeper', '~> 4.3'
gem 'doorkeeper-sequel', '~> 1.5'
# For Doorkeeper 5.1
gem 'doorkeeper', '~> 5.0' # or 5.1
gem 'doorkeeper-sequel', '~> 2.0'
# For Doorkeeper >= 5.2
gem 'doorkeeper', '~> 5.2'
gem 'doorkeeper-sequel', '~> 2.1'
# For Doorkeeper >= 5.3
gem 'doorkeeper', '~> 5.3'
gem 'doorkeeper-sequel', '~> 2.2'
```
Or you can use git `master` branch for the latest gem version:
``` ruby
gem 'doorkeeper-sequel', git: 'https://github.com/nbulaj/doorkeeper-sequel.git'
```
Set the Doorkeeper ORM configuration:
``` ruby
Doorkeeper.configure do
orm :sequel
end
```
Generate migrations:
```
rake doorkeeper_sequel:generate:migration
rake doorkeeper_sequel:generate:application_owner
rake doorkeeper_sequel:generate:previous_refresh_token
rake doorkeeper_sequel:generate:confidential_applications # for Doorkeeper >= 4.4
rake doorkeeper_sequel:generate:pkce # for Doorkeeper >= 5.x
rake doorkeeper_sequel:generate:polymorphic_resource_owner # for Doorkeeper >= 5.3
```
## Tests
To run tests, clone this repository and run `rake`. It will copy and run `Doorkeeper`’s original test suite after configuring the ORM and other stuffs.
```
$ bundle exec rake
```
## Contributing
You are very welcome to help improve `doorkeeper-sequel` if you have suggestions for features that other people can use or some code improvements.
To contribute:
1. Fork the project.
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Implement your feature or bug fix.
4. Add documentation for your feature or bug fix.
5. Add tests for your feature or bug fix.
6. Run `rake` to make sure all tests pass.
7. Commit your changes (`git commit -am 'Add new feature'`).
8. Push to the branch (`git push origin my-new-feature`).
9. Create new pull request.
Thanks.
## License
Doorkeeper-sequel gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).
Copyright (c) 2016-2020 Nikita Bulai ([email protected]).
---
Please refer to [https://github.com/doorkeeper-gem/doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) for instructions on
doorkeeper’s project.