uiza 1.0.0

data/doc/ERRORS_CODE.md

@@ -0,0 +1,60 @@
+## 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://docs.uiza.io/#errors-code).
+
+## HTTP status code summary
+| Error Code                  | Detail                                                                    |
+| ---------------------------:|:--------------------------------------------------------------------------|
+| 200 - OK                    | Everything worked as expected.                                            |
+| 400 - Bad Request           | The request was unacceptable, often due to missing a required parameter.  |
+| 401 - Unauthorized          | No valid API key provided.                                                |
+| 404 - Not Found             | The requested resource doesn't exist.                                     |
+| 422 - Unprocessable         | The syntax of the request is correct (often cause of wrong parameter).    |
+| 500 - Internal Server Error | We had a problem with our server. Try again later.                        |
+| 503 - Service Unavailable   | The server is overloaded or down for maintenance.                         |
+
+## Error types
+| Error Type                      | Detail                                                                    |
+| -------------------------------:|:--------------------------------------------------------------------------|
+| 400 - BadRequestError           | The request was unacceptable, often due to missing a required parameter.  |
+| 401 - UnauthorizedError         | No valid API key provided.                                                |
+| 404 - NotFoundError             | The requested resource doesn't exist.                                     |
+| 422 - UnprocessableError        | The syntax of the request is correct (often cause of wrong parameter).    |
+| 500 - InternalServerErrorError  | We had a problem with our server. Try again later.                        |
+| 503 - ServiceUnavailableError   | The server is overloaded or down for maintenance.                         |
+| 4xx - ClientError               | The error seems to have been caused by the client.                        |
+| 5xx - ServerError               | The server is aware that it has encountered an error.                     |
+
+## Example Request
+```ruby
+begin
+  # use Uiza's library to make requests ...
+rescue Uiza::Error::BadRequestError => e
+  # BadRequestError
+  puts "#description_link: {e.description_link}"
+  puts "message: #{e.message}"
+  puts "code: #{e.code}"
+rescue Uiza::Error::UnauthorizedError => e
+  # UnauthorizedError
+rescue Uiza::Error::NotFoundError => e
+  # NotFoundError
+rescue Uiza::Error::UnprocessableError => e
+  # UnprocessableError
+rescue Uiza::Error::InternalServerErrorError => e
+  # InternalServerErrorError
+rescue Uiza::Error::ServiceUnavailableError => e
+  # ServiceUnavailableError
+rescue Uiza::Error::ClientError => e
+  # ClientError
+rescue Uiza::Error::ServerError => e
+  # ServerError
+rescue Uiza::Error::UizaError => e
+  # UizaError
+rescue => e
+  # Something else happened, completely unrelated to Uiza
+end
+```

data/doc/LIVE_STREAMING.md

@@ -0,0 +1,6 @@
+## 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://docs.uiza.io/#live-streaming).

data/doc/STORAGE.md

