omniauth-splitwise 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5dd3a989e67c5c6bcd9b6786890681f2e7c24da
-  data.tar.gz: e49d6a8bc3284f0cec23168c164242537fb5a716
+SHA256:
+  metadata.gz: 9bc6c1857d364dc5239bab481eef88c31912a70057e7840825bafdced35dba18
+  data.tar.gz: cc0416a613b44a05c5dc000b7eaec93c04013ad531d01a3ecb941b973ec16d4a
 SHA512:
-  metadata.gz: 7a382edfc303c4421607b55c0f35f2e727132561b7c39de250c5ee4e68e777c91403b3f73f48c316b4f7a40fe9e7a603734bb724a8eeff98ead55f609513b8ab
-  data.tar.gz: 8ec95fd694ca45b677f833eeea3c134c13aeb52678f671916c0201caa993126b83e9f3868915eec80e46c37f146917f66370f43b3c19f4d1ec1312b3d07d048c
+  metadata.gz: e175f3194e9ed25d411feebaab9d377cc08ba32df794b1d3ee5e4e6b32d4feca04fcebd205608e635b5b2807bcfd81b8751a0501f8ff22772352b1fc63826ec8
+  data.tar.gz: 88ce09fe1d5c9a6854c4f03069c93da33a426b2087455a542490f09c58ad2344e630101926a87f63968b85c42449df6df88a14dc63aa146deb2d98a68a333f29

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nathan Griffith
+
+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

@@ -1,6 +1,9 @@
 # OmniAuth Splitwise
 
