ruthienachmany/omniauth-jawbone

OmniAuth Jawbone

Updated 2013.09.19 to work with the officially released Jawbone API.

This is an OmniAuth strategy for authenticating to Jawbone. To use it, you'll need to sign up for an OAuth2 Application ID and Secret.

Basic Usage

Add the strategy to your Gemfile:

gem 'omniauth-jawbone'

Then integrate the strategy into your middleware:

use OmniAuth::Builder do
  provider :jawbone, 
    ENV['JAWBONE_CLIENT_ID'], 
    ENV['JAWBONE_CLIENT_SECRET'], 
    :scope => "basic_read mood_read"
end

In Rails, create a new file under config/initializers called omniauth.rb to plug the strategy into your middleware stack.

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :jawbone, 
    ENV['JAWBONE_CLIENT_ID'], 
    ENV['JAWBONE_CLIENT_SECRET'], 
    :scope => "basic_read mood_read"
end

Please see the OmniAuth Getting Started section for more important details about how to integrate omniauth-jawbone into your project.

As with other OAuth 2.0 providers, the token (which you need to get Jawbone data from their API) is in the auth hash, in request.env["omniauth.auth"]["credentials"]["token"].

There will also be provided a refresh token (described here), in request.env["omniauth.auth"]["credentials"]["refresh_token"].

For additional information about OmniAuth, visit OmniAuth wiki.

For a short tutorial on how to use OmniAuth in your Rails application, visit this tutsplus.com tutorial.

(The above stolen and adapted from omniauth-fitbit)

Original License

Copyright (c) 2011 Michael Bleigh and Intridea, Inc.

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.

omniauth-jawbone's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can image, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Bump version and publish gem

Can we get an updated gem published on rubygems with the updated omniauth-oauth2 dependency?