kaltura-ruby-client 1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +7 -0
  2. data/README +20 -0
  3. data/Rakefile +19 -0
  4. data/agpl.txt +674 -0
  5. data/kaltura.yml +7 -0
  6. data/lib/kaltura.rb +31 -0
  7. data/lib/kaltura_client.rb +14450 -0
  8. data/lib/kaltura_client_base.rb +432 -0
  9. data/lib/kaltura_plugins/kaltura_abc_screeners_watermark_access_control_client_plugin.rb +37 -0
  10. data/lib/kaltura_plugins/kaltura_ad_cue_point_client_plugin.rb +108 -0
  11. data/lib/kaltura_plugins/kaltura_annotation_client_plugin.rb +237 -0
  12. data/lib/kaltura_plugins/kaltura_aspera_client_plugin.rb +61 -0
  13. data/lib/kaltura_plugins/kaltura_attachment_client_plugin.rb +227 -0
  14. data/lib/kaltura_plugins/kaltura_audit_client_plugin.rb +349 -0
  15. data/lib/kaltura_plugins/kaltura_bulk_upload_client_plugin.rb +109 -0
  16. data/lib/kaltura_plugins/kaltura_bulk_upload_csv_client_plugin.rb +55 -0
  17. data/lib/kaltura_plugins/kaltura_bulk_upload_filter_client_plugin.rb +46 -0
  18. data/lib/kaltura_plugins/kaltura_bulk_upload_xml_client_plugin.rb +40 -0
  19. data/lib/kaltura_plugins/kaltura_caption_client_plugin.rb +406 -0
  20. data/lib/kaltura_plugins/kaltura_caption_search_client_plugin.rb +138 -0
  21. data/lib/kaltura_plugins/kaltura_code_cue_point_client_plugin.rb +97 -0
  22. data/lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb +1717 -0
  23. data/lib/kaltura_plugins/kaltura_cue_point_client_plugin.rb +290 -0
  24. data/lib/kaltura_plugins/kaltura_document_client_plugin.rb +522 -0
  25. data/lib/kaltura_plugins/kaltura_drm_client_plugin.rb +204 -0
  26. data/lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb +810 -0
  27. data/lib/kaltura_plugins/kaltura_drop_folder_xml_bulk_upload_client_plugin.rb +39 -0
  28. data/lib/kaltura_plugins/kaltura_email_notification_client_plugin.rb +276 -0
  29. data/lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb +405 -0
  30. data/lib/kaltura_plugins/kaltura_external_media_client_plugin.rb +203 -0
  31. data/lib/kaltura_plugins/kaltura_file_sync_client_plugin.rb +151 -0
  32. data/lib/kaltura_plugins/kaltura_http_notification_client_plugin.rb +309 -0
  33. data/lib/kaltura_plugins/kaltura_kontiki_client_plugin.rb +72 -0
  34. data/lib/kaltura_plugins/kaltura_like_client_plugin.rb +82 -0
  35. data/lib/kaltura_plugins/kaltura_metadata_client_plugin.rb +788 -0
  36. data/lib/kaltura_plugins/kaltura_multi_centers_client_plugin.rb +45 -0
  37. data/lib/kaltura_plugins/kaltura_short_link_client_plugin.rb +231 -0
  38. data/lib/kaltura_plugins/kaltura_tag_search_client_plugin.rb +145 -0
  39. data/lib/kaltura_plugins/kaltura_var_console_client_plugin.rb +238 -0
  40. data/lib/kaltura_plugins/kaltura_velocix_client_plugin.rb +40 -0
  41. data/lib/kaltura_plugins/kaltura_virus_scan_client_plugin.rb +263 -0
  42. data/lib/kaltura_plugins/kaltura_webex_drop_folder_client_plugin.rb +121 -0
  43. data/lib/kaltura_plugins/kaltura_widevine_client_plugin.rb +195 -0
  44. data/license.txt +674 -0
  45. data/test/access_control_service_test.rb +75 -0
  46. data/test/base_entry_service_test.rb +267 -0
  47. data/test/configuration_test.rb +178 -0
  48. data/test/cue_point_service_test.rb +67 -0
  49. data/test/data_service_test.rb +76 -0
  50. data/test/document_service_test.rb +41 -0
  51. data/test/media/test.mov +0 -0
  52. data/test/media/test.pdf +0 -0
  53. data/test/media/test.png +0 -0
  54. data/test/media/test.swf +0 -0
  55. data/test/media/test.wmv +0 -0
  56. data/test/media_service_test.rb +294 -0
  57. data/test/metadata_profile_service_test.rb +63 -0
  58. data/test/test_helper.rb +59 -0
  59. metadata +127 -0
