agilix 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a82f77811d3cfeb64d923f26b0ea861505f62d304aeac3f50ea1ccd0bdefc14
-  data.tar.gz: bc528e6a6ae236c48856e6a824538638b95ce4ecd15e7d878c4f1b452f0d48b1
+  metadata.gz: 13bbcf27a8daa395a4e36a627dc9deb051ca2eb6d59d8b7461e75d2f5e002001
+  data.tar.gz: 4868b13937a95a056514a5b084a6da3b3bdec86f0032de5af76f6e7d47984ff6
 SHA512:
-  metadata.gz: 588b495b07ef024a8769457a760461938cb5791068e1e6aa451e61c649250250c811cb58c64546758461ac1e91bea697b7f18e0fd597ad385354c9c3c7974cde
-  data.tar.gz: 267fa0d5a739c92ce0220205dfcb09cc43d3cb9ff8a110e17e581e2624b7a3bd7157d042258bb10f0c36c1fe0944c9354bdeae2196ddd4ea0e001edd50bc79eb
+  metadata.gz: 28650a6f11ff0d3bb4aa4d0f4e4597679d889392cee1436c2827459d0fdfc6c30f707c7fb9797ea07db75873da0bd81bcb5a6b23042d2677c9b8d6641d18ca63
+  data.tar.gz: 6edb84ced7f75aad3c80be7018e866d1be80689e19fe5fcf8ba2dc61ca43a61899ffe29ed149b1bc55f50c57aab42be3c57a086a48f93675846f272ad6848545

data/README.md

@@ -374,20 +374,129 @@ api.update_courses [{courseid: 60994, title: "Updated Course"}]
 
 ## Enrollments
 
-- [ ] [CreateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/CreateEnrollments)
-- [ ] [DeleteEnrollments](https://api.agilixbuzz.com/docs/#!/Command/DeleteEnrollments)
-- [ ] [GetEnrollment3](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollment3)
-- [ ] [GetEnrollmentActivity](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentActivity)
-- [ ] [GetEnrollmentGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGradebook2)
-- [ ] [GetEnrollmentGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGroupList)
-- [ ] [GetEnrollmentMetricsReport](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentMetricsReport)
-- [ ] [ListEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollments)
-- [ ] [ListEnrollmentsByTeacher](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollmentsByTeacher)
-- [ ] [ListEntityEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEntityEnrollments)
-- [ ] [ListUserEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListUserEnrollments)
-- [ ] [PutSelfAssessment](https://api.agilixbuzz.com/docs/#!/Command/PutSelfAssessment)
-- [ ] [RestoreEnrollment](https://api.agilixbuzz.com/docs/#!/Command/RestoreEnrollment)
-- [ ] [UpdateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/UpdateEnrollments)
+#### [CreateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/CreateEnrollments)
+ISSUE: API format is very inconsistent on this one, requires both query string modification & body modification
+```
+api.create_enrollments [{userid: 57026, entityid: 57025}]
+```
+
+#### [DeleteEnrollments](https://api.agilixbuzz.com/docs/#!/Command/DeleteEnrollments)
+ISSUE: Inconsistent from other delete apis. many are singular, not plural
+```
+api.delete_enrollments [ { enrollmentid: 60997 }]
+```
+
+#### [GetEnrollment3](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollment3)
+This is aliased to `get_enrollment`
+```
+api.get_enrollment enrollmentid: 60997
+```
+
+#### [GetEnrollmentActivity](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentActivity)
+```
+api.get_enrollment_activity enrollmentid: 60997
+```
+
+#### [GetEnrollmentGradebook2](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGradebook2)
+```
+api.get_enrollment_gradebook enrollmentid: 60997
+```
+
+#### [GetEnrollmentGroupList](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentGroupList)
+```
+api.get_enrollment_group_list enrollmentid: 60997
+```
+
+#### [GetEnrollmentMetricsReport](https://api.agilixbuzz.com/docs/#!/Command/GetEnrollmentMetricsReport)
+This is available in two types:
+Student Report
+```
+api.get_enrollment_metrics_report entityid: 50725, report: "Student"
+```
+Enrollment Report
+```
+api.get_enrollment_metrics_report entityid: 50725, report: "Enrollment"
+```
+
+#### [ListEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollments)
+```
+api.list_enrollments domainid: 50725
+```
+
+#### [ListEnrollmentsByTeacher](https://api.agilixbuzz.com/docs/#!/Command/ListEnrollmentsByTeacher)
+```
+api.list_enrollments_by_teacher teacheruserid: 50726
+
+# If you don't pass in a teacher user id, it will default to the logged in API user
+
+api.list_enrollments_by_teacher
+```
+
+#### [ListEntityEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListEntityEnrollments)
+```
+api.list_entity_enrollments entityid: 60982
+```
+
+#### [ListUserEnrollments](https://api.agilixbuzz.com/docs/#!/Command/ListUserEnrollments)
+```
+api.list_user_enrollments userid: 57181
+```
+
+#### [PutSelfAssessment](https://api.agilixbuzz.com/docs/#!/Command/PutSelfAssessment)
+# ISSUE: this should be a post, not a get
+```
+api.put_self_assessment enrollmentid: 60997, understanding: 200, effort: 220, interest: 100
+```
+
+#### [RestoreEnrollment](https://api.agilixbuzz.com/docs/#!/Command/RestoreEnrollment)
+```
+api.restore_enrollment enrollmentid: 60997
+```
+
+#### [UpdateEnrollments](https://api.agilixbuzz.com/docs/#!/Command/UpdateEnrollments)
+```
+api.update_enrollments [{enrollmentid: 60997, status: 7}]
+```
+
+## General
+
+#### [Echo](https://api.agilixbuzz.com/docs/#!/Command/Echo)
+```
+api.echo test: 'param'
+```
+
+#### [GetCommandList](https://api.agilixbuzz.com/docs/#!/Command/GetCommandList)
+```
+api.get_command_list
+```
+
+#### [GetEntityType](https://api.agilixbuzz.com/docs/#!/Command/GetEntityType)
+ISSUE: nothing saying this is an authenticated call, when others are non-authenticated
+```
+api.get_entity_type entityid: 57025
+```
+
+#### [GetStatus](https://api.agilixbuzz.com/docs/#!/Command/GetStatus)
+ISSUE: docs in getting started reference a `level` param, actual docs suggest using rating
+```
+api.get_status rating: 4, html: true, sms: true
+
+# you can also call this one non-authenticated
+api.get_basic_status
+```
+
+#### [GetUploadLimits](https://api.agilixbuzz.com/docs/#!/Command/GetUploadLimits)
+ISSUE: Docs have cmd spelled wrong, this API doesn't seem to work at all AccessDenied. It did say experimental
+```
+api.get_upload_limits
+api.get_upload_limits domainid: 57025
+```
+
+#### [SendMail](https://api.agilixbuzz.com/docs/#!/Command/SendMail)
+This is one of the more confusing APIs, it allows you to send emails to people in the same enrollment grouping as the person wanting to send the email (`enrollmentid`).
+```
+api.send_mail subject: "Test email", body: "Did you get this?", enrollmentid: 60997, enrollment_ids: ["all"]
+```
 
 ## Rights
 
@@ -434,15 +543,6 @@ api.update_courses [{courseid: 60994, title: "Updated Course"}]
 - [ ] [SubmitAttemptAnswers](https://api.agilixbuzz.com/docs/#!/Command/SubmitAttemptAnswers)
 - [ ] [SubmitOfflineAttempt](https://api.agilixbuzz.com/docs/#!/Command/SubmitOfflineAttempt)
 
-## General
-
-- [ ] [Echo](https://api.agilixbuzz.com/docs/#!/Command/Echo)
-- [ ] [GetCommandList](https://api.agilixbuzz.com/docs/#!/Command/GetCommandList)
-- [ ] [GetEntityType](https://api.agilixbuzz.com/docs/#!/Command/GetEntityType)
-- [ ] [GetStatus](https://api.agilixbuzz.com/docs/#!/Command/GetStatus)
-- [ ] [GetUploadLimits](https://api.agilixbuzz.com/docs/#!/Command/GetUploadLimits)
-- [ ] [SendMail](https://api.agilixbuzz.com/docs/#!/Command/SendMail)
-
 ## Manifests and Items
 
 - [ ] [AssignItem](https://api.agilixbuzz.com/docs/#!/Command/AssignItem)

data/lib/agilix.rb

@@ -6,6 +6,7 @@ require "ostruct"
 require "agilix/buzz/commands/authentication"
 require "agilix/buzz/commands/course"
 require "agilix/buzz/commands/domain"
+require "agilix/buzz/commands/enrollment"
 require "agilix/buzz/commands/general"
 require "agilix/buzz/commands/report"
 require "agilix/buzz/commands/user"

data/lib/agilix/buzz/api.rb

@@ -8,6 +8,7 @@ module Agilix
       include Agilix::Buzz::Commands::Authentication
       include Agilix::Buzz::Commands::Course
       include Agilix::Buzz::Commands::Domain
+      include Agilix::Buzz::Commands::Enrollment
       include Agilix::Buzz::Commands::General
       include Agilix::Buzz::Commands::Report
       include Agilix::Buzz::Commands::User
@@ -32,6 +33,11 @@ module Agilix
         post query
       end
 
+      def authenticated_query_post(query = {})
+        check_authentication unless query.delete(:bypass_authentication_check)
+        query_post query
+      end
+
       def authenticated_bulk_post(query = {})
         check_authentication
         bulk_post query
@@ -45,9 +51,23 @@ module Agilix
         response = self.class.post(URL_BASE, body: modify_body(query), timeout: 60, headers: headers)
       end
 
+      # For when the api is super unconventional & you need to modify both query params & body params in a custom fashion
+      def query_post(query = {})
+        url = URL_BASE
+        query_params = query.delete(:query_params)
+        if query_params
+          url += "?&_token=#{token}" + query_params.map {|k,v| "&#{k}=#{v}" }.join("")
+        end
+        response = self.class.post(url, body: query.to_json, timeout: 60, headers: headers)
+      end
+
       def bulk_post(query = {})
         cmd = query.delete(:cmd)
         url = URL_BASE + "?cmd=#{cmd}&_token=#{token}"
+        query_params = query.delete(:query_params)
+        if query_params
+          url += query_params.map {|k,v| "&#{k}=#{v}" }.join("")
+        end
         response = self.class.post(url, body: modify_bulk_body(query), timeout: 60, headers: headers)
       end
 

data/lib/agilix/buzz/commands/enrollment.rb

@@ -0,0 +1,140 @@
+module Agilix
+  module Buzz
+    module Commands
+      module Enrollment
+
+        def enrollment_status
+          {
+            active: 1,
+            withdrawn: 4,
+            withdrawn_failed: 5,
+            transferred: 6,
+            completed: 7,
+            completed_no_credit: 8,
+            suspended: 9,
+            inactive: 10
+          }
+        end
+
+        def enrollment_status_lookup_value(int)
+          int = int.to_i
+          raise ArgumentError.new("Not a valid enrollment status code") unless enrollment_status.values.include?(int)
+          enrollment_status.find {|k,v| v == int}.first
+        end
+
+        # ISSUE: API format is very inconsistent on this one, requires both query string modification & body modification
+        # api.create_enrollments [{userid: 57026, entityid: 57025}]
+        def create_enrollments(items = [], disallowduplicates: false, disallowsamestatusduplicates: false )
+          options = items.map do |item|
+            item[:status] ||= 1
+            argument_cleaner(required_params: %i( userid entityid status ), optional_params: %i( roleid flags domainid startdate enddate reference schema data ), options: item )
+          end
+          if [disallowduplicates, disallowsamestatusduplicates].compact.any?
+            query_params = {}
+            query_params[:disallowduplicates] = disallowduplicates
+            query_params[:disallowsamestatusduplicates] = disallowsamestatusduplicates
+          end
+          authenticated_bulk_post cmd: "createenrollments", root_node: 'enrollment', query_params: query_params, body: options
+        end
+
+        # ISSUE: Inconsistent from other delete apis. many are singular, not plural
+        # api.delete_enrollments [ { enrollmentid: 60997 }]
+        def delete_enrollments(items = {})
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( ), options: item )
+          end
+          authenticated_bulk_post cmd: "deleteenrollments", root_node: 'enrollment', body: options
+        end
+
+        # api.get_enrollment enrollmentid: 60997
+        def get_enrollment3(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( select ), options: options )
+          authenticated_get cmd: "getenrollment3", **options
+        end
+        alias_method :get_enrollment, :get_enrollment3
+
+        # api.get_enrollment_activity enrollmentid: 60997
+        def get_enrollment_activity(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( last mergeoverlap ), options: options )
+          authenticated_get cmd: "getenrollmentactivity", **options
+        end
+
+        # api.get_enrollment_gradebook enrollmentid: 60997
+        def get_enrollment_gradebook2(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( forcerequireditems gradingschemeid gradingscheme itemid scorm zerounscored ), options: options )
+          authenticated_get cmd: "getenrollmentgradebook2", **options
+        end
+        alias_method :get_enrollment_gradebook, :get_enrollment_gradebook2
+
+        # api.get_enrollment_group_list enrollmentid: 60997
+        def get_enrollment_group_list(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( setid ), options: options )
+          authenticated_get cmd: "getenrollmentgrouplist", **options
+        end
+
+        # api.get_enrollment_metrics_report entityid: 50725, report: "Student"
+        # api.get_enrollment_metrics_report entityid: 50725, report: "Enrollment"
+        def get_enrollment_metrics_report(options = {})
+          raise ArgumentError.new("report can only be Student or Enrollment") unless ['Student', 'Enrollment'].include?(options[:report])
+          default_select = %w( user.id user.firstname user.lastname user.username user.reference)
+          student_select = %w( coursecount latecount failedcount paceyellows pacereds performanceyellows performancereds)
+          enrollment_select = %w(enrollment.id course.title course.id course.reference score achieved possible failing seconds completable completed gradable completedgradable graded percentcomplete late failed recentlyfailed pacelight pacereason performancelight performancereason lastduedatemissed calculateddate )
+          if options[:report] == "Student"
+            options[:select] ||= (default_select + student_select).flatten.join(",")
+          elsif options[:report] == "Enrollment"
+            options[:select] ||= (default_select + enrollment_select).flatten.join(",")
+          end
+          options = argument_cleaner(required_params: %i( entityid report select  ), optional_params: %i( filename format ), options: options )
+          authenticated_get cmd: "getenrollmentmetricsreport", **options
+        end
+
+        # api.list_enrollments domainid: 50725
+        def list_enrollments(options = {})
+          options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( includedescendantdomains limit show select query userdomainid userquery usertext coursedomainid coursequery coursetext ), options: options )
+          authenticated_get cmd: "listenrollments", **options
+        end
+
+        # api.list_enrollments_by_teacher teacheruserid: 50726
+        # api.list_enrollments_by_teacher
+        def list_enrollments_by_teacher(options = {})
+          options = argument_cleaner(required_params: %i(  ), optional_params: %i( teacheruserid teacherallstatus teacherdaysactivepastend privileges allstatus daysactivepastend userid select ), options: options )
+          authenticated_get cmd: "listenrollmentsbyteacher", **options
+        end
+
+        # api.list_entity_enrollments entityid: 60982
+        def list_entity_enrollments(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( privileges allstatus daysactivepastend userid select ), options: options )
+          authenticated_get cmd: "listentityenrollments", **options
+        end
+
+        # api.list_user_enrollments userid: 57181
+        def list_user_enrollments(options = {})
+          options = argument_cleaner(required_params: %i( userid ), optional_params: %i( allstatus entityid privileges daysactivepastend query select ), options: options )
+          authenticated_get cmd: "listuserenrollments", **options
+        end
+
+        # ISSUE: this should be a post, not a get
+        # api.put_self_assessment enrollmentid: 60997, understanding: 200, effort: 220, interest: 100
+        def put_self_assessment(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( understanding interest effort ), options: options )
+          authenticated_get cmd: "putselfassessment", **options
+        end
+
+        # api.restore_enrollment enrollmentid: 60997
+        def restore_enrollment(options = {})
+          options = argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( ), options: options )
+          authenticated_get cmd: "restoreenrollment", **options
+        end
+
+        # api.update_enrollments [{enrollmentid: 60997, status: 7}]
+        def update_enrollments(items)
+          options = items.map do |item|
+            argument_cleaner(required_params: %i( enrollmentid ), optional_params: %i( userid entityid domainid roleid flags status startdate enddate reference schema data ), options: item)
+          end
+          authenticated_bulk_post cmd: "updateenrollments", root_node: 'enrollment', body: options
+        end
+
+      end
+    end
+  end
+end

data/lib/agilix/buzz/commands/general.rb

@@ -3,11 +3,67 @@ module Agilix
     module Commands
       module General
 
+        # api.echo test: 'param'
+        def echo(options= {})
+          post cmd: "echo", **options
+        end
+
+        # api.get_command_list
+        def get_command_list
+          get cmd: "getcommandlist"
+        end
+
+        # ISSUE: nothing saying this is an authenticated call, when others are non-authenticated
+        # api.get_entity_type entityid: 57025
+        def get_entity_type(options = {})
+          options = argument_cleaner(required_params: %i( entityid ), optional_params: %i( select ), options: options )
+          authenticated_get cmd: "getentitytype", **options
+        end
+
+        # ISSUE: docs in getting started reference a `level` param, actual docs suggest using rating
+        # api.get_status rating: 4, html: true, sms: true
+        def get_status(options = {})
+          options = argument_cleaner(required_params: %i(  ), optional_params: %i( rating sms html ), options: options )
+          authenticated_get cmd: "getstatus", **options
+        end
+
+        # this is a non-authenticated call
         # api.get_status
-        def get_status
-          get cmd: "getstatus", level: 2
+        def get_basic_status(options = {})
+          options = argument_cleaner(required_params: %i(  ), optional_params: %i( rating sms html ), options: options )
+          get cmd: "getstatus", **options
+        end
+
+        # ISSUE: Docs have cmd spelled wrong, this API doesn't seem to work at all AccessDenied. It did say experimental
+        # api.get_upload_limits
+        # api.get_upload_limits domainid: 57025
+        def get_upload_limits(options = {})
+          options = argument_cleaner(required_params: %i(  ), optional_params: %i( userid domainid ), options: options )
+          get cmd: "getuploadlimits", **options
         end
 
+        # api.send_mail subject: "Test email", body: "Did you get this?", enrollmentid: 60997, enrollment_ids: ["all"]
+        def send_mail(options = {})
+          options = argument_cleaner(required_params: %i( subject body enrollmentid enrollment_ids ), optional_params: %i( groups roles strings), options: options )
+          request = {email: {
+            subject: {"$value" => options[:subject]},
+            body: {"$value" => options[:body]},
+            enrollments: {enrollment: options[:enrollment_ids].map {|id| {id: id} } }
+          }}
+          request[:email][:groups] = {group: options[:groups].map {|id| {id: id} } } if options[:groups]
+          request[:email][:roles] = {role: options[:roles].map {|id| {id: id} } } if options[:roles]
+          if options[:strings]
+            request[:email][:strings] = options[:strings].map do |k,v|
+              [ k , {"$value" => v } ]
+            end.to_h
+          end
+          enrollment_response = self.get_enrollment enrollmentid: options[:enrollmentid]
+          user_id = enrollment_response.dig("response", "enrollment", "userid")
+          proxy_api = self.proxy_api userid: user_id
+          proxy_api.authenticated_query_post query_params: {cmd: "sendmail", enrollmentid: options[:enrollmentid] },  **request
+        end
+
+
       end
     end
   end

data/lib/agilix/version.rb

@@ -1,3 +1,3 @@
 module Agilix
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/stats.html

@@ -0,0 +1 @@
+<div style=\"text-indent:0em\"><h1>certificates: <div style=\"display:inline;color:#F0F000\">Acceptable</div></h1><div style=\"text-indent:1em\"><h2>certificate (BLOCKEDMACHINE)</h2><div style=\"text-indent:2em\">The certificate is expiring soon.  If it is still in use, renew the certificate and replace it.  If it is not still in use, remove the certificate.</div></div></div><div style=\"text-indent:0em\"><h1>databaseaccess: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>emailaccess (BLOCKEDMACHINE/587): <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>fileaccess: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>localdisk: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>mediastreaming: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>misc: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>networkaccess: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>queueaccess: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>search: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div><div style=\"text-indent:0em\"><h1>sharedcacheaccess: <div style=\"display:inline;color:#009900\">Ideal</div></h1></div>4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agilix
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Eggett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -188,10 +188,12 @@ files:
 - lib/agilix/buzz/commands/authentication.rb
 - lib/agilix/buzz/commands/course.rb
 - lib/agilix/buzz/commands/domain.rb
+- lib/agilix/buzz/commands/enrollment.rb
 - lib/agilix/buzz/commands/general.rb
 - lib/agilix/buzz/commands/report.rb
 - lib/agilix/buzz/commands/user.rb
 - lib/agilix/version.rb
+- stats.html
 homepage: https://github.com/beneggett/agilix
 licenses:
 - MIT