Class: LMS::Canvas

Inherits:
Object
  • Object
show all
Defined in:
lib/lms/canvas.rb

Defined Under Namespace

Classes: CanvasException, InvalidAPIMethodRequestException, InvalidAPIRequestException, InvalidAPIRequestFailedException, InvalidRefreshOptionsException, MissingRequiredParameterException, RefreshTokenFailedException, RefreshTokenRequired

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lms_uri, authentication, refresh_token_options = nil) ⇒ Canvas

The authentication parameter must be either a string (indicating a token), or an object that responds to:

- #id
- #token
- #update(hash) -- which should update #token with hash[:token]:noh


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/lms/canvas.rb', line 52

def initialize(lms_uri, authentication, refresh_token_options = nil)
  @per_page = 100
  @lms_uri = lms_uri
  @refresh_token_options = refresh_token_options
  @authentication = if authentication.is_a?(String)
                      OpenStruct.new(token: authentication)
                    else
                      authentication
                    end

  if refresh_token_options.present?
    required_options = [:client_id, :client_secret, :redirect_uri, :refresh_token]
    extra_options = @refresh_token_options.keys - required_options
    unless extra_options.empty?
      raise InvalidRefreshOptionsException,
            "Invalid option(s) provided: #{extra_options.join(', ')}"
    end
    missing_options = required_options - @refresh_token_options.keys
    unless missing_options.empty?
      raise InvalidRefreshOptionsException,
            "Missing required option(s): #{missing_options.join(', ')}"
    end
  end
end

Class Attribute Details

.auth_state_model ⇒ Object

Returns the value of attribute auth_state_model.



20
21
22
 
# File 'lib/lms/canvas.rb', line 20

def auth_state_model
  @auth_state_model
end

Instance Attribute Details

#authentication ⇒ Object (readonly)

Returns the value of attribute authentication.



45
46
47
 
# File 'lib/lms/canvas.rb', line 45

def authentication
  @authentication
end

Class Method Details

.ignore_required(type) ⇒ Object

Ignore required params for specific calls. For example, the external tool calls have required params "name, privacy_level, consumer_key, shared_secret". However, those params are not required if the call specifies config_type: "by_xml".



248
249
250
251
252
253
 
# File 'lib/lms/canvas.rb', line 248

def self.ignore_required(type)
  [
    "CREATE_EXTERNAL_TOOL_COURSES",
    "CREATE_EXTERNAL_TOOL_ACCOUNTS"
  ].include?(type)
end

.lms_url(type, params, payload = nil) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/lms/canvas.rb', line 255

def self.lms_url(type, params, payload = nil)
  endpoint = LMS::CANVAS_URLs[type]
  parameters = endpoint[:parameters]

  # Make sure all required parameters are present
  missing = []
  if !ignore_required(type)
    parameters.select { |p| p["required"] }.map { |p| p["name"] }.each do |p|
      if p.include?("[") && p.include?("]")
        parts = p.split("[")
        parent = parts[0].to_sym
        child = parts[1].gsub("]", "").to_sym
        missing << p unless (params[parent].present? && params[parent][child].present?) ||
            (payload.present? && payload[parent].present? && payload[parent][child].present?)
      else
        missing << p unless params[p.to_sym].present? ||
            (payload.present? && !payload.is_a?(String) && payload[p.to_sym].present?)
      end
    end
  end

  if !missing.empty?
    raise LMS::Canvas::MissingRequiredParameterException,
          "Missing required parameter(s): #{missing.join(', ')}"
  end

  # Generate the uri. Only allow path parameters
  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
  uri = args.blank? ? uri_proc.call : uri_proc.call(**args)

  # Generate the query string
  query_parameters = parameters.select { |p| p["paramType"] == "query" }.
    map { |p| p["name"].to_sym }

  # always allow paging parameters
  query_parameters << :per_page
  query_parameters << :page

  allowed_params = params.slice(*query_parameters)

  if allowed_params.present?
    "#{uri}?#{allowed_params.to_query}"
  else
    uri
  end
end

.on_auth(callback = nil, &block) ⇒ Object

callback must accept a single parameter (the API object itself) and return the new authentication object.



30
31
32
 
# File 'lib/lms/canvas.rb', line 30

def self.on_auth(callback = nil, &block)
  @@on_auth = callback || block
end

Instance Method Details

#all_accounts ⇒ Object

Get all accounts including sub accounts



310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/lms/canvas.rb', line 310

def all_accounts
  all = []
  proxy("LIST_ACCOUNTS", {}, nil, true).each do ||
    all << 
    sub_accounts = proxy("GET_SUB_ACCOUNTS_OF_ACCOUNT",
                         { account_id: ["id"] },
                         nil,
                         true)
    all = all.concat(sub_accounts)
  end
  all
end

#api_delete_request(api_url, additional_headers = {}) ⇒ Object 



131
132
133
134
135
136
 
# File 'lib/lms/canvas.rb', line 131

def api_delete_request(api_url, additional_headers = {})
  url = full_url(api_url)
  refreshably do
    HTTParty.delete(url, headers: headers(additional_headers))
  end
end

#api_error(result) ⇒ Object 



189
190
191
192
193
 
# File 'lib/lms/canvas.rb', line 189

def api_error(result)
  error = "Status: #{result.headers['status']} \n"
  error << "Http Response: #{result.response.code} \n"
  error << "Error: #{result['errors'] || result.response.message} \n"
end

#api_get_all_request(api_url, additional_headers = {}) ⇒ Object 



138
139
140
141
142
143
144
 
# File 'lib/lms/canvas.rb', line 138

