cwickham / cnvs Goto Github PK

• Constructors for common objects
  E.g. assignment(name = "Homework 1", points_possible = 10) generates list of right form for passing to POST /api/v1/courses/:course_id/assignments with class cnvs_assignment.
  • Allows for argument checking. Match Canvas docs for required vs. optional.
  • Allows for certain responses to be returned as these objects, e.g. GET /api/v1/courses/:course_id/assignments returns lists of cnvs_assignment objects
  • Custom print methods can include URL to visit the resource on Canvas.
  • Accessor functions, e.g. id() might make it easy to feed output from one query as endpoint parameter in another, e.g.

    disc <- cnvs("POST /api/v1/courses/:course_id/discussion_topics",
      course_id = 101991,
      title = "Q&A"
    )
    entry <- cnvs("POST /api/v1/courses/:course_id/discussion_topics/:topic_id/entries",
      course_id = 101991,
      topic_id = id(disc),
      message = "I have a question"
    )

• Endpoint Shortcut functions
  E.g. create_assignment(), shortcut for cnvs("POST /api/v1/courses/:course_id/assignments")
  I'm not sure how I feel about this, requires implementing function for every (?) endpoint?

Should follow https://canvas.instructure.com/doc/api/file.file_uploads.html

To facilitate copy and paste usage, endpoints should need to be specified with /api/url so can copy-and-paste from canvas docs which specify endpoints like:

GET /api/v1/courses/:course_id/modules 

Instead treat domain more like token, you can't do anything without setting one explicitly: either as an argument or with an environment variable.

E.g. rather than having something like:

course_id <- 199291

at the top of each script (which is a pain when reusing a course in a new term), look for an environment variable CANVAS_COURSE_ID. This could be set on a project level with usethis::edit_r_environ("project").

These still have gh documentation

export(cnvs)
export(cnvs_token)
export(cnvs_whoami)
export(gh_first)
export(gh_last)
export(gh_next)
export(gh_prev)

Might be nice to have a way to handle multiple domain-token pairs for situations where you use two different canvas sites, e.g.: https://canvas.instructure.com/ and https://oregonstate.instructure.com/