omniauth-dex-energy

An OmniAuth strategy to authenticate with deX.

Table of Contents

• omniauth-dex-energy
  • Table of Contents
  • Installation
  • Usage
    • First Steps
    • Sinatra
  • Development
    • Releasing a new version
  • Contributing
  • License

Installation

Add this line to your application's Gemfile:

gem 'omniauth-dex-energy'

And then execute:

bundle install

Or install it yourself as:

gem install omniauth-dex-energy

Usage

First Steps

Regardless of your web framework, you will need to provision an OAuth2 Client in the IdP through the GreenSync Platform Team. You'll be provided with a Client ID and Client Secret that can be used to configure this gem.

Contact the [GreenSync Platform Team].

Sinatra

See examples/sinatra/app.rb for example usage.

To run the example application:

export OAUTH2_CLIENT_ID='my-client-id'
export OAUTH2_CLIENT_SECRET='my-client-secret'

cd examples/sinatra
bundle install
bundle exec foreman start

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Releasing a new version

First, create and push a git tag off HEAD.

• bump version.rb; commit and push
• run bin/publish-gem

This will publish the gem to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/greensync/omniauth-dex-energy.

License

The gem is available as open source under the terms of the MIT License.