danish2210 / omniauth-xero

Xero authentication strategy for OmniAuth

Omniauth Xero

Omniauth Xero is an OmniAuth authentication strategy for Xero.

Installation

Add this to your application's Gemfile:

gem 'omniauth', '~> 1.0.0'
gem 'omniauth-xero'

And then execute:

bundle

Or install it yourself as:

gem install omniauth-xero

Usage

Register your public application on the Xero API site.

For a Rack application:

use OmniAuth::Builder do
  provider :xero, CONSUMER_KEY, CONSUMER_SECRET
end

For a Rails application:

# config/intializers/omniauth.rb
Rails.application.config.middleware.use OmniAuth::Builder do
  provider :xero, CONSUMER_KEY, CONSUMER_SECRET
end

Or, if you use devise for authentication:

# config/initializers/devise.rb
Devise.setup do |config|
  config.omniauth :xero, CONSUMER_KEY, CONSUMER_SECRET
end

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Copyright

Copyright (c) 2013-2018 Kale Worsley. See LICENSE.txt for details.