qalam_oauth_engine 3.0.4 → 3.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e153aaa7541aee767fe47cb0824831482a12f392f1bd87803ee4ad4703e7d30f
-  data.tar.gz: '0494829ca2a3a9d94c7ddee7ca5b853de2df985e74e1d3f142f1d805578826ad'
+  metadata.gz: a94aa9f960fad372ccd1ce843c502f7f1f8011f010e29dd095224a0d9a5c701f
+  data.tar.gz: a1f11ff92ae13c52c42271180623616cbf47cd42780e34e3f029a30c6143fe44
 SHA512:
-  metadata.gz: 2bca130d4a82b30db36ebb3fb1a6208db2b7cc6350cd97e8c1a9e9ada3498e0d3f431f2c4f626db35bfeb03e540e27a1b9e5543487380da2b9b73783b4b6d0cc
-  data.tar.gz: 91a7d377612aa1e3d5036e730348224c7c0d0f60f0aa1635d4c4f1f6f6d7d847f6c9f40430bb3538d4e6cb8638893d2b6ccf0f631aebdcd6768953cb1ab293df
+  metadata.gz: 8540835b1a123aae6f271195d80443a7627649dc2156c1ec2a6f0e6be6295d99f0669815b5e11250b7b0c7f70c7811d901158107ed1e2424934a0de3ba2c3d7b
+  data.tar.gz: f01b816cc088416ffa80ddfd5908ae40bded8ac8e11f8c784ead5317fd82a3d4039b424aa29cfff82aad4756c5776bbcdc291ec8116ebec48776dd2cb0a3b5a1

data/app/controllers/canvas_oauth/canvas_controller.rb

@@ -23,13 +23,13 @@ module CanvasOauth
     def verify_oauth2_state(callback_state)
       callback_state.present? && callback_state == session.delete(:oauth2_state)
     end
-  end
 
-  def set_root_account
-    if current_account_id
-      @root_account_id = canvas.root_account_id(current_account_id)
-    elsif current_course_id
-      @root_account_id = canvas.course_root_account_id(current_course_id)
+    def set_root_account
+      if session[:account_id]
+        @root_account_id = canvas.root_account_id(session[:account_id])
+      elsif session[:course_id]
+        @root_account_id = canvas.course_root_account_id(session[:course_id])
+      end
     end
   end
 end

data/lib/canvas_oauth/canvas_api.rb

@@ -4,7 +4,7 @@ module CanvasOauth
     PER_PAGE = 50
 
     attr_accessor :token, :refresh_token, :key, :secret
-    attr_reader :canvas_url, :canvas_user_id
+    attr_reader :canvas_url, :canvas_user_id, :canvas_root_account_id
 
     def initialize(canvas_url, canvas_user_id, canvas_root_account_id, token, refresh_token, key, secret)
       unless [key, secret].all?(&:present?)
@@ -104,18 +104,23 @@ module CanvasOauth
       authenticated_request(:put, *params)
     end
 
-    def paginated_get(url, params = {})
+    def paginated_get(url, params={})
       params[:query] ||= {}
-      params[:query][:per_page] = PER_PAGE
-
+      params[:query][:per_page] ||= PER_PAGE
+      params[:query][:page] ||= 1
       all_pages = []
 
-      while url && current_page = authenticated_get(url, params) do
+      if params[:current_page]
+        current_page = authenticated_get(url, params)
         all_pages.concat(current_page) if valid_page?(current_page)
+      else
+        while url && current_page = authenticated_get(url, params) do
+          all_pages.concat(current_page) if valid_page?(current_page)
 
-        links = LinkHeader.parse(current_page.headers['link'])
-        url = links.find_link(["rel", "next"]).try(:href)
-        params[:query] = nil if params[:query]
+          links = LinkHeader.parse(current_page.headers['link'])
+          url = links.find_link(["rel", "next"]).try(:href)
+          params[:query] = nil if params[:query]
+        end
       end
 
       all_pages
@@ -195,7 +200,7 @@ module CanvasOauth
       # root_account_id
       # course_root_account_id
     
-    def get_report(account_id, report_type, params)
+    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')
@@ -212,108 +217,108 @@ module CanvasOauth
       end
     end
 
-    def get_file(file_id)
+    def get_file(file_id, params={})
       authenticated_get "/api/v1/files/#{file_id}"
     end
 
-    def get_accounts_provisioning_report(account_id)
+    def get_accounts_provisioning_report(account_id, params={})
       get_report(account_id, :provisioning_csv, 'parameters[accounts]' => true)
     end
 
-    def get_courses
+    def get_courses(params={})
       paginated_get "/api/v1/courses"
     end
 
-    def get_account(account_id)
+    def get_account(account_id, params={})
       authenticated_get "/api/v1/accounts/#{account_id}"
     end
 
