Class: Canvas::API

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ API

Returns a new instance of API.



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/canvas-api.rb', line 9

def initialize(args={}) 
  @host = args[:host] && args[:host].to_s
  @token = args[:token] && args[:token].to_s
  @client_id = args[:client_id] && args[:client_id].to_s
  @secret = args[:secret] && args[:secret].to_s
  raise "host required" unless @host
  raise "invalid host, protocol required" unless @host.match(/^http/)
  raise "invalid host" unless @host.match(/^https?:\/\/[^\/]+$/)
  raise "token or client_id required" if !@token && !@client_id
  raise "secret required for client_id configuration" if @client_id && !@secret
end

Instance Attribute Details

#client_id ⇒ Object

Returns the value of attribute client_id.



23
24
25
 
# File 'lib/canvas-api.rb', line 23

def client_id
  @client_id
end

#host ⇒ Object

Returns the value of attribute host.



21
22
23
 
# File 'lib/canvas-api.rb', line 21

def host
  @host
end

#token ⇒ Object

Returns the value of attribute token.



22
23
24
 
# File 'lib/canvas-api.rb', line 22

def token
  @token
end

Class Method Details

.encode_id(prefix, id) ⇒ Object 



33
34
35
36
 
# File 'lib/canvas-api.rb', line 33

def self.encode_id(prefix, id)
  return nil unless prefix && id
  "hex:#{prefix}:" + id.to_s.unpack("H*")[0]
end

Instance Method Details

#clean_params(params, prefix = nil) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/canvas-api.rb', line 172

def clean_params(params, prefix=nil)
  params ||= {}
  return params if params.is_a?(Array)
  return nil unless params.is_a?(Hash)
  params.delete(:query_parameters)
  res = PairArray.new
  params.each do |key, val|
    if val.is_a?(Array)
      raise "No support for nested array parameters currently"
    elsif val.is_a?(Hash)
      res.concat clean_params(val, prefix ? (prefix + "[" + key.to_s + "]") : key.to_s)
    else
      if prefix
        res << [prefix + "[" + key.to_s + "]", val.to_s]
      else
        res << [key.to_s, val.to_s]
      end
    end
  end
  res
end

#delete(endpoint, params = {}) ⇒ Object 



144
145
146
147
148
149
 
# File 'lib/canvas-api.rb', line 144

def delete(endpoint, params={})
  generate_uri(endpoint, params['query_parameters'] || params[:query_parameters])
  request = Typhoeus::Request.new(@uri.to_s, method: :delete)
  request.options[:body] = clean_params(params)
  retrieve_response(request)
end

#encode_id(prefix, id) ⇒ Object 



38
39
40
 
# File 'lib/canvas-api.rb', line 38

def encode_id(prefix, id)
  Canvas::API.encode_id(prefix, id)
end

#generate_uri(endpoint, params = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/canvas-api.rb', line 83

def generate_uri(endpoint, params=nil)
  validate_call(endpoint)
  unless @token == "ignore"
    endpoint += (endpoint.match(/\?/) ? "&" : "?") + "access_token=" + @token
    endpoint += "&as_user_id=" + @as_user_id.to_s if @as_user_id
  end
  (params || {}).each do |key, value|
    if value.is_a?(Array)
      key = key + "[]" unless key.match(/\[\]/)
      value.each do |val|
        endpoint += (endpoint.match(/\?/) ? "&" : "?") + "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
      end
    else
      endpoint += (endpoint.match(/\?/) ? "&" : "?") + "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
    end
  end
  @uri = URI.parse(@host + endpoint)
  @http = Net::HTTP.new(@uri.host, @uri.port)
  @http.use_ssl = @uri.scheme == 'https'
  @uri
end

#get(endpoint, params = nil) ⇒ Object 



138
139
140
141
142
 
# File 'lib/canvas-api.rb', line 138

def get(endpoint, params=nil)
  generate_uri(endpoint, params)
  request = get_request(endpoint)
  retrieve_response(request)
end

#get_request(endpoint) ⇒ Object

Semi-hack so I can write better specs



