lms-api 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7810e8e657f6cc9bdd4cd8c451ce96d829bfa79fed75389b4af081b0609ccc
-  data.tar.gz: 353814c783f580c8bfc8a6371dcf00d7acb837f5c31a8640f20e6c71d98cc291
+  metadata.gz: 60f916cc58245886a7eb557a5630951e126bc14231066e5908fc70e329c4733e
+  data.tar.gz: 223ba1598894697c5f15c8e1467a0118a00e867ec077ab28a1b09be27cf7c243
 SHA512:
-  metadata.gz: 22d3736b78f0f4ee915469ef96ac27ba8f667a672fb9aa5a277f8b464914b5829bee30612547981b313497ca4d25baf8ca864765176b7d3a3cc265b6e0a2def7
-  data.tar.gz: e2f54b89aedab87683f2811497ac360b7adde2fdfee27ca59d191911200cc46b3776a6774b1d7fb5a2cc71d730f25fe501395ecabdc5c4ca9c180dd2f6c3006f
+  metadata.gz: '0680840f0e5481d592103a5931c799ae7476eb337635661db8ceccf1517ea3c14fffca6393786bdc52c1d3c2225a555043f77dedbb94b8bcb66e46cf90b8e434'
+  data.tar.gz: 11093e447b976098ed043a33d5cc0d089d03de90b745d1668a61dc424870e11c2d05db6070f2dbaf67caa52c4cc031de9d230f9001591905243c8b3a8317e563

data/lib/canvas_api/go_helpers.rb

@@ -327,7 +327,9 @@ module CanvasApi
         puts "Using string type for '#{name}' ('#{property}') of type object."
         "map[string](interface{})"
       else
-        if property["type"] == "list of content items"
+        if property["type"] == "array of outcome ids"
+          "[]string"
+        elsif property["type"] == "list of content items"
           # HACK There's no list of content items object so we return an array of string
           "[]string"
         elsif property["type"].include?('{ "unread_count": "integer" }')
@@ -366,6 +368,8 @@ module CanvasApi
           "no-op" # this is handled further up the stack
         elsif property["type"] == "URL"
           "string"
+        elsif property["type"] == "uuid"
+          "string"
         else
           raise "Unable to match '#{name}' requested property '#{property}' to Go Type."
         end

data/lib/canvas_api/helpers.rb

@@ -1,5 +1,12 @@
 module CanvasApi
   def nested_arg(str)
+    # update_list_of_blackout_dates has a parameter named 'blackout_dates:'
+    # This results in a parameter in the resolver named 'blackout_dates::'
+    # which causes a syntax error.
+    if str[str.length() - 1] == ":"
+      str = str.chop
+    end
+
     # TODO/HACK we are replacing values from the string here to get things to work for now.
     # However, removing these symbols means that the methods that use the arguments
     # generated herein will have bugs and be unusable.
@@ -9,9 +16,9 @@ module CanvasApi
       gsub("<", "_").
       gsub(">", "_").
       gsub("`", "").
-      gsub("https://canvas.instructure.com/lti/", "").
+      gsub("https://canvas.instructure.com/lti/", "lti_").
       gsub("https://www.instructure.com/", "").
-      gsub("https://purl.imsglobal.org/spec/lti/claim/", "").
+      gsub("https://purl.imsglobal.org/spec/lti/claim/", "lti_claim_").
       gsub(".", "")
   end
 end

data/lib/canvas_api/rb_graphql_helpers.rb

@@ -6,7 +6,11 @@ module CanvasApi
     CONFLICTING_NAMES = ["end", "context", "next", "module"]
 
     def graphql_type(name, property, return_type = false, model = nil, input_type = false)
-      if property["$ref"]
+      if property["nickname"] == "get_bulk_user_progress"
+        # custom type specific to the get_bulk_user_progress endpoint. The type from canvas is void but
+        # we have to use a custom type in order to return data.
+        "LMSGraphQL::Types::CanvasBespoke::CanvasModuleUser"
+      elsif property["$ref"]
         canvas_name(property['$ref'], input_type)
       elsif property["allowableValues"]
         enum_class_name(model, name, input_type)
@@ -28,7 +32,7 @@ module CanvasApi
                   elsif property["items"]["$ref"] == "[String]"
                     "[String]"
                   elsif property["items"]["$ref"] == "DateTime" || property["items"]["$ref"] == "Date"
-                    "[LMSGraphQL::Types::DateTimeType]"
+                    "[GraphQL::Types::ISO8601DateTime]"
                   elsif property["items"]["$ref"]
                     # HACK on https://canvas.instructure.com/doc/api/submissions.json
                     # the ref value is set to a full sentence rather than a
@@ -54,15 +58,23 @@ module CanvasApi
           puts "Using string type for '#{name}' ('#{property}') of type object."
           "String"
         else
-          if property["type"] == "TermsOfService"
+          if property["type"] == "array of outcome ids"
+            "[String]"
+          elsif property["type"] == "TermsOfService"
             # HACK There's no TermsOfService object so we return a string
             "String"
           elsif property["type"] == "list of content items"
             # HACK There's no list of content items object so we return an array of string
             "[String]"
+          elsif property["type"] == "uuid"
+            # uuid is a string
+            "String"
           elsif property["type"].include?('{ "unread_count": "integer" }')
             # HACK TODO this should probably be a different type.
             "Int"
+          elsif property["type"].include?('{ "count": "integer" }')
+            # HACK TODO this should probably be a different type.
+            "Int"
           elsif return_type
             canvas_name(property["type"], input_type)
           else
@@ -76,6 +88,12 @@ module CanvasApi
     def canvas_name(type, input_type = false)
       # Remove chars and fix spelling errors
       name = type.split('|').first.strip.gsub(" ", "_").singularize.gsub("MediaTrackk", "MediaTrack")
+
+      # Handle comment in type
+      if name.include?("BlackoutDate_The_result_(which_should_match_the_input_with_maybe_some_different_IDs).")
+        name = "BlackoutDate"
+      end
+
       "LMSGraphQL::Types::Canvas::Canvas#{name}#{input_type ? 'Input' : ''}"
     end
 
@@ -98,9 +116,9 @@ module CanvasApi
       when "boolean"
         "Boolean"
       when "datetime"
-        "LMSGraphQL::Types::DateTimeType"
+        "GraphQL::Types::ISO8601DateTime"
       when "date"
-        "LMSGraphQL::Types::DateTimeType"
+        "GraphQL::Types::ISO8601DateTime"
       else
         raise "Unable to match requested primitive '#{type}' to GraphQL Type."
       end
@@ -192,7 +210,7 @@ field :#{name.underscore}, #{type}, "#{description}", resolver_method: :resolve_
     end
 
     def is_basic_type(type)
-      ["Int", "String", "Boolean", "LMSGraphQL::Types::DateTimeType", "Float", "ID"].include?(type)
+      ["Int", "String", "Boolean", "GraphQL::Types::ISO8601DateTime", "Float", "ID"].include?(type)
     end
 
     def no_brackets_period(str)
@@ -203,9 +221,15 @@ field :#{name.underscore}, #{type}, "#{description}", resolver_method: :resolve_
       str.underscore.split("/").last.split("|").first.gsub(/^canvas_?/, "").gsub(" ", "_").strip.singularize
     end
 
+    def make_bespoke_file_name(str)
+      str.underscore.split("/").last.split("|").first.gsub(" ", "_").strip.singularize
+    end
+
     def require_from_operation(operation)
       type = no_brackets_period(type_from_operation(@operation))
-      if !is_basic_type(type)
+      if type.include?("CanvasBespoke")
+        "require_relative \"../../types/canvas_bespoke/#{make_bespoke_file_name(type)}\""
+      elsif !is_basic_type(type)
         "require_relative \"../../types/canvas/#{make_file_name(type)}\""
       end
     end

data/lib/canvas_api/render.rb

@@ -37,6 +37,11 @@ module CanvasApi
       end
       if operation
         nickname = operation["nickname"]
+
+        if nickname == "save_enabled_account_calendars_creates_and_updates_enabled_account_calendars_and_mark_feature_as_seen_user_preferences_argument_mark_feature_as_seen_optional_boolean_flag_to_mark_account_calendars_feature_as_seen_argument_enabled_account_calendars_optional_array_array_of_account_ids_to_remember_in_calendars_list_of_user_curl_https_canvas_api_v_calendar_events_save_enabled_account_calendars_x_post_f_mark_feature_as_seen_true_f_enabled_account_calendars_f_enabled_account_calendars_h_authorization_bearer_token"
+          nickname = "save_enabled_account_calendars"
+        end
+
         nickname = "#{@name}_#{nickname}" if [
           "upload_file",
           "query_by_course",

data/lib/canvas_api/templates/rb_graphql_input_type.erb

@@ -7,7 +7,7 @@ module LMSGraphQL
       class Canvas<%=@model['id'].singularize%>Input < BaseInputObject
   <%=graphql_field_enums(@model, true)-%>
         description "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html"
-      <%=graphql_fields(@model, @resource_name, true, true).join("      ")%>
+        <%=graphql_fields(@model, @resource_name, true, true).join("        ")%>
       end
     end
   end