lms-api 1.0.0

data/lib/lms/version.rb

@@ -0,0 +1,3 @@
+module LMS
+  VERSION = "1.0.0"
+end

data/lib/lms.rb

@@ -0,0 +1,4 @@
+module LMS
+end
+
+require 'lms/api'

data/lib/tasks/lms_api/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%> = { type: "<%=@nickname.upcase%>", method: "<%=@method.downcase%>", key: "<%=reducer_key(@nickname, @args)%>", required: <%=js_args(@args)%> };

data/lib/tasks/lms_api/constants.erb

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

data/lib/tasks/lms_api/graphql_model.erb

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

data/lib/tasks/lms_api/graphql_mutations.erb

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

data/lib/tasks/lms_api/graphql_queries.erb

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

data/lib/tasks/lms_api/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/tasks/lms_api/graphql_types.erb

@@ -0,0 +1,64 @@
+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 Schema = new GraphQLSchema({
+  query: Query,
+  mutation: Mutuation
+});
+
+export default Schema;

data/lib/tasks/lms_api/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/tasks/lms_api/js_urls.erb

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

data/lib/tasks/lms_api/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/tasks/lms_api/rb_urls.erb

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

data/lib/tasks/lms_api.rake

@@ -0,0 +1,265 @@
+namespace :lms do
+
+  module GraphQLHelpers
+
+    def graphQLType(name, property, resource_name)
+      if property["$ref"]
+        "#{property["$ref"]}, resolve: function(model){ return model.#{name}; }"
+      else
+        type = property['type']
+        case type
+        when "integer", "string", "boolean", "datetime", "number"
+          graphQLPrimitive(type, property['format'])
+        when "array"
+          begin
+            if property["items"]["$ref"]
+              type = property["items"]["$ref"]
+            else
+              type = graphQLPrimitive(property["items"]["type"], property["items"]["format"])
+            end
+          rescue => ex
+            type = "GraphQLString"
+          end
+          "new GraphQLList(#{type})"
+        when "object"
+          # TODO handle objects
+          nil
+        else
+          "unknown - #{property}"
+        end
+      end
+    end
+
+    def graphQLResolve(name, property, resource_name)
+      if property["$ref"]
+        "function(model){ return model.#{name}; }"
+      elsif property['type'] == "array" && property["items"] && property["items"]["$ref"]
+        "function(model){ return model.#{name}; }"
+      end
+    end
+
+    def graphQLPrimitive(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"
+      end
+    end
+
+    def 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 << "#{safeJs(property["description"])}. Example: #{safeJs(property["example"])}".gsub("..", "").gsub("\n", " ")
+          end
+
+          if type = graphQLType(name, property, resource_name)
+            resolve = graphQLResolve(name, property, resource_name)
+            resolve = "resolve: #{resolve}, " if resolve.present?
+            "#{name}: { type: #{type}, #{resolve}description: \"#{description}\" }"
+          end
+
+        end
+
+      end.compact
+    end
+
+    def safeJs(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
+
+  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
+          %Q{"#{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.length > 0
+          "\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
+
+  module RubyHelpers
+
+    def ruby_api_url(api_url)
+      api_url.gsub("{", "#\{")
+    end
+
+  end
+
+  class Render
+    include GraphQLHelpers
+    include JsHelpers
+    include 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
+
+  class LMSApiBuilder
+
+    def self.build
+      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 << Render.new("./lms_api/constant.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            lms_urls_rb << Render.new("./lms_api/rb_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            lms_urls_js << Render.new("./lms_api/js_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            if "GET" == operation["method"].upcase
+              queries << Render.new("./lms_api/graphql_query.erb", api, resource, resource_api, operation, parameters, nil, nil).render
+            else
+              mutations << Render.new("./lms_api/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 << Render.new("./lms_api/graphql_model.erb", api, resource, nil, nil, nil, nil, model).render
+          end
+        end
+        # Generate one file of constants for every LMS API
+        constants_renderer = Render.new("./lms_api/constants.erb", api, resource, nil, nil, nil, constants, nil)
+        constants_renderer.save("#{Rails.root}/../atomic-client/client/js/libs/lms/constants/#{constants_renderer.name}.js")
+      end
+
+      Render.new("./lms_api/rb_urls.erb", nil, nil, nil, nil, nil, lms_urls_rb, nil).save("#{Rails.root}/lib/lms/urls.rb")
+      Render.new("./lms_api/js_urls.erb", nil, nil, nil, nil, nil, lms_urls_js, nil).save("#{Rails.root}/../atomic-lti/apps/lib/lms/urls.js")
+
+      Render.new("./lms_api/graphql_types.erb", nil, nil, nil, nil, nil, models.compact, nil).save("#{Rails.root}/../atomic-lti/apps/lib/lms/graphql_types.js")
+      Render.new("./lms_api/graphql_queries.erb", nil, nil, nil, nil, nil, queries, nil).save("#{Rails.root}/../atomic-lti/apps/lib/lms/graphql_queries.js")
+      Render.new("./lms_api/graphql_mutations.erb", nil, nil, nil, nil, nil, mutations, nil).save("#{Rails.root}/../atomic-lti/apps/lib/lms/graphql_mutations.js")
+    end
+
+  end
+
+  desc "Scrape the LMS api"
+  task :api => [:environment] do
+    LMSApiBuilder.build
+  end
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: lms-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for LMS API
+email:
+- jamis@jamisbuck.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/lms.rb
+- lib/lms/api.rb
+- lib/lms/urls.rb
+- lib/lms/version.rb
+- lib/tasks/lms_api.rake
+- lib/tasks/lms_api/constant.erb
+- lib/tasks/lms_api/constants.erb
+- lib/tasks/lms_api/graphql_model.erb
+- lib/tasks/lms_api/graphql_mutation.erb
+- lib/tasks/lms_api/graphql_mutations.erb
+- lib/tasks/lms_api/graphql_queries.erb
+- lib/tasks/lms_api/graphql_query.erb
+- lib/tasks/lms_api/graphql_types.erb
+- lib/tasks/lms_api/js_url.erb
+- lib/tasks/lms_api/js_urls.erb
+- lib/tasks/lms_api/rb_url.erb
+- lib/tasks/lms_api/rb_urls.erb
+homepage: https://github.com/atomicjolt/lms_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wrapper for LMS API
+test_files: []