https://github.com/omniauth/omniauth-venmo
OmniAuth strategy for Venmo
https://github.com/omniauth/omniauth-venmo
Last synced: about 1 year ago
JSON representation
OmniAuth strategy for Venmo
- Host: GitHub
- URL: https://github.com/omniauth/omniauth-venmo
- Owner: omniauth
- Created: 2013-10-09T21:12:20.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2014-12-25T22:33:15.000Z (over 11 years ago)
- Last Synced: 2025-04-06T13:43:34.834Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 218 KB
- Stars: 18
- Watchers: 4
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
omniauth-venmo
==============
[](http://badge.fury.io/rb/omniauth-venmo)
[](https://travis-ci.org/tmilewski/omniauth-venmo)
Venmo OAuth2 Strategy for OmniAuth 1.x and supports the OAuth 2.0 server-side flow.
You may view the Venmo API documentation [here](https://developer.venmo.com/docs/oauth).
## Installation
Add to your `Gemfile`:
```ruby
gem 'omniauth-venmo'
```
Then `bundle install`.
## Usage
`OmniAuth::Strategies::Venmo` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :venmo, ENV['VENMO_CLIENT_ID'], ENV['VENMO_CLIENT_SECRET']
end
```
## Configuration
Currently, there is only one configuration option that needs to be set:
* `scope`: A comma-separated list of permissions you want to request from the user. The available permissions are as follows: `access_email`, `access_phone`, `access_balance`, `access_feed`, `access_profile`, `access_friends`, and `make_payments`. Default: `access_profile`
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :venmo, ENV['VENMO_CLIENT_ID'], ENV['VENMO_CLIENT_SECRET'], :scope => 'access_profile,make_payments'
end
```
## Auth Hash
Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
```ruby
{
:provider => 'venmo',
:uid => '1234567',
:info => {
:username => 'tmilewski',
:email => 'foo@bar.com',
:phone => '16105553287',
:name => 'Tom Milewski',
:first_name => 'Tom',
:last_name => 'Milewski',
:image => 'https://venmopics.appspot.com/u/v1/s/caa2d1a7-192d-4516-bfef-4ef8a1cd9dbe',
:balance => 0.0,
:urls => { :profile => 'https://venmo.com/tmilewski' },
},
:credentials => {
:token => 'ABCDEF...',
:expires => false
},
:extra => {
:raw_info => {
:id => '1234567',
:username => 'tmilewski',
:email => 'foo@bar.com',
:phone => '16105553287',
:name => 'Tom Milewski',
:firstname => 'Tom',
:lastname => 'Milewski',
:picture => 'https://venmopics.appspot.com/u/v1/s/caa2d1a7-192d-4516-bfef-4ef8a1cd9dbe',
:balance => 0.0,
:urls => { :profile => 'https://venmo.com/tmilewski' },
}
}
}
```
## Supported Ruby Versions
`omniauth-venmo` is tested under 1.8.7, 1.9.2, 1.9.3, 2.0.0, JRuby (1.8 mode), and Rubinius
(1.8 and 1.9 modes).
## Versioning
This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
of this scheme should be reported as bugs. Specifically, if a minor or patch
version is released that breaks backward compatibility, that version should be
immediately yanked and/or a new version should be immediately released that
restores compatibility. Breaking changes to the public API will only be
introduced with new major versions. As a result of this policy, you can (and
should) specify a dependency on this gem using the [Pessimistic Version
Constraint][pvc] with two digits of precision. For example:
spec.add_dependency 'omniauth-venmo', '~> 1.0'
[semver]: http://semver.org/
[pvc]: http://docs.rubygems.org/read/chapter/16#page74
## License
Copyright (c) 2013 by Tom Milewski
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.