usos_auth_lib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135ee424533e6fee6163985ab9116940d3809e107ede2ebde5deb42afcf40489
-  data.tar.gz: c1a3fc3af4ac488228bb79b8f48919cbd79eccb8ba8a81ab8773285b458134c5
+  metadata.gz: eee3395c39abdb1728488402efdf0031fcf25e82fee6e2744298b7dd99a7ada3
+  data.tar.gz: 6a10256f1a17f26c1d2e865f0e531e6aafeeb4d3dd777a9c8bbeb70ac3daec09
 SHA512:
-  metadata.gz: a1d8a55ce5caa3b6a1482d3df93bb9fc03e75289b5b89dd2a51ee83c05a87075fa30c9b0703af57dcd126a198db79ebac69511d7ce90441b2fcf50fde52066d3
-  data.tar.gz: 193c8ea2b7907f5e361ce266c50acd78e88d27270ea345313dd247f86af95defd11ad17f62537198c96040e1181df3add71698d1bf15ffd64b128b90871ecb5e
+  metadata.gz: c8c8a609c03eb87242389d6a561ae80e17f1403468b4c8f53fe3974c02a9114afd8802c456aac190db04a4086942ed02be797413659b68d5e79907ac4090c194
+  data.tar.gz: 40d5ff729c4e5f42c627a3380fa430776b159e0e72685e3694f91593a6a845c8669ce5569e46a6ee675f52adefe0bbc87017fb06110abb674a76603e1e41d844

data/README.md

@@ -6,6 +6,25 @@ The USOS API, a cornerstone of academic data access, opens up a world of possibi
 
 The OAuth 1.0a workflow ensures a robust and secure authentication process, safeguarding user credentials while granting seamless access to the USOS API. By adhering to the guidelines provided in the official source, developers can confidently build applications that tap into the extensive educational resources offered by USOS, enriching their projects with academic data in a reliable and user-friendly manner. Explore the possibilities of educational integration through the USOS API and OAuth 1.0a, empowering your applications with a wealth of valuable information.
 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "usos_auth_lib"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install usos_auth_lib
+```
+
+
 ## Usage
 Here's an example for adding the configuration to a Rails app in `config/initializers/usos_auth_lib.rb`:
 ```ruby
@@ -45,7 +64,6 @@ class User < ApplicationRecord
       first_name: token[:first_name],
       last_name: token[:last_name],
       usos_id: token[:id],
-      img_url: token[:photo_url] || nil
     ) unless user
 
     user
@@ -55,33 +73,24 @@ end
 
 Here's an example for callback method in `controllers/users_controller.rb`:
 ```ruby
-class UsersController < ApplicationController
-  def usos_auth
-    session[:access_token] = params[:token]
-    session[:access_token_secret] = params[:secret]
-    @user = User.from_usos(params)
+  def callback
+    user = User.from_usos(session.delete(:user_data))
+    session[:current_user_id] = user.id
   end
-end
 ```
 
-Here's an example for use of handle_request method in `controllers/users_controller.rb`:
+Here's an example for use of handle_request and get_terms_grades method in `controllers/users_controller.rb`:
 ```ruby
 class UsersController < ApplicationController
   include UsosAuthCommon
-  def usos_auth
-    session[:access_token] = params[:token]
-    session[:access_token_secret] = params[:secret]
-    @user = User.from_usos(params)
-  end
-
   def grades
-    response = handle_request(session[:access_token], session[:access_token_secret], '/services/grades/terms2?term_ids=2023/24Z')
+    response = handle_request(session[:access_token], session[:access_token_secret], '/services/grades/terms2?term_ids=2023/24Z|2022/23L')
 
-    render json: response
+    response_2 = get_terms_grades(session[:access_token], session[:access_token_secret], '2023/24Z|2022/23L')
   end
 end
 ```
-In this example, we want to retrieve all grades from the 2023/2024Z semester.
+In this example, we want to retrieve all grades from the 2023/2024Z and 2022/2023L semester.
 
 ## Scopes
 When you request a Request Token, you may pass the scopes parameter, which describes the things you want the User to share with you. Many API methods require you to have the access to multiple scopes.
