lms-api 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08796d33a3cdc324011e85cffaa2d44cd47daca12b2b77b8294e1024311ce57
-  data.tar.gz: 5e6fe01d0f7564476a24740885f224c1e6c5f7f249a2c9e733482934dbcfdfd8
+  metadata.gz: 9cd1b4b836309477ea61ae5c2f09400e86d1b3e3ae422460c8faa31e70c049cb
+  data.tar.gz: 6798941f1e531beff1e49d6e1821c27047e168a2062060944f6ff7dab6525c15
 SHA512:
-  metadata.gz: 4715e5c22aed0e4f021337c3007de2b2e33d667b28798479e303b1d269f92bc8f13b7f3c2393f0551f117c4318646ec0df615702d30f009165896af44dc72794
-  data.tar.gz: 94b55f63c92acb1c78c69a25f3ff2cf87fe0a307254ac88dac18145793968ff75d343d1e6031fc628dc8edf0aa42fcfea0c6650da0d79e23a92f24961afa6b55
+  metadata.gz: e7b848ba5f6001cd556f58efaea3532490d598f9408e16deae40ffbeddd4c6cbba08c98e3f33166c65578e01d9836eeea68fd141cbaef2a50aef72bac81da75e
+  data.tar.gz: 64042bda319f8e32e76e9b51124ef2205bf20b0c4b6e593d204bfaade0cd4e03f18af7e1635eba568eac713ace2cba369c0d81b68a6a2a727e201d17811d1000

data/lib/canvas_api/builder.rb

@@ -47,13 +47,13 @@ module CanvasApi
 
               # One file per Canvas graphql resolver
               canvas_graphql_resolver_renderer = CanvasApi::Render.new("./templates/rb_graphql_resolver.erb", api, resource, resource_api, operation, parameters, nil, nil)
-              canvas_graphql_resolver_renderer.save("#{rb_graphql_app_path}/lib/lms/graphql/resolvers/canvas/#{canvas_graphql_resolver_renderer.nickname}.rb")
+              canvas_graphql_resolver_renderer.save("#{rb_graphql_app_path}/lib/lms_graphql/resolvers/canvas/#{canvas_graphql_resolver_renderer.nickname}.rb")
               rb_graphql_fields << CanvasApi::Render.new("./templates/rb_graphql_field.erb", api, resource, resource_api, operation, parameters, nil, nil).render
             else
               js_graphql_mutations << CanvasApi::Render.new("./templates/js_graphql_mutation.erb", api, resource, resource_api, operation, parameters, nil, nil).render
 
               rb_graphql_mutation_renderer = CanvasApi::Render.new("./templates/rb_graphql_mutation.erb", api, resource, resource_api, operation, parameters, nil, nil)
-              rb_graphql_mutation_renderer.save("#{rb_graphql_app_path}/lib/lms/graphql/mutations/canvas/#{rb_graphql_mutation_renderer.nickname}.rb")
+              rb_graphql_mutation_renderer.save("#{rb_graphql_app_path}/lib/lms_graphql/mutations/canvas/#{rb_graphql_mutation_renderer.nickname}.rb")
               rb_graphql_mutations << CanvasApi::Render.new("./templates/rb_graphql_mutation_include.erb", api, resource, resource_api, operation, parameters, nil, nil).render
             end
 
@@ -65,8 +65,11 @@ module CanvasApi
           end
 
           # Generate one file for each Canvas graphql type
-          canvas_graphql_renderer = CanvasApi::Render.new("./templates/rb_graphql_model.erb", api, resource, nil, nil, nil, nil, model)
-          canvas_graphql_renderer.save("#{rb_graphql_app_path}/lib/lms/graphql/types/canvas/#{model['id'].underscore.singularize}.rb")
+          canvas_graphql_type_render = CanvasApi::Render.new("./templates/rb_graphql_type.erb", api, resource, nil, nil, nil, nil, model)
+          canvas_graphql_type_render.save("#{rb_graphql_app_path}/lib/lms_graphql/types/canvas/#{model['id'].underscore.singularize}.rb")
+
+          canvas_graphql_input_render = CanvasApi::Render.new("./templates/rb_graphql_input_type.erb", api, resource, nil, nil, nil, nil, model)
+          canvas_graphql_input_render.save("#{rb_graphql_app_path}/lib/lms_graphql/types/canvas/#{model['id'].underscore.singularize}_input.rb")
         end
 
         # Generate one file of constants for every LMS API
