uiza_minh_phong 0.4.0

data/doc/STORAGE.md

@@ -0,0 +1,188 @@
+## 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
+
+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/doc/USER.md

@@ -0,0 +1,286 @@
+## User Management
+You can manage user with APIs user. Uiza have 2 levels of user:
+  Admin - This account will have the highest priority, can have permission to create & manage users.
+  User - This account level is under Admin level. It only manages APIs that relates to this account.
+
+See details [here](https://docs.uiza.io/#user-management).
+
+## Create an user
+Create an user account for workspace
+
+See details [here](https://docs.uiza.io/#create-an-user).
+
+```ruby
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  status: 1,
+  username: "user_test",
+  email: "user_test@uiza.io",
+  password: "FMpsr<4[dGPu?B#u",
+  gender: 0,
+  dob: "05/15/2018",
+  avatar: "https://exemple.com/avatar.jpeg",
+  fullname: "User Test",
+  isAdmin: 0
+}
+
+begin
+  user = Uiza::User.create params
+  puts user.id
+  puts user.username
+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": "37d6706e-be91-463e-b3b3-b69451dd4752",
+  "isAdmin": 0,
+  "username": "user_test",
+  "email": "user_test@uiza.io",
+  "avatar": "https://exemple.com/avatar.jpeg",
+  "fullname": "User Test",
+  "updatedAt": "2018-06-22T18:05:47.000Z",
+  "createdAt": "2018-06-22T18:05:47.000Z"
+}
+```
+
+## Retrieve an user
+Retrieves the details of an existing user.
+You need only supply the unique userId that was returned upon user creation.
+
+See details [here](https://docs.uiza.io/#retrieve-an-user).
+
+```ruby
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  user = Uiza::User.retrieve "your-user-id"
+  puts user.id
+  puts user.username
+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": "37d6706e-be91-463e-b3b3-b69451dd4752",
+  "isAdmin": 0,
+  "username": "user_test",
+  "email": "user_test@uiza.io",
+  "avatar": "https://exemple.com/avatar.jpeg",
+  "fullname": "User Test",
+  "updatedAt": "2018-06-22T18:05:47.000Z",
+  "createdAt": "2018-06-22T18:05:47.000Z"
+}
+```
+
+## List all users
+Returns a list of your user. The users are returned sorted by creation date, with the most recent user appearing first.
+If you use Admin token, you will get all the user.
+If you use User token, you can only get the information of that user
+
+See details [here](https://docs.uiza.io/#list-all-users).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  users = Uiza::User.list
+  # or users = Uiza::User.list limit: 2, page: 2
+  puts users.first.id
+  puts users.first.username
+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": "1a95f752-19e0-4a2e-9951-6d1fc0adbeaf",
+  "isAdmin": 0,
+  "username": "user_test",
+  "email": "user_test@uiza.io",
+  "updatedAt": "2018-06-22T02:31:14.000Z",
+  "createdAt": "2018-06-22T02:31:14.000Z"
+},
+{
+  "id": "95c1229a-73e6-4ef7-98eb-e64a765c32d5",
+  "isAdmin": 1,
+  "username": "user_admin",
+  "email": "user_admin@uiza.io",
+  "updatedAt": "2018-06-22T00:00:00.000Z",
+  "createdAt": "2018-06-22T02:32:29.000Z"
+}
+```
+
+## Update an user
+Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+
+See details [here](https://docs.uiza.io/#update-an-user).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  id: "37d6706e-be91-463e-b3b3-b69451dd4752"
+  status: 1,
+  username: "user_test",
+  email: "user_test@uiza.io",
+  password: "FMpsr<4[dGPu?B#u",
+  gender: 0,
+  dob: "05/15/2018",
+  avatar: "https://exemple.com/avatar.jpeg",
+  fullname: "User Test",
+  isAdmin: 0
+}
+
+begin
+  user = Uiza::User.update params
+  puts user.id
+  puts user.username
+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": "37d6706e-be91-463e-b3b3-b69451dd4752",
+  "isAdmin": 0,
+  "username": "user_test",
+  "email": "user_test@uiza.io",
+  "avatar": "https://exemple.com/avatar.jpeg",
+  "fullname": "User Test",
+  "updatedAt": "2018-06-22T18:05:47.000Z",
+  "createdAt": "2018-06-22T18:05:47.000Z"
+}
+```
+
+## Delete an user
+Permanently deletes an user. It cannot be undone. Also immediately cancels all token & information of this user.
+
+See details [here](https://docs.uiza.io/#delete-an-user).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  user = Uiza::User.delete "your-user-id"
+  puts user.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
+```
+{
+  "id": "2c98b4d5-7d7f-4a0f-9258-5689f90fd28c"
+}
+```
+
+## Update password
+Update password allows Admin or User update their current password.
+
+See details [here](https://docs.uiza.io/#update-password).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+params = {
+  id: "your-user-id",
+  oldPassword: "FMpsr<4[dGPu?B#u",
+  newPassword: "S57Eb{:aMZhW=)G$"
+}
+
+begin
+  response = Uiza::User.change_password params
+  puts response.result
+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
+{
+  "result": "ok"
+}
+```
+
+## Log Out
+This API use to log out an user. After logged out, token will be removed.
+
+See details [here](https://docs.uiza.io/#log-out).
+
+```ruby
+require "uiza"
+
+Uiza.workspace_api_domain = "your-workspace-api-domain.uiza.co"
+Uiza.authorization = "your-authorization"
+
+begin
+  response = Uiza::User.logout
+  puts response.message
+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
+{
+  "message": "Logout success"
+}
+```