No release in over 3 years
Low commit activity in last 3 years
an OmniAuth strategy for authenticating with deX
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 3.8.0
~> 2.2.3
~> 12.0
~> 3.0
~> 0.77
~> 1.37.0

Runtime

 Project Readme

omniauth-dex-energy

CI Gem Version

An OmniAuth strategy to authenticate with deX.

Table of Contents

  • omniauth-dex-energy
    • Table of Contents
    • Installation
    • Usage
      • First Steps
      • Sinatra
    • Development
    • 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. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file 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.