Class: Cielo24::Actions

Inherits:
Object
  • Object
show all
Includes:
Cielo24, Errno, Hashie
Defined in:
lib/cielo24/actions.rb

Constant Summary collapse

API_VERSION = 
1
LOGIN_PATH = 
"/api/account/login"
LOGOUT_PATH = 
"/api/account/logout"
UPDATE_PASSWORD_PATH = 
"/api/account/update_password"
GENERATE_API_KEY_PATH = 
"/api/account/generate_api_key"
REMOVE_API_KEY_PATH = 
"/api/account/remove_api_key"
CREATE_JOB_PATH = 
"/api/job/new"
AUTHORIZE_JOB_PATH = 
"/api/job/authorize"
DELETE_JOB_PATH = 
"/api/job/del"
GET_JOB_INFO_PATH = 
"/api/job/info"
GET_JOB_LIST_PATH = 
"/api/job/list"
ADD_MEDIA_TO_JOB_PATH = 
"/api/job/add_media"
ADD_EMBEDDED_MEDIA_TO_JOB_PATH = 
"/api/job/add_media_url"
GET_MEDIA_PATH = 
"/api/job/media"
PERFORM_TRANSCRIPTION = 
"/api/job/perform_transcription"
GET_TRANSCRIPTION_PATH = 
"/api/job/get_transcript"
GET_CAPTION_PATH = 
"/api/job/get_caption"
GET_ELEMENT_LIST_PATH = 
"/api/job/get_elementlist"
GET_LIST_OF_ELEMENT_LISTS_PATH = 
"/api/job/list_elementlists"

Constants included from Cielo24

VERSION

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_url = "https://api.cielo24.com") ⇒ Actions

Returns a new instance of Actions.



35
36
37
 
# File 'lib/cielo24/actions.rb', line 35

def initialize(base_url="https://api.cielo24.com")
  @base_url = base_url
end

Instance Attribute Details

#base_url ⇒ Object

Returns the value of attribute base_url.



12
13
14
 
# File 'lib/cielo24/actions.rb', line 12

def base_url
  @base_url
end

Instance Method Details

#add_media_to_job_embedded(api_token, job_id, media_url) ⇒ Object 



148
149
150
 
# File 'lib/cielo24/actions.rb', line 148

def add_media_to_job_embedded(api_token, job_id, media_url)
  return send_media_url(api_token, job_id, media_url, ADD_EMBEDDED_MEDIA_TO_JOB_PATH)
end

#add_media_to_job_file(api_token, job_id, media_file) ⇒ Object 



135
136
137
138
139
140
141
142
 
# File 'lib/cielo24/actions.rb', line 135

def add_media_to_job_file(api_token, job_id, media_file)
  assert_argument(media_file, "Media File")
  query_hash = init_job_req_dict(api_token, job_id)
  file_size = File.size(media_file.path)

  json = WebUtils.get_json(@base_url + ADD_MEDIA_TO_JOB_PATH, 'POST', nil, query_hash, {'Content-Type' => 'video/mp4', 'Content-Length' => file_size}, media_file)
  return json["TaskId"]
end

#add_media_to_job_url(api_token, job_id, media_url) ⇒ Object 



144
145
146
 
# File 'lib/cielo24/actions.rb', line 144

def add_media_to_job_url(api_token, job_id, media_url)
  return send_media_url(api_token, job_id, media_url, ADD_MEDIA_TO_JOB_PATH)
end

#authorize_job(api_token, job_id) ⇒ Object 



108
109
110
111
112
 
# File 'lib/cielo24/actions.rb', line 108