-    def get_account_sub_accounts(account_id)
+    def get_account_sub_accounts(account_id, params={})
       paginated_get "/api/v1/accounts/#{account_id}/sub_accounts", { query: { :recursive => true } }
     end
 
-    def get_account_courses(account_id)
+    def get_account_courses(account_id, params={})
       paginated_get "/api/v1/accounts/#{account_id}/courses"
     end
 
-    def get_account_users(account_id)
+    def get_account_users(account_id, params={})
       paginated_get "/api/v1/accounts/#{account_id}/users"
     end
 
-    def get_course(course_id)
+    def get_course(course_id, params={})
       authenticated_get "/api/v1/courses/#{course_id}"
     end
 
-    def get_section_enrollments(section_id)
+    def get_section_enrollments(section_id, params={})
       paginated_get "/api/v1/sections/#{section_id}/enrollments"
     end
 
-    def get_user_enrollments(user_id)
+    def get_user_enrollments(user_id, params={})
       paginated_get "/api/v1/users/#{user_id}/enrollments"
     end
 
-    def get_course_users(course_id)
+    def get_course_users(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/users"
     end
 
-    def get_all_course_users(course_id)
+    def get_all_course_users(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/users", { query: {enrollment_state: ["active","invited","rejected","completed","inactive"] } }
     end
 
-    def get_course_teachers_and_tas(course_id)
+    def get_course_teachers_and_tas(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/users", { query: { enrollment_type: ['teacher', 'ta'] } }
     end
 
-    def get_course_students(course_id)
+    def get_course_students(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/students"
     end
 
-    def get_course_active_students(course_id)
+    def get_course_active_students(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/active_users"
     end
 
-    def get_section(section_id)
+    def get_section(section_id, params={})
       authenticated_get "/api/v1/sections/#{section_id}"
     end
 
-    def get_sections(course_id)
+    def get_sections(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/sections", { query: { :include => ['students', 'avatar_url', 'enrollments'] } }
     end
 
-    def get_assignments(course_id)
+    def get_assignments(course_id, params={})
       paginated_get "/api/v1/courses/#{course_id}/assignments"
     end
 
-    def get_assignment(course_id, assignment_id)
+    def get_assignment(course_id, assignment_id, params={})
       authenticated_get "/api/v1/courses/#{course_id}/assignments/#{assignment_id}"
     end
 
-    def get_user_profile(user_id)
+    def get_user_profile(user_id, params={})
       authenticated_get "/api/v1/users/#{user_id}/profile"
     end
 
-    def create_assignment(course_id, params)
+    def create_assignment(course_id, params={})
       authenticated_post "/api/v1/courses/#{course_id}/assignments", { body: { assignment: params } }
     end
 
-    def update_assignment(course_id, assignment_id, params)
+    def update_assignment(course_id, assignment_id, params={})
       authenticated_put "/api/v1/courses/#{course_id}/assignments/#{assignment_id}", { body: { assignment: params } }
     end
 
-    def grade_assignment(course_id, assignment_id, user_id, params)
+    def grade_assignment(course_id, assignment_id, user_id, params={})
       authenticated_put "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}", { body: params }
     end
 
-    def get_submission(course_id, assignment_id, user_id)
+    def get_submission(course_id, assignment_id, user_id, params={})
       authenticated_get "/api/v1/courses/#{course_id}/assignments/#{assignment_id}/submissions/#{user_id}"
     end
 
-    def course_account_id(course_id)
+    def course_account_id(course_id, params={})
       course = get_course(course_id)
       course['account_id'] if course
     end
 
-    def root_account_id(account_id)
+    def root_account_id(account_id, params={})
       if account_id && account = get_account(account_id)
         root_id = account['root_account_id']
       end
@@ -321,7 +326,7 @@ module CanvasOauth
       root_id || account_id
     end
 
-    def course_root_account_id(course_id)
+    def course_root_account_id(course_id, params={})
       root_account_id(course_account_id(course_id))
     end
     ### END CANVAS API ###
@@ -329,44 +334,84 @@ module CanvasOauth
     ### QALAM API ENDPOINTS ###
       # get_canvas_user_profile
       # get_course_active_pages
-      # course_external_tool_update
-      # account_external_tool_update
+      # update_external_tool_nav
       # get_school_details
-      # get_grade_students
-      # get_classroom_students
-
-    def get_canvas_user_profile
+      # get_school_grades
+      # get_school_grade
+      # get_school_class_rooms
+      # get_school_class_room
+      # get_school_subjects
+      # get_school_subject
+      # get_students_by_grade
+      # get_students_by_class_room
+
+    def get_canvas_user_profile(params={})
       authenticated_get "/api/v1/users/#{canvas_user_id}/profile"
     end
 
-    def get_course_active_pages(course_id, publish=nil)
+    def get_course_active_pages(course_id, publish=nil, params={})
       unless publish.nil?
-        paginated_get "/api/v1/courses/#{course_id}/pages?published=#{publish}&sort=created_at&order=desc"
+        paginated_get "/api/v1/courses/#{course_id}/pages?published=#{publish}&sort=created_at&order=desc", params
       else
-        paginated_get "/api/v1/courses/#{course_id}/pages?sort=created_at&order=desc"
+        paginated_get "/api/v1/courses/#{course_id}/pages?sort=created_at&order=desc", params
       end
     end
 
-    def course_external_tool_update(external_tool_url, tool_id, account_id, publish)
-      authenticated_put "/api/v1/accounts/#{account_id}/external_tools_url", { body: {"course_navigation"=>{"enabled"=>"#{publish}"},
-       "tool_id"=>tool_id, "external_tool_url"=>external_tool_url} }
+    def update_external_tool_nav(external_tool_url, tool_id, publish, type, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      if type == 'account'
+        body = {"account_navigation"=>{"enabled"=>"#{publish}"},
+        "tool_id"=>tool_id, "external_tool_url"=>external_tool_url}
+      elsif type == 'course'
+        body = {"course_navigation"=>{"enabled"=>"#{publish}"},
+        "tool_id"=>tool_id, "external_tool_url"=>external_tool_url}
+      end
+      authenticated_put "/api/v1/accounts/#{account_id}/external_tools_url", { body: body } if body
     end
 
-    def account_external_tool_update(external_tool_url, tool_id, account_id, publish)
-      authenticated_put "/api/v1/accounts/#{account_id}/external_tools_url", { body: {"account_navigation"=>{"enabled"=>"#{publish}"},
-       "tool_id"=>tool_id, "external_tool_url"=>external_tool_url} }
+    def get_school_details(account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      authenticated_get "/api/v1/accounts/#{account_id}/school_details"
     end
 
-    def get_school_details(account_id)
-      authenticated_get "/api/v1/accounts/#{account_id}/school_details"
+    def get_school_grades(account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      paginated_get "/api/v1/accounts/#{account_id}/school_grades", params
+    end
+
+    def get_school_grade(grade_id, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      authenticated_get "/api/v1/accounts/#{account_id}/school_grades/#{grade_id}", params
+    end
+
+    def get_school_subjects(account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      paginated_get "/api/v1/accounts/#{account_id}/school_subjects", params
+    end
+
+    def get_school_subject(subject_id, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      authenticated_get "/api/v1/accounts/#{account_id}/school_subjects/#{subject_id}", params
+    end
+
+    def get_school_class_rooms(account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      paginated_get "/api/v1/accounts/#{account_id}/school_class_rooms", params
+    end
+
+    def get_school_class_room(class_room_id, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      authenticated_get "/api/v1/accounts/#{account_id}/school_class_rooms/#{class_room_id}", params
     end
 
-    def get_grade_students(account_id, grade_id)
-      paginated_get "/api/v1/accounts/#{account_id}/grade_students/#{grade_id}"
+    def get_students_by_grade(grade_id, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      paginated_get "/api/v1/accounts/#{account_id}/grade_students/#{grade_id}", params
     end
 
-    def get_classroom_students(account_id, class_id)
-      paginated_get "/api/v1/accounts/#{account_id}/classroom_students/#{class_id}"
+    def get_students_by_class_room(class_room_id, account_id=@canvas_root_account_id, params={})
+      account_id ||= @canvas_root_account_id
+      paginated_get "/api/v1/accounts/#{account_id}/class_room_students/#{class_room_id}", params
     end
     ### END QALAM API ###
   end

data/lib/canvas_oauth/canvas_api_extensions.rb

@@ -1,7 +1,7 @@
 module CanvasOauth
   class CanvasApiExtensions
     def self.build(canvas_url, user_id, tool_consumer_instance_guid)
-      account_id = CanvasOauth::Authorization.fetch_ccount(user_id, tool_consumer_instance_guid)
+      account_id = CanvasOauth::Authorization.fetch_account(user_id, tool_consumer_instance_guid)
       token = CanvasOauth::Authorization.fetch_token(user_id, tool_consumer_instance_guid)
       refresh_token = CanvasOauth::Authorization.fetch_refresh_token(user_id, tool_consumer_instance_guid)
       canvas_key = ((CanvasLtiKey.table_exists? && CanvasLtiKey.find_by(canvas_url: canvas_url)&.key) or CanvasConfig.key)

data/lib/canvas_oauth/version.rb

@@ -1,3 +1,3 @@
 module CanvasOauth
-  VERSION = "3.0.4"
+  VERSION = "3.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qalam_oauth_engine
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.8
 platform: ruby
 authors:
 - Dave Donahue
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-22 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty