omniauth-linkedin-openid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 200128bdbafbd862d10c5694e699ca036ad03a195b3f24ebd407747243470591
+  data.tar.gz: 24dd2b40e1e9ce855829c3ed5850b2f45e89348b583655c7895a90ce4252af7d
+SHA512:
+  metadata.gz: 511d291fec173c1f43e5d2df576e7165228fedc46dbd6992a708c9b4f0e7eea81efadf4b46bba5e963623a6b8b7ebeacdd9ee7159cc3c1cf985de7438c8c9921
+  data.tar.gz: 96fc2818001fac2167e991c61d6753418e5ae8046c50211939d9c054cdf1804b42c77582217a0c84793e9f5d05025c4798c55a3410dedea7cad87f4cc8bfff23

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+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', '2.7', '3.0', '3.1', '3.2', 'truffleruby-head']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Build and test with Rake
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-github.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jarrett Lusso
+
+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,70 @@
+# OmniAuth LinkedIn
+
+![Ruby](https://github.com/omniauth/omniauth-github/workflows/Ruby/badge.svg?branch=master)
+[![Gem](https://img.shields.io/gem/v/omniauth-linkedin-openid)](https://rubygems.org/gems/omniauth-linkedin-openid)
+
+This is the a OmniAuth strategy for authenticating to LinkedIn using OpenID. To
+use it, you'll need to register an application on the
+[LinkedIn Apps Page](https://www.linkedin.com/developers/apps) to get your
+Client ID and Client Secret. Additionally, you'll need to request access to the
+"Sign In with LinkedIn using OpenID Connect" product.
+
+For more details, read the [Sign In with LinkedIn using OpenID Connect](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2) documentation.
+
+## Installation
+
+```ruby
+gem 'omniauth-linkedin-openid'
+```
+
+## Usage
+
+```ruby
+use OmniAuth::Builder do
+  provider :linkedin, ENV['LINKEDIN_CLIENT_ID'], ENV['LINKEDIN_CLIENT_SECRET']
+end
+```
+
+## Authenticating Members
+
+With the LinkedIn API, you have the ability to specify which permissions you want users to grant your application. For more details, read the LinkedIn [Authenticating Members](https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2#authenticating-members) documentation.
+
+The following scopes are requested by default:
+
+'openid profile email'
+
+Here is an example of how you can configure the `scope` option:
+
+```ruby
+provider :linkedin, ENV['LINKEDIN_CLIENT_ID'], ENV['LINKEDIN_CLIENT_SECRET'],
+  scope: 'openid profile email'
+```
+
+## Profile Fields
+
+When specifying which permissions you want users to grant to your application, you can also specify the array of fields that you want returned in the OmniAuth hash. The following fields are requested by default:
+
+```ruby
+%w(id full-name first-name last-name picture-url email-address)
+```
+
+Here is an example of how you can configure the `fields` option:
+
+```ruby
+provider :linkedin, ENV['LINKEDIN_CLIENT_ID'], ENV['LINKEDIN_CLIENT_SECRET'],
+  fields: %w(id full-name email-address)
+```
+
+To see a complete list of available fields, read the LinkedIn [Profile Fields](https://learn.microsoft.com/en-us/linkedin/shared/references/fields) documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jclusso/omniauth-linkedin-openid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "omniauth-linkedin-openid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/strategies/linkedin.rb

@@ -0,0 +1,89 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class LinkedIn < OmniAuth::Strategies::OAuth2
+      option :name, 'linkedin'
+
+      option :client_options, {
+        :site => 'https://api.linkedin.com',
+        :authorize_url => 'https://www.linkedin.com/oauth/v2/authorization?response_type=code',
+        :token_url => 'https://www.linkedin.com/oauth/v2/accessToken'
+      }
+
+      option :scope, 'openid profile email'
+      option :fields, %w(
+        id full-name first-name last-name picture-url email-address
+      )
+      option :redirect_url
+
+      uid do
+        raw_info['sub']
+      end
+
+      info do
+        {
+          email: raw_info['email'],
+          first_name: raw_info['given_name'],
+          last_name: raw_info['family_name'],
+          picture_url: raw_info['picture']
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def callback_url
+        return options.redirect_url if options.redirect_url
+
+        full_host + script_name + callback_path
+      end
+
+      alias :oauth2_access_token :access_token
+
+      def access_token
+        ::OAuth2::AccessToken.new(client, oauth2_access_token.token, {
+          expires_in: oauth2_access_token.expires_in,
+          expires_at: oauth2_access_token.expires_at,
+          refresh_token: oauth2_access_token.refresh_token
+        })
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(profile_endpoint).parsed
+      end
+
+      private
+
+      def fields_mapping
+        # https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2?context=linkedin%2Fconsumer%2Fcontext#api-request-to-retreive-member-details
+        {
+          'id' => 'sub',
+          'full-name' => 'name',
+          'first-name' => 'given_name',
+          'last-name' => 'family_name',
+          'picture-url' => 'picture'
+        }
+      end
+
+      def fields
+        options.fields.each.with_object([]) do |field, result|
+          result << fields_mapping[field] if fields_mapping.has_key? field
+        end
+      end
+
+      def profile_endpoint
+        '/v2/userinfo'
+      end
+
+      def token_params
+        super.tap do |params|
+          params.client_secret = options.client_secret
+        end
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'linkedin', 'LinkedIn'

data/lib/omniauth-linkedin-openid/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module LinkedInOpenID
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth-linkedin-openid.rb

@@ -0,0 +1,2 @@
+require "omniauth-linkedin-openid/version"
+require 'omniauth/strategies/linkedin'

data/omniauth-linkedin-openid.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-linkedin-openid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = 'Jarrett Lusso'
+  gem.email         = 'jclusso@gmail.com'
+  gem.description   = 'OmniAuth strategy for LinkedIn using OpenID.'
+  gem.summary       = 'OmniAuth strategy for LinkedIn using OpenID.'
+  gem.homepage      = 'https://github.com/jclusso/omniauth-linkedin-openid'
+  gem.license       = 'MIT'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'omniauth-linkedin-openid'
+  gem.require_paths = ['lib']
+  gem.version       = OmniAuth::LinkedInOpenID::VERSION
+
+  gem.metadata = {
+    "bug_tracker_uri" => "https://github.com/jclusso/omniauth-linkedin-openid/issues",
+    "documentation_uri" => "https://github.com/jclusso/omniauth-linkedin-openid/README.md",
+    "source_code_uri" => "https://github.com/jclusso/omniauth-linkedin-openid"
+  }
+
+  gem.add_dependency 'omniauth', '~> 2.0'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.8'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/linkedin_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'omniauth-linkedin-openid'
+
+describe OmniAuth::Strategies::LinkedIn do
+  subject { OmniAuth::Strategies::LinkedIn.new(nil) }
+
+  it 'adds camelization for itself' do
+    expect(OmniAuth::Utils.camelize('linkedin')).to eq('LinkedIn')
+  end
+
+  describe '#client' do
+    it 'has correct LinkedIn site' do
+      expect(subject.client.site).to eq('https://api.linkedin.com')
+    end
+
+    it 'has correct `authorize_url`' do
+      expect(subject.client.options[:authorize_url]).to eq('https://www.linkedin.com/oauth/v2/authorization?response_type=code')
+    end
+
+    it 'has correct `token_url`' do
+      expect(subject.client.options[:token_url]).to eq('https://www.linkedin.com/oauth/v2/accessToken')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/linkedin/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { Hash['sub' => 'uid'] }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('uid')
+    end
+  end
+
+  describe '#info / #raw_info' do
+    let(:access_token) { instance_double OAuth2::AccessToken }
+
+    let(:parsed_response) { Hash[:foo => 'bar'] }
+
+    let(:profile_endpoint) { '/v2/userinfo' }
+    let(:profile_response) { instance_double OAuth2::Response, parsed: parsed_response }
+
+    before :each do
+      allow(subject).to receive(:access_token).and_return access_token
+
+      allow(access_token).to receive(:get)
+        .with(profile_endpoint)
+        .and_return(profile_response)
+    end
+
+    it 'returns parsed responses using access token' do
+      expect(subject.info).to have_key :email
+      expect(subject.info).to have_key :first_name
+      expect(subject.info).to have_key :last_name
+      expect(subject.info).to have_key :picture_url
+
+      expect(subject.raw_info).to eq({ :foo => 'bar' })
+    end
+  end
+
+  describe '#extra' do
+    let(:raw_info) { Hash[:foo => 'bar'] }
+
+    before :each do
+      allow(subject).to receive(:raw_info).and_return raw_info
+    end
+
+    specify { expect(subject.extra['raw_info']).to eq raw_info }
+  end
+
+  describe '#access_token' do
+    let(:expires_in) { 3600 }
+    let(:expires_at) { 946688400 }
+    let(:token) { 'token' }
+    let(:refresh_token) { 'refresh_token' }
+    let(:access_token) do
+      instance_double OAuth2::AccessToken, :expires_in => expires_in,
+        :expires_at => expires_at, :token => token, :refresh_token => refresh_token
+    end
+
+    before :each do
+      allow(subject).to receive(:oauth2_access_token).and_return access_token
+    end
+
+    specify { expect(subject.access_token.expires_in).to eq expires_in }
+    specify { expect(subject.access_token.expires_at).to eq expires_at }
+  end
+
+  describe '#authorize_params' do
+    describe 'scope' do
+      before :each do
+        allow(subject).to receive(:session).and_return({})
+      end
+
+      it 'sets default scope' do
+        expect(subject.authorize_params['scope']).to eq('openid profile email')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-linkedin-openid'
+
+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,134 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-linkedin-openid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jarrett Lusso
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for LinkedIn using OpenID.
+email: jclusso@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-linkedin-openid.rb
+- lib/omniauth-linkedin-openid/version.rb
+- lib/omniauth/strategies/linkedin.rb
+- omniauth-linkedin-openid.gemspec
+- spec/omniauth/strategies/linkedin_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jclusso/omniauth-linkedin-openid
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/jclusso/omniauth-linkedin-openid/issues
+  documentation_uri: https://github.com/jclusso/omniauth-linkedin-openid/README.md
+  source_code_uri: https://github.com/jclusso/omniauth-linkedin-openid
+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: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: OmniAuth strategy for LinkedIn using OpenID.
+test_files:
+- spec/omniauth/strategies/linkedin_spec.rb
+- spec/spec_helper.rb