-An OmniAuth strategy for authenticating to [Splitwise](http://www.splitwise.com). To use it, you'll need to [sign up for a Consumer Key and Secret](https://secure.splitwise.com/oauth_clients).
+An OmniAuth strategy for authenticating to [Splitwise](http://www.splitwise.com).
+To use it, you'll need to [sign up for a Consumer Key and Secret](https://secure.splitwise.com/oauth_clients).
+
+As of 2020, this gem uses OAuth 2.0 to interface with Splitwise.
 
 ## Installation
 
@@ -16,13 +19,13 @@ Or install it yourself:
 
     $ gem install omniauth-splitwise
 
-## Usage
+## App Setup
 
 For Rack apps, in your config.ru:
 
 ```ruby
 use OmniAuth::Builder do
-  provider :splitwise, ENV['SPLITWISE_KEY'], ENV['SPLITWISE_SECRET']
+  provider :splitwise, ENV.fetch('SPLITWISE_KEY'), ENV.fetch('SPLITWISE_SECRET')
 end
 ```
 
@@ -30,21 +33,37 @@ For Rails apps, in config/initializers/omniauth.rb:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :splitwise, ENV['SPLITWISE_KEY'], ENV['SPLITWISE_SECRET']
+  provider :splitwise, ENV.fetch('SPLITWISE_KEY'), ENV.fetch('SPLITWISE_SECRET')
 end
 ```
 
 See also: [Integrating OmniAuth Into Your Application](https://github.com/intridea/omniauth#integrating-omniauth-into-your-application).
 
-## Example
+### Usage
 
-In the `example/` directory, run the provided Sinatra application for a demo:
+Once a successful OAuth2 request has been made, several fields are available immediately:
 
-    $ cd example/
-    $ bundle
-    $ SPLITWISE_KEY=abc123 SPLITWISE_SECRET=def456 rackup
+```ruby
+auth = request.env['omniauth.auth']
+
+auth['provider']  # => 'splitwise'
+auth['uid']       # => Splitwise User ID
+auth['info']      # => A hash containing 'first_name', 'last_name', and 'email'
+auth['extra']     # => The full user hash from /api/v3.0/get_current_user
+```
+
+Additionally, the bearer token may be extracted and reused:
+
+```ruby
+auth = request.env['omniauth.auth']
 
-Then visit [localhost:9292](http://localhost:9292) to try it out.
+token = auth['credentials']['token']
+client = OAuth2::Client.new(ENV["SPLITWISE_KEY"], ENV["SPLITWISE_SECRET"])
+access_token = OAuth2::AccessToken.new(client, splitwise_token)
+
+# Start making API requests:
+access_token.get('/api/v3.0/get_current_user').parsed
+```
 
 ## Contributing
 
@@ -53,13 +72,3 @@ Then visit [localhost:9292](http://localhost:9292) to try it out.
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
-
-# License
-
-Copyright (C) 2014 by Nathan Griffith
-
-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

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task(:default).clear
+task default: %i(rubocop spec)

data/lib/omniauth-splitwise.rb

@@ -1,2 +1 @@
-require "omniauth/splitwise/version"
-require 'omniauth/strategies/splitwise'
+require 'omniauth_splitwise' # rubocop:disable Naming/FileName

data/lib/omniauth/strategies/splitwise.rb

@@ -1,36 +1,39 @@
-require 'omniauth/strategies/oauth'
+require 'omniauth-oauth2'
 
 module OmniAuth
   module Strategies
-    class Splitwise < OmniAuth::Strategies::OAuth
-      option :name, "splitwise"
+    class Splitwise < OmniAuth::Strategies::OAuth2
+      BASE_SITE = 'https://secure.splitwise.com/'.freeze
 
-      option :client_options, {
-        :site => 'https://secure.splitwise.com',
-        :request_token_path => '/api/v3.0/get_request_token',
-        :access_token_path => '/api/v3.0/get_access_token',
-        :authorize_path => '/authorize',
-        :http_method => :post,
-        :scheme => :header
-      }
+      option :name, "splitwise"
+      option :client_options, site: BASE_SITE
 
       uid do
-        user_data['id']
+        raw_info.fetch('id')
       end
 
       info do
-        user_data
+        {
+          'first_name' => raw_info['first_name'],
+          'last_name' => raw_info['last_name'],
+          'email' => raw_info['email'],
+        }
+      end
+
+      extra do
+        raw_info
       end
 
-private
+      private
 
-      def user_data
-        @info ||= MultiJson.decode(access_token.get('/api/v3.0/get_current_user').body)['user']
+      def raw_info
+        @raw_info ||= access_token.get('/api/v3.0/get_current_user').parsed['user']
       end
 
-      def callback_phase
-        session['oauth'][name.to_s]['callback_confirmed'] = true
-        super
+      # We must override callback_url due to this issue:
+      # https://github.com/omniauth/omniauth-oauth2/issues/93
+      def callback_url
+        full_host + script_name + callback_path
       end
     end
   end

data/lib/omniauth_splitwise.rb

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

data/lib/omniauth_splitwise/version.rb

@@ -0,0 +1,3 @@
+module OmniAuthSplitwise
+  VERSION = "0.1.0".freeze
+end

data/spec/omniauth/strategies/splitwise_spec.rb

@@ -2,36 +2,50 @@ require 'spec_helper'
 
 describe "OmniAuth::Strategies::Splitwise" do
   subject do
-    OmniAuth::Strategies::Splitwise.new(nil, @options || {})
+    OmniAuth::Strategies::Splitwise.new(nil)
   end
 
   context 'client options' do
+    it 'has correct provider name' do
+      subject.options.name eq('splitwise')
+    end
+
     it 'has correct Splitwise site' do
-      subject.options.client_options.site.should eq('https://secure.splitwise.com')
+      subject.options.client_options.site.should eq('https://secure.splitwise.com/')
     end
 
-    it 'has correct request token path' do
-      subject.options.client_options.request_token_path.should eq('/api/v3.0/get_request_token')
+    it 'has correct callback uri' do
+      subject.callback_path.should eq('/auth/splitwise/callback')
     end
 
-    it 'has correct access token path' do
-      subject.options.client_options.access_token_path.should eq('/api/v3.0/get_access_token')
+    it 'has correct token path' do
+      subject.client.options[:token_url].should eq('/oauth/token')
     end
 
     it 'has correct authorize path' do
-      subject.options.client_options.authorize_path.should eq('/authorize')
+      subject.client.options[:authorize_url].should eq('/oauth/authorize')
     end
   end
 
   context '#uid' do
     before :each do
-      subject.stub(:user_data) { { 'id' => '123', "other_data" => 012345 } }
+      subject.stub(
+        raw_info: {
+          'id' => '123',
+          'first_name' => 'Marie',
+          'last_name' => 'Curie',
+          'email' => 'mc@example.org',
+          'other_data' => 0o12345,
+        },
+      )
     end
 
     it 'returns the id from user_data' do
       subject.uid.should eq('123')
-      subject.info["id"].should eq("123")
-      subject.info["other_data"].should eq(012345)
+      subject.info['first_name'].should eq('Marie')
+      subject.info['last_name'].should eq('Curie')
+      subject.info['email'].should eq('mc@example.org')
+      subject.extra['other_data'].should eq(0o12345)
     end
   end
 end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-splitwise
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Griffith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2020-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: omniauth-oauth
+  name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-betterment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - nathan@ngriffith.com
@@ -59,23 +73,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
-- example/Gemfile
-- example/Gemfile.lock
-- example/config.ru
 - lib/omniauth-splitwise.rb
-- lib/omniauth/splitwise/version.rb
 - lib/omniauth/strategies/splitwise.rb
-- omniauth-splitwise.gemspec
+- lib/omniauth_splitwise.rb
+- lib/omniauth_splitwise/version.rb
 - spec/omniauth/strategies/splitwise_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Smudge/omniauth-splitwise
-licenses: []
+homepage: https://github.com/smudge/omniauth-splitwise
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -83,20 +92,19 @@ 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.0.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Splitwise strategy for OmniAuth
 test_files:
-- spec/omniauth/strategies/splitwise_spec.rb
 - spec/spec_helper.rb
+- spec/omniauth/strategies/splitwise_spec.rb

data/.gitignore

@@ -1,16 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-/pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1 +0,0 @@
---color

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in omniauth-splitwise.gemspec
-gemspec

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    omniauth-splitwise (0.0.1)
-      multi_json
-      omniauth-oauth (~> 1.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    hashie (2.0.5)
-    multi_json (1.8.2)
-    oauth (0.4.7)
-    omniauth (1.1.4)
-      hashie (>= 1.2, < 3)
-      rack
-    omniauth-oauth (1.0.1)
-      oauth
-      omniauth (~> 1.0)
-    rack (1.5.2)
-    rspec (2.7.0)
-      rspec-core (~> 2.7.0)
-      rspec-expectations (~> 2.7.0)
-      rspec-mocks (~> 2.7.0)
-    rspec-core (2.7.1)
-    rspec-expectations (2.7.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  omniauth-splitwise!
-  rspec (~> 2.7.0)

data/example/Gemfile

@@ -1,6 +0,0 @@
-source :rubygems
-
-gem 'sinatra'
-gem 'multi_json'
-gem 'omniauth-splitwise', :path => '../'
-

data/example/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    omniauth-splitwise (0.0.1)
-      multi_json
-      omniauth-oauth (~> 1.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    hashie (2.0.5)
-    multi_json (1.8.2)
-    oauth (0.4.7)
-    omniauth (1.1.4)
-      hashie (>= 1.2, < 3)
-      rack
-    omniauth-oauth (1.0.1)
-      oauth
-      omniauth (~> 1.0)
-    rack (1.5.2)
-    rack-protection (1.5.0)
-      rack
-    sinatra (1.4.3)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
-    tilt (1.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  multi_json
-  omniauth-splitwise!
-  sinatra

data/example/config.ru

@@ -1,27 +0,0 @@
-require 'bundler/setup'
-require 'sinatra/base'
-require 'omniauth-splitwise'
-
-class App < Sinatra::Base
-  get '/' do
-    redirect '/auth/splitwise'
-  end
-
-  get '/auth/:provider/callback' do
-    content_type 'application/json'
-    MultiJson.encode(request.env)
-  end
-
-  get '/auth/failure' do
-    content_type 'application/json'
-    MultiJson.encode(request.env)
-  end
-end
-
-use Rack::Session::Cookie
-
-use OmniAuth::Builder do
-  provider :splitwise, ENV['SPLITWISE_KEY'], ENV['SPLITWISE_SECRET']
-end
-
-run App.new

data/lib/omniauth/splitwise/version.rb

@@ -1,5 +0,0 @@
-module OmniAuth
-  module Splitwise
-    VERSION = "0.0.1"
-  end
-end

data/omniauth-splitwise.gemspec

@@ -1,22 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'omniauth/splitwise/version'
-
-Gem::Specification.new do |s|
-  s.name     = 'omniauth-splitwise'
-  s.version  = OmniAuth::Splitwise::VERSION
-  s.authors  = ['Nathan Griffith']
-  s.email    = ['nathan@ngriffith.com']
-  s.summary  = 'Splitwise strategy for OmniAuth'
-  s.homepage = 'https://github.com/Smudge/omniauth-splitwise'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_runtime_dependency 'omniauth-oauth', '~> 1.0.0'
-  s.add_runtime_dependency 'multi_json'
-
-  s.add_development_dependency 'rspec', '~> 2.7.0'
-end