uiza 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## 0.1.0 - 2019-02-21
+[#53](https://github.com/uizaio/api-wrapper-ruby/pull/53) Release Sprint 2
+1. Add APIOperation
+- `Uiza::APIOperation::Add`
+- `Uiza::APIOperation::Remove`
+
+2. Remove APIResource
+
+3. Add Storage
+
+4. Add Category
+
+## 0.1.0 - 2019-02-18
+[#39](https://github.com/uizaio/api-wrapper-ruby/pull/39) Release Sprint 1
+1. Add APIOperation
+- `Uiza::APIOperation::Create`
+- `Uiza::APIOperation::Retrieve`
+- `Uiza::APIOperation::List`
+- `Uiza::APIOperation::Update`
+- `Uiza::APIOperation::Delete`
+
+2. Add APIResource
+- `Uiza::APIResource::EntityResource`
+
+3. Add Error
+- `Uiza::Error::UizaError`
+- `Uiza::Error::BadRequestError`
+- `Uiza::Error::ClientError`
+- `Uiza::Error::InternalServerError`
+- `Uiza::Error::NotFoundError`
+- `Uiza::Error::ServerError`
+- `Uiza::Error::ServiceUnavailableError`
+- `Uiza::Error::UnauthorizedError`
+- `Uiza::Error::UnprocessableError`
+
+4. Add Entity
+
+## 0.1.0 - 2019-02-12
+[#1](https://github.com/uizaio/api-wrapper-ruby/pull/1) Init project

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tanthanhcr95@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTORS.txt

@@ -0,0 +1,3 @@
+Le Tan Thanh <le.tan.thanh@framgia.com>
+Nguyen Thi Dieu <nguyen.thi.dieu@framgia.com>
+Nguyen Tien Trung <nguyen.tien.trung@framgia.com>

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "rubocop"
+gem "webmock"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    uiza (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.64.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.4.1)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  uiza!
+  webmock
+
+BUNDLED WITH
+   2.0.1

data/History.txt

@@ -0,0 +1 @@
+History.txt has been converted to a formal changelog. Please see CHANGELOG.md.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Uiza (https://uiza.io/)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,44 @@
+## Related Tickets
+
+- [#TicketID](https://dev.framgia.com/issues/xxx)
+
+## What's this PR do ?
+
+- [x] Implement function A
+- [x] Fix bugs on function B
+
+## Library
+*(List gem, library third party add new include version)*
+
+- Gem devise v1.2.0
+- Library: google-analysis.js
+
+## Impacted Areas in Application
+*(List features, api, models or services that this PR will affect)*
+
+- foo/bar
+- bar/baz
+
+## Performance
+
+- [ ] Resolved n + 1 query
+- [ ] Run explain query already
+- [ ] Time run rake task : 1000 ms
+
+## Checklist
+
+- [ ] It was tested in local success?
+- [ ] Fill link PR into ticket and the opposite
+- [ ] Note reason, scope of influence, solution into ticket
+- [ ] Validate UI/Model/API
+
+## Deploy Notes
+*(List rake task command, environment variable need config after deploy)*
+
+```sh
+rake course:import
+export ENVIRONMENT_VARIABLE = "abcxyz"
+```
+
+## Notes
+*(Other notes)*

data/README.md

@@ -0,0 +1,179 @@
+# Uiza
+
+## Introduction
+This is documents the public API for Uiza version 3.0.
+
+The Uiza API is organized around RESTful standard.
+Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.
+JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
+
+All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
+
+## Authentication
+In order, to use the Uiza, you should follow these steps:
+
+* **Step 1:** Having an active Uiza account. (If you don't have, please get [here](https://id.uiza.io/))
+* **Step 2:** Once you have an Uiza account, you can get a Token to call the APIs.
+
+This Token will have right & permission related with your account.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "uiza"
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install uiza
+```
+
+### Requirements
+* Ruby 2.0+.
+
+## Usage
+The library needs to be configured with your account's `workspace_api_domain` and `authorization` (API key).\
+Set `Uiza.workspace_api_domain` and `Uiza.authorization` with your values:
+
+See details [here](https://docs.uiza.io/#authentication).
+
+## Ruby
+```ruby
+require "uiza"
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+```
+
+## ROR
+Create file `your-app/config/initializers/uiza.rb`
+
+```ruby
+Uiza.workspace_api_domain = ENV["WORKSPACE_API_DOMAIN"]
+Uiza.authorization = ENV["AUTHORIZATION"]
+```
+
+## Entity
+These below APIs used to take action with your media files (we called Entity).
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ENTITY.md).
+
+```ruby
+begin
+  entity = Uiza::Entity.retrieve "your-entity-id"
+  puts entity.id
+  puts entity.name
+rescue Uiza::Error::UizaError => e
+  puts "description_link: #{e.description_link}"
+  puts "code: #{e.code}"
+  puts "message: #{e.message}"
+rescue StandardError => e
+  puts "message: #{e.message}"
+end
+```
+
+## Category
+Category has been splits into 3 types: `folder`, `playlist` and `tag`. These will make the management of entity more easier.
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CATEGORY.md).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  category = Uiza::Category.retrieve "your-category-id"
+  puts category.id
+  puts category.name
+rescue Uiza::Error::UizaError => e
+  puts "description_link: #{e.description_link}"
+  puts "code: #{e.code}"
+  puts "message: #{e.message}"
+rescue StandardError => e
+  puts "message: #{e.message}"
+end
+```
+
+## Storage
+You can add your storage (`FTP`, `AWS S3`) with UIZA.
+After synced, you can select your content easier from your storage to [create entity](https://docs.uiza.io/#create-entity).
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/STORAGE.md).
+
+```ruby
+require "json"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  storage = Uiza::Storage.retrieve "your-storage-id"
+  puts storage.id
+  puts storage.name
+rescue Uiza::Error::UizaError => e
+  puts "description_link: #{e.description_link}"
+  puts "code: #{e.code}"
+  puts "message: #{e.message}"
+rescue StandardError => e
+  puts "message: #{e.message}"
+end
+```
+
+## Live Streaming
+These APIs used to create and manage live streaming event.
+* When a Live is not start : it's named as `Event`.
+* When have an `Event` , you can start it : it's named as `Feed`.
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/LIVE_STREAMING.md).
+
+## Callback
+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 .
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/CALLBACK.md).
+
+## Analytic
+Monitor the four key dimensions of video QoS: playback failures, startup time, rebuffering, and video quality.
+These 15 metrics help you track playback performance, so your team can know exactly what’s going on.
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ANALYTIC.md).
+
+## Embed Metadata
+Embed metadata is information that can be embed into video/audio file. You can embed into file by adding a json compose these tag.
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/EMBED_METADATA.md).
+
+## Errors Code
+Uiza uses conventional HTTP response codes to indicate the success or failure of an API request.
+In general: Codes in the `2xx` range indicate success.
+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.).
+Codes in the `5xx` range indicate an error with Uiza's servers.
+
+See details [here](https://github.com/uizaio/api-wrapper-ruby/blob/develop/doc/ERRORS_CODE.md).
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec