Module: Framey::Api

Defined in:
lib/api.rb

Defined Under Namespace

Classes: BadRequest, Error, Forbidden, InternalServerError, NotFound

Class Method Summary collapse

Class Method Details

.delete_video(video_name) ⇒ Object

Use this method to delete a recording.

Example Usage:

Framey::Api.delete_video("c96323e0-54b1-012e-9d34-7c6d628c53d4")



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

def self.delete_video(video_name)
  res = self.make_request("delete","/api/videos/#{video_name}")
  return true
end

.get_video(video_name) ⇒ Object

Use this method to fetch updating information about a recording.

Example Usage:

Framey::Api.get_video("c96323e0-54b1-012e-9d34-7c6d628c53d4")



11
12
13
14
 
# File 'lib/api.rb', line 11

def self.get_video(video_name)
  res = self.make_request("get","/api/videos/#{video_name}")
  return Video.new(res["video"])
end

.make_request(method, url, params = {}) ⇒ Object 



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
 
# File 'lib/api.rb', line 25

def self.make_request(method,url,params={})
  timestamp, signature = self.sign
  
  params = params.merge({:time_stamp => timestamp, :signature => signature, :api_key => Framey.api_key})
  res = begin
    HTTParty.send(method,Framey::API_HOST + url,{:query => params}) 
  rescue SocketError => e
    nil
  end
  
  parsed_res = res ? res.parsed_response : nil
  
  if !res || parsed_res["success"] == false
    err = nil
    msg = parsed_res ? parsed_res["message"]  : "There was a problem connecting to framey. Please try again."
    
    case res.code
    when 400
      err = BadRequest.new(msg,res.headers)
    when 403
      err = Forbidden.new(msg,res.headers)
    when 404
      err = NotFound.new(msg,res.headers)
    when 500
      err = InternalServerError.new(msg,res.headers)
    else
      err = SocketError.new(msg)
    end
    
    raise err
  end
  
  parsed_res
end

.sign ⇒ Object 



60
61
62
63
64
 
# File 'lib/api.rb', line 60

def self.sign
  timestamp = (Time.now.utc + Framey::API_TIMEOUT * 60).to_i
  signature = Digest::MD5.hexdigest(Framey::SECRET + "&" + timestamp.to_s)
  return timestamp.to_s, signature
end