qalam_oauth_engine 2.2.9 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca4df23009a1ac767c658d767afb25ce07614896e9a64c4a29902034377be29c
-  data.tar.gz: f64d346bf4ef5619e98b491de827602c8b18bec4c38d2e8ee3a761be4b85e858
+  metadata.gz: 7d5f44f20e6e7274024cb0db320eea0b44c806fe1071a6b1f22f55126d9705a7
+  data.tar.gz: 98a8dbd9c702bcf62038b8acc8916c2357684995fb44538ac95a073d6254af8d
 SHA512:
-  metadata.gz: b3f808048822cc4442059f75203df5662bc0657cedca326842c2a909ed05e16688ffd3bc295addb02081363cc6d37a68e72e898d49ae4b19fa1cfa4c077c91f7
-  data.tar.gz: 476c685d5a946c4a89494fed0500e439fae6bc1adbec7e51f7f04497ecdfc9e48d5a05be906bd4700fc0ea478360bbcec69a68552812685398472a7d5f4ff897
+  metadata.gz: 33f504f27fad28dd842e8cc0c8e1766e77dc1561b6fbd93e9b798ee29f72355431f7acca0007cdf0b82d2d131b82b4d3b6bb116d0190c12889dcf4bcc2f96699
+  data.tar.gz: fd3270a95699a8cc7c9bedbda1b0ec3cc46a2bf31ff06f363e50b1d5f6dbd459b83487bbf2a8f6ae09793bffe5fdadcb16e8ae5a044f22e0564a413238f5dd14

data/app/controllers/canvas_oauth/canvas_controller.rb

@@ -23,4 +23,4 @@ module CanvasOauth
       callback_state.present? && callback_state == session.delete(:oauth2_state)
     end
   end
-end
+end

data/app/models/canvas_lti_key.rb

@@ -0,0 +1,4 @@
+class CanvasLtiKey < ApplicationRecord
+    validates :canvas_url, :secret, presence: true
+    validates :key, presence: true, :uniqueness => {:scope=>:canvas_url}
+end

data/db/migrate/20210809092919_create_canvas_lti_keys.rb

@@ -0,0 +1,11 @@
+class CreateCanvasLtiKeys < ActiveRecord::Migration[6.0]
+  def change
+    create_table :canvas_lti_keys do |t|
+      t.string :key
+      t.string :secret
+      t.string :canvas_url
+
+      t.timestamps
+    end
+  end
+end

data/lib/canvas_oauth/canvas_api.rb

@@ -8,7 +8,7 @@ module CanvasOauth
 
     def initialize(canvas_url, canvas_user_id, token, refresh_token, key, secret)
       unless [key, secret].all?(&:present?)
-        raise "Invalid Canvas oAuth configuration"
+        raise "Invalid Qalam oAuth configuration"
       end
       
       self.refresh_token = refresh_token
@@ -19,6 +19,7 @@ module CanvasOauth
       self.secret = secret
     end
 
+    ### START AUTH ###
     def authenticated_request(method, *params)
       params << {} if params.size == 1
 
@@ -53,6 +54,55 @@ module CanvasOauth
       end
     end
 
+    def auth_url(redirect_uri, oauth2_state)
+      "#{canvas_url}/login/oauth2/auth?client_id=#{key}&response_type=code&state=#{oauth2_state}&redirect_uri=#{redirect_uri}"
+    end
+    
+    def qalam_auth_url(qalam_url, redirect_uri, oauth2_state)
+      "#{qalam_url}/login/oauth2/auth?client_id=#{key}&response_type=code&state=#{oauth2_state}&redirect_uri=#{redirect_uri}"
+    end
+
+    def get_access_token(code)
+      params = {
+        body: {
+          client_id: key,
+          client_secret: secret,
+          code: code
+        }
+      }
+      
+      response = self.class.post '/login/oauth2/token', params
+      self.refresh_token = response['refresh_token']
+      self.token = response['access_token']
+    end
+    
+    def get_access_token_by_refresh_token
+      params = {
+        body: {
+          grant_type: 'refresh_token',
+          client_id: key,
+          client_secret: secret,
+          refresh_token: refresh_token
+        }
+      }
+      
+      response = self.class.post '/login/oauth2/token', params
+      self.token = response['access_token']
+      CanvasOauth::Authorization.update_token(refresh_token, token)
+    end
+    
+    def authenticated_get(*params)
+      authenticated_request(:get, *params)
+    end
+    
+    def authenticated_post(*params)
+      authenticated_request(:post, *params)
+    end
+    
+    def authenticated_put(*params)
+      authenticated_request(:put, *params)
+    end
+
     def paginated_get(url, params = {})
       params[:query] ||= {}
       params[:query][:per_page] = PER_PAGE
@@ -69,34 +119,25 @@ module CanvasOauth
 
       all_pages
     end
-
-    def get_report(account_id, report_type, params)
-      report = authenticated_post("/api/v1/accounts/#{account_id}/reports/#{report_type}", { body: params })
-      report = authenticated_get "/api/v1/accounts/#{account_id}/reports/#{report_type}/#{report['id']}"
-      while (report['status'] == 'created' || report['status'] == 'running')
-        sleep(4)
-        report = authenticated_get "/api/v1/accounts/#{account_id}/reports/#{report_type}/#{report['id']}"
-      end
-
-      if report['status'] == 'complete'
-        file_id = report['file_url'].match(/files\/([0-9]+)\/download/)[1]
-        file = get_file(file_id)
-        return hash_csv(self.class.get(file['url'], limit: 15, parser: DefaultUTF8Parser).parsed_response)
-      else
-        return report
-      end
+    ### END AUTH ###
+    
+    ### HELPER METHODS ###
+    def canvas_url=(value)
+      @canvas_url = value
+      self.class.base_uri(value)
     end
-
-    def valid_page?(page)
-      page && page.size > 0
+    
+    def canvas_user_id=(value)
+      @canvas_user_id = value
     end
-
-    def get_file(file_id)
-      authenticated_get "/api/v1/files/#{file_id}"
+    
+    def hex_sis_id(name, value)
+      hex = value.unpack("H*")[0]
+      return "hex:#{name}:#{hex}"
     end
 
-    def get_accounts_provisioning_report(account_id)
-      get_report(account_id, :provisioning_csv, 'parameters[accounts]' => true)
+    def valid_page?(page)
+      page && page.size > 0
     end
 
     #Needs to be refactored to somewhere more generic
@@ -117,17 +158,61 @@ module CanvasOauth
 
       return output
     end
+    ### END HELPER METHODS ###
+
+    ### CANVAS API ###
+      # get_report
+      # get_file
+      # get_accounts_provisioning_report
+      # get_courses
+      # get_account
+      # get_account_sub_accounts
+      # get_account_courses
+      # get_account_users
+      # get_course
+      # get_section_enrollments
+      # get_user_enrollments
+      # get_course_users
+      # get_all_course_users
+      # get_course_teachers_and_tas
+      # get_course_students
+      # get_course_active_students
+      # get_section
+      # get_sections
+      # get_assignments
+      # get_assignment
+      # get_user_profile
+      # create_assignment
+      # update_assignment
+      # grade_assignment
+      # get_submission
+      # course_account_id
+      # root_account_id
+      # course_root_account_id
+    
+    def get_report(account_id, report_type, params)
+      report = authenticated_post("/api/v1/accounts/#{account_id}/reports/#{report_type}", { body: params })
+      report = authenticated_get "/api/v1/accounts/#{account_id}/reports/#{report_type}/#{report['id']}"
+      while (report['status'] == 'created' || report['status'] == 'running')
+        sleep(4)
+        report = authenticated_get "/api/v1/accounts/#{account_id}/reports/#{report_type}/#{report['id']}"
+      end
 
-    def authenticated_get(*params)
-      authenticated_request(:get, *params)
+      if report['status'] == 'complete'
+        file_id = report['file_url'].match(/files\/([0-9]+)\/download/)[1]
+        file = get_file(file_id)
+        return hash_csv(self.class.get(file['url'], limit: 15, parser: DefaultUTF8Parser).parsed_response)
+      else
+        return report
+      end
     end
 
-    def authenticated_post(*params)
-      authenticated_request(:post, *params)
+    def get_file(file_id)
+      authenticated_get "/api/v1/files/#{file_id}"
     end
 
-    def authenticated_put(*params)
-      authenticated_request(:put, *params)
+    def get_accounts_provisioning_report(account_id)
+      get_report(account_id, :provisioning_csv, 'parameters[accounts]' => true)
     end
 
     def get_courses
@@ -146,7 +231,7 @@ module CanvasOauth
       paginated_get "/api/v1/accounts/#{account_id}/courses"
     end
 
-    def get_account_courses(account_id)
+    def get_account_users(account_id)
       paginated_get "/api/v1/accounts/#{account_id}/users"
     end
 
@@ -234,59 +319,17 @@ module CanvasOauth
     def course_root_account_id(course_id)
       root_account_id(course_account_id(course_id))
     end
+    ### END CANVAS API ###
 
-    def auth_url(redirect_uri, oauth2_state)
-      "#{canvas_url}/login/oauth2/auth?client_id=#{key}&response_type=code&state=#{oauth2_state}&redirect_uri=#{redirect_uri}"
-    end
+    ### QALAM API ENDPOINTS ###
+      # get_canvas_user_profile
+      # get_course_active_pages
+      # course_external_tool_update
+      # account_external_tool_update
+      # get_school_details
+      # get_grade_students
+      # get_classroom_students
 
-    def qalam_auth_url(qalam_url, redirect_uri, oauth2_state)
-      "#{qalam_url}/login/oauth2/auth?client_id=#{key}&response_type=code&state=#{oauth2_state}&redirect_uri=#{redirect_uri}"
-    end
-
-    def get_access_token(code)
-      params = {
-        body: {
-          client_id: key,
-          client_secret: secret,
-          code: code
-        }
-      }
-
-      response = self.class.post '/login/oauth2/token', params
-      self.refresh_token = response['refresh_token']
-      self.token = response['access_token']
-    end
-
-    def get_access_token_by_refresh_token
-      params = {
-        body: {
-          grant_type: 'refresh_token',
-          client_id: key,
-          client_secret: secret,
-          refresh_token: refresh_token
-        }
-      }
-
-      response = self.class.post '/login/oauth2/token', params
-      self.token = response['access_token']
-      CanvasOauth::Authorization.update_token(refresh_token, token)
-    end
-
-    def hex_sis_id(name, value)
-      hex = value.unpack("H*")[0]
-      return "hex:#{name}:#{hex}"
-    end
-
-    def canvas_url=(value)
-      @canvas_url = value
-      self.class.base_uri(value)
-    end
-
-    def canvas_user_id=(value)
-      @canvas_user_id = value
-    end
-
-    ### QALAM ###
     def get_canvas_user_profile
       authenticated_get "/api/v1/users/#{canvas_user_id}/profile"
     end
@@ -313,17 +356,14 @@ module CanvasOauth
       authenticated_get "/api/v1/accounts/#{account_id}/school_details"
     end
 
-    def get_school_account(account_id)
-      authenticated_get "/api/v1/accounts/#{account_id}/school_account"
-    end
-
-    def get_students_by_grade(account_id, grade_id)
-      paginated_get "/api/v1/accounts/#{account_id}/students_by_grade/#{grade_id}"
+    def get_grade_students(account_id, grade_id)
+      paginated_get "/api/v1/accounts/#{account_id}/grade_students/#{grade_id}"
     end
 
-    def get_students_by_class(account_id, class_id)
-      paginated_get "/api/v1/accounts/#{account_id}/students_by_class_room/#{class_id}"
+    def get_classroom_students(account_id, class_id)
+      paginated_get "/api/v1/accounts/#{account_id}/classroom_students/#{class_id}"
     end
+    ### END QALAM API ###
   end
 
   class CanvasApi::Unauthorized < StandardError ; end

data/lib/canvas_oauth/canvas_api_extensions.rb

@@ -3,7 +3,9 @@ module CanvasOauth
     def self.build(canvas_url, user_id, tool_consumer_instance_guid)
       refresh_token = CanvasOauth::Authorization.fetch_refresh_token(user_id, tool_consumer_instance_guid)
       token = CanvasOauth::Authorization.fetch_token(user_id, tool_consumer_instance_guid)
-      CanvasApi.new(canvas_url, user_id, token, refresh_token, CanvasConfig.key, CanvasConfig.secret)
+      canvas_key = ((CanvasLtiKey.table_exists? && CanvasLtiKey.find_by(canvas_url: canvas_url)&.key) or CanvasConfig.key)
+      canvas_secret = ((CanvasLtiKey.table_exists? && CanvasLtiKey.find_by(key: canvas_key, canvas_url: canvas_url)&.secret) or CanvasConfig.secret)
+      CanvasApi.new(canvas_url, user_id, token, refresh_token, canvas_key, canvas_secret)
     end
   end
 end

data/lib/canvas_oauth/canvas_config.rb

@@ -13,21 +13,16 @@ module CanvasOauth
 
     def self.setup!
       if File.exists?(config_file)
-        Rails.logger.info "Initializing Canvas using configuration in #{config_file}"
+        Rails.logger.info "Initializing Qalam using configuration in #{config_file}"
         config = load_config
         self.key = config['key']
         self.secret = config['secret']
-
-        Rails.logger.info "\n> Initializing Key #{config['key']} - Secret #{config['secret']}\n".green
-
       elsif ENV['CANVAS_KEY'].present? && ENV['CANVAS_SECRET'].present?
-        Rails.logger.info "Initializing Canvas using environment vars CANVAS_KEY and CANVAS_SECRET"
+        Rails.logger.info "Initializing Qalam using environment vars CANVAS_KEY and CANVAS_SECRET"
         self.key = ENV['CANVAS_KEY']
         self.secret = ENV['CANVAS_SECRET']
-
-        Rails.logger.info "\n> Initializing Key #{ENV['CANVAS_KEY']} - Secret #{ENV['CANVAS_SECRET']}\n".green
       else
-        warn "Warning: Canvas key and secret not configured (RAILS_ENV = #{ENV['RAILS_ENV']})."
+        warn "Warning: Qalam key and secret not configured (RAILS_ENV = #{ENV['RAILS_ENV']})."
       end
     end
   end

data/lib/canvas_oauth/version.rb

@@ -1,3 +1,3 @@
 module CanvasOauth
-  VERSION = "2.2.9"
+  VERSION = "3.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qalam_oauth_engine
 version: !ruby/object:Gem::Version
-  version: 2.2.9
+  version: 3.0.3
 platform: ruby
 authors:
 - Dave Donahue
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -50,7 +50,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -60,7 +60,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -257,10 +257,12 @@ files:
 - Rakefile
 - app/controllers/canvas_oauth/canvas_controller.rb
 - app/controllers/canvas_oauth/oauth_application_controller.rb
+- app/models/canvas_lti_key.rb
 - app/models/canvas_oauth/authorization.rb
 - config/canvas.yml.example
 - config/routes.rb
 - db/migrate/20121121005358_create_canvas_oauth_authorizations.rb
+- db/migrate/20210809092919_create_canvas_lti_keys.rb
 - lib/canvas_oauth.rb
 - lib/canvas_oauth/canvas_api.rb
 - lib/canvas_oauth/canvas_api_extensions.rb
@@ -330,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: CanvasOauth is a mountable engine for handling the oauth workflow with canvas