Class: DmCloud::Media

Inherits:
Object
  • Object
show all
Defined in:
lib/dm_cloud/media.rb

Class Method Summary collapse

Class Method Details

.create(url, assets_names = [], meta = {}) ⇒ Object

Creates a new media object. This method can either create an empty media object or also download a media with the url paramater and use it as the source to encode the ASSET_NAME listed in assets_names Params :

args:
  url: SCHEME://USER:PASSWORD@HOSTNAME/MY/PATH/FILENAME.EXTENSION (could be ftp or http)
  author: an author name
  title: a title for the film
  assets_names: (Array) – (optional) the list of ASSET_NAME you want to transcode,
    when you set this parameter you must also set the url parameter

Return :

media_id: return the media id of the object



18
19
20
21
22
23
24
25
26
 
# File 'lib/dm_cloud/media.rb', line 18

def self.create(url, assets_names = [], meta = {})
  call_type = "media.create"

  params = {
    :call =>  call_type,
    args: Builder::Media.create(url, assets_names, meta)
  }
  DmCloud.config[:auto_call] == true ? DmCloud::Request.execute(call_type, params) : {call: call_type, params: params}
end

.delete(media_id) ⇒ Object

Delete a media object with all its associated assets.

Parameters:

id (media ID) – (required) the id of the media object you want to delete.

Return :

Nothing

Raises:

  • (StandardError) 


34
35
36
37
38
39
40
41
42
43
 
# File 'lib/dm_cloud/media.rb', line 34

def self.delete(media_id)
  raise StandardError, "missing :media_id in params" unless media_id
  call_type = "media.delete"

  params = {
    :call =>  call_type,
    args: { id: media_id}
  }
  DmCloud.config[:auto_call] == true ? DmCloud::Request.execute(call_type, params) : {call: call_type, params: params}
end

.download_url(media_id, asset_name) ⇒ Object

Gets the real URL that points to the download link on DMCloud’s specific server



99
100
101
102
103
104
105
 
# File 'lib/dm_cloud/media.rb', line 99

def self.download_url(media_id, asset_name)
  download_url = self.url(media_id, asset_name)
  response = Net::HTTP.get_response(URI.parse(download_url))
  download_url = response.header["location"]

  download_url
end

.info(media_id, assets_names = ['source'], authToken = false, fields = {}) ⇒ Object

Gives information about a given media object.

Params :

media_id: (media ID) – (required) the id of the new media object.
fields (Array) – (required) the list of fields to retrieve.

Returns:

a multi-level structure containing about the media related to the requested fields.

Raises:

  • (StandardError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/dm_cloud/media.rb', line 52

def self.info(media_id, assets_names = ['source'], authToken = false, fields = {})
  raise StandardError, "missing :media_id in params" unless media_id
  call_type = "media.info"

  params = {
    :call =>  call_type,
    args: DmCloud::Builder::Media.info(media_id, assets_names, fields, authToken)
  }

  if authToken
    return DmCloud::Signing.identify(params)
  else
    DmCloud.config[:auto_call] == true ? DmCloud::Request.execute(call_type, params) : {call: call_type, params: params}
  end
end

.list(page = 1, per_page = 10, fields = {}) ⇒ Object

Returns a paginated list of media info structures. You must specify the fields you want to retrieve. The fields are described in the documentation of the method info.

Parameters:

options:
  fields (Array) – (optional default return all informations) the fields to retrieve
  page (Integer) – (optional) the page number, default: 1
  per_page (Integer) – (optional) the number of objet per page, default: 10
  Returns:
  an object with information for the pagination and the result of the query.



79
80
81
82
83
84
85
86
87
 
# File 'lib/dm_cloud/media.rb', line 79

def self.list(page = 1, per_page = 10, fields = {})
  call_type = "media.list"

  params = {
    :call =>  call_type,
    args: DmCloud::Builder::Media.list( page, per_page, fields)
  }
  DmCloud.config[:auto_call] == true ? DmCloud::Request.execute(call_type, params) : {call: call_type, params: params}
end

.url(media_id, asset_name) ⇒ Object

Gets a URL pointer to the actual file…

Raises:

  • (StandardError) 


90
91
92
93
94
95
96
 
# File 'lib/dm_cloud/media.rb', line 90

def self.url(media_id, asset_name)
  raise StandardError, "missing :media_id in params" unless media_id
  raise StandardError, "missing :asset_name in params" unless asset_name
  fields = { :assets => ["download_url"] }

  self.info(media_id, [asset_name], false, fields)["result"]["assets"][asset_name]["download_url"]
end