uiza_minh_phong 0.4.0

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uiza"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/doc/ANALYTIC.md

@@ -0,0 +1,143 @@
+## 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://docs.uiza.io/#analytic).
+
+## Total Line
+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.
+
+See details [here](https://docs.uiza.io/#total-line).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  start_date: "YYYY-MM-DD hh:mm",
+  end_date: "YYYY-MM-DD hh:mm",
+  metric: "rebuffer_count"
+}
+
+begin
+  response = Uiza::Analytic.get_total_line params
+  puts response.first.rebuffer_count
+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
+```
+
+Example Response
+```ruby
+[
+  {
+    "date_time": 1542978000000,
+    "rebuffer_count": 1.6666666666666667
+  },
+  {
+    "date_time": 1543215600000,
+    "rebuffer_count": 5
+  }
+]
+```
+
+## Type
+Get data base on 4 type of filter: country, device, title, player
+
+See details [here](https://docs.uiza.io/#type).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  start_date: "YYYY-MM-DD hh:mm",
+  end_date: "YYYY-MM-DD hh:mm",
+  type_filter: "country"
+}
+
+begin
+  response = Uiza::Analytic.get_type params
+  puts response.first.name
+  puts response.first.total_view
+  puts response.first.percentage_of_view
+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
+```
+
+Example Response
+```ruby
+[
+  {
+    "name": "Vietnam",
+    "total_view": 15,
+    "percentage_of_view": 0.625
+  },
+  {
+    "name": "Other",
+    "total_view": 9,
+    "percentage_of_view": 0.375
+  }
+]
+```
+
+## Line
+Get data grouped by hour. Get total view in time range. This help you to draw a line chart to visualize data
+
+See details [here](https://docs.uiza.io/#line).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  start_date: "YYYY-MM-DD hh:mm",
+  end_date: "YYYY-MM-DD hh:mm",
+  type: "your-metric-type"
+}
+
+begin
+  response = Uiza::Analytic.get_line params
+  puts response.first.day_time
+  puts response.first.value
+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
+```
+
+Example Response
+```ruby
+[
+  {
+    "day_time": 1541548800000,
+    "value": 4
+  },
+  {
+    "day_time": 1541635200000,
+    "value": 5
+  },
+  {
+    "day_time": 1541721600000,
+    "value": 5
+  }
+]
+```

data/doc/CALLBACK.md

@@ -0,0 +1,161 @@
+## 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://docs.uiza.io/#callback).
+
+## Create a callback
+This API will allow you setup a callback to your server when an entity is completed for upload or public
+
+See details [here](https://docs.uiza.io/#create-a-callback).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  url: "https://callback-url.uiza.co",
+  method: "POST"
+}
+
+begin
+  callback = Uiza::Callback.create params
+  puts callback.id
+  puts callback.url
+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
+```
+
+Example Response
+```ruby
+{
+  "id": "0a6bf245-1cce-494f-a193-b5a44aa05558",
+  "url": "https://callback-url.uiza.co",
+  "headersData": null,
+  "jsonData": null,
+  "method": "POST",
+  "status": 1,
+  "createdAt": "2018-06-23T01:27:08.000Z",
+  "updatedAt": "2018-06-23T01:27:08.000Z"
+}
+```
+
+## Retrieve a callback
+Retrieves the details of an existing callback.
+
+See details [here](https://docs.uiza.io/#retrieve-a-callback).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  callback = Uiza::Callback.retrieve "your-callback-id"
+  puts callback.id
+  puts callback.url
+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
+```
+
+Example Response
+```ruby
+{
+  "id": "0a6bf245-1cce-494f-a193-b5a44aa05558",
+  "url": "https://callback-url.uiza.co",
+  "headersData": null,
+  "jsonData": {
+    "text": "example callback"
+  },
+  "method": "POST",
+  "status": 1,
+  "createdAt": "2018-06-23T01:27:08.000Z",
+  "updatedAt": "2018-06-23T01:27:08.000Z"
+}
+```
+
+## Update a callback
+This API will allow you setup a callback to your server when an entity is completed for upload or public
+
+See details [here](https://docs.uiza.io/#update-a-callback).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  id: "your-callback-id",
+  url: "https://callback-url.uiza.co",
+  method: "GET"
+}
+
+begin
+  callback = Uiza::Callback.update params
+  puts callback.id
+  puts callback.url
+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
+```
+
+Example Response
+```ruby
+{
+  "id": "your-callback-id",
+  "url": "https://callback-url.uiza.co",
+  "headersData": null,
+  "jsonData": null,
+  "method": "GET",
+  "status": 1,
+  "createdAt": "2018-06-23T01:27:08.000Z",
+  "updatedAt": "2018-06-23T01:27:08.000Z"
+}
+```
+
+## Delete a callback
+Delete an existing callback.
+
+See details [here](https://docs.uiza.io/#delete-a-callback).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  callback = Uiza::Callback.delete "your-callback-id"
+  puts callback.id
+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
+```
+
+Example Response
+```ruby
+{
+  "id": "your-callback-id"
+}
+```

data/doc/CATEGORY.md

@@ -0,0 +1,312 @@
+## 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://docs.uiza.io/#category).
+
+## Create category
+Create category for entity for easier management.
+Category use to group all the same entities into a group (like `Folder`/`playlist` or `tag`).
+
+See details [here](https://docs.uiza.io/#create-category).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  name: "Folder sample",
+  type: "folder",
+  description: "Folder description"
+}
+
+begin
+  category = Uiza::Category.create params
+  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
+```
+
+Example Response
+```ruby
+{
+  "id": "f932aa79-852a-41f7-9adc-19935034f944",
+  "name": "Playlist sample",
+  "description": "Playlist description",
+  "slug": "playlist-sample",
+  "type": "playlist",
+  "orderNumber": 3,
+  "icon": "https:///example.com/image002.png",
+  "status": 1,
+  "createdAt": "2018-06-18T04:29:05.000Z",
+  "updatedAt": "2018-06-18T04:29:05.000Z"
+}
+```
+
+## Retrieve category
+Get detail of category.
+
+See details [here](https://docs.uiza.io/?shell#retrieve-category).
+
+```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
+```
+
+Example Response
+```ruby
+{
+  "id": "f932aa79-852a-41f7-9adc-19935034f944",
+  "name": "Playlist sample",
+  "description": "Playlist description",
+  "slug": "playlist-sample",
+  "type": "playlist",
+  "orderNumber": 3,
+  "icon": "https:///example.com/image002.png",
+  "status": 1,
+  "createdAt": "2018-06-18T04:29:05.000Z",
+  "updatedAt": "2018-06-18T04:29:05.000Z"
+}
+```
+
+## Retrieve category list
+Get all category.
+
+See details [here](https://docs.uiza.io/#retrieve-category-list).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  categories = Uiza::Category.list
+  puts categories.first.id
+  puts categories.first.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
+```
+
+Example Response
+```ruby
+[
+  {
+    "id": "f932aa79-852a-41f7-9adc-19935034f944",
+    "name": "Playlist sample",
+    "description": "Playlist desciption",
+    "slug": "playlist-sample",
+    "type": "playlist",
+    "orderNumber": 3,
+    "icon": "/example.com/image002.png",
+    "status": 1,
+    "createdAt": "2018-06-18T04:29:05.000Z",
+    "updatedAt": "2018-06-18T04:29:05.000Z"
+  },
+  {
+    "id": "ab54db88-0c8c-4928-b1be-1e7120ad2c39",
+    "name": "Folder sample",
+    "description": "Folder's description",
+    "slug": "folder-sample",
+    "type": "folder",
+    "orderNumber": 1,
+    "icon": "/example.com/icon.png",
+    "status": 1,
+    "createdAt": "2018-06-18T03:17:07.000Z",
+    "updatedAt": "2018-06-18T03:17:07.000Z"
+  }
+]
+```
+
+## Update category
+Update information of category.
+
+See details [here](https://docs.uiza.io/#update-category).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  id: "your-category-id",
+  name: "Folder edited",
+  type: "folder"
+}
+
+begin
+  category = Uiza::Category.update params
+  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
+```
+
+Example Response
+```ruby
+{
+  "id": "f932aa79-852a-41f7-9adc-19935034f944",
+  "name": "Folder edited",
+  "description": "Playlist description",
+  "slug": "playlist-sample",
+  "type": "folder",
+  "orderNumber": 3,
+  "icon": "https:///example.com/image002.png",
+  "status": 1,
+  "createdAt": "2018-06-18T04:29:05.000Z",
+  "updatedAt": "2018-06-18T04:29:05.000Z"
+}
+```
+
+## Delete category
+Delete category.
+
+See details [here](https://docs.uiza.io/#delete-category).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  category = Uiza::Category.delete "your-category-id"
+  puts category.id
+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
+```
+
+Example Response
+```ruby
+{
+  "id": "f932aa79-852a-41f7-9adc-19935034f944"
+}
+```
+
+## Create category relation
+Add relation for entity and category.
+
+See details [here](https://docs.uiza.io/#create-category-relation).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  entityId: "your-entity-id",
+  metadataIds: ["your-category-id-1", "your-category-id-2"]
+}
+
+begin
+  relations = Uiza::Category.create_relation params
+  puts relations.first.id
+  puts relations.first.entityId
+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
+```
+
+Example Response
+```ruby
+[
+  {
+    "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
+    "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
+    "metadataId": "095778fa-7e42-45cc-8a0e-6118e540b61d"
+  },
+  {
+    "id": "47209e60-a99f-4c96-99fb-be4f858481b4",
+    "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
+    "metadataId": "e00586b9-032a-46a3-af71-d275f01b03cf"
+  }
+]
+```
+
+## Delete category relation
+Delete relation for entity and category.
+
+See details [here](https://docs.uiza.io/#delete-category-relation).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  entityId: "your-entity-id",
+  metadataIds: ["your-category-id-1", "your-category-id-2"]
+}
+
+begin
+  relations = Uiza::Category.delete_relation params
+  puts relations.first.id
+  puts relations.first.entityId
+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
+```
+
+Example Response
+```ruby
+[
+  {
+      "id": "5620ed3c-b725-4a9a-8ec1-ecc9df3e5aa6",
+      "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
+      "metadataId": "095778fa-7e42-45cc-8a0e-6118e540b61d"
+  },
+  {
+      "id": "47209e60-a99f-4c96-99fb-be4f858481b4",
+      "entityId": "16ab25d3-fd0f-4568-8aa0-0339bbfd674f",
+      "metadataId": "e00586b9-032a-46a3-af71-d275f01b03cf"
+  }
+]
+```