@@ -0,0 +1,189 @@
+## 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://docs.uiza.io/#storage).
+
+## Add a storage
+You can sync 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://docs.uiza.io/#add-a-storage).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  name: "FTP Uiza",
+  description: "FTP of Uiza, use for transcode",
+  storageType: "ftp",
+  host: "ftp-example.uiza.io"
+}
+
+begin
+  storage = Uiza::Storage.add params
+  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
+```
+
+Example Response
+```ruby
+{
+  "id": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49",
+  "name": "FTP Uiza",
+  "description": "FTP of Uiza, use for transcode",
+  "storageType": "ftp",
+  "usageType": "input",
+  "bucket": null,
+  "prefix": null,
+  "host": "ftp-exemple.uiza.io",
+  "awsAccessKey": null,
+  "awsSecretKey": null,
+  "username": "uiza",
+  "password": "=5;9x@LPsd+w7qW",
+  "region": null,
+  "port": 21,
+  "createdAt": "2018-06-19T03:01:56.000Z",
+  "updatedAt": "2018-06-19T03:01:56.000Z"
+}
+```
+
+## Retrieve a storage
+Get information of your added storage (`FTP` or `AWS S3`).
+
+See details [here](https://docs.uiza.io/#retrieve-a-storage).
+
+```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
+```
+
+Example Response
+```ruby
+{
+  "id": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49",
+  "name": "FTP Uiza",
+  "description": "FTP of Uiza, use for transcode",
+  "storageType": "ftp",
+  "usageType": "input",
+  "bucket": null,
+  "prefix": null,
+  "host": "ftp-exemple.uiza.io",
+  "awsAccessKey": null,
+  "awsSecretKey": null,
+  "username": "uiza",
+  "password": "=5;9x@LPsd+w7qW",
+  "region": null,
+  "port": 21,
+  "createdAt": "2018-06-19T03:01:56.000Z",
+  "updatedAt": "2018-06-19T03:01:56.000Z"
+}
+```
+
+## Update storage
+Update storage's information.
+
+See details [here](https://docs.uiza.io/#update-storage).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  id: "your-storage-id",
+  name: "FTP Uiza edited",
+  host: "ftp-example.uiza.io",
+  port: 21,
+  storageType: "ftp"
+}
+
+begin
+  storage = Uiza::Storage.update params
+  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
+```
+
+Example Response
+```ruby
+{
+  "id": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49",
+  "name": "FTP Uiza edited",
+  "description": "FTP of Uiza, use for transcode",
+  "storageType": "ftp",
+  "usageType": "input",
+  "bucket": null,
+  "prefix": null,
+  "host": "ftp-exemple.uiza.io",
+  "awsAccessKey": null,
+  "awsSecretKey": null,
+  "username": "uiza",
+  "password": "=5;9x@LPsd+w7qW",
+  "region": null,
+  "port": 21,
+  "createdAt": "2018-06-19T03:01:56.000Z",
+  "updatedAt": "2018-06-19T03:01:56.000Z"
+}
+```
+
+## Remove storage
+Remove storage that added to Uiza.
+
+See details [here](https://docs.uiza.io/#remove-storage).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  storage = Uiza::Storage.remove "your-storage-id"
+  puts storage.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": "cd003123-7ec9-4f3a-9d7c-f2de93e83e49"
+}
+```

data/lib/uiza.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "net/https"
+require "json"
+
+require "uiza/version"
+require "uiza/uiza_client"
+
+require "uiza/error/uiza_error"
+require "uiza/error/bad_request_error"
+require "uiza/error/unauthorized_error"
+require "uiza/error/not_found_error"
+require "uiza/error/unprocessable_error"
+require "uiza/error/internal_server_error"
+require "uiza/error/service_unavailable_error"
+require "uiza/error/client_error"
+require "uiza/error/server_error"
+
+require "uiza/api_operation/create"
+require "uiza/api_operation/add"
+require "uiza/api_operation/retrieve"
+require "uiza/api_operation/list"
+require "uiza/api_operation/update"
+require "uiza/api_operation/delete"
+require "uiza/api_operation/remove"
+
+require "uiza/entity"
+require "uiza/storage"
+require "uiza/category"
+
+module Uiza
+  class << self
+    attr_accessor :workspace_api_domain, :authorization
+  end
+end

data/lib/uiza/api_operation/add.rb

@@ -0,0 +1,16 @@
+module Uiza
+  module APIOperation
+    module Add
+      def add params
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :post
+        headers = {"Authorization" => Uiza.authorization}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:add]
+        response = uiza_client.execute_request
+
+        retrieve response.id
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/create.rb

@@ -0,0 +1,16 @@
+module Uiza
+  module APIOperation
+    module Create
+      def create params
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :post
+        headers = {"Authorization" => Uiza.authorization}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:create]
+        response = uiza_client.execute_request
+
+        retrieve response.id
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/delete.rb

@@ -0,0 +1,15 @@
+module Uiza
+  module APIOperation
+    module Delete
+      def delete id
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :delete
+        headers = {"Authorization" => Uiza.authorization}
+        params = {id: id}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:delete]
+        uiza_client.execute_request
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/list.rb

@@ -0,0 +1,14 @@
+module Uiza
+  module APIOperation
+    module List
+      def list params = {}
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :get
+        headers = {"Authorization" => Uiza.authorization}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:list]
+        uiza_client.execute_request
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/remove.rb

@@ -0,0 +1,15 @@
+module Uiza
+  module APIOperation
+    module Remove
+      def remove id
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :delete
+        headers = {"Authorization" => Uiza.authorization}
+        params = {id: id}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:remove]
+        uiza_client.execute_request
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/retrieve.rb

@@ -0,0 +1,15 @@
+module Uiza
+  module APIOperation
+    module Retrieve
+      def retrieve id
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :get
+        headers = {"Authorization" => Uiza.authorization}
+        params = {id: id}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:retrieve]
+        uiza_client.execute_request
+      end
+    end
+  end
+end

data/lib/uiza/api_operation/update.rb

@@ -0,0 +1,16 @@
+module Uiza
+  module APIOperation
+    module Update
+      def update params
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/#{self::OBJECT_API_PATH}"
+        method = :put
+        headers = {"Authorization" => Uiza.authorization}
+
+        uiza_client = UizaClient.new url, method, headers, params, self::OBJECT_API_DESCRIPTION_LINK[:update]
+        response = uiza_client.execute_request
+
+        retrieve response.id
+      end
+    end
+  end
+end

data/lib/uiza/category.rb

@@ -0,0 +1,42 @@
+module Uiza
+  class Category
+    extend Uiza::APIOperation::Create
+    extend Uiza::APIOperation::Retrieve
+    extend Uiza::APIOperation::Update
+    extend Uiza::APIOperation::Delete
+    extend Uiza::APIOperation::List
+
+    OBJECT_API_PATH = "media/metadata".freeze
+    OBJECT_API_DESCRIPTION_LINK = {
+      create: "https://docs.uiza.io/#create-category",
+      retrieve: "https://docs.uiza.io/#retrieve-category",
+      list: "https://docs.uiza.io/#retrieve-category-list",
+      update: "https://docs.uiza.io/#update-category",
+      delete: "https://docs.uiza.io/#delete-category",
+      create_relation: "https://docs.uiza.io/#create-category-relation",
+      delete_relation: "https://docs.uiza.io/#delete-category-relation"
+    }.freeze
+
+    class << self
+      def create_relation params
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/media/entity/related/metadata"
+        method = :post
+        headers = {"Authorization" => Uiza.authorization}
+        description_link = OBJECT_API_DESCRIPTION_LINK[:create_relation]
+
+        uiza_client = UizaClient.new url, method, headers, params, description_link
+        uiza_client.execute_request
+      end
+
+      def delete_relation params
+        url = "https://#{Uiza.workspace_api_domain}/api/public/v3/media/entity/related/metadata"
+        method = :post
+        headers = {"Authorization" => Uiza.authorization}
+        description_link = OBJECT_API_DESCRIPTION_LINK[:delete_relation]
+
+        uiza_client = UizaClient.new url, method, headers, params, description_link
+        uiza_client.execute_request
+      end
+    end
+  end
+end