@@ -85,8 +88,8 @@ module CanvasApi
       CanvasApi::Render.new("./templates/js_graphql_mutations.erb", nil, nil, nil, nil, nil, js_graphql_mutations, nil).save("#{server_app_path}/lib/canvas/graphql_mutations.js")
 
       # GraphQL Ruby
-      CanvasApi::Render.new("./templates/rb_graphql_root_query.erb", nil, nil, nil, nil, nil, rb_graphql_fields, nil).save("#{rb_graphql_app_path}/lib/lms/graphql/types/canvas/query_type.rb")
-      CanvasApi::Render.new("./templates/rb_graphql_mutations.erb", nil, nil, nil, nil, nil, rb_graphql_mutations, nil).save("#{rb_graphql_app_path}/lib/lms/graphql/mutations/canvas/mutations.rb")
+      CanvasApi::Render.new("./templates/rb_graphql_root_query.erb", nil, nil, nil, nil, nil, rb_graphql_fields, nil).save("#{rb_graphql_app_path}/lib/lms_graphql/types/canvas/query_type.rb")
+      CanvasApi::Render.new("./templates/rb_graphql_mutations.erb", nil, nil, nil, nil, nil, rb_graphql_mutations, nil).save("#{rb_graphql_app_path}/lib/lms_graphql/mutations/canvas/mutations.rb")
     end
 
   end

data/lib/canvas_api/js_helpers.rb

@@ -20,14 +20,18 @@ module CanvasApi
       end
     end
 
-    def parameters_doc(operation)
+    def parameters_doc(operation, method)
       if operation["parameters"].present?
         parameters = operation["parameters"].
           reject { |p| p["paramType"] == "path" }.
           map { |p| "#{p['name']}#{p['required'] ? ' (required)' : ''}" }.
           compact
         if parameters.present?
-          "\n// const query = {\n//   #{parameters.join("\n//   ")}\n// }"
+          if method == "get"
+            "\n// const query = {\n//   #{parameters.join("\n//   ")}\n// }"
+          else
+            "\n// const body = {\n//   #{parameters.join("\n//   ")}\n// }"
+          end
         else
           ""
         end

data/lib/canvas_api/rb_graphql_helpers.rb

@@ -1,14 +1,17 @@
 module CanvasApi
   module GraphQLHelpers
 
-    def graphql_type(name, property, return_type = false, model = nil)
+    def graphql_type(name, property, return_type = false, model = nil, input_type = false)
       if property["$ref"]
-        canvas_name(property['$ref'])
+        canvas_name(property['$ref'], input_type)
       elsif property["allowableValues"]
         enum_class_name(model, name)
       else
         type = property["type"].downcase
+
         case type
+        when "{success: true}"
+          "String"
         when "integer", "string", "boolean", "datetime", "number", "date"
           graphql_primitive(name, type, property["format"])
         when "void"
@@ -22,9 +25,9 @@ module CanvasApi
                    elsif property["items"]["$ref"] == "[String]"
                      "[String]"
                   elsif property["items"]["$ref"] == "DateTime" || property["items"]["$ref"] == "Date"
-                     "[LMS::GraphQL::Types::DateTimeType]"
+                     "[LMSGraphQL::Types::DateTimeType]"
                    elsif property["items"]["$ref"]
-                     "[#{canvas_name(property["items"]["$ref"])}]"
+                     "[#{canvas_name(property["items"]["$ref"], input_type)}]"
                    else
                      graphql_primitive(name, property["items"]["type"].downcase, property["items"]["format"])
                    end
@@ -41,7 +44,7 @@ module CanvasApi
             # HACK There's no TermsOfService object so we return a string
             "String"
           elsif return_type
-            canvas_name(property["type"])
+            canvas_name(property["type"], input_type)
           else
             puts "Unable to match '#{name}' requested property '#{property}' to GraphQL Type."
             "String"
@@ -50,9 +53,9 @@ module CanvasApi
       end
     end
 
-    def canvas_name(type)
+    def canvas_name(type, input_type = false)
       name = type.split('|').first.strip.singularize
-      "LMS::GraphQL::Types::Canvas::#{name}"
+      "LMSGraphQL::Types::Canvas::Canvas#{name}#{input_type ? 'Input' : ''}"
     end
 
     def graphql_primitive(name, type, format)
@@ -74,9 +77,9 @@ module CanvasApi
       when "boolean"
         "Boolean"
       when "datetime"
-        "LMS::GraphQL::Types::DateTimeType"
+        "LMSGraphQL::Types::DateTimeType"
       when "date"
-        "LMS::GraphQL::Types::DateTimeType"
+        "LMSGraphQL::Types::DateTimeType"
       else
         raise "Unable to match requested primitive '#{type}' to GraphQL Type."
       end
@@ -107,7 +110,7 @@ module CanvasApi
       end
     end
 
-    def graphql_fields(model, resource_name)
+    def graphql_fields(model, resource_name, argument = false)
       if !model["properties"]
         puts "NO properties for #{resource_name} !!!!!!!!!!!!!!!!!!!!!"
         return []
@@ -118,9 +121,15 @@ module CanvasApi
         description << "Example: #{safe_rb(property['example'])}".gsub("..", "").gsub("\n", " ") if property["example"].present?
 
         if type = graphql_type(name, property, false, model)
-          <<-CODE
+          if argument
+            <<-CODE
+  argument :#{name.underscore}, #{type}, "#{description}", required: false
+            CODE
+          else
+            <<-CODE
   field :#{name.underscore}, #{type}, "#{description}", null: true
-          CODE
+            CODE
+          end
         else
           puts "Unable to determine type for #{name}"
         end
@@ -128,7 +137,7 @@ module CanvasApi
     end
 
     def type_from_operation(operation)
-      graphql_type("operation", operation, true)
+      type = graphql_type("operation", operation, true)
     end
 
     def name_from_operation(operation)
@@ -141,7 +150,7 @@ module CanvasApi
     end
 
     def is_basic_type(type)
-      ["Int", "String", "Boolean", "LMS::GraphQL::Types::DateTimeType", "Float", "ID"].include?(type)
+      ["Int", "String", "Boolean", "LMSGraphQL::Types::DateTimeType", "Float", "ID"].include?(type)
     end
 
     def no_brackets(str)
@@ -149,7 +158,7 @@ module CanvasApi
     end
 
     def make_file_name(str)
-      str.underscore.split("/").last.split("|").first.strip.singularize
+      str.underscore.split("/").last.split("|").first.gsub("canvas_", "").strip.singularize
     end
 
     def require_from_operation(operation)
@@ -182,7 +191,10 @@ module CanvasApi
     end
 
     def nested_arg(str)
-      str.gsub("[", "_").gsub("]", "").gsub("*", "star").gsub("<X>", "_x_")
+      # 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(">", "_")
     end
 
   end

data/lib/canvas_api/templates/constant.erb

@@ -1,4 +1,4 @@
-<% parameters_doc = parameters_doc(operation) -%>
+<% parameters_doc = parameters_doc(operation, @method.downcase) -%>
 // <%=@summary%>
 // <%=@notes%>
 //
@@ -6,5 +6,5 @@
 // API Url: <%=@api_url%>
 //
 // Example:<%=parameters_doc%>
-// return canvasRequest(<%=@nickname%>, {<%=@args.join(', ')%>}<%= parameters_doc.present? ? ", query" : ""%>);
+// return canvasRequest(<%=@nickname%>, {<%=@args.present? ? @args.join(', ') : ""%><%= @method.downcase == "get" && parameters_doc.present? ? ", ...query" : ""%>}<%= @method.downcase != "get" && parameters_doc.present? ? ", body" : ""%>);
 export const <%=@nickname.camelcase(:lower)%> = { type: '<%=@nickname.upcase%>', method: '<%=@method.downcase%>', key: '<%=reducer_key(@nickname, @args)%>', required: <%=js_args(@args)%> };

data/lib/canvas_api/templates/rb_graphql_field.erb

@@ -1,3 +1,3 @@
-          field :<%= @nickname %>,
-            resolver: LMS::GraphQL::Resolvers::Canvas::<%= @nickname.classify %>,
-            description: "<%= @summary %>. <%= @notes.gsub(/\n+/, " ").gsub("//", " ").gsub('"', "'") %>"
+        field :<%= @nickname %>,
+          resolver: LMSGraphQL::Resolvers::Canvas::<%= @nickname.classify %>,
+          description: "<%= @summary %>. <%= @notes.gsub(/\n+/, " ").gsub("//", " ").gsub('"', "'") %>"

data/lib/canvas_api/templates/rb_graphql_input_type.erb

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

data/lib/canvas_api/templates/rb_graphql_mutation.erb

@@ -1,22 +1,20 @@
 require_relative "../canvas_base_mutation"
 <%= require_from_operation(operation) -%>
 
-module LMS
-  module GraphQL
-    module Mutations
-      module Canvas
-        class <%= @nickname.classify %> < CanvasBaseMutation
-<%= @parameters.map{|p| "          argument :#{nested_arg(p["name"])}, #{graphql_type(p["name"], p)}, required: #{p["required"]}"}.join("\n") %>
-          field :<%= name_from_operation(operation) %>, <%= type_from_operation(operation) %>, null: false
-          def resolve(<%= @parameters.map{|p| "#{nested_arg(p['name'])}#{p['required'] ? ':' : ': nil'}"}.join(", ") %>)
-            ctx[:canvas_api].proxy(
-              "<%= @nickname.upcase %>",
-              {
-<%= @parameters.map{|p| "                \"#{p['name']}\": #{nested_arg(p['name'])}"}.join(",\n") -%>
-              },
-              nil,
-            ).parsed_response
-          end
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class <%= @nickname.classify %> < BaseMutation
+<%= @parameters.map{|p| "        argument :#{nested_arg(p["name"])}, #{graphql_type(p["name"], p, false, nil, true)}, required: #{p["required"]}"}.join("\n") %>
+        field :<%= name_from_operation(operation) %>, <%= type_from_operation(operation) %>, null: false
+        def resolve(<%= @parameters.map{|p| "#{nested_arg(p['name'])}#{p['required'] ? ':' : ': nil'}"}.join(", ") %>)
+          context[:canvas_api].call("<%= @nickname.upcase %>").proxy(
+            "<%= @nickname.upcase %>",
+            {
+<%= @parameters.map{|p| "              \"#{p['name']}\": #{nested_arg(p['name'])}"}.join(",\n") -%>
+            },
+            nil,
+          ).parsed_response
         end
       end
     end

data/lib/canvas_api/templates/rb_graphql_mutation_include.erb

@@ -1 +1 @@
-field :<%= @nickname %>, mutation: LMS::GraphQL::Mutations::Canvas::<%= @nickname.classify %>
+field :<%= @nickname %>, mutation: LMSGraphQL::Mutations::Canvas::<%= @nickname.classify %>

data/lib/canvas_api/templates/rb_graphql_mutations.erb

@@ -1,16 +1,14 @@
-require "lms/utils"
-require "lms/graphql/mutations/canvas_base_mutation"
+require_relative "../../utils"
+require_relative "../../types/canvas_base_type"
 require_all(File.absolute_path(__FILE__), "../../mutations/canvas/")
 
-module LMS
-  module GraphQL
-    module Mutations
-      module Canvas
-        class MutationType < CanvasBaseMutation
-          description "Canvas API mutations"
+module LMSGraphQL
+  module Mutations
+    module Canvas
+      class MutationType < LMSGraphQL::Types::Canvas::BaseType
+        description "Canvas API mutations"
 
-          <%= @content.join("\n          ") %>
-        end
+        <%= @content.join("\n        ") %>
       end
     end
   end

data/lib/canvas_api/templates/rb_graphql_resolver.erb

@@ -1,22 +1,20 @@
 require_relative "../canvas_base_resolver"
 <%= require_from_operation(operation) -%>
 
-module LMS
-  module GraphQL
-    module Resolvers
-      module Canvas
-        class <%= @nickname.classify %> < CanvasBaseResolver
-          type <%= type_from_operation(operation) %>, null: false
-<%= @parameters.map{|p| "          argument :#{nested_arg(p["name"])}, #{graphql_type(p["name"], p)}, required: #{p["required"]}"}.join("\n") %>
-          def resolve(<%= @parameters.map{|p| "#{nested_arg(p['name'])}#{p['required'] ? ':' : ': nil'}"}.join(", ") %>)
-            context[:canvas_api].proxy(
-              "<%= @nickname.upcase %>",
-              {
-<%= @parameters.map{|p| "                \"#{p['name']}\": #{nested_arg(p['name'])}"}.join(",\n") -%>
-              },
-              nil,
-            ).parsed_response
-          end
+module LMSGraphQL
+  module Resolvers
+    module Canvas
+      class <%= @nickname.classify %> < CanvasBaseResolver
+        type <%= type_from_operation(operation) %>, null: false
+<%= @parameters.map{|p| "        argument :#{nested_arg(p["name"])}, #{graphql_type(p["name"], p)}, required: #{p["required"]}"}.join("\n") %>
+        def resolve(<%= @parameters.map{|p| "#{nested_arg(p['name'])}#{p['required'] ? ':' : ': nil'}"}.join(", ") %>)
+          context[:canvas_api].call("<%= @nickname.upcase %>").proxy(
+            "<%= @nickname.upcase %>",
+            {
+<%= @parameters.map{|p| "              \"#{p['name']}\": #{nested_arg(p['name'])}"}.join(",\n") -%>
+            },
+            nil,
+          ).parsed_response
         end
       end
     end

data/lib/canvas_api/templates/rb_graphql_root_query.erb

@@ -1,15 +1,13 @@
-require_relative "../../../utils"
+require_relative "../../utils"
 require_relative "../canvas_base_type"
 require_all(File.absolute_path(__FILE__), "../../resolvers/canvas/")
 
-module LMS
-  module GraphQL
-    module Types
-      module Canvas
-        class QueryType < BaseType
-          description "The root query of Canvas schema"
-          <%= @content.join("\n\n          ") %>
-        end
+module LMSGraphQL
+  module Types
+    module Canvas
+      class QueryType < BaseType
+        description "The root query of Canvas schema"
+        <%= @content.join("\n\n        ") %>
       end
     end
   end

data/lib/canvas_api/templates/rb_graphql_type.erb

@@ -0,0 +1,14 @@
+require_relative "../canvas_base_type"
+<%= require_from_properties(@model) %>
+
+module LMSGraphQL
+  module Types
+    module Canvas
+<%=graphql_field_enums(@model)-%>
+      class Canvas<%=@model['id'].singularize%> < BaseType
+        description "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html"
+      <%=graphql_fields(@model, @resource_name).join("      ")%>
+      end
+    end
+  end
+end

data/lib/lms/canvas.rb

@@ -337,7 +337,9 @@ module LMS
       query_parameters << :page
       query_parameters << :as_user_id
 
-      allowed_params = params.slice(*query_parameters)
+      allowed_params = params.
+        slice(*query_parameters).
+        reject { |key, value| value.nil? }
 
       if allowed_params.present?
         "#{uri}?#{allowed_params.to_query}"

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.5.0".freeze
+  VERSION = "1.5.1".freeze
 end

data/lib/tasks/canvas_api.rake

@@ -13,7 +13,7 @@ namespace :canvas do
   desc "Scrape the LMS api"
   task :api do
     current_path = File.expand_path(File.dirname(__FILE__))
-    client_app_path = File.expand_path(File.join(current_path, "../../../atomic-client/client/libs/canvas/constants"))
+    client_app_path = File.expand_path(File.join(current_path, "../../../atomic-canvas/src/constants"))
     server_app_path = File.expand_path(File.join(current_path, "../../../atomic-lti"))
     elixir_app_path = File.expand_path(File.join(current_path, "../../../catalyst"))
     rb_graphql_app_path = File.expand_path(File.join(current_path, "../../../lms_graphql_api"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Atomic Jolt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,12 +129,13 @@ files:
 - lib/canvas_api/templates/js_url.erb
 - lib/canvas_api/templates/js_urls.erb
 - lib/canvas_api/templates/rb_graphql_field.erb
-- lib/canvas_api/templates/rb_graphql_model.erb
+- lib/canvas_api/templates/rb_graphql_input_type.erb
 - lib/canvas_api/templates/rb_graphql_mutation.erb
 - lib/canvas_api/templates/rb_graphql_mutation_include.erb
 - lib/canvas_api/templates/rb_graphql_mutations.erb
 - lib/canvas_api/templates/rb_graphql_resolver.erb
 - lib/canvas_api/templates/rb_graphql_root_query.erb
+- lib/canvas_api/templates/rb_graphql_type.erb
 - lib/canvas_api/templates/rb_url.erb
 - lib/canvas_api/templates/rb_urls.erb
 - lib/lms/canvas.rb

data/lib/canvas_api/templates/rb_graphql_model.erb

@@ -1,16 +0,0 @@
-require_relative "../canvas_base_type"
-<%= require_from_properties(@model) %>
-
-module LMS
-  module GraphQL
-    module Types
-      module Canvas
-<%=graphql_field_enums(@model)-%>
-        class <%=@model['id'].singularize%> < BaseType
-          description "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html"
-        <%=graphql_fields(@model, @resource_name).join("        ")%>
-        end
-      end
-    end
-  end
-end