134
135
136
 
# File 'lib/canvas-api.rb', line 134

def get_request(endpoint)
  Typhoeus::Request.new(@uri.to_s, method: :get)
end

#login_url(callback_url) ⇒ Object 



52
53
54
 
# File 'lib/canvas-api.rb', line 52

def (callback_url)
  oauth_url(callback_url, "/auth/userinfo")
end

#logout ⇒ Object 



70
71
72
 
# File 'lib/canvas-api.rb', line 70

def logout
  !!delete("/login/oauth2/token")['logged_out']
end

#masquerade_as(user_id) ⇒ Object 



25
26
27
 
# File 'lib/canvas-api.rb', line 25

def masquerade_as(user_id)
  @as_user_id = user_id && user_id.to_s
end

#multipart_upload(url, upload_params, params, file) ⇒ Object

Raises:



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/canvas-api.rb', line 218

def multipart_upload(url, upload_params, params, file)
  req = Typhoeus::Request.new(url, method: :post)
  upload_params.each do |k, v|
    upload_params[k] = v.to_s if v
  end
  upload_params['file'] = file
  req.options[:body] = upload_params
  @multi_request = req
  res = req.run
  raise ApiError.new("Unexpected error: #{res.body}") if !res.headers['Location']
  res.headers['Location']
end

#oauth_url(callback_url, scopes = "") ⇒ Object 



42
43
44
45
46
47
48
49
50
 
# File 'lib/canvas-api.rb', line 42

def oauth_url(callback_url, scopes="")
  raise "client_id required for oauth flow" unless @client_id
  raise "secret required for oauth flow" unless @secret
  raise "callback_url required" unless callback_url
  raise "invalid callback_url" unless (URI.parse(callback_url) rescue nil)
  scopes ||= ""
  scopes = scopes.length > 0 ? "&scopes=#{CGI.escape(scopes)}" : ""
  "#{@host}/login/oauth2/auth?client_id=#{@client_id}&response_type=code&redirect_uri=#{CGI.escape(callback_url)}#{scopes}"
end

#post(endpoint, params = {}) ⇒ Object 



158
159
160
161
162
163
 
# File 'lib/canvas-api.rb', line 158

def post(endpoint, params={})
  generate_uri(endpoint, params['query_parameters'] || params[:query_parameters])
  request = Typhoeus::Request.new(@uri.to_s, method: :post)
  request.options[:body] = params #clean_params(params)
  retrieve_response(request)
end

#post_multi(endpoint, params = {}) ⇒ Object 



165
166
167
168
169
170
 
# File 'lib/canvas-api.rb', line 165

def post_multi(endpoint, params={})
  generate_uri(endpoint, params['query_parameters'] || params[:query_parameters])
  request = Typhoeus::Request.new(@uri.to_s, method: :post)
  request.options[:body] = clean_params(params)
  retrieve_response(request)
end

#put(endpoint, params = {}) ⇒ Object 



151
152
153
154
155
156
 
# File 'lib/canvas-api.rb', line 151

def put(endpoint, params={})
  generate_uri(endpoint, params['query_parameters'] || params[:query_parameters])
  request = Typhoeus::Request.new(@uri.to_s, method: :put)
  request.options[:body] = clean_params(params)
  retrieve_response(request)
end

#retrieve_access_token(code, callback_url) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/canvas-api.rb', line 56

def retrieve_access_token(code, callback_url)
  raise "client_id required for oauth flow" unless @client_id
  raise "secret required for oauth flow" unless @secret
  raise "code required" unless code
  raise "callback_url required" unless callback_url
  raise "invalid callback_url" unless (URI.parse(callback_url) rescue nil)
  @token = "ignore"
  res = post("/login/oauth2/token", :client_id => @client_id, :redirect_uri => callback_url, :client_secret => @secret, :code => code)
  if res['access_token']
    @token = res['access_token']
  end
  res
end

#retrieve_response(request) ⇒ Object

Raises:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/canvas-api.rb', line 105

def retrieve_response(request)
  request.options[:headers]['User-Agent'] = "CanvasAPI Ruby"
  begin
    response = request.run
    raise ApiError.new("request timed out") if response.timed_out?
  rescue Timeout::Error => e
    raise ApiError.new("request timed out")
  end
  raise ApiError.new("unexpected redirect to #{response.headers['Location']}") if response.code.to_s.match(/3\d\d/)
  json = JSON.parse(response.body) rescue {'error' => 'invalid JSON'}
  if !json.is_a?(Array)
    raise ApiError.new(json['error']) if json['error']
    raise ApiError.new(json['errors']) if json['errors']
    if !response.code.to_s.match(/2\d\d/)
      json['message'] ||= "unexpected error"
      json['status'] ||= response.code.to_s
      raise ApiError.new("#{json['status']} #{json['message']}") 
    end
  else
    json = ResultSet.new(self, json)
    if response.headers['Link']
      json.link = response.headers['Link']
      json.next_endpoint = response.headers['Link'].split(/,/).detect{|rel| rel.match(/rel="next"/) }.split(/;/).first.strip[1..-2].sub(/https?:\/\/[^\/]+/, '') rescue nil
    end
  end
  json
end

#stop_masquerading ⇒ Object 



29
30
31
 
# File 'lib/canvas-api.rb', line 29

def stop_masquerading
  @as_user_id = nil
end

#upload_file_from_local(endpoint, file, opts = {}) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/canvas-api.rb', line 194

def upload_file_from_local(endpoint, file, opts={})
  raise "Missing File object" unless file.is_a?(File)
  params = {
    :size => file.size,
    :name => opts[:name] || opts['name'] || File.basename(file.path),
    :content_type => opts[:content_type] || opts['content_type'] || "application/octet-stream",
    :on_duplicate => opts[:on_duplicate] || opts['on_duplicate']
  }
  if opts[:parent_folder_id] || opts['parent_folder_id']
    params[:parent_folder_id] = opts[:parent_folder_id] || opts['parent_folder_id']
  elsif opts[:parent_folder_path] || opts['parent_folder_path']
    params[:parent_folder_path] = opts[:parent_folder_path] || opts['parent_folder_path']
  end
  
  res = post(endpoint, params)
  if !res['upload_url']
    raise ApiError.new("Unexpected error: #{res['message'] || 'no upload URL returned'}")
  end
  status_url = multipart_upload(res['upload_url'], res['upload_params'], params, file)
  status_path = "/" + status_url.split(/\//, 4)[-1]
  res = get(status_path)
  res
end

#upload_file_from_url(endpoint, opts) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/canvas-api.rb', line 231

def upload_file_from_url(endpoint, opts)
  asynch = opts.delete('asynch') || opts.delete(:asynch)
  ['url', 'name', 'size'].each do |k|
    raise "Missing value: #{k}" unless opts[k.to_s] || opts[k.to_sym]
  end

  res = post(endpoint, opts)
  status_url = res['status_url']
  if !status_url
    raise ApiError.new("Unexpected error: #{res['message'] || 'no status URL returned'}")
  end
  status_path = "/" + status_url.split(/\//, 4)[-1]
  if asynch
    return status_path
  else
    attachment = nil
    while !attachment
      res = get(status_path)
      if res['upload_status'] == 'errored'
        raise ApiError.new(res['message'])
      elsif !res['upload_status']
        raise ApiError.new("Unexpected response")
      end
      status_path = res['status_path'] if res['status_path']
      attachment = res['attachment']
      sleep (defined?(SLEEP_TIME) ? SLEEP_TIME : 5) unless attachment
    end
    attachment
  end
end

#validate_call(endpoint) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/canvas-api.rb', line 74

def validate_call(endpoint)
  raise "token required for api calls" unless @token
  raise "missing host" unless @host
  raise "missing endpoint" unless endpoint
  raise "missing leading slash on endpoint" unless endpoint.match(/^\//)
  raise "invalid endpoint" unless endpoint.match(/^\/api\/v\d+\//) unless @token == 'ignore'
  raise "invalid endpoint" unless (URI.parse(endpoint) rescue nil)
end