vaginessa / omniauth-fidor

OmniAuth strategy for the Fidor Banking API.

OmniAuth Fidor

This is a OmniAuth strategy for authenticating to Fidor Banking. To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the Fidor Developer Page.

Basic Usage

Installation

Add this line to your application's Gemfile:

gem 'omniauth-fidor'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-fidor

Usage

use OmniAuth::Builder do
  provider :fidor, ENV['FIDOR_KEY'], ENV['FIDOR_SECRET']
end

Development

After checking out the repo, run rake install:development to install dependencies. Then, run rake test to run the tests.

To install this gem onto your local machine, run rake install. To release a new version, update the version number in the CHANGELOG, and then run rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

You can also use the sandbox versions of the API and OAuth URLs for testing by passing an optional fourth parameter to the builder:

use OmniAuth::Builder do
  provider :fidor, ENV['FIDOR_KEY'], ENV['FIDOR_SECRET'], false
end

If you need to use endpoints that differ from Fidor's production or sandbox environments, you can override them by setting the FIDOR_API_URL and/or FIDOR_OAUTH_URL environment variables.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

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