Doorkeeper Sequel ORM extension
doorkeeper-sequel
provides Doorkeeper support to 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:
# 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:
gem 'doorkeeper-sequel', git: 'https://github.com/nbulaj/doorkeeper-sequel.git'
Set the Doorkeeper ORM configuration:
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:
- Fork the project.
- Create your feature branch (
git checkout -b my-new-feature
). - Implement your feature or bug fix.
- Add documentation for your feature or bug fix.
- Add tests for your feature or bug fix.
- Run
rake
to make sure all tests pass. - Commit your changes (
git commit -am 'Add new feature'
). - Push to the branch (
git push origin my-new-feature
). - Create new pull request.
Thanks.
License
Doorkeeper-sequel gem is released under the MIT License.
Copyright (c) 2016-2020 Nikita Bulai (bulajnikita@gmail.com).
Please refer to https://github.com/doorkeeper-gem/doorkeeper for instructions on doorkeeper’s project.