omniauth-withings2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2548e4dd3ea286bd7956e05ef9c23f9c85654a06cb92c6d2c22a95b1f33f8cf
+  data.tar.gz: 4f453612db759c47a6ea899b2a6db1798e1f3d30dbc2eb164a6998a9546d7ff6
+SHA512:
+  metadata.gz: e475ca68c31802af693d9f8594532b74200933167cbb1eeb568a537e71fe371d4221f64975c4c3ebbb9523b7b7a1684b840c425973d8bd0c2079f693c2e18083
+  data.tar.gz: 4c8f3e4d2d77154a638f0c549681d1546182a7786c653270f1faa1f7a1c236102960910a20f364c0368a7a43c5f2785cd54cbc43291d524fcbe6f71fa7481d64

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/*
+*.iml
+.DS_Store

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+ - "2.1.1"
+ - rbx
+# run tests
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'omniauth-oauth2', '~> 1.4'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'webmock'
+  gem 'rack-test'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daniel Nelson
+
+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.

data/README.md

@@ -0,0 +1,125 @@
+# OmniAuth Withings2 Strategy
+
+This is an OmniAuth OAuth 2.0 strategy for authenticating with the [Nokia OAuth 2.0 api](see https://developer.health.nokia.com/oauth2/#tag/OAuth-2.0).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-withings2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-withings2
+
+
+## Get your Oauth credentials
+
+To register your application with Nokia and obtain a client id and consumer secret, go to the [Nokia application registration](https://account.health.nokia.com/partner/add_oauth2).
+
+## 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`:
+
+```ruby
+gem 'omniauth-withings2'
+```
+
+Then integrate the strategy into your middleware:
+
+```ruby
+use OmniAuth::Builder do
+  provider :withings2,
+    ENV['WITHINGS_CLIENT_ID'],
+    ENV['WITHINGS_CONSUMER_SECRET'],
+    scope: 'user.metrics'
+end
+```
+
+In Rails, create a new file under config/initializers called omniauth.rb to plug the strategy into your middleware stack.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :withings2,
+    ENV['WITHINGS_CLIENT_ID'],
+    ENV['WITHINGS_CONSUMER_SECRET'],
+    scope: 'user.metrics'
+end
+```
+
+In your controller action (responding to /auth/nokia/callback), get the credentials and store them for later interaction with the API:
+
+```ruby
+request.env['omniauth.auth']['credentials']
+```
+
+### TODO: update
+To interact with the Nokia API (e.g. retrieve weight measurements recorded by a Nokia scale):
+
+```ruby
+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)
+```
+### END TODO: update
+
+## About OmniAuth
+
+For additional information about OmniAuth, visit [OmniAuth wiki](https://github.com/intridea/omniauth/wiki).
+
+For a short tutorial on how to use OmniAuth in your Rails application, visit [this tutsplus.com tutorial](http://net.tutsplus.com/tutorials/ruby/how-to-use-omniauth-to-authenticate-your-users/).
+
+(The above adapted from [omniauth-fitbit](https://github.com/tkgospodinov/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](https://github.com/tkgospodinov/omniauth-fitbit/blob/master/LICENSE.md) 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.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/example/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'omniauth-withings2', path: '../'
+gem 'pry'
+gem 'pry-stack_explorer'
+gem 'sinatra'

data/example/example.rb

@@ -0,0 +1,20 @@
+require 'sinatra'
+require 'omniauth-withings2'
+require 'pry'
+
+use Rack::Session::Cookie
+use OmniAuth::Builder do
+  provider :withings2, ENV['WITHINGS_CLIENT_ID'], ENV['WITHINGS_CONSUMER_SECRET'], { :scope => 'user.metrics', :redirect_uri => 'http://localhost:4567/auth/withings2/callback' }
+end
+
+get '/' do
+  <<-HTML
+  <a href='/auth/withings2'>Sign in with Withings</a>
+  HTML
+end
+
+get '/auth/withings2/callback' do
+  # Do whatever you want with the data
+  # MultiJson.encode(request.env['omniauth.auth'])
+  request.env['omniauth.auth'].to_json
+end

data/lib/omniauth/strategies/withings2.rb

@@ -0,0 +1,37 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Withings2 < OmniAuth::Strategies::OAuth2
+
+      option :name, 'withings2'
+      option :client_options, {
+          :site          => 'https://account.health.nokia.com',
+          :authorize_url => 'https://account.health.nokia.com/oauth2_user/authorize2',
+          :token_url     => 'https://account.health.nokia.com/oauth2/token'
+      }
+
+      option :response_type, 'code'
+      option :authorize_options, %i(scope response_type redirect_uri)
+
+      def build_access_token
+        options.token_params.merge!(:headers => {'Authorization' => basic_auth_header })
+        super
+      end
+
+      def basic_auth_header
+        "Basic " + Base64.strict_encode64("#{options[:client_id]}:#{options[:client_secret]}")
+      end
+
+      def query_string
+        # Using state and code params in the callback_url causes a mismatch with
+        # the value set in the withings2 application configuration, so we're skipping them
+        ''
+      end
+
+      uid do
+        access_token.params['user_id']
+      end
+    end
+  end
+end

data/lib/omniauth-withings2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Withings
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-withings2.rb

@@ -0,0 +1,2 @@
+require 'omniauth-withings2/version'
+require 'omniauth/strategies/withings2'

data/omniauth-withings2.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-withings2/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-withings2"
+  s.version     = OmniAuth::Withings::VERSION
+  s.authors     = ["Daniel Nelson"]
+  s.email       = ["daniel@platejoy.com"]
+  s.homepage    = "http://github.com/platejoy/omniauth-withings2"
+  s.summary     = %q{OmniAuth OAuth2 strategy for Withings}
+  s.description = %q{OmniAuth OAuth2 strategy for Withings}
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.4'
+end

data/spec/omniauth/strategies/withings2_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe "OmniAuth::Strategies::Withings2" do
+  subject do
+    OmniAuth::Strategies::Withings2.new(nil, @options || {})
+  end
+
+  describe 'response_type' do
+    it 'includes :code' do
+      expect(subject.options["response_type"]).to include('code')
+    end
+  end
+
+  describe 'authorize_options' do
+    it 'includes :scope' do
+      expect(subject.options["authorize_options"]).to include(:scope)
+    end
+
+    it 'includes :response_type' do
+      expect(subject.options["authorize_options"]).to include(:response_type)
+    end
+
+    it 'includes :redirect_uri' do
+      expect(subject.options["authorize_options"]).to include(:redirect_uri)
+    end
+  end
+
+  context 'client options' do
+    it 'has correct OAuth endpoint' do
+      expect(subject.options.client_options.site).to eq('https://account.health.nokia.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://account.health.nokia.com/oauth2_user/authorize2')
+    end
+
+    it 'has correct token url' do
+      expect(subject.options.client_options.token_url).to eq('https://account.health.nokia.com/oauth2/token')
+    end
+  end
+
+  context 'auth header' do
+    before :each do
+      subject.options.client_id = 'testclientid'
+      subject.options.client_secret = 'testclientsecret'
+    end
+
+    it 'returns the correct authorization header value' do
+      expect(subject.basic_auth_header).to eq('Basic ' + Base64.strict_encode64("testclientid:testclientsecret"))
+    end
+  end
+
+  context 'uid' do
+    before :each do
+      access_token = double('access_token')
+      allow(access_token).to receive('params') { { 'user_id' => '123ABC' } }
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns the correct id from raw_info' do
+      expect(subject.uid).to eq('123ABC')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth-oauth2'
+require 'omniauth-withings2'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-withings2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: OmniAuth OAuth2 strategy for Withings
+email:
+- daniel@platejoy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- example/Gemfile
+- example/example.rb
+- lib/omniauth-withings2.rb
+- lib/omniauth-withings2/version.rb
+- lib/omniauth/strategies/withings2.rb
+- omniauth-withings2.gemspec
+- spec/omniauth/strategies/withings2_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/platejoy/omniauth-withings2
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: OmniAuth OAuth2 strategy for Withings
+test_files:
+- spec/omniauth/strategies/withings2_spec.rb
+- spec/spec_helper.rb