omniauth-github 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 72538f29bb0f32daba3074d330d8e5524ec05d3a
-  data.tar.gz: 4b2077a891853d05e098024fb0e7cdaab2ce1436
+SHA256:
+  metadata.gz: 69587c7e122010a4aa5042e82d83a5783167c86b583dd5cda1d5f2a745e671f1
+  data.tar.gz: 01a585f28b26650b42fba83bf283760e0d26929f4b9ea0100bf7f244ed40898c
 SHA512:
-  metadata.gz: a80670fc15ad32bb5ebd033cdf80ee1da215141180963b8df2560d9763a9f1c2bcad916312dd9f1e75bc5770ada73ca327e39fe48adbc0ffcd9b8b8431dd7171
-  data.tar.gz: 903d08d81f70fe1ef648a19b8b468e027a8c6b41de7635486a2680f806eadc62b5135cf45a6722ccd6e23eb28b04fac3a104fb28004bc688cf1811d5e3d3f8be
+  metadata.gz: 23d79870e430a1331da27792d46151470a13e3bec0e98a8feff5a4d6df71605563ebc2b9206b2adfa60ab57c96f83e164f5351ee75ffe69f0803332385bc00f2
+  data.tar.gz: 47023e14293172e0e7ad0d24023097b8c6769435b05e8463b590bbe79a63bbad3e93dcc20c7845b7bf5981b6d86e723fd9430894a0a21561ce9ee49e3c35816b

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/README.md

@@ -1,9 +1,17 @@
+![Ruby](https://github.com/omniauth/omniauth-github/workflows/Ruby/badge.svg?branch=master)
+
 # OmniAuth GitHub
 
 This is the official OmniAuth strategy for authenticating to GitHub. To
 use it, you'll need to sign up for an OAuth2 Application ID and Secret
 on the [GitHub Applications Page](https://github.com/settings/applications).
 
+## Installation
+
+```ruby
+gem 'omniauth-github', github: 'omniauth/omniauth-github', branch: 'master'
+```
+
 ## Basic Usage
 
 ```ruby
@@ -12,6 +20,18 @@ use OmniAuth::Builder do
 end
 ```
 
+
+## Basic Usage Rails
+
+In `config/initializers/github.rb`
+
+```ruby
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :github, ENV['GITHUB_KEY'], ENV['GITHUB_SECRET']
+  end
+```
+
+
 ## Github Enterprise Usage
 
 ```ruby
@@ -35,7 +55,12 @@ use OmniAuth::Builder do
 end
 ```
 
-More info on [Scopes](http://developer.github.com/v3/oauth/#scopes).
+More info on [Scopes](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps).
+
+
+## Semver
+This project adheres to Semantic Versioning 2.0.0. Any violations of this scheme are considered to be bugs. 
+All changes will be tracked [here](https://github.com/omniauth/omniauth-github/releases).
 
 ## License
 

data/lib/omniauth-github/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GitHub
-    VERSION = "1.2.1"
+    VERSION = "2.0.0"
   end
 end

data/lib/omniauth/strategies/github.rb

@@ -28,7 +28,7 @@ module OmniAuth
       info do
         {
           'nickname' => raw_info['login'],
-          'email' => primary_email,
+          'email' => email,
           'name' => raw_info['name'],
           'image' => raw_info['avatar_url'],
           'urls' => {
@@ -39,11 +39,11 @@ module OmniAuth
       end
 
       extra do
-        {:raw_info => raw_info, :all_emails => emails}
+        {:raw_info => raw_info, :all_emails => emails, :scope => scope }
       end
 
       def raw_info
-        access_token.options[:mode] = :query
+        access_token.options[:mode] = :header
         @raw_info ||= access_token.get('user').parsed
       end
 
@@ -51,6 +51,10 @@ module OmniAuth
         (email_access_allowed?) ? primary_email : raw_info['email']
       end
 
+      def scope
+        access_token['scope']
+      end
+
       def primary_email
         primary = emails.find{ |i| i['primary'] && i['verified'] }
         primary && primary['email'] || nil
@@ -59,7 +63,7 @@ module OmniAuth
       # The new /user/emails API - http://developer.github.com/v3/users/emails/#future-response
       def emails
         return [] unless email_access_allowed?
-        access_token.options[:mode] = :query
+        access_token.options[:mode] = :header
         @emails ||= access_token.get('user/emails', :headers => { 'Accept' => 'application/vnd.github.v3' }).parsed
       end
 
@@ -69,6 +73,10 @@ module OmniAuth
         scopes = options['scope'].split(',')
         (scopes & email_scopes).any?
       end
+
+      def callback_url
+        full_host + callback_path
+      end
     end
   end
 end

data/omniauth-github.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = OmniAuth::GitHub::VERSION
 
-  gem.add_dependency 'omniauth', '~> 1.4.0'
-  gem.add_dependency 'omniauth-oauth2', '>= 1.4.0', '< 2.0'
+  gem.add_dependency 'omniauth', '~> 2.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.7.1'
   gem.add_development_dependency 'rspec', '~> 3.5'
   gem.add_development_dependency 'rack-test'
   gem.add_development_dependency 'simplecov'

data/spec/omniauth/strategies/github_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe OmniAuth::Strategies::GitHub do
-  let(:access_token) { instance_double('AccessToken', :options => {}) }
+  let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
   let(:parsed_response) { instance_double('ParsedResponse') }
   let(:response) { instance_double('Response', :parsed => parsed_response) }
 
@@ -122,6 +122,12 @@ describe OmniAuth::Strategies::GitHub do
       expect(access_token).to receive(:get).with('user').and_return(response)
       expect(subject.raw_info).to eq(parsed_response)
     end
+
+    it 'should use the header auth mode' do
+      expect(access_token).to receive(:get).with('user').and_return(response)
+      subject.raw_info
+      expect(access_token.options[:mode]).to eq(:header)
+    end
   end
 
   context '#emails' do
@@ -133,6 +139,24 @@ describe OmniAuth::Strategies::GitHub do
       subject.options['scope'] = 'user'
       expect(subject.emails).to eq(parsed_response)
     end
+
+    it 'should use the header auth mode' do
+      expect(access_token).to receive(:get).with('user/emails', :headers => {
+        'Accept' => 'application/vnd.github.v3'
+      }).and_return(response)
+
+      subject.options['scope'] = 'user'
+      subject.emails
+      expect(access_token.options[:mode]).to eq(:header)
+    end
+  end
+
+  context '#info.email' do
+    it 'should use any available email' do
+      allow(subject).to receive(:raw_info).and_return({})
+      allow(subject).to receive(:email).and_return('you@example.com')
+      expect(subject.info['email']).to eq('you@example.com')
+    end
   end
 
   context '#info.urls' do
@@ -141,4 +165,19 @@ describe OmniAuth::Strategies::GitHub do
       expect(subject.info['urls']['GitHub']).to eq('http://enterprise/me')
     end
   end
+
+  context '#extra.scope' do
+    it 'returns the scope on the returned access_token' do
+      expect(subject.scope).to eq('user')
+    end
+  end
+
+  describe '#callback_url' do
+    it 'is a combination of host, script name, and callback path' do
+      allow(subject).to receive(:full_host).and_return('https://example.com')
+      allow(subject).to receive(:script_name).and_return('/sub_uri')
+
+      expect(subject.callback_url).to eq('https://example.com/sub_uri/auth/github/callback')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-github
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -139,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Official OmniAuth strategy for GitHub.