omniauth-ncu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67758a1f70dcf09ba436e5b8e2a227e7dc264ff0
+  data.tar.gz: 24bed3669869d199128bda950ce4ee926dc3c636
+SHA512:
+  metadata.gz: 0406a550b064a1a7cb4b78fee4e40131e986b3983db0417e369084a69f023386be2b7ae11dbca4557990d7a960e0e779647cbe15ef362f0233708b51cc067ef4
+  data.tar.gz: 492c7385bcad6f9f7f859dd589be9850ea1c721864f917ac6c1219f8768ee90d9c86a5e34c1049fd952532aa4759a62d5a031a4e0f6596cc68a81c9b341d7b5f

data/.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

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 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-ncu.gemspec')
+end

data/LICENSE

@@ -0,0 +1,8 @@
+
+Copyright (c) 2015- Community of Networking and Open Source
+
+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,38 @@
+
+# Omniauth::NCU
+> English | [繁體中文](README.zh-tw.md)
+
+This is the community version OmniAuth strategy for authenticating to [NCU](http://www.ncu.edu.tw) (National Central University, Taiwan). To use it, you'll need to sign up for an OAuth Client ID and Secret on the [NCU OAuth Applications Page](https://api.cc.ncu.edu.tw/manage/developer/client/list).
+
+## Basic Usage
+
+```
+use OmniAuth::Builder do
+  provider :ncu, ENV['NCU_CLIENT_ID'], ENV['NCU_CLIENT_SECRET']
+end
+```
+
+## Scopes
+
+NCU OAuth API lets you set scopes to provide granular access to different types of data:
+
+```
+use OmniAuth::Builder do
+  provider :ncu, ENV['NCU_CLIENT_ID'], ENV['NCU_CLIENT_SECRET'], scope: %w(user.info.basic.read course.schedule.read)
+end
+```
+
+More info on [Scopes](https://github.com/NCU-CC/API-Documentation/blob/master/oauth-service/scope.md).
+
+## License
+
+Under MIT License.
+
+> Copyright (c) 2015- Community of Networking and Open Source
+>
+> 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.zh-tw.md

@@ -0,0 +1,38 @@
+
+# Omniauth::NCU
+> [English](README.md) | 繁體中文
+
+此為社群版本之可用於[中央大學](http://www.ncu.edu.tw)認證之 OmniAuth strategy。 使用前你可能需要先前往[中央大學 OAuth 應用服務管理](https://api.cc.ncu.edu.tw/manage/developer/client/list)申請 Client ID 以及 Client Secret。
+
+## 基礎用法
+
+```
+use OmniAuth::Builder do
+  provider :ncu, ENV['NCU_CLIENT_ID'], ENV['NCU_CLIENT_SECRET']
+end
+```
+
+## Scope
+
+NCU OAuth API 提供你設定 scopes 來取得不同資料的存取權限：
+
+```
+use OmniAuth::Builder do
+  provider :ncu, ENV['NCU_CLIENT_ID'], ENV['NCU_CLIENT_SECRET'], scope: %w(user.info.basic.read course.schedule.read)
+end
+```
+
+更多資訊請上 [Scopes](https://github.com/NCU-CC/API-Documentation/blob/master/oauth-service/scope.md)。
+
+## 授權條款
+
+以 MIT License 釋出。
+
+> Copyright (c) 2015- Community of Networking and Open Source
+>
+> 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,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

data/lib/omniauth-ncu.rb

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

data/lib/omniauth-ncu/version.rb

@@ -0,0 +1,6 @@
+module OmniAuth
+  module NCU
+    VERSION = "1.0.0"
+  end
+end
+

data/lib/omniauth/strategies/ncu.rb

@@ -0,0 +1,80 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class NCU < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPES = %w(user.info.basic.read)
+
+      option :client_options, {
+        :site => 'https://api.cc.ncu.edu.tw',
+        :authorize_url => 'https://api.cc.ncu.edu.tw/oauth/oauth/authorize',
+        :token_url => 'https://api.cc.ncu.edu.tw/oauth/oauth/token'
+      }
+
+      option :token_params, {
+        :parse => :json
+      }
+
+      option :authorize_params, {
+        :scope => DEFAULT_SCOPES
+      }
+
+      def request_phase
+        super
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope client_options].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+          params[:scope] = params[:scope].join ' ' if params[:scope]
+        end
+      end
+
+      uid {
+        #raw_info['id'].to_s
+        info.hash
+      }
+
+      info do
+        next {} unless info_allowed?
+        {
+          'name' => raw_info['name'],
+          'type' => raw_info['type'],
+          'unit' => raw_info['unit']
+        }.merge(raw_info['type'] == 'STUDENT' ? {
+          'group' => raw_info['group'],
+          'number' => raw_info['number']
+        } : {
+          'title' => raw_info['title']
+        })
+      end
+
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      def raw_info
+        return {} unless info_allowed?
+        access_token.options[:mode] = :header
+        @raw_info ||= access_token.get('personnel/v1/info').parsed
+      rescue ::OAuth2::Error => e
+        Logger.new(STDOUT).info e.to_s
+        {}
+      end
+
+      def info_allowed?
+        info_scopes = %w(user.info.basic.read)
+        scope = (options['scope'] || DEFAULT_SCOPES)
+        (info_scopes & scope).any?
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'ncu', 'NCU'

data/omniauth-ncu.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-ncu/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Kuo"]
+  gem.email         = ["me@davy.tw"]
+  gem.description   = %q{OmniAuth strategy for NCU OAuth.}
+  gem.summary       = %q{OmniAuth strategy for NCU OAuth.}
+  gem.homepage      = "https://github.com/ncunos/omniauth-ncu"
+  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-ncu"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::NCU::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.0'
+  # Nothing lower than omniauth-oauth2 1.1.1
+  # http://www.rubysec.com/advisories/CVE-2012-6134/
+  gem.add_dependency 'omniauth-oauth2', '>= 1.1.1', '< 2.0'
+  gem.add_development_dependency 'rspec', '~> 2.99'
+  gem.add_development_dependency 'rack-test', '~> 0.6'
+  gem.add_development_dependency 'simplecov', '~> 0.10'
+  gem.add_development_dependency 'webmock', '~> 1.21'
+end

data/spec/omniauth/strategies/ncu_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::NCU do
+  let!(:info_endpoint) { 'personnel/v1/info' }
+  let(:access_token) { double('AccessToken', :options => {}) }
+  let(:response) { double('Response', :parsed => {}) }
+  let(:student_response) { double('Response', :parsed => {
+    'name' => 'Steve',
+    'type' => 'STUDENT',
+    'unit' => 'test unit',
+    'group' => 'test group',
+    'number' => '123456789'
+  }) }
+  let(:faculty_response) { double('Response', :parsed => {
+    'name' => 'Steve',
+    'type' => 'FACULTY',
+    'unit' => 'test unit',
+    'title' => 'test title'
+  }) }
+
+  subject do
+    OmniAuth::Strategies::NCU.new({})
+  end
+
+  before :each do
+    allow(subject).to receive(:access_token).and_return(access_token)
+  end
+
+  context "client options" do
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq("https://api.cc.ncu.edu.tw")
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://api.cc.ncu.edu.tw/oauth/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('https://api.cc.ncu.edu.tw/oauth/oauth/token')
+    end
+  end
+
+  context "#info_allowed?" do
+    it "should allow raw_info if scope is nil by filling default scope" do
+      expect(subject.options['scope']).to be_nil
+      expect(subject.info_allowed?).to be true
+    end
+
+    it "should allow raw_info if scope is user.info.basic.read" do
+      allow(subject.options).to receive(:[]).with('scope').and_return %w(user.info.basic.read)
+      expect(subject.info_allowed?).to be true
+    end
+
+    it "should allow raw_info if scope has included user.info.basic.read" do
+      allow(subject.options).to receive(:[]).with('scope').and_return %w(user.info.basic.read course.schedule.read)
+      expect(subject.info_allowed?).to be true
+    end
+
+    it "should not allow raw_info if scope does not grant email access" do
+      allow(subject.options).to receive(:[]).with('scope').and_return %w(course.schedule.read)
+      expect(subject.info_allowed?).to be false
+    end
+
+    it "should assume raw_info access not allowed if scope is something currently not documented " do
+      allow(subject.options).to receive(:[]).with('scope').and_return %w(currently_not_documented)
+      expect(subject.info_allowed?).to be false
+    end
+  end
+
+  context "#raw_info" do
+    it "should return empty Hash if info not allowed" do
+      allow(subject).to receive(:info_allowed?).and_return false
+      expect(subject.raw_info.class).to be Hash
+      expect(subject.raw_info).to be_empty
+    end
+    it "should return correct info" do
+      allow(subject).to receive(:info_allowed?).and_return true
+      expect(access_token).to receive(:get).with(info_endpoint).and_return response
+      expect(subject.raw_info).to eq(response.parsed)
+    end
+  end
+
+  context "#info" do
+    before :each do
+      allow(subject).to receive(:info_allowed?).and_return true
+    end
+    it "should return student info if type is STUDENT" do
+      allow(subject).to receive(:raw_info).and_return student_response.parsed
+      expect(subject.info).to eq(student_response.parsed)
+    end
+    it "should return faculty info if type is FACULTY" do
+      allow(subject).to receive(:raw_info).and_return faculty_response.parsed
+      expect(subject.info).to eq(faculty_response.parsed)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-ncu'
+
+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,152 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-ncu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Kuo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: OmniAuth strategy for NCU OAuth.
+email:
+- me@davy.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- README.zh-tw.md
+- Rakefile
+- lib/omniauth-ncu.rb
+- lib/omniauth-ncu/version.rb
+- lib/omniauth/strategies/ncu.rb
+- omniauth-ncu.gemspec
+- spec/omniauth/strategies/ncu_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ncunos/omniauth-ncu
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for NCU OAuth.
+test_files:
+- spec/omniauth/strategies/ncu_spec.rb
+- spec/spec_helper.rb
+has_rdoc: