This gem contains Kiva Strategy for OmniAuth. Please visit http://build.kiva.org/ for learning more.
Add this line to your application's Gemfile:
gem 'omniauth-kiva'
You can get latest HEAD version directly from github e.g.:
gem 'omniauth-kiva', :github => "kiva/omniauth-kiva"
And then execute:
$ bundle
Or install it yourself as:
$ gem install omniauth-kiva
Once you install the gem, you need to add these in your config files.
Example for Rails-3+ config/initializers/omniauth.rb
require 'omniauth-oauth'
Rails.application.config.middleware.use OmniAuth::Builder do
provider :kiva, "client_id", "client_secret", :scope => 'access', :redirect_url => "callback_url"
end
Replace client_id and client_secret with the appropriate values you obtained from http://build.kiva.org/ earlier. To get your keys, you should click "My Apps" link. Currently only limited scopes are accessible to public, but plans are to release more in future. You are safe to leave :scope value as is. Replace :redirect_url with your callback url that you mentioned on http://build.kiva.org/ while aquiring your application keys. Note :redirect_url and :scope are required and not optional fields.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
##Useful links Watch this screen cast by Ryan Bates: http://railscasts.com/episodes/241-simple-omniauth
##License Copyright (c) 2013 Kiva Microfunds
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.