qalam_oauth_engine 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fedb8888333b8e5593967fd75d34041dabd73bd19af4cc017b77f3ee4125d6b9
-  data.tar.gz: 6bc18fbcb7d0cae6641da7418dad7835bf5890dcc28502b06a42e9737bb35c68
+  metadata.gz: 9ce5f3ea19a895f5964a450249d587a9a9e847064071bb260f42f078d3a5ed58
+  data.tar.gz: d2621e2449cb88ec7dfcaea89219c4e825a981e4ed82eaaf2dd9af40beb554a2
 SHA512:
-  metadata.gz: 8cc4173cba1f1fefd30015c358b0e123ab34f329fad944559996a88c14f9d5ca0e36ce4077d7de064a80989c0c9bd7a2893fff621f9644e73168b3670dcb86a0
-  data.tar.gz: 16dd53a5746b3cb1d2166057874a77faeccb53a7fa154dec30cd1804be8db76443d8cf5139ad0f864aeb1f9b5d6a5ec0ebd746b4ed84d35c43ee08e9f808df0f
+  metadata.gz: 68a55695a6a6b196a6cb7cc3402d314b987473ed58a1b78dd538b35f80903b0035beff1dd00acb714c1a2f521348f9baf978f941584098c742e182f2be003a0b
+  data.tar.gz: df1b190fb6e62609f9867ca96c6365786137681c2c5bc3f0b14fef895308912fce6d1956d40385e1a06d233c7e2437fd0bf5ebf3f2c98372d2ec0ea9cc62743c

data/app/controllers/canvas_oauth/canvas_controller.rb

@@ -6,7 +6,6 @@ module CanvasOauth
       if verify_oauth2_state(params[:state]) && params[:code]
         if token = canvas.get_access_token(params[:code])
           set_root_account
-          puts @root_account_id.inspect.green
           refresh_token = canvas.refresh_token
           if CanvasOauth::Authorization.cache_token(token, refresh_token, user_id, @root_account_id, tool_consumer_instance_guid)
             redirect_to main_app.root_path

data/lib/canvas_oauth/canvas_api.rb

@@ -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
-        all_pages.concat(current_page) if valid_page?(current_page)
+      if params[:all_pages]
+        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
+      else
+        current_page = authenticated_get(url, params)
+        all_pages.concat(current_page) if valid_page?(current_page)
       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,66 @@ 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
+      # get_school_grades
+      # get_school_class_rooms
+      # get_school_subjects
+      # get_students_by_grade
+      # get_students_by_class_room
 
-    def get_canvas_user_profile
+    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 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 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 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 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 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_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_details(account_id)
-      authenticated_get "/api/v1/accounts/#{account_id}/school_details"
+    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_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/version.rb

@@ -1,3 +1,3 @@
 module CanvasOauth
-  VERSION = "3.0.6"
+  VERSION = "3.0.7"
 end

metadata

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