uiza_minh_phong 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rubocop.yml +535 -0
- data/.rubocop_disable.yml +78 -0
- data/.rubocop_enable.yml +786 -0
- data/CHANGELOG.md +50 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTORS.txt +3 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +73 -0
- data/History.txt +1 -0
- data/LICENSE.txt +21 -0
- data/PULL_REQUEST_TEMPLATE.md +44 -0
- data/README.md +248 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/ANALYTIC.md +143 -0
- data/doc/CALLBACK.md +161 -0
- data/doc/CATEGORY.md +312 -0
- data/doc/EMBED_METADATA.md +4 -0
- data/doc/ENTITY.md +470 -0
- data/doc/ERRORS_CODE.md +60 -0
- data/doc/LIVE_STREAMING.md +452 -0
- data/doc/STORAGE.md +188 -0
- data/doc/USER.md +286 -0
- data/lib/uiza.rb +39 -0
- data/lib/uiza/analytic.rb +42 -0
- data/lib/uiza/api_operation/add.rb +16 -0
- data/lib/uiza/api_operation/create.rb +16 -0
- data/lib/uiza/api_operation/delete.rb +15 -0
- data/lib/uiza/api_operation/list.rb +14 -0
- data/lib/uiza/api_operation/remove.rb +15 -0
- data/lib/uiza/api_operation/retrieve.rb +15 -0
- data/lib/uiza/api_operation/update.rb +16 -0
- data/lib/uiza/callback.rb +16 -0
- data/lib/uiza/category.rb +42 -0
- data/lib/uiza/entity.rb +68 -0
- data/lib/uiza/error/bad_request_error.rb +8 -0
- data/lib/uiza/error/client_error.rb +8 -0
- data/lib/uiza/error/internal_server_error.rb +8 -0
- data/lib/uiza/error/not_found_error.rb +8 -0
- data/lib/uiza/error/server_error.rb +8 -0
- data/lib/uiza/error/service_unavailable_error.rb +8 -0
- data/lib/uiza/error/uiza_error.rb +18 -0
- data/lib/uiza/error/unauthorized_error.rb +8 -0
- data/lib/uiza/error/unprocessable_error.rb +8 -0
- data/lib/uiza/live.rb +86 -0
- data/lib/uiza/storage.rb +17 -0
- data/lib/uiza/uiza_client.rb +86 -0
- data/lib/uiza/uiza_open_struct.rb +18 -0
- data/lib/uiza/user.rb +41 -0
- data/lib/uiza/version.rb +3 -0
- data/uiza.gemspec +36 -0
- metadata +141 -0
data/CHANGELOG.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
## 1.0.1 - 2019-02-23
|
4
|
+
[#72](https://github.com/uizaio/api-wrapper-ruby/pull/72) Reslease Sprint 3
|
5
|
+
1. Add Live
|
6
|
+
|
7
|
+
2. Add Callback
|
8
|
+
|
9
|
+
## 1.0.0 - 2019-02-25
|
10
|
+
Publish gem to https://rubygems.org
|
11
|
+
|
12
|
+
## 0.1.0 - 2019-02-21
|
13
|
+
[#53](https://github.com/uizaio/api-wrapper-ruby/pull/53) Release Sprint 2
|
14
|
+
1. Add APIOperation
|
15
|
+
- `Uiza::APIOperation::Add`
|
16
|
+
- `Uiza::APIOperation::Remove`
|
17
|
+
|
18
|
+
2. Remove APIResource
|
19
|
+
|
20
|
+
3. Add Storage
|
21
|
+
|
22
|
+
4. Add Category
|
23
|
+
|
24
|
+
## 0.1.0 - 2019-02-18
|
25
|
+
[#39](https://github.com/uizaio/api-wrapper-ruby/pull/39) Release Sprint 1
|
26
|
+
1. Add APIOperation
|
27
|
+
- `Uiza::APIOperation::Create`
|
28
|
+
- `Uiza::APIOperation::Retrieve`
|
29
|
+
- `Uiza::APIOperation::List`
|
30
|
+
- `Uiza::APIOperation::Update`
|
31
|
+
- `Uiza::APIOperation::Delete`
|
32
|
+
|
33
|
+
2. Add APIResource
|
34
|
+
- `Uiza::APIResource::EntityResource`
|
35
|
+
|
36
|
+
3. Add Error
|
37
|
+
- `Uiza::Error::UizaError`
|
38
|
+
- `Uiza::Error::BadRequestError`
|
39
|
+
- `Uiza::Error::ClientError`
|
40
|
+
- `Uiza::Error::InternalServerError`
|
41
|
+
- `Uiza::Error::NotFoundError`
|
42
|
+
- `Uiza::Error::ServerError`
|
43
|
+
- `Uiza::Error::ServiceUnavailableError`
|
44
|
+
- `Uiza::Error::UnauthorizedError`
|
45
|
+
- `Uiza::Error::UnprocessableError`
|
46
|
+
|
47
|
+
4. Add Entity
|
48
|
+
|
49
|
+
## 0.1.0 - 2019-02-12
|
50
|
+
[#1](https://github.com/uizaio/api-wrapper-ruby/pull/1) Init project
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at tanthanhcr95@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/CONTRIBUTORS.txt
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
uiza (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
addressable (2.6.0)
|
10
|
+
public_suffix (>= 2.0.2, < 4.0)
|
11
|
+
ast (2.4.0)
|
12
|
+
crack (0.4.3)
|
13
|
+
safe_yaml (~> 1.0.0)
|
14
|
+
diff-lcs (1.3)
|
15
|
+
docile (1.3.1)
|
16
|
+
hashdiff (0.3.8)
|
17
|
+
jaro_winkler (1.5.2)
|
18
|
+
json (2.2.0)
|
19
|
+
parallel (1.13.0)
|
20
|
+
parser (2.6.0.0)
|
21
|
+
ast (~> 2.4.0)
|
22
|
+
powerpack (0.1.2)
|
23
|
+
public_suffix (3.0.3)
|
24
|
+
rainbow (3.0.0)
|
25
|
+
rake (10.5.0)
|
26
|
+
rspec (3.8.0)
|
27
|
+
rspec-core (~> 3.8.0)
|
28
|
+
rspec-expectations (~> 3.8.0)
|
29
|
+
rspec-mocks (~> 3.8.0)
|
30
|
+
rspec-core (3.8.0)
|
31
|
+
rspec-support (~> 3.8.0)
|
32
|
+
rspec-expectations (3.8.2)
|
33
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
34
|
+
rspec-support (~> 3.8.0)
|
35
|
+
rspec-mocks (3.8.0)
|
36
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
37
|
+
rspec-support (~> 3.8.0)
|
38
|
+
rspec-support (3.8.0)
|
39
|
+
rubocop (0.64.0)
|
40
|
+
jaro_winkler (~> 1.5.1)
|
41
|
+
parallel (~> 1.10)
|
42
|
+
parser (>= 2.5, != 2.5.1.1)
|
43
|
+
powerpack (~> 0.1)
|
44
|
+
rainbow (>= 2.2.2, < 4.0)
|
45
|
+
ruby-progressbar (~> 1.7)
|
46
|
+
unicode-display_width (~> 1.4.0)
|
47
|
+
ruby-progressbar (1.10.0)
|
48
|
+
safe_yaml (1.0.4)
|
49
|
+
simplecov (0.16.1)
|
50
|
+
docile (~> 1.1)
|
51
|
+
json (>= 1.8, < 3)
|
52
|
+
simplecov-html (~> 0.10.0)
|
53
|
+
simplecov-html (0.10.2)
|
54
|
+
unicode-display_width (1.4.1)
|
55
|
+
webmock (3.5.1)
|
56
|
+
addressable (>= 2.3.6)
|
57
|
+
crack (>= 0.3.2)
|
58
|
+
hashdiff
|
59
|
+
|
60
|
+
PLATFORMS
|
61
|
+
ruby
|
62
|
+
|
63
|
+
DEPENDENCIES
|
64
|
+
bundler (~> 2.0)
|
65
|
+
rake (~> 10.0)
|
66
|
+
rspec (~> 3.0)
|
67
|
+
rubocop
|
68
|
+
simplecov
|
69
|
+
uiza!
|
70
|
+
webmock
|
71
|
+
|
72
|
+
BUNDLED WITH
|
73
|
+
2.0.1
|
data/History.txt
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
History.txt has been converted to a formal changelog. Please see CHANGELOG.md.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2010-2018 Uiza Pte. Ltd. https://www.uiza.io
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
@@ -0,0 +1,44 @@
|
|
1
|
+
## Related Tickets
|
2
|
+
|
3
|
+
- [#TicketID](https://dev.framgia.com/issues/xxx)
|
4
|
+
|
5
|
+
## What's this PR do ?
|
6
|
+
|
7
|
+
- [x] Implement function A
|
8
|
+
- [x] Fix bugs on function B
|
9
|
+
|
10
|
+
## Library
|
11
|
+
*(List gem, library third party add new include version)*
|
12
|
+
|
13
|
+
- Gem devise v1.2.0
|
14
|
+
- Library: google-analysis.js
|
15
|
+
|
16
|
+
## Impacted Areas in Application
|
17
|
+
*(List features, api, models or services that this PR will affect)*
|
18
|
+
|
19
|
+
- foo/bar
|
20
|
+
- bar/baz
|
21
|
+
|
22
|
+
## Performance
|
23
|
+
|
24
|
+
- [ ] Resolved n + 1 query
|
25
|
+
- [ ] Run explain query already
|
26
|
+
- [ ] Time run rake task : 1000 ms
|
27
|
+
|
28
|
+
## Checklist
|
29
|
+
|
30
|
+
- [ ] It was tested in local success?
|
31
|
+
- [ ] Fill link PR into ticket and the opposite
|
32
|
+
- [ ] Note reason, scope of influence, solution into ticket
|
33
|
+
- [ ] Validate UI/Model/API
|
34
|
+
|
35
|
+
## Deploy Notes
|
36
|
+
*(List rake task command, environment variable need config after deploy)*
|
37
|
+
|
38
|
+
```sh
|
39
|
+
rake course:import
|
40
|
+
export ENVIRONMENT_VARIABLE = "abcxyz"
|
41
|
+
```
|
42
|
+
|
43
|
+
## Notes
|
44
|
+
*(Other notes)*
|
data/README.md
ADDED
@@ -0,0 +1,248 @@
|
|
1
|
+
# Uiza
|
2
|
+
|
3
|
+
## Introduction
|
4
|
+
This is documents the public API for Uiza version 3.0.
|
5
|
+
|
6
|
+
The Uiza API is organized around RESTful standard.
|
7
|
+
Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
|
8
|
+
JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
|
9
|
+
|
10
|
+
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
|
11
|
+
|
12
|
+
## Authentication
|
13
|
+
In order, to use the Uiza, you should follow these steps:
|
14
|
+
|
15
|
+
* **Step 1:** Having an active Uiza account. (If you don't have, please get [here](https://id.uiza.io/))
|
16
|
+
* **Step 2:** Once you have an Uiza account, you can get a Token to call the APIs.
|
17
|
+
|
18
|
+
This Token will have right & permission related with your account.
|
19
|
+
|
20
|
+
|
21
|
+
## Installation
|
22
|
+
Add this line to your application's Gemfile:
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
gem "uiza"
|
26
|
+
```
|
27
|
+
|
28
|
+
And then execute:
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
$ bundle
|
32
|
+
```
|
33
|
+
|
34
|
+
Or install it yourself as:
|
35
|
+
|
36
|
+
```ruby
|
37
|
+
$ gem install uiza
|
38
|
+
```
|
39
|
+
|
40
|
+
### Requirements
|
41
|
+
* Ruby 2.0+.
|
42
|
+
|
43
|
+
## Usage
|
44
|
+
The library needs to be configured with your account's `workspace_api_domain` and `authorization` (API key).\
|
45
|
+
Set `Uiza.workspace_api_domain` and `Uiza.authorization` with your values:
|
46
|
+
|
47
|
+
See details [here](https://docs.uiza.io/#authentication).
|
48
|
+
|
49
|
+
## Ruby
|
50
|
+
```ruby
|
51
|
+
require "uiza"
|
52
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
53
|
+
Uiza.authorization = "your-authorization"
|
54
|
+
```
|
55
|
+
|
56
|
+
## ROR
|
57
|
+
Create file `your-app/config/initializers/uiza.rb`
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
Uiza.workspace_api_domain = ENV["WORKSPACE_API_DOMAIN"]
|
61
|
+
Uiza.authorization = ENV["AUTHORIZATION"]
|
62
|
+
```
|
63
|
+
|
64
|
+
## Entity
|
65
|
+
These below APIs used to take action with your media files (we called Entity).
|
66
|
+
|
67
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ENTITY.md).
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
begin
|
71
|
+
entity = Uiza::Entity.retrieve "your-entity-id"
|
72
|
+
puts entity.id
|
73
|
+
puts entity.name
|
74
|
+
rescue Uiza::Error::UizaError => e
|
75
|
+
puts "description_link: #{e.description_link}"
|
76
|
+
puts "code: #{e.code}"
|
77
|
+
puts "message: #{e.message}"
|
78
|
+
rescue StandardError => e
|
79
|
+
puts "message: #{e.message}"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
## Category
|
84
|
+
Category has been splits into 3 types: `folder`, `playlist` and `tag`. These will make the management of entity more easier.
|
85
|
+
|
86
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CATEGORY.md).
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
require "uiza"
|
90
|
+
|
91
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
92
|
+
Uiza.authorization = "your-authorization"
|
93
|
+
|
94
|
+
begin
|
95
|
+
category = Uiza::Category.retrieve "your-category-id"
|
96
|
+
puts category.id
|
97
|
+
puts category.name
|
98
|
+
rescue Uiza::Error::UizaError => e
|
99
|
+
puts "description_link: #{e.description_link}"
|
100
|
+
puts "code: #{e.code}"
|
101
|
+
puts "message: #{e.message}"
|
102
|
+
rescue StandardError => e
|
103
|
+
puts "message: #{e.message}"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
## Storage
|
108
|
+
You can add your storage (`FTP`, `AWS S3`) with UIZA.
|
109
|
+
After synced, you can select your content easier from your storage to [create entity](https://docs.uiza.io/#create-entity).
|
110
|
+
|
111
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/STORAGE.md).
|
112
|
+
|
113
|
+
```ruby
|
114
|
+
require "json"
|
115
|
+
|
116
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
117
|
+
Uiza.authorization = "your-authorization"
|
118
|
+
|
119
|
+
begin
|
120
|
+
storage = Uiza::Storage.retrieve "your-storage-id"
|
121
|
+
puts storage.id
|
122
|
+
puts storage.name
|
123
|
+
rescue Uiza::Error::UizaError => e
|
124
|
+
puts "description_link: #{e.description_link}"
|
125
|
+
puts "code: #{e.code}"
|
126
|
+
puts "message: #{e.message}"
|
127
|
+
rescue StandardError => e
|
128
|
+
puts "message: #{e.message}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
## Live Streaming
|
133
|
+
These APIs used to create and manage live streaming event.
|
134
|
+
* When a Live is not start : it's named as `Event`.
|
135
|
+
* When have an `Event` , you can start it : it's named as `Feed`.
|
136
|
+
|
137
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/LIVE_STREAMING.md).
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
require "json"
|
141
|
+
|
142
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
143
|
+
Uiza.authorization = "your-authorization"
|
144
|
+
|
145
|
+
begin
|
146
|
+
live = Uiza::Live.retrieve "your-live-id"
|
147
|
+
puts live.id
|
148
|
+
puts live.name
|
149
|
+
rescue Uiza::Error::UizaError => e
|
150
|
+
puts "description_link: #{e.description_link}"
|
151
|
+
puts "code: #{e.code}"
|
152
|
+
puts "message: #{e.message}"
|
153
|
+
rescue StandardError => e
|
154
|
+
puts "message: #{e.message}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
## Callback
|
159
|
+
Callback used to retrieve an information for Uiza to your server, so you can have a trigger notice about an entity is upload completed and .
|
160
|
+
|
161
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CALLBACK.md).
|
162
|
+
|
163
|
+
```ruby
|
164
|
+
require "json"
|
165
|
+
|
166
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
167
|
+
Uiza.authorization = "your-authorization"
|
168
|
+
|
169
|
+
begin
|
170
|
+
callback = Uiza::Live.retrieve "your-callback-id"
|
171
|
+
puts callback.id
|
172
|
+
puts callback.url
|
173
|
+
rescue Uiza::Error::UizaError => e
|
174
|
+
puts "description_link: #{e.description_link}"
|
175
|
+
puts "code: #{e.code}"
|
176
|
+
puts "message: #{e.message}"
|
177
|
+
rescue StandardError => e
|
178
|
+
puts "message: #{e.message}"
|
179
|
+
end
|
180
|
+
```
|
181
|
+
|
182
|
+
## User Management
|
183
|
+
You can manage user with APIs user. Uiza have 2 levels of user:
|
184
|
+
Admin - This account will have the highest priority, can have permission to create & manage users.
|
185
|
+
User - This account level is under Admin level. It only manages APIs that relates to this account.
|
186
|
+
|
187
|
+
See details [here](https://docs.uiza.io/#user-management).
|
188
|
+
|
189
|
+
```ruby
|
190
|
+
require "json"
|
191
|
+
|
192
|
+
Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
|
193
|
+
Uiza.authorization = "your-authorization"
|
194
|
+
|
195
|
+
begin
|
196
|
+
user = Uiza::User.retrieve "your-user-id"
|
197
|
+
puts user.id
|
198
|
+
puts user.username
|
199
|
+
rescue Uiza::Error::UizaError => e
|
200
|
+
puts "description_link: #{e.description_link}"
|
201
|
+
puts "code: #{e.code}"
|
202
|
+
puts "message: #{e.message}"
|
203
|
+
rescue StandardError => e
|
204
|
+
puts "message: #{e.message}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
## Analytic
|
209
|
+
Monitor the four key dimensions of video QoS: playback failures, startup time, rebuffering, and video quality.
|
210
|
+
These 15 metrics help you track playback performance, so your team can know exactly what’s going on.
|
211
|
+
|
212
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ANALYTIC.md).
|
213
|
+
|
214
|
+
## Embed Metadata
|
215
|
+
Embed metadata is information that can be embed into video/audio file. You can embed into file by adding a json compose these tag.
|
216
|
+
|
217
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/EMBED_METADATA.md).
|
218
|
+
|
219
|
+
## Errors Code
|
220
|
+
Uiza uses conventional HTTP response codes to indicate the success or failure of an API request.
|
221
|
+
In general: Codes in the `2xx` range indicate success.
|
222
|
+
Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
|
223
|
+
Codes in the `5xx` range indicate an error with Uiza's servers.
|
224
|
+
|
225
|
+
See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ERRORS_CODE.md).
|
226
|
+
|
227
|
+
## Development
|
228
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
229
|
+
|
230
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
231
|
+
|
232
|
+
## Testing
|
233
|
+
Run below command to run rspec for project.
|
234
|
+
```ruby
|
235
|
+
bundle exec rspec spec
|
236
|
+
```
|
237
|
+
|
238
|
+
Open `coverage/index.html` to see coversage of RSpec.
|
239
|
+
See details [here](https://github.com/colszowka/simplecov).
|
240
|
+
|
241
|
+
## Contributing
|
242
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/uizaio/api-wrapper-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
243
|
+
|
244
|
+
## License
|
245
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
246
|
+
|
247
|
+
## Code of Conduct
|
248
|
+
Everyone interacting in the Uiza project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/uizaio/api-wrapper-ruby/blob/master/CODE_OF_CONDUCT.md).
|