uiza 1.1.1 → 1.2.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 (29) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +21 -53
  5. data/doc/CALLBACK.md +77 -39
  6. data/doc/CATEGORY.md +202 -104
  7. data/doc/ENTITY.md +295 -200
  8. data/doc/LIVE.md +513 -0
  9. data/doc/STORAGE.md +123 -66
  10. data/doc/USER.md +114 -194
  11. data/lib/uiza.rb +9 -2
  12. data/lib/uiza/api_operation/add.rb +2 -1
  13. data/lib/uiza/api_operation/create.rb +2 -1
  14. data/lib/uiza/api_operation/delete.rb +2 -2
  15. data/lib/uiza/api_operation/list.rb +3 -1
  16. data/lib/uiza/api_operation/remove.rb +2 -2
  17. data/lib/uiza/api_operation/retrieve.rb +2 -2
  18. data/lib/uiza/api_operation/update.rb +2 -1
  19. data/lib/uiza/callback.rb +4 -4
  20. data/lib/uiza/category.rb +11 -9
  21. data/lib/uiza/entity.rb +17 -17
  22. data/lib/uiza/live.rb +23 -22
  23. data/lib/uiza/storage.rb +4 -4
  24. data/lib/uiza/user.rb +14 -15
  25. data/lib/uiza/version.rb +1 -1
  26. metadata +3 -5
  27. data/doc/ANALYTIC.md +0 -143
  28. data/doc/LIVE_STREAMING.md +0 -435
  29. data/lib/uiza/analytic.rb +0 -42
data/doc/ANALYTIC.md DELETED
@@ -1,143 +0,0 @@
1
- ## Analytic
2
- Monitor the four key dimensions of video QoS: playback failures, startup time, rebuffering, and video quality.
3
- These 15 metrics help you track playback performance, so your team can know exactly what’s going on.
4
-
5
- See details [here](https://docs.uiza.io/#analytic).
6
-
7
- ## Total Line
8
- Get data grouped by hour (data refresh every 5 minutes). Track video playback on any metric performance, so you can know exactly what’s happening on every user’s device and debug more effectively.
9
-
10
- See details [here](https://docs.uiza.io/#total-line).
11
-
12
- ```ruby
13
- require "uiza"
14
-
15
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
16
- Uiza.authorization = "your-authorization"
17
-
18
- params = {
19
- start_date: "YYYY-MM-DD hh:mm",
20
- end_date: "YYYY-MM-DD hh:mm",
21
- metric: "rebuffer_count"
22
- }
23
-
24
- begin
25
- response = Uiza::Analytic.get_total_line params
26
- puts response.first.rebuffer_count
27
- rescue Uiza::Error::UizaError => e
28
- puts "description_link: #{e.description_link}"
29
- puts "code: #{e.code}"
30
- puts "message: #{e.message}"
31
- rescue StandardError => e
32
- puts "message: #{e.message}"
33
- end
34
- ```
35
-
36
- Example Response
37
- ```ruby
38
- [
39
- {
40
- "date_time": 1542978000000,
41
- "rebuffer_count": 1.6666666666666667
42
- },
43
- {
44
- "date_time": 1543215600000,
45
- "rebuffer_count": 5
46
- }
47
- ]
48
- ```
49
-
50
- ## Type
51
- Get data base on 4 type of filter: country, device, title, player
52
-
53
- See details [here](https://docs.uiza.io/#type).
54
-
55
- ```ruby
56
- require "uiza"
57
-
58
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
59
- Uiza.authorization = "your-authorization"
60
-
61
- params = {
62
- start_date: "YYYY-MM-DD hh:mm",
63
- end_date: "YYYY-MM-DD hh:mm",
64
- type_filter: "country"
65
- }
66
-
67
- begin
68
- response = Uiza::Analytic.get_type params
69
- puts response.first.name
70
- puts response.first.total_view
71
- puts response.first.percentage_of_view
72
- rescue Uiza::Error::UizaError => e
73
- puts "description_link: #{e.description_link}"
74
- puts "code: #{e.code}"
75
- puts "message: #{e.message}"
76
- rescue StandardError => e
77
- puts "message: #{e.message}"
78
- end
79
- ```
80
-
81
- Example Response
82
- ```ruby
83
- [
84
- {
85
- "name": "Vietnam",
86
- "total_view": 15,
87
- "percentage_of_view": 0.625
88
- },
89
- {
90
- "name": "Other",
91
- "total_view": 9,
92
- "percentage_of_view": 0.375
93
- }
94
- ]
95
- ```
96
-
97
- ## Line
98
- Get data grouped by hour. Get total view in time range. This help you to draw a line chart to visualize data
99
-
100
- See details [here](https://docs.uiza.io/#line).
101
-
102
- ```ruby
103
- require "uiza"
104
-
105
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
106
- Uiza.authorization = "your-authorization"
107
-
108
- params = {
109
- start_date: "YYYY-MM-DD hh:mm",
110
- end_date: "YYYY-MM-DD hh:mm",
111
- type: "your-metric-type"
112
- }
113
-
114
- begin
115
- response = Uiza::Analytic.get_line params
116
- puts response.first.day_time
117
- puts response.first.value
118
- rescue Uiza::Error::UizaError => e
119
- puts "description_link: #{e.description_link}"
120
- puts "code: #{e.code}"
121
- puts "message: #{e.message}"
122
- rescue StandardError => e
123
- puts "message: #{e.message}"
124
- end
125
- ```
126
-
127
- Example Response
128
- ```ruby
129
- [
130
- {
131
- "day_time": 1541548800000,
132
- "value": 4
133
- },
134
- {
135
- "day_time": 1541635200000,
136
- "value": 5
137
- },
138
- {
139
- "day_time": 1541721600000,
140
- "value": 5
141
- }
142
- ]
143
- ```
data/doc/LIVE_STREAMING.md DELETED
@@ -1,435 +0,0 @@
1
- ## Live Streaming
2
- These APIs used to create and manage live streaming event.
3
- * When a Live is not start : it's named as `Event`.
4
- * When have an Event , you can start it : it's named as `Feed`.
5
-
6
- See details [here](https://docs.uiza.io/#live-streaming).
7
-
8
- ## Create a live event
9
- These APIs use to create a live streaming and manage the live streaming input (output).
10
- A live stream can be set up and start later or start right after set up.
11
- Live Channel Minutes counts when the event starts.
12
-
13
- See details [here](https://docs.uiza.io/#create-a-live-event).
14
-
15
- ```ruby
16
- require "uiza"
17
-
18
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
19
- Uiza.authorization = "your-authorization"
20
-
21
- params = {
22
- name: "test event",
23
- mode: "push",
24
- encode: 1,
25
- dvr: 1,
26
- description: "This is for test event",
27
- poster: "https://example.com/poster.jpeg",
28
- thumbnail: "https://example.com/poster.jpeg",
29
- linkStream: [
30
- "https://playlist.m3u8"
31
- ],
32
- resourceMode: "single"
33
- }
34
-
35
- begin
36
- live = Uiza::Live.create params
37
- puts live.id
38
- puts live.name
39
- rescue Uiza::Error::UizaError => e
40
- puts "description_link: #{e.description_link}"
41
- puts "code: #{e.code}"
42
- puts "message: #{e.message}"
43
- rescue StandardError => e
44
- puts "message: #{e.message}"
45
- end
46
- ```
47
-
48
- Example Response
49
- ```ruby
50
- {
51
- "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
52
- "name": "checking 01",
53
- "description": "checking",
54
- "mode": "pull",
55
- "resourceMode": "single",
56
- "encode": 0,
57
- "channelName": "checking-01",
58
- "lastPresetId": null,
59
- "lastFeedId": null,
60
- "poster": "https://example.com/poster.jpeg",
61
- "thumbnail": "https://example.com/thumbnail.jpeg",
62
- "linkPublishSocial": null,
63
- "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
64
- "lastPullInfo": null,
65
- "lastPushInfo": null,
66
- "lastProcess": null,
67
- "eventType": null,
68
- "createdAt": "2018-06-21T14:33:36.000Z",
69
- "updatedAt": "2018-06-21T14:33:36.000Z"
70
- }
71
- ```
72
-
73
- ## Retrieve a live event
74
- Retrieves the details of an existing event.
75
- You need only provide the unique identifier of event that was returned upon Live event creation.
76
-
77
- See details [here](https://docs.uiza.io/#retrieve-a-live-event).
78
-
79
- ```ruby
80
- require "uiza"
81
-
82
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
83
- Uiza.authorization = "your-authorization"
84
-
85
- begin
86
- live = Uiza::Live.retrieve "your-live-id"
87
- puts live.id
88
- puts live.name
89
- rescue Uiza::Error::UizaError => e
90
- puts "description_link: #{e.description_link}"
91
- puts "code: #{e.code}"
92
- puts "message: #{e.message}"
93
- rescue StandardError => e
94
- puts "message: #{e.message}"
95
- end
96
- ```
97
-
98
- Example Response
99
- ```ruby
100
- {
101
- "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
102
- "name": "checking 01",
103
- "description": "checking",
104
- "mode": "pull",
105
- "resourceMode": "single",
106
- "encode": 0,
107
- "channelName": "checking-01",
108
- "lastPresetId": null,
109
- "lastFeedId": null,
110
- "poster": "https://example.com/poster.jpeg",
111
- "thumbnail": "https://example.com/thumbnail.jpeg",
112
- "linkPublishSocial": null,
113
- "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
114
- "lastPullInfo": null,
115
- "lastPushInfo": null,
116
- "lastProcess": null,
117
- "eventType": null,
118
- "createdAt": "2018-06-21T14:33:36.000Z",
119
- "updatedAt": "2018-06-21T14:33:36.000Z"
120
- }
121
- ```
122
-
123
- ## Update a live event
124
- Update the specific Live event by edit values of parameters.
125
-
126
- See details [here](https://docs.uiza.io/#update-a-live-event).
127
-
128
- ```ruby
129
- require "uiza"
130
-
131
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
132
- Uiza.authorization = "your-authorization"
133
-
134
- params = {
135
- id: "your-live-id",
136
- name: "live test",
137
- mode: "pull",
138
- encode: 0,
139
- dvr: 1
140
- resourceMode: "single"
141
- }
142
-
143
- begin
144
- live = Uiza::Live.update params
145
- puts live.id
146
- puts live.name
147
- rescue Uiza::Error::UizaError => e
148
- puts "description_link: #{e.description_link}"
149
- puts "code: #{e.code}"
150
- puts "message: #{e.message}"
151
- rescue StandardError => e
152
- puts "message: #{e.message}"
153
- end
154
- ```
155
-
156
- Example Response
157
- ```ruby
158
- {
159
- "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
160
- "name": "checking 01",
161
- "description": "checking",
162
- "mode": "pull",
163
- "resourceMode": "single",
164
- "encode": 0,
165
- "channelName": "checking-01",
166
- "lastPresetId": null,
167
- "lastFeedId": null,
168
- "poster": "https://example.com/poster.jpeg",
169
- "thumbnail": "https://example.com/thumbnail.jpeg",
170
- "linkPublishSocial": null,
171
- "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
172
- "lastPullInfo": null,
173
- "lastPushInfo": null,
174
- "lastProcess": null,
175
- "eventType": null,
176
- "createdAt": "2018-06-21T14:33:36.000Z",
177
- "updatedAt": "2018-06-21T14:33:36.000Z"
178
- }
179
- ```
180
-
181
- ## Start a live feed
182
- These API use to start a live event that has been create success.
183
- The Live channel minute start count whenever the event start success
184
-
185
- See details [here](https://docs.uiza.io/#start-a-live-feed).
186
-
187
- ```ruby
188
- require "uiza"
189
-
190
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
191
- Uiza.authorization = "your-authorization"
192
-
193
- begin
194
- live = Uiza::Live.start_feed "your-live-id"
195
- puts live.id
196
- puts live.name
197
- rescue Uiza::Error::UizaError => e
198
- puts "description_link: #{e.description_link}"
199
- puts "code: #{e.code}"
200
- puts "message: #{e.message}"
201
- rescue StandardError => e
202
- puts "message: #{e.message}"
203
- end
204
- ```
205
-
206
- Example Response
207
- ```ruby
208
- {
209
- "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
210
- "name": "checking 01",
211
- "description": "checking",
212
- "mode": "pull",
213
- "resourceMode": "single",
214
- "encode": 0,
215
- "channelName": "checking-01",
216
- "lastPresetId": null,
217
- "lastFeedId": null,
218
- "poster": "https://example.com/poster.jpeg",
219
- "thumbnail": "https://example.com/thumbnail.jpeg",
220
- "linkPublishSocial": null,
221
- "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
222
- "lastPullInfo": null,
223
- "lastPushInfo": null,
224
- "lastProcess": null,
225
- "eventType": null,
226
- "createdAt": "2018-06-21T14:33:36.000Z",
227
- "updatedAt": "2018-06-21T14:33:36.000Z"
228
- }
229
- ```
230
-
231
- ## Get view of live feed
232
- This API use to get a live view status . This view only show when event has been started and being processing.
233
-
234
- See details [here](https://docs.uiza.io/#get-view-of-live-feed).
235
-
236
- ```ruby
237
- require "uiza"
238
-
239
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
240
- Uiza.authorization = "your-authorization"
241
-
242
- begin
243
- response = Uiza::Live.get_view "your-live-id"
244
- puts response.stream_name
245
- puts response.watchnow
246
- puts response.day
247
- rescue Uiza::Error::UizaError => e
248
- puts "description_link: #{e.description_link}"
249
- puts "code: #{e.code}"
250
- puts "message: #{e.message}"
251
- rescue StandardError => e
252
- puts "message: #{e.message}"
253
- end
254
- ```
255
-
256
- Example Response
257
- ```ruby
258
- {
259
- "stream_name": "peppa-pig-english-episodes",
260
- "watchnow": 1,
261
- "day": 1533271205999
262
- }
263
- ```
264
-
265
- ## Stop a live feed
266
- Stop live event
267
-
268
- See details [here](https://docs.uiza.io/#stop-a-live-feed).
269
-
270
- ```ruby
271
- require "uiza"
272
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
273
- Uiza.authorization = "your-authorization"
274
-
275
- begin
276
- live = Uiza::Live.stop_feed "your-live-id"
277
- puts live.id
278
- puts live.name
279
- rescue Uiza::Error::UizaError => e
280
- puts "description_link: #{e.description_link}"
281
- puts "code: #{e.code}"
282
- puts "message: #{e.message}"
283
- rescue StandardError => e
284
- puts "message: #{e.message}"
285
- end
286
- ```
287
-
288
- Example Response
289
- ```ruby
290
- {
291
- "id": "8b83886e-9cc3-4eab-9258-ebb16c0c73de",
292
- "name": "checking 01",
293
- "description": "checking",
294
- "mode": "pull",
295
- "resourceMode": "single",
296
- "encode": 0,
297
- "channelName": "checking-01",
298
- "lastPresetId": null,
299
- "lastFeedId": null,
300
- "poster": "https://example.com/poster.jpeg",
301
- "thumbnail": "https://example.com/thumbnail.jpeg",
302
- "linkPublishSocial": null,
303
- "linkStream": "[\"https://www.youtube.com/watch?v=pQzaHPoNX1I\"]",
304
- "lastPullInfo": null,
305
- "lastPushInfo": null,
306
- "lastProcess": null,
307
- "eventType": null,
308
- "createdAt": "2018-06-21T14:33:36.000Z",
309
- "updatedAt": "2018-06-21T14:33:36.000Z"
310
- }
311
- ```
312
-
313
- ## List all recorded files
314
- Retrieves list of recorded file after streamed (only available when your live event has turned on Record feature)
315
-
316
- See details [here](https://docs.uiza.io/#list-all-recorded-files).
317
-
318
- ```ruby
319
- require "uiza"
320
-
321
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
322
- Uiza.authorization = "your-authorization"
323
-
324
- begin
325
- live = Uiza::Live.list_recorded limit: 2
326
- # limit is optional
327
- # or live = Uiza::Live.list_recorded
328
- puts live.first.id
329
- puts live.first.entityId
330
- rescue Uiza::Error::UizaError => e
331
- puts "description_link: #{e.description_link}"
332
- puts "code: #{e.code}"
333
- puts "message: #{e.message}"
334
- rescue StandardError => e
335
- puts "message: #{e.message}"
336
- end
337
- ```
338
-
339
- Example Response
340
- ```ruby
341
- [
342
- {
343
- "id": "040df935-61c4-46f7-a41f-0a899ebaa2cc",
344
- "entityId": "ee122e85-553f-4621-bc77-1396191d5846",
345
- "channelName": "dcb8686f-d0f8-4a0f-8b92-22db339eb315",
346
- "feedId": "3e3b75df-e6fa-471c-b386-8f44b8a34b6c",
347
- "eventType": "pull",
348
- "startTime": "2018-12-13T16:28:29.000Z",
349
- "endTime": "2018-12-13T18:28:29.000Z",
350
- "length": "7200",
351
- "fileSize": "9276182",
352
- "extraInfo": null,
353
- "endpointConfig": "s3-uiza-dvr",
354
- "createdAt": "2018-12-13T19:28:43.000Z",
355
- "updatedAt": "2018-12-13T19:28:43.000Z",
356
- "entityName": "Christmas 2018 Holidays Special | Best Christmas Songs & Cartoons for Kids & Babies on Baby First TV"
357
- },
358
- {
359
- "id": "3fec45e9-932b-4efe-b97f-dc3053acaa05",
360
- "entityId": "47e804bc-d4e5-4442-8f1f-20341a156a70",
361
- "channelName": "e9034eac-4905-4f9a-8e79-c0bd67e49dd5",
362
- "feedId": "12830696-87e3-4209-a877-954f8f008964",
363
- "eventType": "pull",
364
- "startTime": "2018-12-13T14:14:14.000Z",
365
- "endTime": "2018-12-13T16:14:14.000Z",
366
- "length": "7200",
367
- "fileSize": "439858038",
368
- "extraInfo": null,
369
- "endpointConfig": "s3-uiza-dvr",
370
- "createdAt": "2018-12-13T17:30:42.000Z",
371
- "updatedAt": "2018-12-13T17:30:42.000Z",
372
- "entityName": "WATCH: SpaceX to Launch Falcon 9 Rocket #Spaceflight CRS16 @1:16pm EST"
373
- }
374
- ]
375
- ```
376
-
377
- ## Delete a record file
378
- Delete a recorded file
379
-
380
- See details [here](https://docs.uiza.io/#delete-a-record-file).
381
-
382
- ```ruby
383
- require "uiza"
384
-
385
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
386
- Uiza.authorization = "your-authorization"
387
-
388
- begin
389
- live = Uiza::Live.delete "your-record-id" #Identifier of record (get from list record)
390
- puts live.id
391
- rescue Uiza::Error::UizaError => e
392
- puts "description_link: #{e.description_link}"
393
- puts "code: #{e.code}"
394
- puts "message: #{e.message}"
395
- rescue StandardError => e
396
- puts "message: #{e.message}"
397
- end
398
- ```
399
-
400
- Example Response
401
- ```ruby
402
- {
403
- "id": "040df935-61c4-46f7-a41f-0a899ebaa2cc"
404
- }
405
- ```
406
-
407
- ## Convert into VOD
408
- Convert recorded file into VOD entity. After converted, your file can be stream via Uiza's CDN.
409
-
410
- See details [here](https://docs.uiza.io/#convert-into-vod).
411
-
412
- ```ruby
413
- require "uiza"
414
-
415
- Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
416
- Uiza.authorization = "your-authorization"
417
-
418
- begin
419
- live = Uiza::Live.convert_to_vod "your-record-id" #Identifier of record (get from list record)
420
- puts live.id
421
- rescue Uiza::Error::UizaError => e
422
- puts "description_link: #{e.description_link}"
423
- puts "code: #{e.code}"
424
- puts "message: #{e.message}"
425
- rescue StandardError => e
426
- puts "message: #{e.message}"
427
- end
428
- ```
429
-
430
- Example Response
431
- ```ruby
432
- {
433
- "id": "03739912-d781-4d5a-aaf8-7262691a5d0c"
434
- }
435
- ```