omniauth-classlink 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd19e536467b6d9f6d1f6849b3e13b797908acb8
-  data.tar.gz: 7a13fbd776b77450f8a5716e700622f6a4559394
+  metadata.gz: 39a933cfdc9037bea236532c640b54b56a0f2bc7
+  data.tar.gz: 75b187f8b5497a9e672f59ebeefefed1eef163b4
 SHA512:
-  metadata.gz: 7ee56bba9433274d9cfc34b622ffce6a25890d41bb45ee4df0994745d1ee1f20137b8cdcdff4b1157496ea5290d97f6ffd45cef6224e458a09c07f78ab2110cd
-  data.tar.gz: 9118728ccad62d52791cd8866abcbbd58fc148fbf0739b6511854b455c45b311802902886421d1fe24b5297e904195066bc4a64daa6ba39a74630904d6a19ee8
+  metadata.gz: e9935f73e199f001c676bbe64fa1e9c1181a203521c42d679ad4d410d8df07726da4ccb015de6600b5c351b1f621d47c253add7553a5f5d0443c6d272f6c74f9
+  data.tar.gz: f0cf877c8a622c04bff8fab528ade6179a8dc763fd3a9bf7ec699ce30912b129f86084301f055ada1f8e70ba72ef0c917f59d7dc691c605c6dd881fe4ab38f46

data/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+Gemfile.lock
 
 # Used by dotenv library to load environment variables.
 # .env

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in omniauth-clever.gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-clever.gemspec
 gemspec

data/README.md

@@ -1,5 +1,39 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-classlink.svg)](https://badge.fury.io/rb/omniauth-classlink)
+
 # OmniAuth ClassLink
-Unofficial OmniAuth strategy for [ClassLink](classlink.com) integration.
+Unofficial OmniAuth strategy for [ClassLink](https://classlink.com) integration.
+
+# Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+gem 'omniauth-classlink'
+```
+And then execute:
+
+```
+$ bundle
+```
+
+# Usage
+
+First, you need to have your OAuth2 application registered in ClassLink. After creating one, you'll be provided with access key and secret that should be used for configuring the gem.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :class_link, 'your-classlink-access-key', 'your-classlink-secret', strategy_class: 'OmniAuth::Strategies::ClassLink'
+end
+```
+
+Or, alternatively, if you use [Devise](https://github.com/plataformatec/devise), you can put this in the `Devise.setup` section:
+
+```ruby
+ config.omniauth :class_link,
+                 'your-classlink-access-key',
+                 'your-classlink-secret',
+                 strategy_class: 'OmniAuth::Strategies::ClassLink'
+```
 
 # Contributing
 1. Fork it

data/lib/omniauth/{classlink → class_link}/version.rb

@@ -1,5 +1,5 @@
-module Omniauth
-  module ClassLink
-    VERSION = "0.1.0"
-  end
-end
+module Omniauth
+  module ClassLink
+    VERSION = "0.2.0"
+  end
+end

data/lib/omniauth/{classlink.rb → class_link.rb}

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

data/lib/omniauth/strategies/{classlink.rb → class_link.rb}

@@ -1,42 +1,49 @@
-require 'omniauth-oauth2'
-require 'base64'
-
-module OmniAuth
-  module Strategies
-    class ClassLink < OmniAuth::Strategies::OAuth2
-      option :name, :classlink
-      option :client_options, {
-        :site          => 'https://launchpad.classlink.com',
-        :authorize_url => '/oauth2/v2/auth',
-        :token_url     => '/oauth2/v2/token'
-      }
-      option :fields, [:email, :profile]
-      option :uid_field, :email
-
-      def authorize_params
-        super.tap do |params|
-          params[:scope] = [:email, :profile]
-          params[:response_type] = :code
-        end
-      end
-
-      info do
-        {
-          first_name: raw_info['FirstName'],
-          district_id: raw_info['TenantId'],
-          classlink_id: raw_info['UserId'],
-          external_id: raw_info['SourcedId'],
-          role: raw_info['Role']
-        }
-      end
-
-      extra do
-        { 'raw_info' => raw_info }
-      end
-
-      def raw_info
-        @raw_info ||= access_token.get('https://nodeapi.classlink.com/v2/my/info').parsed
-      end
-    end
-  end
-end
+require 'omniauth-oauth2'
+require 'base64'
+
+module OmniAuth
+  module Strategies
+    class ClassLink < OmniAuth::Strategies::OAuth2
+      option :name, :classlink
+      option :client_options, {
+        site:          'https://launchpad.classlink.com',
+        authorize_url: '/oauth2/v2/auth',
+        token_url:     '/oauth2/v2/token'
+      }
+      option :fields, [:email, :profile]
+      option :uid_field, 'UserId'
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] = [:email, :profile]
+          params[:response_type] = :code
+        end
+      end
+
+      info do
+        {
+          first_name: raw_info['FirstName'],
+          district_id: raw_info['TenantId'],
+          classlink_id: raw_info['UserId'],
+          external_id: raw_info['SourcedId'],
+          role: raw_info['Role']
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('https://nodeapi.classlink.com/v2/my/info').parsed
+      end
+
+      private
+
+      def callback_url
+        # You can overwrite it for development purposes
+        options[:redirect_uri] || super
+      end
+    end
+  end
+end

data/lib/omniauth-classlink.rb

@@ -1 +1 @@
-require 'omniauth/classlink'
+require 'omniauth/classlink'

data/omniauth-classlink.gemspec

@@ -1,25 +1,25 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'omniauth/classlink/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "omniauth-classlink"
-  gem.version       = Omniauth::ClassLink::VERSION
-  gem.authors       = ["Kamil Bednarz"]
-  gem.email         = ["kamil.bednarz@u2i.com"]
-  gem.description   = %q{Unofficial OmniAuth strategy for ClassLink SSO OAuth2 integration}
-  gem.summary       = %q{The unofficial strategy for authenticating users using launchpad.classlink.com using OAuth2 provider}
-  gem.homepage      = "https://github.com/u2i/omniauth-classlink"
-  gem.license       = 'Apache2'
-
-  gem.signing_key   = ENV['GEM_PRIVATE_KEY']
-  gem.cert_chain    = ['gem-public_cert.pem']
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.1'
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/class_link/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-classlink"
+  gem.version       = Omniauth::ClassLink::VERSION
+  gem.authors       = ["Kamil Bednarz"]
+  gem.email         = ["kamil.bednarz@u2i.com"]
+  gem.description   = %q{Unofficial OmniAuth strategy for ClassLink SSO OAuth2 integration}
+  gem.summary       = %q{The unofficial strategy for authenticating users using launchpad.classlink.com using OAuth2 provider}
+  gem.homepage      = "https://github.com/u2i/omniauth-classlink"
+  gem.license       = 'Apache2'
+
+  gem.signing_key   = ENV['GEM_PRIVATE_KEY']
+  gem.cert_chain    = ['gem-public_cert.pem']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.4'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-classlink
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kamil Bednarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain:
 - gem-public_cert.pem
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.4'
 description: Unofficial OmniAuth strategy for ClassLink SSO OAuth2 integration
 email:
 - kamil.bednarz@u2i.com
@@ -38,9 +38,9 @@ files:
 - README.md
 - Rakefile
 - lib/omniauth-classlink.rb
-- lib/omniauth/classlink.rb
-- lib/omniauth/classlink/version.rb
-- lib/omniauth/strategies/classlink.rb
+- lib/omniauth/class_link.rb
+- lib/omniauth/class_link/version.rb
+- lib/omniauth/strategies/class_link.rb
 - omniauth-classlink.gemspec
 homepage: https://github.com/u2i/omniauth-classlink
 licenses:
@@ -62,10 +62,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: The unofficial strategy for authenticating users using launchpad.classlink.com
   using OAuth2 provider
 test_files: []
-has_rdoc: