lms-api 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a2b3bff766499f69c000baa9f9f95ae75909c1
-  data.tar.gz: a9c358a4fdbdffbf3e483d5eaede08b13727a035
+  metadata.gz: 777bf9afd9565fde961baae2844dc52c76805923
+  data.tar.gz: fac9b9652c3bd22324495f1773bac632299c89d4
 SHA512:
-  metadata.gz: 96bf9ce9f000c0eb4bf7176d103c3c60b4320bf8c708f587f8865f008f2460bf81134e4947f86b6a189cba143ca0cacc6958393f7b0d63f74a1719ef291ed493
-  data.tar.gz: a420885bedb76e1114eb4b97853a79dbe19b13e821d68d34ccb76240226d1e49c6b939d26856a641e2f61f93de31d4acf38fa2adbc8177518c9052c64c25ca5b
+  metadata.gz: 8a1b01e99e069189e1ffa1904946f44975f01dd47aaf4c6da0e6fe4d050823edfd2cbbf5edc888d8d501fdf5c049b851941c93c0ba44526ac96b4cf18878394d
+  data.tar.gz: f4bad4474f786009e32df7aec3a916a0b6e3a49ee30f2f30c72976394470f2778f4be7bba5a60fa00b76b36c80ec8727cc8505a951abcfd4ea6103f86b9a9601

data/lib/canvas_api.rb

@@ -0,0 +1,4 @@
+module CanvasApi
+end
+
+require "canvas_api/builder"

data/lib/canvas_api/builder.rb

@@ -0,0 +1,59 @@
+require "canvas_api/render"
+
+module CanvasApi
+
+  class Builder
+
+    #
+    # project_root: This is the directory where the canvas_urls.rb file will be written. This file contains all urls and functions for access to the Canvas API from this gem (lms_api).
+    # client_app_path: This where all client side Javascript for accessing the Canvas API will be written.
+    # server_app_path: This is where all server side Javascript for accessing the Canvas API will be written. Currently, this is generating GraphQL for Javascript
+    #
+    def self.build(project_root, client_app_path, server_app_path)
+      endpoint = "https://canvas.instructure.com/doc/api"
+      directory = HTTParty.get("#{endpoint}/api-docs.json")
+
+      lms_urls_rb = []
+      lms_urls_js = []
+      models = []
+      queries = []
+      mutations = []
+      directory["apis"].each do |api|
+        puts "Generating #{api['description']}"
+        resource = HTTParty.get("#{endpoint}#{api['path']}")
+        constants = []
+        resource["apis"].each do |resource_api|
+          resource_api["operations"].each do |operation|
+            parameters = operation["parameters"]
+            constants << CanvasApi::Render.new("./templates/constant.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            lms_urls_rb << CanvasApi::Render.new("./templates/rb_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            lms_urls_js << CanvasApi::Render.new("./templates/js_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            if "GET" == operation["method"].upcase
+              queries << CanvasApi::Render.new("./templates/graphql_query.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            else
+              mutations << CanvasApi::Render.new("./templates/graphql_mutation.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            end
+          end
+        end
+        resource["models"].map do |_name, model|
+          if model["properties"] # Don't generate models without properties
+            models << CanvasApi::Render.new("./templates/graphql_model.erb", api, resource, nil, nil, nil, nil, model).render
+          end
+        end
+        # Generate one file of constants for every LMS API
+        constants_renderer = CanvasApi::Render.new("./templates/constants.erb", api, resource, nil, nil, nil, constants, nil)
+        constants_renderer.save("#{client_app_path}/#{constants_renderer.name}.js")
+      end
+
+      CanvasApi::Render.new("./templates/rb_urls.erb", nil, nil, nil, nil, nil, lms_urls_rb, nil).save("#{project_root}/lib/lms/canvas_urls.rb")
+      CanvasApi::Render.new("./templates/js_urls.erb", nil, nil, nil, nil, nil, lms_urls_js, nil).save("#{server_app_path}/lib/canvas/urls.js")
+
+      # GraphQL - still not complete
+      CanvasApi::Render.new("./templates/graphql_types.erb", nil, nil, nil, nil, nil, models.compact, nil).save("#{server_app_path}/lib/canvas/graphql_types.js")
+      CanvasApi::Render.new("./templates/graphql_queries.erb", nil, nil, nil, nil, nil, queries, nil).save("#{server_app_path}/lib/canvas/graphql_queries.js")
+      CanvasApi::Render.new("./templates/graphql_mutations.erb", nil, nil, nil, nil, nil, mutations, nil).save("#{server_app_path}/lib/canvas/graphql_mutations.js")
+    end
+
+  end
+
+end

data/lib/canvas_api/graphql_helpers.rb

@@ -0,0 +1,99 @@
+require 'byebug'
+module CanvasApi
+
+  module GraphQLHelpers
+
+    def graphql_type(name, property)
+      if property["$ref"]
+        "#{property['$ref']}, resolve: function(model){ return model.#{name}; }"
+      else
+        type = property["type"]
+        case type
+        when "integer", "string", "boolean", "datetime", "number"
+          graphql_primitive(type, property["format"])
+        when "array"
+          begin
+            type = if property["items"]["$ref"]
+                     property["items"]["$ref"]
+                   else
+                     graphql_primitive(property["items"]["type"], property["items"]["format"])
+                   end
+          rescue
+            puts "Unable to discover list type for '#{name}' ('#{property}'). Defaulting to GraphQLString"
+            type = "GraphQLString"
+          end
+          "new GraphQLList(#{type})"
+        when "object"
+          puts "Using string type for '#{name}' ('#{property}') of type object."
+          "GraphQLString"
+        else
+          puts "Unable to match '#{name}' requested property '#{property}' to GraphQL Type."
+          "GraphQLString"
+        end
+      end
+    end
+
+    def graphql_primitive(type, format)
+      case type
+      when "integer"
+        "GraphQLInt"
+      when "number"
+        if format == "float64"
+          "GraphQLFloat"
+        else
+          # TODO many of the LMS types with 'number' don't indicate a type so we have to guess
+          # Hopefully that changes. For now we go with float
+          "GraphQLFloat"
+        end
+      when "string"
+        "GraphQLString"
+      when "boolean"
+        "GraphQLBoolean"
+      when "datetime"
+        "GraphQLDateTime"
+      else
+        raise "Unable to match requested primitive '#{type}' to GraphQL Type."
+      end
+    end
+
+    def graphql_resolve(name, property)
+      if property["$ref"]
+        "resolve(model){ return model.#{name}; }"
+      elsif property["type"] == "array" && property["items"] && property["items"]["$ref"]
+        "resolve(model){ return model.#{name}; }"
+      end
+      "resolve(model){ return model.#{name}; }"
+    end
+
+    def graphql_fields(model, resource_name)
+      model["properties"].map do |name, property|
+        # HACK. This property doesn't have any metadata. Throw in a couple lines of code
+        # specific to this field.
+        if name == "created_source" && property == "manual|sis|api"
+          "#{name}: new GraphQLEnumType({ name: '#{name}', values: { manual: { value: 'manual' }, sis: { value: 'sis' }, api: { value: 'api' } } })"
+        else
+
+          description = ""
+          if property["description"].present? && property["example"].present?
+            description << "#{safe_js(property['description'])}. Example: #{safe_js(property['example'])}".gsub("..", "").gsub("\n", " ")
+          end
+
+          if type = graphql_type(name, property)
+            resolve = graphql_resolve(name, property)
+            resolve = "#{resolve}, " if resolve.present?
+            "#{name}: { type: #{type}, #{resolve}description: \"#{description}\" }"
+          end
+
+        end
+      end.compact
+    end
+
+    def safe_js(str)
+      str = str.join(", ") if str.is_a?(Array)
+      str = str.map { |_k, v| v }.join(", ") if str.is_a?(Hash)
+      return str unless str.is_a?(String)
+      str.gsub('"', "'")
+    end
+  end
+
+end

data/lib/canvas_api/js_helpers.rb

@@ -0,0 +1,54 @@
+module CanvasApi
+  module JsHelpers
+
+    def js_url_parts(api_url)
+      api_url.split(/(\{[a-z_]+\})/).map do |part|
+        if part[0] == "{"
+          arg = part.gsub(/[\{\}]/, "")
+          "args['#{arg}']"
+        else
+          %{"#{part}"}
+        end
+      end
+    end
+
+    def js_args(args)
+      if args.present?
+        "['#{args.join("', '")}']"
+      else
+        "[]"
+      end
+    end
+
+    def parameters_doc(operation)
+      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// }"
+        else
+          ""
+        end
+      else
+        ""
+      end
+    end
+
+    def key_args(args)
+      if args.blank?
+        ""
+      elsif args.length > 1
+        "#{nickname}_{#{args.join('}_{')}}"
+      else
+        "#{nickname}_#{args[0]}"
+      end
+    end
+
+    def reducer_key(nickname, args)
+      "#{nickname}#{key_args(args)}"
+    end
+
+  end
+end

data/lib/canvas_api/render.rb

@@ -0,0 +1,73 @@
+require "canvas_api/graphql_helpers"
+require "canvas_api/js_helpers"
+require "canvas_api/ruby_helpers"
+
+module CanvasApi
+
+  class Render
+    include CanvasApi::GraphQLHelpers
+    include CanvasApi::JsHelpers
+    include CanvasApi::RubyHelpers
+    attr_accessor :template, :description, :resource, :api_url, :operation,
+                  :args, :method, :api, :name, :resource_name, :resource_api,
+                  :nickname, :notes, :content, :summary, :model, :model_name
+
+    def initialize(template, api, resource, resource_api, operation, parameters, content, model)
+      @template = File.read(File.expand_path(template, __dir__))
+      if api
+        @api         = api
+        @name        = @api["path"].gsub("/", "").gsub(".json", "")
+        @description = @api["description"]
+      end
+      if resource
+        @resource      = resource
+        @resource_name = resource["resourcePath"].gsub("/", "")
+      end
+      if resource_api
+        @resource_api = resource_api
+        @api_url      = resource_api["path"].gsub("/v1/", "")
+        @args         = args(@api_url)
+      end
+      if operation
+        nickname = operation["nickname"]
+        nickname = "#{@name}_#{nickname}" if [
+          "upload_file",
+          "query_by_course",
+          "preview_processed_html",
+          "create_peer_review_courses",
+          "create_peer_review_sections",
+          "set_extensions_for_student_quiz_submissions"
+        ].include?(nickname)
+
+        @method    = operation["method"]
+        @operation = operation
+        @nickname  = nickname
+        @notes     = operation["notes"].gsub("\n", "\n// ")
+        @summary   = operation["summary"]
+      end
+      if parameters
+        @parameters = parameters.map { |p| p.delete("description"); p }
+      end
+      @content = content
+      @model = model
+    end
+
+    def args(api_url)
+      api_url.split("/").map do |part|
+        if part[0] == "{"
+          part.gsub(/[\{\}]/, "")
+        end
+      end.compact
+    end
+
+    def render
+      ERB.new(@template, nil, "-").result(binding).strip
+    end
+
+    def save(file)
+      File.write(file, render)
+    end
+
+  end
+
+end

data/lib/canvas_api/ruby_helpers.rb

@@ -0,0 +1,9 @@
+module CanvasApi
+  module RubyHelpers
+
+    def ruby_api_url(api_url)
+      api_url.gsub("{", "#\{")
+    end
+
+  end
+end

data/lib/canvas_api/templates/constant.erb

@@ -0,0 +1,10 @@
+<% parameters_doc = parameters_doc(operation) -%>
+// <%=@summary%>
+// <%=@notes%>
+//
+// API Docs: https://canvas.instructure.com/doc/api/<%=@resource_name%>.html
+// API Url: <%=@api_url%>
+//
+// Example:<%=parameters_doc%>
+// return canvasRequest(<%=@nickname%>, {<%=@args.join(', ')%>}<%= parameters_doc.present? ? ", query" : ""%>);
+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/constants.erb

@@ -0,0 +1,4 @@
+//
+// <%= @description %>
+//
+<%=@content.join("\n\n")%>

data/lib/canvas_api/templates/graphql_model.erb

@@ -0,0 +1,9 @@
+const <%=@model['id']%> = new GraphQLObjectType({
+  name: "<%=@model['id']%>",
+  description: "<%=@description%>. API Docs: https://canvas.instructure.com/doc/api/<%=@name%>.html",
+  fields() {
+    return {
+      <%=graphql_fields(@model, @resource_name).join(",\n      ")%>
+    };
+  }
+});

data/lib/canvas_api/templates/graphql_mutations.erb

@@ -0,0 +1,6 @@
+const Mutuation = new GraphQLObjectType({
+  name: 'Canvas Api Mutations',
+  fields: {
+    <%=@content.join("\n\n")%>
+  }
+});

data/lib/canvas_api/templates/graphql_queries.erb

@@ -0,0 +1,7 @@
+const Query = new GraphQLObjectType({
+  name: 'Canvas Api Queries',
+  description: "Root of the Canvas Api",
+  fields: () => ({
+    <%=@content.join("\n\n")%>
+  })
+});

data/lib/canvas_api/templates/graphql_query.erb

@@ -0,0 +1,7 @@
+<%=@nickname%>: {
+  type: new GraphQLList(Post),
+  description: "<%=@description%>",
+  resolve: function(context, args) {
+    return canvasRequest(context, args, urls.<%=@nickname.upcase%>);
+  }
+}

data/lib/canvas_api/templates/graphql_types.erb

@@ -0,0 +1,100 @@
+import {
+  GraphQLBoolean,
+  GraphQLFloat,
+  GraphQLID,
+  GraphQLInt,
+  GraphQLList,
+  GraphQLNonNull,
+  GraphQLObjectType,
+  GraphQLSchema,
+  GraphQLString
+} from 'graphql';
+
+import {
+  connectionArgs,
+  connectionDefinitions,
+  connectionFromArray,
+  fromGlobalId,
+  globalIdField,
+  mutationWithClientMutationId,
+  nodeDefinitions,
+  connectionFromPromisedArray
+} from 'graphql-relay';
+
+import {
+  GraphQLLimitedString,
+  GraphQLDateTime
+} from 'graphql-custom-types';
+
+/**
+ * We get the node interface and field from the Relay library.
+ *
+ * The first method defines the way we resolve an ID to its object.
+ * The second defines the way we resolve an object to its GraphQL type.
+ */
+var {nodeInterface, nodeField} = nodeDefinitions(
+  (globalId) => {
+    var {type, id} = fromGlobalId(globalId);
+    if (type === 'User') {
+      return getUser(id);
+    } else if (type === 'Widget') {
+      return getWidget(id);
+    } else {
+      return null;
+    }
+  },
+  (obj) => {
+    if (obj instanceof User) {
+      return userType;
+    } else if (obj instanceof Widget)  {
+      return widgetType;
+    } else {
+      return null;
+    }
+  }
+);
+
+<%=@content.join("\n\n")%>
+
+const Query = new GraphQLObjectType({
+  name: 'Query',
+  description: 'Root query',
+  fields: () => ({
+    node: nodeField,
+    peopleRelay: {
+      type: PersonConnection,
+      description: 'Person connection test',
+      args: connectionArgs,
+      resolve (root, args) {
+        return connectionFromPromisedArray(Db.models.person.findAll(), args);
+      }
+    },
+    person: {
+       type: personType,
+       resolve (root, args) {
+         return Db.models.person.findOne({ where: args });
+       }
+     },
+    people: {
+       type: new GraphQLList(personType),
+       args: {
+         id: {
+           type: GraphQLInt
+         },
+         email: {
+           type: GraphQLString
+         }
+       },
+       resolve (root, args) {
+         return Db.models.person.findAll({ where: args });
+       }
+     }
+  })
+});
+
+const Schema = new GraphQLSchema({
+  query: Query,
+  //mutation: Mutuation
+});
+
+export default Schema;

data/lib/canvas_api/templates/js_url.erb

@@ -0,0 +1 @@
+  <%=@nickname.upcase%>: { uri: function(args){return <%=js_url_parts(@api_url).join(' + ')%>}, method: "<%=@method%>", parameters: <%=@parameters.to_json%> }

data/lib/canvas_api/templates/js_urls.erb

@@ -0,0 +1,3 @@
+module.exports = {
+  <%=@content.join(",\n  ")%>
+};

data/lib/canvas_api/templates/rb_url.erb

@@ -0,0 +1 @@
+    "<%=@nickname.upcase%>" => { uri: ->(<%=@args.map{|a| "#{a}:"}.join(', ')%>) { "<%=ruby_api_url(@api_url)%>" }, method: "<%=@method%>", parameters: <%=@parameters%> }

data/lib/canvas_api/templates/rb_urls.erb

@@ -0,0 +1,5 @@
+module LMS
+  CANVAS_URLs = {
+    <%=@content.join(",\n    ")%>
+  }
+end

data/lib/lms/canvas.rb

@@ -282,6 +282,7 @@ module LMS
     end
 
     def self.lms_url(type, params, payload = nil)
+      params = params.to_h
       endpoint = LMS::CANVAS_URLs[type]
       parameters = endpoint[:parameters]
 
@@ -311,7 +312,7 @@ module LMS
       uri_proc = endpoint[:uri]
       path_parameters = parameters.select { |p| p["paramType"] == "path" }.
         map { |p| p["name"].to_sym }
-      args = params.slice(*path_parameters).symbolize_keys
+      args = params.slice(*path_parameters)
       uri = args.blank? ? uri_proc.call : uri_proc.call(**args)
 
       # Handle scopes in the url. These API endpoints allow for additional path

data/lib/lms/version.rb

@@ -1,3 +1,3 @@
 module LMS
-  VERSION = "1.2.9".freeze
+  VERSION = "1.3.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lms-api
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.3.0
 platform: ruby
 authors:
 - Atomic Jolt
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,6 +107,24 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/canvas_api.rb
+- lib/canvas_api/builder.rb
+- lib/canvas_api/graphql_helpers.rb
+- lib/canvas_api/js_helpers.rb
+- lib/canvas_api/render.rb
+- lib/canvas_api/ruby_helpers.rb
+- lib/canvas_api/templates/constant.erb
+- lib/canvas_api/templates/constants.erb
+- lib/canvas_api/templates/graphql_model.erb
+- lib/canvas_api/templates/graphql_mutation.erb
+- lib/canvas_api/templates/graphql_mutations.erb
+- lib/canvas_api/templates/graphql_queries.erb
+- lib/canvas_api/templates/graphql_query.erb
+- lib/canvas_api/templates/graphql_types.erb
+- lib/canvas_api/templates/js_url.erb
+- lib/canvas_api/templates/js_urls.erb
+- lib/canvas_api/templates/rb_url.erb
+- lib/canvas_api/templates/rb_urls.erb
 - lib/lms/canvas.rb
 - lib/lms/canvas_urls.rb
 - lib/lms/helper_urls.rb
@@ -145,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Instructure Canvas API