sethherr/grape-doorkeeper

Get to API building quickly

Grape-Doorkeeper

Create an awesome versioned API, secured with OAuth2 and automatically documented.

This is a basic Rails 5 application with Doorkeeper, Grape & Swagger for getting to API building quickly.

You can view the live app and the Swagger-ui documentation.

This app is ready to deploy to Heroku

Set up

• Set up the rails app and database with bundle install and rake db:setup

• Run ./start to get the server running locally. It runs at http://localhost:3003

• Copy .env.sample to .env and replace the values with your own values.

• Delete the imaginary item class and serializer, which are included for demonstration in the me/items endpoint.

This app includes omniauth-bike-index. For Bike Index login to work, create a Bike Index app at BikeIndex.org/oauth/applications/new and add the values from BIKEINDEX_APP_ID and BIKEINDEX_APP_SECRET to the .env file.

Bike Index uses a similar grape, Swagger, doorkeeper setup—this is an example of creating an OmniAuth strategy for doorkeeper.

Adding to an existing application

View how to on the wiki.

Notes

Grape is mounted in app/controllers/api, as described in the excellent Introduction to building APIs with Grape by Monterail, and part 2 of the series.

There are are other posts in the series which are worth reading, particularly OAuth Implicit Grant with Grape, Doorkeeper and AngularJS.

There is also a Railscast on doorkeeper.

Important things in the Gemfile:

• Doorkeeper (OAuth providing)
• grape (API building)
• wine_bouncer (Doorkeeper and Grape)
• grape-swagger (automatically generates Swagger docs for the auto documentation)
• Devise (users)

Also important, but maybe not as necessary to know about:

• rails-assets manages the js for swagger-ui
• Puma (the web server)
• api-pagination
• active_model_serializers - uses 0.8 branch of active model serializers, because nothing past 0.8 supports caching
• CORS
• foreman (in development to manage processes)
• Haml - and Hamlit, which is faster haml
• dotenv-rails (load environmental variables - .env is in .gitignore, so it isn't committed)
• Bootstrap
• Postgres

---

If you want to change the name of the app, swap out:

• GrapeDoorkeeper in config/application.rb
• grape-doorkeeper in config/database.yml (multiple instances)
• grape-doorkeeper in config/initializers/session_store.rb
• Do a project wide search of /grape.doorkeeper/i to catch any lingering ones like api_v1.html.haml

Testing

Rspec and guard - run bundle exec guard to watch your spec files for changes and rerun tests for those files.

There is a spec for the api/v1/me API route and for the swagger docs to help get you started.

grape-doorkeeper's Issues

Issue with config for 'default_scopes' and 'optional_scopes' getting put into a nested array

Cross-posting from this issue: doorkeeper-gem/doorkeeper#763 (comment)

Add serializer and display of serializer

It would be best if we included it in an endpoint with pagination.

authorise fail when request access token for particular scope

steps to reproduce

1. create a application
2. authrise without scope
3. go to document page
4. delete the access token
5. go back to document page
6. choose a scope like "write_user" to request a new token
7. click the auth link, it fails with the error showing on the page

The requested scope is invalid, unknown, or malformed.

proposed fix:
in config file "doorkeeper.rb", change the line from

optional_scopes OAUTH_SCOPES

to

optional_scopes *OAUTH_SCOPES

(unwrap the params)

login_url redirection issue when auth a application

08:08:44 log.1        | NameError (undefined local variable or method `login_url' for #<Doorkeeper::AuthorizationsController:0x007ff27b0e2868>):
08:08:44 log.1        |   config/initializers/doorkeeper.rb:12:in `block (2 levels) in <top (required)>'

the issue is in the file of "config/initializers/doorkeeper.rb:12"
should change from

current_user || redirect_to(login_url)

to

current_user || redirect_to(new_user_session_url)