FreshBooks strategy for OmniAuth
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/omniauth
spec
.gitignore
.rspec
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
omniauth-freshbooks.gemspec

README.md

OmniAuth FreshBooks

Gem Version Build Status Code Climate Dependency Status Coverage Status

This is the OmniAuth strategy for authentication to FreshBooks.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-freshbooks'

And then, you need to add the following to your config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :freshbooks, "consumer_key", "consumer_secret" 
end

You will obviously have to put in your key and secret, which you get when you register as a consumer with FreshBooks.

Options

The options are:

  • site The FreshBooks root URI for this site. This can also be passed as a query string parameter although if one specified in your initializer, it will always take precedence. Example: https://sample.freshbooks.com