lms-api 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbf4acfef5de0008c9e181c97242511e28985bc57ea09f722b3a41d5af9c0c04
-  data.tar.gz: fd7557c89ec0e9c52381f90b22c484466276f5d866be2636f7c27e0728b02fe4
+  metadata.gz: cfafd60f403921db6037838554ff73e249aba5b3d19946a6a001c73598534ee8
+  data.tar.gz: 5ba978a32528ff25e6139d18ddaf60e3b82bbf1b412d357c6562d9bccfbf4939
 SHA512:
-  metadata.gz: 8c386ae46339d2474c5056a091095b1ffe85c45f103fd0d6915fcfdcc96f21bf616bac55f42a19671ed429fada551e7942609a51dd7966cc1b79292e6a33415b
-  data.tar.gz: 110fe2f62222d994347bd82e65ab47ecfa8f116f00fef031e991cdc02bd51a6c263b9c27acb54c5698220742b44bf33c9e31d6ed85dadd176dc2bbecde3eb3e2
+  metadata.gz: 71254525d790ceceb28697bed2871c0b1994586c536e523d4a75f27e3a38bb1a9e61a0d7b099eb2c042ef900238bfd296c8bcae53cb98311c9c6d92ecfb01501
+  data.tar.gz: bc99de213a91082613dab0c2cfe82e1eec4c40813271146e7e341aded7bf51a02e07eced2982c8ff4870eb283448d9639820073208e3fee5650e071d78609d9c

data/lib/canvas_api/rb_graphql_helpers.rb

@@ -8,7 +8,6 @@ module CanvasApi
         enum_class_name(model, name)
       else
         type = property["type"].downcase
-
         case type
         when "{success: true}"
           "String"
@@ -19,25 +18,27 @@ module CanvasApi
         when "array"
           begin
             type = if property["items"]["$ref"] == "[Integer]"
-                     "[Int]"
-                   elsif property["items"]["$ref"] == "Array"
-                     "[String]"
-                   elsif property["items"]["$ref"] == "[String]"
-                     "[String]"
+                    "[Int]"
+                  elsif property["items"]["$ref"] == "Array"
+                    "[String]"
+                  elsif property["items"]["$ref"] == "[String]"
+                    "[String]"
                   elsif property["items"]["$ref"] == "DateTime" || property["items"]["$ref"] == "Date"
-                     "[LMSGraphQL::Types::DateTimeType]"
-                   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
-                     # simple type, so we look for that specific value
-                     if property["items"]["$ref"].include?("UserDisplay if anonymous grading is not enabled")
-                       "[LMSGraphQL::Types::Canvas::CanvasUserDisplay]"
-                     else
-                       "[#{canvas_name(property["items"]["$ref"], input_type)}]"
-                     end
-                   else
-                     graphql_primitive(name, property["items"]["type"].downcase, property["items"]["format"])
-                   end
+                    "[LMSGraphQL::Types::DateTimeType]"
+                  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
+                    # simple type, so we look for that specific value
+                    if property["items"]["$ref"].include?("UserDisplay if anonymous grading is not enabled")
+                      "[LMSGraphQL::Types::Canvas::CanvasUserDisplay]"
+                    elsif property["items"]["$ref"].include?("Url String The url to the result that was created")
+                      "String"
+                    else
+                      "[#{canvas_name(property["items"]["$ref"], input_type)}]"
+                    end
+                  else
+                    graphql_primitive(name, property["items"]["type"].downcase, property["items"]["format"])
+                  end
           rescue
             puts "Unable to discover list type for '#{name}' ('#{property}'). Defaulting to String"
             type = "String"
@@ -50,6 +51,12 @@ module CanvasApi
           if 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"].include?('{ "unread_count": "integer" }')
+            # HACK TODO this should probably be a different type.
+            "Int"
           elsif return_type
             canvas_name(property["type"], input_type)
           else
@@ -61,7 +68,8 @@ module CanvasApi
     end
 
     def canvas_name(type, input_type = false)
-      name = type.split('|').first.strip.singularize
+      # Remove chars and fix spelling errors
+      name = type.split('|').first.strip.gsub(" ", "_").singularize.gsub("MediaTrackk", "MediaTrack")
       "LMSGraphQL::Types::Canvas::Canvas#{name}#{input_type ? 'Input' : ''}"
     end
 
@@ -127,6 +135,9 @@ module CanvasApi
         description << "#{safe_rb(property['description'])}." if property["description"].present?
         description << "Example: #{safe_rb(property['example'])}".gsub("..", "").gsub("\n", " ") if property["example"].present?
 
+        # clean up name
+        name = nested_arg(name)
+
         if type = graphql_type(name, property, false, model, input_type)
           if argument
             <<-CODE
@@ -148,7 +159,7 @@ module CanvasApi
     end
 
     def name_from_operation(operation)
-      type = no_brackets(type_from_operation(@operation))
+      type = no_brackets_period(type_from_operation(@operation))
       if !is_basic_type(type)
         make_file_name(type)
       else
@@ -160,16 +171,16 @@ module CanvasApi
       ["Int", "String", "Boolean", "LMSGraphQL::Types::DateTimeType", "Float", "ID"].include?(type)
     end
 
-    def no_brackets(str)
-      str.gsub("[", "").gsub("]", "")
+    def no_brackets_period(str)
+      str.gsub("[", "").gsub("]", "").gsub(".", "")
     end
 
     def make_file_name(str)
-      str.underscore.split("/").last.split("|").first.gsub("canvas_", "").strip.singularize
+      str.underscore.split("/").last.split("|").first.gsub("canvas_", "").gsub(" ", "_").strip.singularize
     end
 
     def require_from_operation(operation)
-      type = no_brackets(type_from_operation(@operation))
+      type = no_brackets_period(type_from_operation(@operation))
       if !is_basic_type(type)
         "require_relative \"../../types/canvas/#{make_file_name(type)}\""
       end
@@ -178,7 +189,7 @@ module CanvasApi
     def require_from_properties(model)
       return unless model["properties"]
       requires = model["properties"].map do |name, property|
-        type = no_brackets(graphql_type(name, property, true, model))
+        type = no_brackets_period(graphql_type(name, property, true, model))
         if !is_basic_type(type) && !property["allowableValues"]
           "require_relative \"#{make_file_name(type)}\""
         end
@@ -201,7 +212,16 @@ module CanvasApi
       # 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.
-      str.gsub("[", "_").gsub("]", "").gsub("*", "star").gsub("<", "_").gsub(">", "_")
+      str.gsub("[", "_").
+        gsub("]", "").
+        gsub("*", "star").
+        gsub("<", "_").
+        gsub(">", "_").
+        gsub("`", "").
+        gsub("https://canvas.instructure.com/lti/", "").
+        gsub("https://www.instructure.com/", "").
+        gsub("https://purl.imsglobal.org/spec/lti/claim/", "").
+        gsub(".", "")
     end
 
     def params_as_string(parameters, paramTypes)

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.16.0".freeze
+  VERSION = "1.17.0".freeze
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Atomic Jolt
 - Jamis Buck
 - Justin Ball
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,7 +153,7 @@ homepage: https://github.com/atomicjolt/lms_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Wrapper for the Instructure Canvas API
 test_files: []