@@ -0,0 +1,349 @@
1
+ # ===================================================================================================
2
+ # _ __ _ _
3
+ # | |/ /__ _| | |_ _ _ _ _ __ _
4
+ # | ' </ _` | | _| || | '_/ _` |
5
+ # |_|\_\__,_|_|\__|\_,_|_| \__,_|
6
+ #
7
+ # This file is part of the Kaltura Collaborative Media Suite which allows users
8
+ # to do with audio, video, and animation what Wiki platfroms allow them to do with
9
+ # text.
10
+ #
11
+ # Copyright (C) 2006-2011 Kaltura Inc.
12
+ #
13
+ # This program is free software: you can redistribute it and/or modify
14
+ # it under the terms of the GNU Affero General Public License as
15
+ # published by the Free Software Foundation, either version 3 of the
16
+ # License, or (at your option) any later version.
17
+ #
18
+ # This program is distributed in the hope that it will be useful,
19
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21
+ # GNU Affero General Public License for more details.
22
+ #
23
+ # You should have received a copy of the GNU Affero General Public License
24
+ # along with this program. If not, see <http:#www.gnu.org/licenses/>.
25
+ #
26
+ # @ignore
27
+ # ===================================================================================================
28
+ require 'kaltura_client.rb'
29
+
30
+ module Kaltura
31
+
32
+ class KalturaAuditTrailChangeXmlNodeType
33
+ CHANGED = 1
34
+ ADDED = 2
35
+ REMOVED = 3
36
+ end
37
+
38
+ class KalturaAuditTrailContext
39
+ CLIENT = -1
40
+ SCRIPT = 0
41
+ PS2 = 1
42
+ API_V3 = 2
43
+ end
44
+
45
+ class KalturaAuditTrailFileSyncType
46
+ FILE = 1
47
+ LINK = 2
48
+ URL = 3
49
+ end
50
+
51
+ class KalturaAuditTrailStatus
52
+ PENDING = 1
53
+ READY = 2
54
+ FAILED = 3
55
+ end
56
+
57
+ class KalturaAuditTrailAction
58
+ CHANGED = "CHANGED"
59
+ CONTENT_VIEWED = "CONTENT_VIEWED"
60
+ COPIED = "COPIED"
61
+ CREATED = "CREATED"
62
+ DELETED = "DELETED"
63
+ FILE_SYNC_CREATED = "FILE_SYNC_CREATED"
64
+ RELATION_ADDED = "RELATION_ADDED"
65
+ RELATION_REMOVED = "RELATION_REMOVED"
66
+ VIEWED = "VIEWED"
67
+ end
68
+
69
+ class KalturaAuditTrailObjectType
70
+ BATCH_JOB = "BatchJob"
71
+ EMAIL_INGESTION_PROFILE = "EmailIngestionProfile"
72
+ FILE_SYNC = "FileSync"
73
+ KSHOW_KUSER = "KshowKuser"
74
+ METADATA = "Metadata"
75
+ METADATA_PROFILE = "MetadataProfile"
76
+ PARTNER = "Partner"
77
+ PERMISSION = "Permission"
78
+ UPLOAD_TOKEN = "UploadToken"
79
+ USER_LOGIN_DATA = "UserLoginData"
80
+ USER_ROLE = "UserRole"
81
+ ACCESS_CONTROL = "accessControl"
82
+ CATEGORY = "category"
83
+ CONVERSION_PROFILE_2 = "conversionProfile2"
84
+ ENTRY = "entry"
85
+ FLAVOR_ASSET = "flavorAsset"
86
+ FLAVOR_PARAMS = "flavorParams"
87
+ FLAVOR_PARAMS_CONVERSION_PROFILE = "flavorParamsConversionProfile"
88
+ FLAVOR_PARAMS_OUTPUT = "flavorParamsOutput"
89
+ KSHOW = "kshow"
90
+ KUSER = "kuser"
91
+ MEDIA_INFO = "mediaInfo"
92
+ MODERATION = "moderation"
93
+ ROUGHCUT = "roughcutEntry"
94
+ SYNDICATION = "syndicationFeed"
95
+ THUMBNAIL_ASSET = "thumbAsset"
96
+ THUMBNAIL_PARAMS = "thumbParams"
97
+ THUMBNAIL_PARAMS_OUTPUT = "thumbParamsOutput"
98
+ UI_CONF = "uiConf"
99
+ WIDGET = "widget"
100
+ end
101
+
102
+ class KalturaAuditTrailOrderBy
103
+ CREATED_AT_ASC = "+createdAt"
104
+ PARSED_AT_ASC = "+parsedAt"
105
+ CREATED_AT_DESC = "-createdAt"
106
+ PARSED_AT_DESC = "-parsedAt"
107
+ end
108
+
109
+ class KalturaAuditTrailInfo < KalturaObjectBase
110
+
111
+ end
112
+
113
+ class KalturaAuditTrail < KalturaObjectBase
114
+ attr_accessor :id
115
+ attr_accessor :created_at
116
+ # Indicates when the data was parsed
117
+ #
118
+ attr_accessor :parsed_at
119
+ attr_accessor :status
120
+ attr_accessor :audit_object_type
121
+ attr_accessor :object_id
122
+ attr_accessor :related_object_id
123
+ attr_accessor :related_object_type
124
+ attr_accessor :entry_id
125
+ attr_accessor :master_partner_id
126
+ attr_accessor :partner_id
127
+ attr_accessor :request_id
128
+ attr_accessor :user_id
129
+ attr_accessor :action
130
+ attr_accessor :data
131
+ attr_accessor :ks
132
+ attr_accessor :context
133
+ # The API service and action that called and caused this audit
134
+ #
135
+ attr_accessor :entry_point
136
+ attr_accessor :server_name
137
+ attr_accessor :ip_address
138
+ attr_accessor :user_agent
139
+ attr_accessor :client_tag
140
+ attr_accessor :description
141
+ attr_accessor :error_description
142
+
143
+ def id=(val)
144
+ @id = val.to_i
145
+ end
146
+ def created_at=(val)
147
+ @created_at = val.to_i
148
+ end
149
+ def parsed_at=(val)
150
+ @parsed_at = val.to_i
151
+ end
152
+ def status=(val)
153
+ @status = val.to_i
154
+ end
155
+ def master_partner_id=(val)
156
+ @master_partner_id = val.to_i
157
+ end
158
+ def partner_id=(val)
159
+ @partner_id = val.to_i
160
+ end
161
+ def context=(val)
162
+ @context = val.to_i
163
+ end
164
+ end
165
+
166
+ class KalturaAuditTrailChangeItem < KalturaObjectBase
167
+ attr_accessor :descriptor
168
+ attr_accessor :old_value
169
+ attr_accessor :new_value
170
+
171
+ end
172
+
173
+ class KalturaAuditTrailListResponse < KalturaObjectBase
174
+ attr_accessor :objects
175
+ attr_accessor :total_count
176
+
177
+ def total_count=(val)
178
+ @total_count = val.to_i
179
+ end
180
+ end
181
+
182
+ class KalturaAuditTrailBaseFilter < KalturaFilter
183
+ attr_accessor :id_equal
184
+ attr_accessor :created_at_greater_than_or_equal
185
+ attr_accessor :created_at_less_than_or_equal
186
+ attr_accessor :parsed_at_greater_than_or_equal
187
+ attr_accessor :parsed_at_less_than_or_equal
188
+ attr_accessor :status_equal
189
+ attr_accessor :status_in
190
+ attr_accessor :audit_object_type_equal
191
+ attr_accessor :audit_object_type_in
192
+ attr_accessor :object_id_equal
193
+ attr_accessor :object_id_in
194
+ attr_accessor :related_object_id_equal
195
+ attr_accessor :related_object_id_in
196
+ attr_accessor :related_object_type_equal
197
+ attr_accessor :related_object_type_in
198
+ attr_accessor :entry_id_equal
199
+ attr_accessor :entry_id_in
200
+ attr_accessor :master_partner_id_equal
201
+ attr_accessor :master_partner_id_in
202
+ attr_accessor :partner_id_equal
203
+ attr_accessor :partner_id_in
204
+ attr_accessor :request_id_equal
205
+ attr_accessor :request_id_in
206
+ attr_accessor :user_id_equal
207
+ attr_accessor :user_id_in
208
+ attr_accessor :action_equal
209
+ attr_accessor :action_in
210
+ attr_accessor :ks_equal
211
+ attr_accessor :context_equal
212
+ attr_accessor :context_in
213
+ attr_accessor :entry_point_equal
214
+ attr_accessor :entry_point_in
215
+ attr_accessor :server_name_equal
216
+ attr_accessor :server_name_in
217
+ attr_accessor :ip_address_equal
218
+ attr_accessor :ip_address_in
219
+ attr_accessor :client_tag_equal
220
+
221
+ def id_equal=(val)
222
+ @id_equal = val.to_i
223
+ end
224
+ def created_at_greater_than_or_equal=(val)
225
+ @created_at_greater_than_or_equal = val.to_i
226
+ end
227
+ def created_at_less_than_or_equal=(val)
228
+ @created_at_less_than_or_equal = val.to_i
229
+ end
230
+ def parsed_at_greater_than_or_equal=(val)
231
+ @parsed_at_greater_than_or_equal = val.to_i
232
+ end
233
+ def parsed_at_less_than_or_equal=(val)
234
+ @parsed_at_less_than_or_equal = val.to_i
235
+ end
236
+ def status_equal=(val)
237
+ @status_equal = val.to_i
238
+ end
239
+ def master_partner_id_equal=(val)
240
+ @master_partner_id_equal = val.to_i
241
+ end
242
+ def partner_id_equal=(val)
243
+ @partner_id_equal = val.to_i
244
+ end
245
+ def context_equal=(val)
246
+ @context_equal = val.to_i
247
+ end
248
+ end
249
+
250
+ class KalturaAuditTrailChangeInfo < KalturaAuditTrailInfo
251
+ attr_accessor :changed_items
252
+
253
+ end
254
+
255
+ class KalturaAuditTrailChangeXmlNode < KalturaAuditTrailChangeItem
256
+ attr_accessor :type
257
+
258
+ def type=(val)
259
+ @type = val.to_i
260
+ end
261
+ end
262
+
263
+ class KalturaAuditTrailFileSyncCreateInfo < KalturaAuditTrailInfo
264
+ attr_accessor :version
265
+ attr_accessor :object_sub_type
266
+ attr_accessor :dc
267
+ attr_accessor :original
268
+ attr_accessor :file_type
269
+
270
+ def object_sub_type=(val)
271
+ @object_sub_type = val.to_i
272
+ end
273
+ def dc=(val)
274
+ @dc = val.to_i
275
+ end
276
+ def original=(val)
277
+ @original = to_b(val)
278
+ end
279
+ def file_type=(val)
280
+ @file_type = val.to_i
281
+ end
282
+ end
283
+
284
+ class KalturaAuditTrailTextInfo < KalturaAuditTrailInfo
285
+ attr_accessor :info
286
+
287
+ end
288
+
289
+ class KalturaAuditTrailFilter < KalturaAuditTrailBaseFilter
290
+
291
+ end
292
+
293
+
294
+ # Audit Trail service
295
+ #
296
+ class KalturaAuditTrailService < KalturaServiceBase
297
+ def initialize(client)
298
+ super(client)
299
+ end
300
+
301
+ # Allows you to add an audit trail object and audit trail content associated with Kaltura object
302
+ #
303
+ def add(audit_trail)
304
+ kparams = {}
305
+ client.add_param(kparams, 'auditTrail', audit_trail);
306
+ client.queue_service_action_call('audit_audittrail', 'add', kparams);
307
+ if (client.is_multirequest)
308
+ return nil;
309
+ end
310
+ return client.do_queue();
311
+ end
312
+
313
+ # Retrieve an audit trail object by id
314
+ #
315
+ def get(id)
316
+ kparams = {}
317
+ client.add_param(kparams, 'id', id);
318
+ client.queue_service_action_call('audit_audittrail', 'get', kparams);
319
+ if (client.is_multirequest)
320
+ return nil;
321
+ end
322
+ return client.do_queue();
323
+ end
324
+
325
+ # List audit trail objects by filter and pager
326
+ #
327
+ def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
328
+ kparams = {}
329
+ client.add_param(kparams, 'filter', filter);
330
+ client.add_param(kparams, 'pager', pager);
331
+ client.queue_service_action_call('audit_audittrail', 'list', kparams);
332
+ if (client.is_multirequest)
333
+ return nil;
334
+ end
335
+ return client.do_queue();
336
+ end
337
+ end
338
+
339
+ class KalturaClient < KalturaClientBase
340
+ attr_reader :audit_trail_service
341
+ def audit_trail_service
342
+ if (@audit_trail_service == nil)
343
+ @audit_trail_service = KalturaAuditTrailService.new(self)
344
+ end
345
+ return @audit_trail_service
346
+ end
347
+ end
348
+
349
+ end
@@ -0,0 +1,109 @@
1
+ # ===================================================================================================
2
+ # _ __ _ _
3
+ # | |/ /__ _| | |_ _ _ _ _ __ _
4
+ # | ' </ _` | | _| || | '_/ _` |
5
+ # |_|\_\__,_|_|\__|\_,_|_| \__,_|
6
+ #
7
+ # This file is part of the Kaltura Collaborative Media Suite which allows users
8
+ # to do with audio, video, and animation what Wiki platfroms allow them to do with
9
+ # text.
10
+ #
11
+ # Copyright (C) 2006-2011 Kaltura Inc.
12
+ #
13
+ # This program is free software: you can redistribute it and/or modify
14
+ # it under the terms of the GNU Affero General Public License as
15
+ # published by the Free Software Foundation, either version 3 of the
16
+ # License, or (at your option) any later version.
17
+ #
18
+ # This program is distributed in the hope that it will be useful,
19
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21
+ # GNU Affero General Public License for more details.
22
+ #
23
+ # You should have received a copy of the GNU Affero General Public License
24
+ # along with this program. If not, see <http:#www.gnu.org/licenses/>.
25
+ #
26
+ # @ignore
27
+ # ===================================================================================================
28
+ require 'kaltura_client.rb'
29
+
30
+ module Kaltura
31
+
32
+
33
+ # Bulk upload service is used to upload & manage bulk uploads
34
+ #
35
+ class KalturaBulkService < KalturaServiceBase
36
+ def initialize(client)
37
+ super(client)
38
+ end
39
+
40
+ # Get bulk upload batch job by id
41
+ #
42
+ def get(id)
43
+ kparams = {}
44
+ client.add_param(kparams, 'id', id);
45
+ client.queue_service_action_call('bulkupload_bulk', 'get', kparams);
46
+ if (client.is_multirequest)
47
+ return nil;
48
+ end
49
+ return client.do_queue();
50
+ end
51
+
52
+ # List bulk upload batch jobs
53
+ #
54
+ def list(bulk_upload_filter=KalturaNotImplemented, pager=KalturaNotImplemented)
55
+ kparams = {}
56
+ client.add_param(kparams, 'bulkUploadFilter', bulk_upload_filter);
57
+ client.add_param(kparams, 'pager', pager);
58
+ client.queue_service_action_call('bulkupload_bulk', 'list', kparams);
59
+ if (client.is_multirequest)
60
+ return nil;
61
+ end
62
+ return client.do_queue();
63
+ end
64
+
65
+ # serve action returns the original file.
66
+ #
67
+ def serve(id)
68
+ kparams = {}
69
+ # job id
70
+ client.add_param(kparams, 'id', id);
71
+ client.queue_service_action_call('bulkupload_bulk', 'serve', kparams);
72
+ return client.get_serve_url();
73
+ end
74
+
75
+ # serveLog action returns the log file for the bulk-upload job.
76
+ #
77
+ def serve_log(id)
78
+ kparams = {}
79
+ # job id
80
+ client.add_param(kparams, 'id', id);
81
+ client.queue_service_action_call('bulkupload_bulk', 'serveLog', kparams);
82
+ return client.get_serve_url();
83
+ end
84
+
85
+ # Aborts the bulk upload and all its child jobs
86
+ #
87
+ def abort(id)
88
+ kparams = {}
89
+ # job id
90
+ client.add_param(kparams, 'id', id);
91
+ client.queue_service_action_call('bulkupload_bulk', 'abort', kparams);
92
+ if (client.is_multirequest)
93
+ return nil;
94
+ end
95
+ return client.do_queue();
96
+ end
97
+ end
98
+
99
+ class KalturaClient < KalturaClientBase
100
+ attr_reader :bulk_service
101
+ def bulk_service
102
+ if (@bulk_service == nil)
103
+ @bulk_service = KalturaBulkService.new(self)
104
+ end
105
+ return @bulk_service
106
+ end
107
+ end
108
+
109
+ end