CampusPortal is a campus portals information system for Chinese Academy of Science, which is developed to provide as unified access entrance for the faculties, students and campus application developers.

CampusPortal ultizes OAuth 2.0 protocol to achieve the interactive communication within mulitple heterogeneous web apps, therefore, UcasPortal can act as the main login panel for campus users and web app developers who are going to conncet their apps with CampusPortal.

• For the campus users, which means faculities and students, UcasPortal is a SSO (Single Sign-on) platform. Once campus users logined in UcasPortal, they could have access to all relative campus applications without providing other username and password.

• For campus applications developers, which means the developers owning the inner campus applications (Campus Libaray System...) and the third-part applications (those ultizes the campus users info to provide their service such as selling take-out food), UcasPortal is the OAuth provider and inforamtion holder.

• Developers could login in UcasPortal and create new apps and configue the OAuth conncetion to owned app. Besides, in UcasPortal, Developers can also decide the target users who they are providing service to.

And we also have an sample course selection system CourseSelect_en to demonstrate the OAuth interaction.

• Multi-role Login (students, teachers, developers and admins)
• Account Mail Acivation (and Password Reset by mail)
• OAuth Provider (other apps can use our OAuth service)
• Access Management (by authorizaiton data tree)

CampusPortal is built based on the Doorkeeper gem to achieve related OAuth function. This app also relies on rails_admin gem for back-end management and bootstrap for front end rendering.

Before getting started, make sure your system has the follwoing requirements:

• Bundler
• Git
• Rails 4.2.x
• RubyGems
• Ruby 2.2.x

• Doorkeeper
• Rails_admin
• Bootstrap

Execute the following code in local machine and go to localhost:3000 in your browser

$ git clone https://github.com/PENGZhaoqing/CampusPortal
$ cd CampusPortal
$ bundle install
$ rake db:migrate
$ rake db:seed
$ rails s 

We use 163 mail service for delivering the activation mail, If you would like to use the same service provider, just craete a 163 mail account and configure the following files: (note: make sure your 163 account has open the stmp function)

1.create a file conf/local_env.yml, and fill in as followings:

163MAIL_USENAME: '[email protected]'
163MAIL_PASSWORD: 'your_mail_account_password'

2.modify the the code in 'app/mailers/application_mailer.rb'

class ApplicationMailer < ActionMailer::Base
  default from: "[email protected]"
  layout 'mailer'
end

If you choose other mailer service provider, please config the following in config/environments/production.rb

  config.action_mailer.default_url_options = {host: 'your_site_domain.com'}

  config.action_mailer.perform_deliveries = true
  config.action_mailer.delivery_method = :smtp


  ActionMailer::Base.smtp_settings = {
      :address => 'smtp.163.com',
      :port => '25',
      :authentication => :login,
      :user_name => ENV['163MAIL_USERNAME'],
      :password => ENV['163MAIL_PASSWORD'],
      :domain => 'www.163.com',
      :enable_starttls_auto => true
  }

We take a rails app as an example to explain how to connect with campus portal using OAuth protocol.

1.add omniauth-oauth2 gem to Gemfile and run bundle install:

gem 'omniauth-oauth2', '~> 1.3.1'

2.create new file confg/initializers/omniauth.rb and fill in the uid and secret:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :doorkeeper,"26322d2e8b1a9f1c4aa90e564c2d75b88284820189205c69e489c0bd56f3ab06", "4a95f5bc3abe35b39307cf8540bab66fe8cedad94f174ab6724fcfccac502bc4"
end

Note: the uid and screet are the code that you got while you are creating a app. See the figure below:

And you have to login as a developer before creating new apps

3.create file confg/initializers/doorkeeper.rb, and write the following code to config with OmniAuth gem :

require 'omniauth-oauth2'

module OmniAuth
  module Strategies
    class Doorkeeper < OmniAuth::Strategies::OAuth2
      option :name, 'doorkeeper'
      option :client_options, {
          site: "https://ucas-portal.herokuapp.com",
          authorize_url: "https://ucas-portal.herokuapp.com/oauth/authorize"
      }

      uid {
        raw_info['user']['id']
      }

      info do
        {
            name: raw_info['user']['name'],
            num: raw_info['user']['number'],
            role: raw_info['user']['role'],
            email: raw_info['user']['email'],
            major: raw_info['user']['major'],
            department: raw_info['user']['department'],
            node: raw_info['access']['node'],
            path: raw_info['access']['path'],
        }
      end

      extra do
        {raw_info: raw_info}
      end

      def raw_info
        @raw_info ||= access_token.get('/me').parsed
      end
    end
  end
end

4.Make sure your routes (confg/routes) point to the right controller and action:

 get '/auth/failure' => 'sessions#failure'
 get '/auth/:provider/callback' => 'sessions#callback'

5.Then you can call auth_hash function to get user data, for example, the user name can be got by auth_hash[:info][:name]

class SessionsController < ApplicationController
  include SessionsHelper
  
  ...
  
  def callback
      @user = User.new
      @user.name=auth_hash[:info][:name]
      @user.num=auth_hash[:info][:num]
      @user.role=auth_hash[:info][:role]
      @user.email=auth_hash[:info][:email]
      @user.major=auth_hash[:info][:major]
      @user.department=auth_hash[:info][:department]
      @user.node=auth_hash[:info][:node]
      @user.path=auth_hash[:info][:path]
      if @user.save!
        log_in(@user)
        redirect_to root_url, flash: {success: "Welcome: #{@user.name} :)"}
      else
        redirect_to root_url, flash: {danger: "Try again, please"}
      end
    end
  end
  
  ...

  private

  def auth_hash
    request.env['omniauth.auth']
  end

end

The following accounts are created in db/seed.rb, you can modify as you want:

1. Student Login

account:[email protected]

password:password

2. Teacher Login

account:[email protected]

password:password

3. Developer Login

account:[email protected]

password:password

4. Admin Login

account:[email protected]

password:password

The number in account can be replaced by 2,3... and so on

Fork this first, modify the branch and pull request back to master

Contributors Welcome! Please feel free to contribute this project

If you like this app, start it. thanks !