def authorize_job(api_token, job_id)
  query_hash = init_job_req_dict(api_token, job_id)
  # Nothing returned
  WebUtils.http_request(@base_url + AUTHORIZE_JOB_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
end

#create_job(api_token, job_name = nil, language = "en") ⇒ Object

JOB CONTROL ###



98
99
100
101
102
103
104
105
106
 
# File 'lib/cielo24/actions.rb', line 98

def create_job(api_token, job_name=nil, language="en")
  query_hash = init_access_req_dict(api_token)
  query_hash[:job_name] = job_name if !(job_name.nil?)
  query_hash[:language] = language

  json = WebUtils.get_json(@base_url + CREATE_JOB_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  # Return a hash with JobId and TaskId
  return Mash.new(json)
end

#delete_job(api_token, job_id) ⇒ Object 



114
115
116
117
118
119
 
# File 'lib/cielo24/actions.rb', line 114

def delete_job(api_token, job_id)
  query_hash = init_job_req_dict(api_token, job_id)

  json = WebUtils.get_json(@base_url + DELETE_JOB_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return json["TaskId"]
end

#generate_api_key(api_token, username, force_new = false) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cielo24/actions.rb', line 77

def generate_api_key(api_token, username, force_new=false)
  assert_argument(username, "Username")
  assert_argument(api_token, "API Token")
  query_hash = init_access_req_dict(api_token)
  query_hash[:account_id] = username
  query_hash[:force_new] = force_new

  json = WebUtils.get_json(@base_url + GENERATE_API_KEY_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return json["ApiKey"]
end

#get_caption(api_token, job_id, caption_format, caption_options = nil) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cielo24/actions.rb', line 197

def get_caption(api_token, job_id, caption_format, caption_options=nil)
  query_hash = init_job_req_dict(api_token, job_id)
  query_hash[:caption_format] = caption_format
  query_hash.merge!(caption_options.get_hash) if !(caption_options.nil?)

  response = WebUtils.http_request(@base_url + GET_CAPTION_PATH, 'GET', WebUtils::DOWNLOAD_TIMEOUT, query_hash)
  if(!caption_options.nil? and caption_options.build_url) # If build_url is true
    return JSON.parse(response)["CaptionUrl"]
  else
    return response # Else return raw caption text
  end
end

#get_element_list(api_token, job_id, elementlist_version = nil) ⇒ Object 



210
211
212
213
214
215
 
# File 'lib/cielo24/actions.rb', line 210

def get_element_list(api_token, job_id, elementlist_version=nil)
  query_hash = init_job_req_dict(api_token, job_id)
  query_hash[:elementlist_version] = elementlist_version if !(elementlist_version.nil?)
  json = WebUtils.get_json(@base_url + GET_ELEMENT_LIST_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return Mash.new(json)
end

#get_job_info(api_token, job_id) ⇒ Object 



121
122
123
124
125
126
 
# File 'lib/cielo24/actions.rb', line 121

def get_job_info(api_token, job_id)
  query_hash = init_job_req_dict(api_token, job_id)

  json = WebUtils.get_json(@base_url + GET_JOB_INFO_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return Mash.new(json)
end

#get_job_list(api_token) ⇒ Object 



128
129
130
131
132
133
 
# File 'lib/cielo24/actions.rb', line 128

def get_job_list(api_token)
  query_hash = init_access_req_dict(api_token)

  json = WebUtils.get_json(@base_url + GET_JOB_LIST_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return Mash.new(json)
end

#get_list_of_element_lists(api_token, job_id) ⇒ Object 



217
218
219
220
221
 
# File 'lib/cielo24/actions.rb', line 217

def get_list_of_element_lists(api_token, job_id)
  query_hash = init_job_req_dict(api_token, job_id)
  json = WebUtils.get_json(@base_url + GET_LIST_OF_ELEMENT_LISTS_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return json
end

#get_media(api_token, job_id) ⇒ Object 



162
163
164
165
166
 
# File 'lib/cielo24/actions.rb', line 162

def get_media(api_token, job_id)
  query_hash = init_job_req_dict(api_token, job_id)
  json = WebUtils.get_json(@base_url + GET_MEDIA_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return json["MediaUrl"]
end

#get_transcript(api_token, job_id, transcript_options = nil) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/cielo24/actions.rb', line 190

def get_transcript(api_token, job_id, transcript_options=nil)
  query_hash = init_job_req_dict(api_token, job_id)
  query_hash.merge!(transcript_options.get_hash) if !(transcript_options.nil?)
  # Return raw transcript text
  return WebUtils.http_request(@base_url + GET_TRANSCRIPTION_PATH, 'GET', WebUtils::DOWNLOAD_TIMEOUT, query_hash)
end

#login(username, password = nil, api_securekey = nil, use_headers = false) ⇒ Object

ACCESS CONTROL ###

Raises:

  • (ArgumentError) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/cielo24/actions.rb', line 41

def (username, password=nil, api_securekey=nil, use_headers=false)
  assert_argument(username, "Username")
  raise ArgumentError.new("Password or API Secure Key must be supplied for login.") if (password.nil? and api_securekey.nil?)

  query_hash = init_version_dict
  headers = Hash.new

  if not use_headers
    query_hash[:username] = username
    query_hash[:password] = password if (!password.nil?)
    query_hash[:securekey] = api_securekey if (!api_securekey.nil?)
  else
    headers[:'x-auth-user'] = username
    headers[:'x-auth-key'] = password if (!password.nil?)
    headers[:'x-auth-securekey'] = api_securekey if (!api_securekey.nil?)
  end

  json = WebUtils.get_json(@base_url + LOGIN_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash, headers)
  return json["ApiToken"]
end

#logout(api_token) ⇒ Object 



62
63
64
65
66
 
# File 'lib/cielo24/actions.rb', line 62

def logout(api_token)
  query_hash = init_access_req_dict(api_token)
  # Nothing returned
  WebUtils.http_request(@base_url + LOGOUT_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
end

#perform_transcription(api_token, job_id, fidelity, priority, callback_uri = nil, turnaround_hours = nil, target_language = nil, options = nil) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/cielo24/actions.rb', line 168

def perform_transcription(api_token,
                          job_id,
                          fidelity,
                          priority,
                          callback_uri=nil,
                          turnaround_hours=nil,
                          target_language=nil,
                          options = nil)
  assert_argument(fidelity, "Fidelity")
  assert_argument(priority, "Priority")
  query_hash = init_job_req_dict(api_token, job_id)
  query_hash[:transcription_fidelity] = fidelity
  query_hash[:priority] = priority
  query_hash[:callback_uri] = URI.escape(callback_uri) if !(callback_uri.nil?)
  query_hash[:turnaround_hours] = turnaround_hours if !(turnaround_hours.nil?)
  query_hash[:target_language] = target_language if !(target_language.nil?)
  query_hash.merge!(options.get_hash) if !(options.nil?)

  json = WebUtils.get_json(@base_url + PERFORM_TRANSCRIPTION, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
  return json["TaskId"]
end

#remove_api_key(api_token, api_securekey) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/cielo24/actions.rb', line 88

def remove_api_key(api_token, api_securekey)
  query_hash = init_access_req_dict(api_token)
  query_hash[:api_securekey] = api_securekey

  # Nothing returned
  WebUtils.http_request(@base_url + REMOVE_API_KEY_PATH, 'GET', WebUtils::BASIC_TIMEOUT, query_hash)
end

#update_password(api_token, new_password) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/cielo24/actions.rb', line 68

def update_password(api_token, new_password)
  assert_argument(new_password, "New Password")
  query_hash = init_access_req_dict(api_token)
  query_hash[:new_password] = new_password

  # Nothing returned
  WebUtils.http_request(@base_url + UPDATE_PASSWORD_PATH, 'POST', WebUtils::BASIC_TIMEOUT, nil, nil, query_hash)
end