@@ -121,23 +130,6 @@ student_exams_write: Allows to register and unregister the student from his exam
 
 Source: `https://apps.usos.edu.pl/developers/api/authorization/`
 
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem "usos_auth_lib"
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install usos_auth_lib
-```
-
 ## Contributing
 Contribution directions go here.
 

data/app/controllers/usos_auth_lib/usos_controller.rb

@@ -4,33 +4,30 @@ module UsosAuthLib
       authorization_url = usos_authorizer.authorize(session, request)
 
       redirect_to authorization_url, allow_other_host: true
+    rescue StandardError => e
+      Rails.logger.error "USOS Authorize User Error: #{e.message}"
     end
 
     def callback
       verifier = params[:oauth_verifier]
       access_token = usos_authorizer.access_token(session, verifier, nil, nil)
 
-      response = access_token.get('/services/users/user?fields=id|first_name|last_name|email|photo_urls')
+      response = access_token.get('/services/users/user?fields=id|first_name|last_name|email')
       parsed_response = JSON.parse(response.body)
 
-      puts parsed_response
+      session[:user_data] = parsed_response
+      session[:access_token] = access_token.token
+      session[:access_token_secret] = access_token.secret
 
-      redirect_path = UsosAuthLib.configuration.redirect_path
-
-      url = url_for(redirect_path)
-
-      url << "?id=#{parsed_response['id']}&email=#{parsed_response['email']}"
-      url << "&first_name=#{parsed_response['first_name']}&last_name=#{parsed_response['last_name']}"
-      url << "&photo_url=#{parsed_response['photo_urls']['50x50']}"
-      url << "&token=#{access_token.token}&secret=#{access_token.secret}"
-
-      redirect_to url, allow_other_host: true
+      redirect_to UsosAuthLib.configuration.redirect_path, allow_other_host: true
+    rescue StandardError => e
+      Rails.logger.error "USOS Callback Error: #{e.message}"
     end
 
     private
 
     def usos_authorizer
-      UsosAuthLib::UsosAuthorizer.new
+      UsosAuthLib::UsosAuthorizer.instance
     end
   end
 end

data/app/models/concerns/usos_auth_common.rb

@@ -2,17 +2,36 @@ module UsosAuthCommon
   extend ActiveSupport::Concern
 
   def handle_request(access_token, access_token_secret, service_path)
-    access_token = usos_authorizer.access_token(session, nil, access_token, access_token_secret)
-
-    puts access_token
+    access_token = UsosAuthLib::UsosAuthorizer.instance.access_token(session, nil, access_token, access_token_secret)
 
     response = access_token.get(service_path)
     JSON.parse(response.body)
+  rescue StandardError => e
+    Rails.logger.error "USOS Handle Request Error: #{e.message}"
+  end
+
+  def get_terms_grades(access_token, access_token_secret, term_ids)
+    path = "/services/grades/terms2?term_ids=#{term_ids}"
+    handle_request(access_token, access_token_secret, path)
+  end
+
+  def get_course_grades(access_token, access_token_secret, course_id, term_id)
+    path = "/services/grades/course_edition2?course_id=#{course_id}&term_id=#{term_id}"
+    handle_request(access_token, access_token_secret, path)
+  end
+
+  def get_latest_grades(access_token, access_token_secret)
+    path = "/services/grades/latest"
+    handle_request(access_token, access_token_secret, path)
   end
 
-  private
+  def get_courses(access_token, access_token_secret, course_ids)
+    path = "/services/grades/latest?course_ids=#{course_ids}"
+    handle_request(access_token, access_token_secret, path)
+  end
 
-  def usos_authorizer
-    UsosAuthLib::UsosAuthorizer.new
+  def get_user_info(access_token, access_token_secret, fields)
+    path = "/services/users/user?fields=#{fields}"
+    handle_request(access_token, access_token_secret, path)
   end
 end

data/lib/usos_auth_lib/version.rb

@@ -1,3 +1,3 @@
 module UsosAuthLib
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/usos_auth_lib.rb

@@ -1,6 +1,7 @@
 require 'usos_auth_lib/version'
 require 'usos_auth_lib/engine'
 require 'oauth'
+require 'singleton'
 
 module UsosAuthLib
   class Configuration
@@ -25,6 +26,8 @@ module UsosAuthLib
   end
 
   class UsosAuthorizer
+    include Singleton
+
     def initialize
       config = UsosAuthLib.configuration
       @api_key = config.api_key
@@ -43,6 +46,8 @@ module UsosAuthLib
       session[:request_token_secret] = request_token.secret
 
       request_token.authorize_url
+    rescue StandardError => e
+      Rails.logger.error "USOS Authorize Error: #{e.message}"
     end
 
     def access_token(session, verifier, access_token, access_token_secret)
@@ -64,6 +69,9 @@ module UsosAuthLib
       end
 
       token
+    rescue StandardError => e
+      Rails.logger.error "USOS Access Token Error: #{e.message}"
+      nil
     end
 
     private
@@ -77,6 +85,8 @@ module UsosAuthLib
         authorize_path: '/services/oauth/authorize',
         access_token_path: '/services/oauth/access_token'
       )
+    rescue StandardError => e
+      Rails.logger.error "USOS Consumer Error: #{e.message}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usos_auth_lib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - mikolajczu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth