Skip to content

doorkeeper-gem/doorkeeper-sinatra-client

Repository files navigation

Doorkeeper Sinatra Client

Build Status

This app is an example of OAuth 2 client. It was built in order to test the doorkeeper provider example. It uses oauth2 and sinatra gems. Check out the live app here. The source code is, as always, available on GitHub.

About Doorkeeper Gem

For more information about the gem, documentation, wiki and another resources, check out the project on GitHub.

Installation

First clone the repository from GitHub:

git clone git://github.com/applicake/doorkeeper-sinatra-client.git

Install all dependencies with:

bundle install

Configuration

Client application

If you have your own provider or you are using this example, you'll need to create a new client for this application. Make sure to append the /callback to the redirect uri (e.g. http://localhost:9393/callback).

Environment variables

You need to setup few environment variables in order to make the client work. You can either set the variables in you environment:

export PUBLIC_CLIENT_ID                 = "129477f..."
export PUBLIC_CLIENT_REDIRECT_URI       = "c1eec90..."

export CONFIDENTIAL_CLIENT_ID           = "129477f..."
export CONFIDENTIAL_CLIENT_SECRET       = "c1eec90..."
export CONFIDENTIAL_CLIENT_REDIRECT_URI = "http://localhost:9393/callback"

export PROVIDER_URL = "http://you-server-app.com"

or set them in a file named .env in the app's root. This file is loaded automatically by the app.

# .env
PUBLIC_CLIENT_ID                 = "129477f..."
PUBLIC_CLIENT_REDIRECT_URI       = "c1eec90..."

CONFIDENTIAL_CLIENT_ID           = "129477f..."
CONFIDENTIAL_CLIENT_SECRET       = "c1eec90..."
CONFIDENTIAL_CLIENT_REDIRECT_URI = "http://localhost:9393/callback"

PROVIDER_URL = "http://you-server-app.com"

Start the server

Fire up the server with:

bundle exec rackup config.ru