Ziggeo 2.21 → 2.24
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.
- checksums.yaml +4 -4
- data/README.md +59 -44
- data/lib/Ziggeo.rb +22 -11
- data/lib/classes/ZiggeoConfig.rb +2 -2
- data/lib/classes/ZiggeoMetaProfileProcess.rb +4 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6c62727eb19a64dc7890312fc3d406e009763979518b96e3849d4c557b9f4086
|
4
|
+
data.tar.gz: d6883d1fae3b1bafdb7e04641d6768a8ee805d134a6765b04a7973fd67590f36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecb7148b82720bffd59e8c434062c5e7dbde22c3360ca2d771254df1b2ebe2df1fb10531f92e8836ff33ce299d13b93a9a662e12222b6a971bfe2fdccdc9ad89
|
7
|
+
data.tar.gz: 58acdd9d5335efd7a0d0ff19b4eca4d7de9a3db92712f5377a1f369482a10590cf09f169c7cc4af3d17ad23fc29e62def596e2f0a0bf926e29adc1bcd38a0100
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ziggeo's Ruby Server SDK
|
2
2
|
|
3
|
-
latest version: **2.
|
3
|
+
latest version: **2.24**
|
4
4
|
|
5
5
|
## Index
|
6
6
|
|
@@ -76,6 +76,7 @@ latest version: **2.21**
|
|
76
76
|
4. [Meta Profile Process Create Video Analysis Process](#method-meta-profile-process-create-video-analysis-process)
|
77
77
|
5. [Meta Profile Process Create Audio Transcription Process](#method-meta-profile-process-create-audio-transcription-process)
|
78
78
|
6. [Meta Profile Process Create Nsfw Process](#method-meta-profile-process-create-nsfw-process)
|
79
|
+
7. [Meta Profile Process Create Profanity Process](#method-meta-profile-process-create-profanity-process)
|
79
80
|
11. [Methods for Webhooks](#method-webhooks)
|
80
81
|
1. [Webhooks Create](#method-webhooks-create)
|
81
82
|
2. [Webhooks Confirm](#method-webhooks-confirm)
|
@@ -172,16 +173,16 @@ Config is optional and if not specified (recommended), the Config file will be u
|
|
172
173
|
|
173
174
|
Currently available methods are branched off within different categories:
|
174
175
|
|
175
|
-
1.Videos
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
176
|
+
1. Videos
|
177
|
+
2. Streams
|
178
|
+
3. Authtokens
|
179
|
+
4. Application
|
180
|
+
5. Effect Profiles
|
181
|
+
6. Effect Profile Process
|
182
|
+
7. Meta Profiles
|
183
|
+
8. Meta Profile Process
|
184
|
+
9. Webhooks
|
185
|
+
10. Analytics
|
185
186
|
|
186
187
|
Each of this sections has their own actions and they are explained bellow
|
187
188
|
|
@@ -192,7 +193,7 @@ Each of this sections has their own actions and they are explained bellow
|
|
192
193
|
|
193
194
|
The videos resource allows you to access all single videos. Each video may contain more than one stream.
|
194
195
|
|
195
|
-
#### Index<a name="method-
|
196
|
+
#### Index<a name="method-videos-index"></a>
|
196
197
|
|
197
198
|
Query an array of videos (will return at most 50 videos by default). Newest videos come first.
|
198
199
|
|
@@ -219,7 +220,7 @@ ziggeo.videos().count(arguments = nil)
|
|
219
220
|
- states: *Filter videos by state*
|
220
221
|
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
221
222
|
|
222
|
-
#### Get<a name="method-
|
223
|
+
#### Get<a name="method-videos-get"></a>
|
223
224
|
|
224
225
|
Get a single video by token or key.
|
225
226
|
|
@@ -250,7 +251,7 @@ ziggeo.videos().stats_bulk(arguments = nil)
|
|
250
251
|
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
251
252
|
- summarize: *Boolean. Set it to TRUE to get the stats summarized. Set it to FALSE to get the stats for each video in a separate array. Default: TRUE.*
|
252
253
|
|
253
|
-
#### Download Video<a name="method-
|
254
|
+
#### Download Video<a name="method-videos-download-video"></a>
|
254
255
|
|
255
256
|
Download the video data file
|
256
257
|
|
@@ -258,7 +259,7 @@ Download the video data file
|
|
258
259
|
ziggeo.videos().download_video(token_or_key)
|
259
260
|
```
|
260
261
|
|
261
|
-
#### Download Image<a name="method-
|
262
|
+
#### Download Image<a name="method-videos-download-image"></a>
|
262
263
|
|
263
264
|
Download the image data file
|
264
265
|
|
@@ -266,7 +267,7 @@ Download the image data file
|
|
266
267
|
ziggeo.videos().download_image(token_or_key)
|
267
268
|
```
|
268
269
|
|
269
|
-
#### Get Stats<a name="method-
|
270
|
+
#### Get Stats<a name="method-videos-get-stats"></a>
|
270
271
|
|
271
272
|
Get the video's stats
|
272
273
|
|
@@ -274,7 +275,7 @@ Get the video's stats
|
|
274
275
|
ziggeo.videos().get_stats(token_or_key)
|
275
276
|
```
|
276
277
|
|
277
|
-
#### Push To Service<a name="method-
|
278
|
+
#### Push To Service<a name="method-videos-push-to-service"></a>
|
278
279
|
|
279
280
|
Push a video to a provided push service.
|
280
281
|
|
@@ -307,7 +308,7 @@ ziggeo.videos().apply_meta(token_or_key, arguments = nil)
|
|
307
308
|
Arguments
|
308
309
|
- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)*
|
309
310
|
|
310
|
-
#### Update<a name="method-
|
311
|
+
#### Update<a name="method-videos-update"></a>
|
311
312
|
|
312
313
|
Update single video by token or key.
|
313
314
|
|
@@ -341,7 +342,7 @@ ziggeo.videos().update_bulk(arguments = nil)
|
|
341
342
|
- expiration_days: *After how many days will this video be deleted*
|
342
343
|
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
343
344
|
|
344
|
-
#### Delete<a name="method-
|
345
|
+
#### Delete<a name="method-videos-delete"></a>
|
345
346
|
|
346
347
|
Delete a single video by token or key.
|
347
348
|
|
@@ -349,7 +350,7 @@ Delete a single video by token or key.
|
|
349
350
|
ziggeo.videos().delete(token_or_key)
|
350
351
|
```
|
351
352
|
|
352
|
-
#### Create<a name="method-
|
353
|
+
#### Create<a name="method-videos-create"></a>
|
353
354
|
|
354
355
|
Create a new video.
|
355
356
|
|
@@ -364,6 +365,9 @@ ziggeo.videos().create(arguments = nil, file = nil)
|
|
364
365
|
- tags: *Video Tags*
|
365
366
|
- key: *Unique (optional) name of video*
|
366
367
|
- volatile: *Automatically removed this video if it remains empty*
|
368
|
+
- effect_profile: *Set the effect profile that you want to have applied to your video.*
|
369
|
+
- meta_profile: *Set the meta profile that you want to have applied to your video once created.*
|
370
|
+
- video_profile: *Set the video profile that you want to have applied to your video as you create it.*
|
367
371
|
|
368
372
|
#### Analytics<a name="method-videos-analytics"></a>
|
369
373
|
|
@@ -384,7 +388,7 @@ ziggeo.videos().analytics(token_or_key, arguments = nil)
|
|
384
388
|
|
385
389
|
The streams resource allows you to directly access all streams associated with a single video.
|
386
390
|
|
387
|
-
#### Index<a name="method-
|
391
|
+
#### Index<a name="method-streams-index"></a>
|
388
392
|
|
389
393
|
Return all streams associated with a video
|
390
394
|
|
@@ -395,7 +399,7 @@ ziggeo.streams().index(video_token_or_key, arguments = nil)
|
|
395
399
|
Arguments
|
396
400
|
- states: *Filter streams by state*
|
397
401
|
|
398
|
-
#### Get<a name="method-
|
402
|
+
#### Get<a name="method-streams-get"></a>
|
399
403
|
|
400
404
|
Get a single stream
|
401
405
|
|
@@ -430,7 +434,7 @@ ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = n
|
|
430
434
|
Arguments
|
431
435
|
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
432
436
|
|
433
|
-
#### Delete<a name="method-
|
437
|
+
#### Delete<a name="method-streams-delete"></a>
|
434
438
|
|
435
439
|
Delete the stream
|
436
440
|
|
@@ -438,7 +442,7 @@ Delete the stream
|
|
438
442
|
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
439
443
|
```
|
440
444
|
|
441
|
-
#### Create<a name="method-
|
445
|
+
#### Create<a name="method-streams-create"></a>
|
442
446
|
|
443
447
|
Create a new stream
|
444
448
|
|
@@ -499,7 +503,7 @@ ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
|
|
499
503
|
|
500
504
|
The auth token resource allows you to manage authorization settings for video objects.
|
501
505
|
|
502
|
-
#### Get<a name="method-
|
506
|
+
#### Get<a name="method-authtokens-get"></a>
|
503
507
|
|
504
508
|
Get a single auth token by token.
|
505
509
|
|
@@ -507,7 +511,7 @@ Get a single auth token by token.
|
|
507
511
|
ziggeo.authtokens().get(token)
|
508
512
|
```
|
509
513
|
|
510
|
-
#### Update<a name="method-
|
514
|
+
#### Update<a name="method-authtokens-update"></a>
|
511
515
|
|
512
516
|
Update single auth token by token.
|
513
517
|
|
@@ -523,7 +527,7 @@ ziggeo.authtokens().update(token_or_key, arguments = nil)
|
|
523
527
|
- session_limit: *Maximal number of sessions*
|
524
528
|
- grants: *Permissions this tokens grants*
|
525
529
|
|
526
|
-
#### Delete<a name="method-
|
530
|
+
#### Delete<a name="method-authtokens-delete"></a>
|
527
531
|
|
528
532
|
Delete a single auth token by token.
|
529
533
|
|
@@ -531,7 +535,7 @@ Delete a single auth token by token.
|
|
531
535
|
ziggeo.authtokens().delete(token_or_key)
|
532
536
|
```
|
533
537
|
|
534
|
-
#### Create<a name="method-
|
538
|
+
#### Create<a name="method-authtokens-create"></a>
|
535
539
|
|
536
540
|
Create a new auth token.
|
537
541
|
|
@@ -552,7 +556,7 @@ ziggeo.authtokens().create(arguments = nil)
|
|
552
556
|
|
553
557
|
The application token resource allows you to manage your application.
|
554
558
|
|
555
|
-
#### Get<a name="method-
|
559
|
+
#### Get<a name="method-application-get"></a>
|
556
560
|
|
557
561
|
Read application.
|
558
562
|
|
@@ -560,7 +564,7 @@ Read application.
|
|
560
564
|
ziggeo.application().get()
|
561
565
|
```
|
562
566
|
|
563
|
-
#### Update<a name="method-
|
567
|
+
#### Update<a name="method-application-update"></a>
|
564
568
|
|
565
569
|
Update application.
|
566
570
|
|
@@ -595,7 +599,7 @@ ziggeo.application().get_stats(arguments = nil)
|
|
595
599
|
|
596
600
|
The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more.
|
597
601
|
|
598
|
-
#### Create<a name="method-
|
602
|
+
#### Create<a name="method-effect-profiles-create"></a>
|
599
603
|
|
600
604
|
Create a new effect profile.
|
601
605
|
|
@@ -608,7 +612,7 @@ ziggeo.effectProfiles().create(arguments = nil)
|
|
608
612
|
- title: *Effect profile title.*
|
609
613
|
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
610
614
|
|
611
|
-
#### Index<a name="method-
|
615
|
+
#### Index<a name="method-effect-profiles-index"></a>
|
612
616
|
|
613
617
|
Get list of effect profiles.
|
614
618
|
|
@@ -621,7 +625,7 @@ ziggeo.effectProfiles().index(arguments = nil)
|
|
621
625
|
- skip: *Skip the first [n] entries.*
|
622
626
|
- reverse: *Reverse the order in which effect profiles are returned.*
|
623
627
|
|
624
|
-
#### Get<a name="method-
|
628
|
+
#### Get<a name="method-effect-profiles-get"></a>
|
625
629
|
|
626
630
|
Get a single effect profile
|
627
631
|
|
@@ -629,7 +633,7 @@ Get a single effect profile
|
|
629
633
|
ziggeo.effectProfiles().get(token_or_key)
|
630
634
|
```
|
631
635
|
|
632
|
-
#### Delete<a name="method-
|
636
|
+
#### Delete<a name="method-effect-profiles-delete"></a>
|
633
637
|
|
634
638
|
Delete the effect profile
|
635
639
|
|
@@ -653,7 +657,7 @@ ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
|
653
657
|
|
654
658
|
The process resource allows you to directly access all process associated with a single effect profile.
|
655
659
|
|
656
|
-
#### Index<a name="method-
|
660
|
+
#### Index<a name="method-effect-profile-process-index"></a>
|
657
661
|
|
658
662
|
Return all processes associated with a effect profile
|
659
663
|
|
@@ -664,7 +668,7 @@ ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
|
|
664
668
|
Arguments
|
665
669
|
- states: *Filter streams by state*
|
666
670
|
|
667
|
-
#### Get<a name="method-
|
671
|
+
#### Get<a name="method-effect-profile-process-get"></a>
|
668
672
|
|
669
673
|
Get a single process
|
670
674
|
|
@@ -672,7 +676,7 @@ Get a single process
|
|
672
676
|
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
673
677
|
```
|
674
678
|
|
675
|
-
#### Delete<a name="method-
|
679
|
+
#### Delete<a name="method-effect-profile-process-delete"></a>
|
676
680
|
|
677
681
|
Delete the process
|
678
682
|
|
@@ -724,7 +728,7 @@ ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_
|
|
724
728
|
|
725
729
|
The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more.
|
726
730
|
|
727
|
-
#### Create<a name="method-
|
731
|
+
#### Create<a name="method-meta-profiles-create"></a>
|
728
732
|
|
729
733
|
Create a new meta profile.
|
730
734
|
|
@@ -736,7 +740,7 @@ ziggeo.metaProfiles().create(arguments = nil)
|
|
736
740
|
- key: *Meta Profile profile key.*
|
737
741
|
- title: *Meta Profile profile title.*
|
738
742
|
|
739
|
-
#### Index<a name="method-meta-
|
743
|
+
#### Index<a name="method-meta-profiles-index"></a>
|
740
744
|
|
741
745
|
Get list of meta profiles.
|
742
746
|
|
@@ -749,7 +753,7 @@ ziggeo.metaProfiles().index(arguments = nil)
|
|
749
753
|
- skip: *Skip the first [n] entries.*
|
750
754
|
- reverse: *Reverse the order in which meta profiles are returned.*
|
751
755
|
|
752
|
-
#### Get<a name="method-
|
756
|
+
#### Get<a name="method-meta-profiles-get"></a>
|
753
757
|
|
754
758
|
Get a single meta profile
|
755
759
|
|
@@ -757,7 +761,7 @@ Get a single meta profile
|
|
757
761
|
ziggeo.metaProfiles().get(token_or_key)
|
758
762
|
```
|
759
763
|
|
760
|
-
#### Delete<a name="method-
|
764
|
+
#### Delete<a name="method-meta-profiles-delete"></a>
|
761
765
|
|
762
766
|
Delete the meta profile
|
763
767
|
|
@@ -778,7 +782,7 @@ Return all processes associated with a meta profile
|
|
778
782
|
ziggeo.metaProfileProcess().index(meta_token_or_key)
|
779
783
|
```
|
780
784
|
|
781
|
-
#### Get<a name="method-
|
785
|
+
#### Get<a name="method-meta-profile-process-get"></a>
|
782
786
|
|
783
787
|
Get a single process
|
784
788
|
|
@@ -786,7 +790,7 @@ Get a single process
|
|
786
790
|
ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
|
787
791
|
```
|
788
792
|
|
789
|
-
#### Delete<a name="method-
|
793
|
+
#### Delete<a name="method-meta-profile-process-delete"></a>
|
790
794
|
|
791
795
|
Delete the process
|
792
796
|
|
@@ -821,6 +825,17 @@ ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = n
|
|
821
825
|
Arguments
|
822
826
|
- nsfw_action: *One of the following three: approve, reject, nothing.*
|
823
827
|
|
828
|
+
#### Create Profanity Process<a name="method-meta-profile-process-create-profanity-process"></a>
|
829
|
+
|
830
|
+
Create a new profanity filter meta process
|
831
|
+
|
832
|
+
```ruby
|
833
|
+
ziggeo.metaProfileProcess().create_profanity_process(meta_token_or_key, arguments = nil)
|
834
|
+
```
|
835
|
+
|
836
|
+
Arguments
|
837
|
+
- profanity_action: *One of the following three: approve, reject, nothing.*
|
838
|
+
|
824
839
|
### Webhooks<a name="method-webhooks"></a>
|
825
840
|
|
826
841
|
|
@@ -887,6 +902,6 @@ ziggeo.analytics().get(arguments = nil)
|
|
887
902
|
|
888
903
|
## License <a name="license"></a>
|
889
904
|
|
890
|
-
Copyright (c) 2013-
|
905
|
+
Copyright (c) 2013-2021 Ziggeo
|
891
906
|
|
892
907
|
Apache 2.0 License
|
data/lib/Ziggeo.rb
CHANGED
@@ -72,47 +72,58 @@ class Ziggeo
|
|
72
72
|
end
|
73
73
|
|
74
74
|
def auth()
|
75
|
-
|
75
|
+
@auth = @auth || ZiggeoAuth.new(self)
|
76
|
+
return @auth
|
76
77
|
end
|
77
78
|
|
78
79
|
def videos()
|
79
|
-
|
80
|
+
@videos = @videos || ZiggeoVideos.new(self)
|
81
|
+
return @videos
|
80
82
|
end
|
81
83
|
|
82
84
|
def streams()
|
83
|
-
|
85
|
+
@streams = @streams || ZiggeoStreams.new(self)
|
86
|
+
return @streams
|
84
87
|
end
|
85
88
|
|
86
89
|
def authtokens()
|
87
|
-
|
90
|
+
@authtokens = @authtokens || ZiggeoAuthtokens.new(self)
|
91
|
+
return @authtokens
|
88
92
|
end
|
89
93
|
|
90
94
|
def application()
|
91
|
-
|
95
|
+
@application = @application || ZiggeoApplication.new(self)
|
96
|
+
return @application
|
92
97
|
end
|
93
98
|
|
94
99
|
def effectProfiles()
|
95
|
-
|
100
|
+
@effectProfiles = @effectProfiles || ZiggeoEffectProfiles.new(self)
|
101
|
+
return @effectProfiles
|
96
102
|
end
|
97
103
|
|
98
104
|
def effectProfileProcess()
|
99
|
-
|
105
|
+
@effectProfileProcess = @effectProfileProcess || ZiggeoEffectProfileProcess.new(self)
|
106
|
+
return @effectProfileProcess
|
100
107
|
end
|
101
108
|
|
102
109
|
def metaProfiles()
|
103
|
-
|
110
|
+
@metaProfiles = @metaProfiles || ZiggeoMetaProfiles.new(self)
|
111
|
+
return @metaProfiles
|
104
112
|
end
|
105
113
|
|
106
114
|
def metaProfileProcess()
|
107
|
-
|
115
|
+
@metaProfileProcess = @metaProfileProcess || ZiggeoMetaProfileProcess.new(self)
|
116
|
+
return @metaProfileProcess
|
108
117
|
end
|
109
118
|
|
110
119
|
def webhooks()
|
111
|
-
|
120
|
+
@webhooks = @webhooks || ZiggeoWebhooks.new(self)
|
121
|
+
return @webhooks
|
112
122
|
end
|
113
123
|
|
114
124
|
def analytics()
|
115
|
-
|
125
|
+
@analytics = @analytics || ZiggeoAnalytics.new(self)
|
126
|
+
return @analytics
|
116
127
|
end
|
117
128
|
|
118
129
|
end
|
data/lib/classes/ZiggeoConfig.rb
CHANGED
@@ -5,10 +5,10 @@ class ZiggeoConfig
|
|
5
5
|
def initialize()
|
6
6
|
@request_timeout = 30 # seconds
|
7
7
|
@request_timeout_per_mb = 20 # seconds per MB of uploaded file
|
8
|
-
@server_api_url = "https://
|
8
|
+
@server_api_url = "https://srv-api.ziggeo.com"
|
9
9
|
@api_url = "https://api-us-east-1.ziggeo.com"
|
10
10
|
@cdn_url = "https://video-cdn.ziggeo.com"
|
11
|
-
@regions = {"r1" => "https://
|
11
|
+
@regions = {"r1" => "https://srv-api-eu-west-1.ziggeo.com", }
|
12
12
|
@api_regions = {"r1" => "https://api-eu-west-1.ziggeo.com", }
|
13
13
|
@cdn_regions = {"r1" => "https://video-cdn-eu-west-1.ziggeo.com", }
|
14
14
|
@resilience_factor = 5
|
@@ -28,4 +28,8 @@ class ZiggeoMetaProfileProcess
|
|
28
28
|
return @application.connect.postJSON('/v1/metaprofiles/' + meta_token_or_key + '/process/nsfw', data)
|
29
29
|
end
|
30
30
|
|
31
|
+
def create_profanity_process(meta_token_or_key, data = nil)
|
32
|
+
return @application.connect.postJSON('/v1/metaprofiles/' + meta_token_or_key + '/process/profanity', data)
|
33
|
+
end
|
34
|
+
|
31
35
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: Ziggeo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: '2.
|
4
|
+
version: '2.24'
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ziggeo, Inc
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|