omniauth-nokia

OmniAuth Nokia Strategy

This is an OmniAuth OAuth 1.0 strategy for authenticating with the [Nokia OAuth 1.0 api](see https://developer.health.nokia.com/api).

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'omniauth-nokia'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-nokia

Get your Nokia credentials

To register your application with Nokia and obtain a consumer key and secret, go to the Nokia application registration.

Running the example

$ cd example $ bundle $ NOKIA_API_KEY=<your_nokia_api_key> NOKIA_API_SECRET=<your_nokia_api_secret> bundle exec ruby example.rb Visit http://localhost:4567/ in a browser

Usage

Add the strategy to your Gemfile:

gem 'omniauth-nokia'

Then integrate the strategy into your middleware:

use OmniAuth::Builder do
  provider :nokia,
    ENV['NOKIA_API_KEY'],
    ENV['NOKIA_API_SECRET']
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 :nokia,
    ENV['NOKIA_API_KEY'],
    ENV['NOKIA_API_SECRET']
end

In your controller action (responding to /auth/nokia/callback), get nokia_user_id, nokia_user_access_token, nokia_user_access_token_secret from the omniauth.auth params and store them for later interaction with the API:

nokia_params = request.env['omniauth.auth']
nokia_user_id = nokia_params['uid']
nokia_user_access_token = nokia_params['extra']['access_token'].token
nokia_user_access_token_secret = nokia_params['extra']['access_token'].secret

To interact with the Nokia API (e.g. retrieve weight measurements recorded by a Nokia scale):

oauth_consumer = OAuth::Consumer.new(
  ENV['NOKIA_API_KEY'],
  ENV['NOKIA_API_SECRET'],
  OmniAuth::Strategies::Nokia.consumer_options,
)

api_access_token = OAuth::AccessToken.from_hash(oauth_consumer, {
  oauth_token: nokia_user_access_token,
  oauth_token_secret: nokia_user_access_token_secret,
})

# Change the uri to access other Nokia API endpoints
uri = "https://api.health.nokia.com/measure?action=getmeas&userid=#{nokia_user_id}"

request = api_access_token.get(uri)
JSON.parse(request.body)

About OmniAuth

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 adapted from omniauth-fitbit)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-nokia.

Original License

Copyright (c) 2016 TK Gospodinov. See LICENSE for details.

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.