Class: CanvasApi::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/canvas_api/builder.rb

Class Method Summary collapse

Class Method Details

.build(project_root, client_app_path, server_app_path, elixir_app_path) ⇒ Object

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



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/canvas_api/builder.rb', line 14

def self.build(project_root, client_app_path, server_app_path, elixir_app_path)
  endpoint = "https://canvas.instructure.com/doc/api"
  directory = HTTParty.get("#{endpoint}/api-docs.json")

  lms_urls_rb = []
  lms_urls_js = []
  lms_urls_ex = []
  course_ids_required_rb = []
  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
        lms_urls_ex << CanvasApi::Render.new("./templates/ex_url.erb", api, resource, resource_api, operation, parameters, nil, nil).render

        if parameters.detect{ |param| param["name"] == "course_id" && param["paramType"] == "path" }
          course_ids_required_rb << CanvasApi::Render.new("./templates/course_id_required.erb", api, resource, resource_api, operation, parameters, nil, nil).render
        end

        if operation["method"].casecmp("GET")
          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")
  CanvasApi::Render.new("./templates/ex_urls.erb", nil, nil, nil, nil, nil, lms_urls_ex, nil).save("#{elixir_app_path}/lib/canvas/actions.ex")
  CanvasApi::Render.new("./templates/course_ids_required.erb", nil, nil, nil, nil, nil, course_ids_required_rb, nil).save("#{project_root}/lib/lms/course_ids_required.rb")

  # 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