def api_get_all_request(api_url, additional_headers = {})
  [].tap do |results|
    api_get_blocks_request(api_url, additional_headers) do |result|
      results.concat(result)
    end
  end
end

#api_get_blocks_request(api_url, additional_headers = {}) ⇒ Object 



146
147
148
149
150
151
152
153
154
 
# File 'lib/lms/canvas.rb', line 146

def api_get_blocks_request(api_url, additional_headers = {})
  connector = api_url.include?("?") ? "&" : "?"
  next_url = "#{api_url}#{connector}per_page=#{@per_page}"
  while next_url
    result = api_get_request(next_url, additional_headers)
    yield result
    next_url = get_next_url(result.headers["link"])
  end
end

#api_get_request(api_url, additional_headers = {}) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/lms/canvas.rb', line 124

def api_get_request(api_url, additional_headers = {})
  url = full_url(api_url)
  refreshably do
    HTTParty.get(url, headers: headers(additional_headers))
  end
end

#api_post_request(api_url, payload, additional_headers = {}) ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/lms/canvas.rb', line 117

def api_post_request(api_url, payload, additional_headers = {})
  url = full_url(api_url)
  refreshably do
    HTTParty.post(url, headers: headers(additional_headers), body: payload)
  end
end

#api_put_request(api_url, payload, additional_headers = {}) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/lms/canvas.rb', line 110

def api_put_request(api_url, payload, additional_headers = {})
  url = full_url(api_url)
  refreshably do
    HTTParty.put(url, headers: headers(additional_headers), body: payload)
  end
end

#auth_state_model ⇒ Object

instance accessor, for convenience



24
25
26
 
# File 'lib/lms/canvas.rb', line 24

def auth_state_model
  self.class.auth_state_model
end

#check_result(result) ⇒ Object

Raises:



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/lms/canvas.rb', line 177

def check_result(result)
  code = result.response.code.to_i

  return result if [200, 201].include?(code)

  if code == 401 && result.headers["www-authenticate"] == 'Bearer realm="canvas-lms"'
    raise LMS::Canvas::RefreshTokenRequired
  end

  raise LMS::Canvas::InvalidAPIRequestException, api_error(result)
end

#full_url(api_url, use_api_prefix = true) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/lms/canvas.rb', line 100

def full_url(api_url, use_api_prefix = true)
  if api_url[0...4] == "http"
    api_url
  elsif use_api_prefix
    "#{@lms_uri}/api/v1/#{api_url}"
  else
    "#{@lms_uri}/#{api_url}"
  end
end

#get_next_url(link) ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/lms/canvas.rb', line 195

def get_next_url(link)
  return nil if link.blank?
  if url = link.split(",").detect { |l| l.split(";")[1].strip == 'rel="next"' }
    url.split(";")[0].gsub(/[\<\>\s]/, "")
  end
end

#headers(additional_headers = {}) ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/lms/canvas.rb', line 93

def headers(additional_headers = {})
  {
    "Authorization" => "Bearer #{@authentication.token}",
    "User-Agent" => "LMS-API Ruby"
  }.merge(additional_headers)
end

#lock ⇒ Object

Obtains a lock (via the API.auth_state_model interface) and yields an authentication object corresponding to self.authentication.id. The object is returned when the block finishes.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/lms/canvas.rb', line 81

def lock
  auth_state_model.transaction do
    record = auth_state_model.
      lock(true).
      find(authentication.id)

    yield record

    record
  end
end

#proxy(type, params, payload = nil, get_all = false) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/lms/canvas.rb', line 202

def proxy(type, params, payload = nil, get_all = false)
  additional_headers = {
    "Content-Type" => "application/json"
  }
  payload = {} if payload.blank?
  payload_json = payload.is_a?(String) ? payload : payload.to_json
  parsed_payload = payload.is_a?(String) ? JSON.parse(payload) : payload
  parsed_payload = parsed_payload.with_indifferent_access

  method = LMS::CANVAS_URLs[type][:method]
  url = LMS::Canvas.lms_url(type, params, parsed_payload)

  case method
  when "GET"
    if block_given?
      api_get_blocks_request(url, additional_headers) do |result|
        yield result
      end
    elsif get_all
      api_get_all_request(url, additional_headers)
    else
      api_get_request(url, additional_headers)
    end
  when "POST"
    api_post_request(url, payload_json, additional_headers)
  when "PUT"
    api_put_request(url, payload_json, additional_headers)
  when "DELETE"
    api_delete_request(url, additional_headers)
  else
    raise LMS::Canvas::InvalidAPIMethodRequestException "Invalid method type: #{method}"
  end

rescue LMS::Canvas::InvalidAPIRequestException => ex
  error = ex.to_s
  error << "API Request Url: #{url} \n"
  error << "API Request Params: #{params} \n"
  error << "API Request Payload: #{payload} \n"
  new_ex = LMS::Canvas::InvalidAPIRequestFailedException.new(error)
  new_ex.set_backtrace(ex.backtrace)
  raise new_ex
end

#refresh_token ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/lms/canvas.rb', line 165

def refresh_token
  payload = {
    grant_type: "refresh_token"
  }.merge(@refresh_token_options)
  url = full_url("login/oauth2/token", false)
  result = HTTParty.post(url, headers: headers, body: payload)
  unless [200, 201].include?(result.response.code.to_i)
    raise LMS::Canvas::RefreshTokenFailedException, api_error(result)
  end
  result["access_token"]
end

#refreshably ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/lms/canvas.rb', line 156

def refreshably
  result = yield
  check_result(result)
rescue LMS::Canvas::RefreshTokenRequired => ex
  raise ex if @refresh_token_options.blank?
  @authentication = @@on_auth.call(self)
  retry
end