datawow 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ab7e943518feee57c144e25d9f384a3336dea35767a70857e98689833d6f26f
+  data.tar.gz: 57eb64866865b7e7d35a6f1e23be00cbd6de32b48f09a423a312173d7a94df28
+SHA512:
+  metadata.gz: 63e3ab17bd9b5163934a30dd4b29acc6980f2416b48bd680d8533a88876dd243cc3ef40e4510b601b094949786fed7acf1051ad364bbfc2ff073ba811644e82d
+  data.tar.gz: 903c6b7a47a6c8aa6003358f8dfcce8e1d2342f2fe1528ab4eb12c53177ebbe785d6aaad7e219ee447f0f0c0c6c4b0088dda3d4861629ebe880e56f673e323f1

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    datawow (1.2.0)
+      faraday (~> 0.13.1, >= 0.13.1)
+      faraday_middleware (~> 0.12.2, >= 0.12.2)
+      json (~> 1.8, >= 1.8.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    json (1.8.6)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.3.1)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  datawow!
+  minitest (~> 5.11, >= 5.11.3)
+  pry-byebug (~> 3.6)
+  rake (~> 12.3)
+  simplecov (~> 0.15.1)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.17.1

data/INSTALL.md

@@ -0,0 +1,7 @@
+After install datawow
+
+Run the generator
+
+  rails generate datawow:install
+
+This will install an initializer which describes ALL of Datawow's configuration options.

data/README/ai_docs.md

@@ -0,0 +1,153 @@
+# Table of Content
+- [How to use it](#create)
+#### [Type of AI](#response-of-each-type-ai)
+- [Standard Criteria](#standard-criteria)
+- [Nudity/Sexual](#nuditysexual)
+- [Demographic](#demographic)
+- [Standard Criteria & Human](#standard-criteria--human)
+- [Common function](#common-function)
+
+### Prediction Images (AI Beta / 95% accuracy)
+ - [nanameue]Standard Criteria (~1 min)
+ - [sexual]Nudity/Sexual (~1 min)
+ - [demographic]Demographic (~3 mins)
+ - [ai_human]Standard Criteria & Human
+
+#### Create prediction
+**Note**: For creation of prediction, a type of AI will be separated by token. Once, you sent request to server your token will be used for find AI'type automatically and you will get response upon your token type 
+
+```ruby
+params = { ..., token: '_token' }
+Datawow.prediction.create(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| data     | 	string | Yes |Data for attachment|
+| postback_url	     | string      | No | Image postback url|
+| postback_method     | 	string | No |Postback method|
+| custom_id	     | string      |   No |Custom's id|
+
+## Response of each type AI
+#### [nanameue]Standard Criteria (~1 min)
+```json
+{
+  "data": {
+    "id": "5a41c388aa05617baa283457",
+    "answer": nil,
+    "credit_charged": 0,
+    "custom_id": "custom_id",
+    "data": "image_url",
+    "postback_url": "https://example.com/callbacks",
+    "processed_at": nil,
+    "project_id": "project_id",
+    "status": "processing"
+  },
+  "success": true,
+  "status": 200,
+  "message": "success",
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### [sexual]Nudity/Sexual (~1 min)
+```json
+{
+  "data": {
+    "id": "5a41ce6eaa05617baa2836aa",
+    "answer": nil,
+    "credit_charged": 0,
+    "custom_id": "custom_id",
+    "data": "image_url",
+    "postback_url": "https://example.com/callbacks",
+    "processed_at": nil,
+    "project_id": "project_id",
+    "status": "processing"
+  },
+  "success": true,
+  "status": 200,
+  "message": "success",
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### [demographic]Demographic (~3 mins)
+```json
+{
+  "data": {
+    "id": "5a41d011fb9d7f273a75a62d",
+    "answer": nil,
+    "credit_charged": 0,
+    "custom_id": "custom_id",
+    "data": "image_url",
+    "postback_url": "https://example.com/callbacks",
+    "processed_at": nil,
+    "project_id": "project_id",
+    "status": "processing"
+  },
+  "success": true,
+  "status": 200,
+  "message": "success",
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### [ai_human]Standard Criteria & Human
+```json
+{
+  "data": {
+    "id": "5a41d10efb9d7f27354c8963",
+    "answer": nil,
+    "credit_charged": 0,
+    "custom_id": "custom_id",
+    "data": "image_url",
+    "postback_url": "https://example.com/callbacks",
+    "processed_at": nil,
+    "project_id": "project_id",
+    "status": "processing"
+  },
+  "success": true,
+  "status": 200,
+  "message": "success",
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+  
+# Common function 
+For every classes there are common functions to get list of data and find by ID. We're going to show you how to use it.
+
+## Query list of data by  `all()`
+
+```ruby 
+params = { ..., token: '_token' }
+Datawow.[model].all(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| page     | 	interger | No | default 0|
+| per_page 	     | string      | No | default 20 |
+
+
+## Find data with ID by  `find_by()`
+```ruby
+params = { id: '_id', token: '_token' }
+Datawow.[model].find_by(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| id	     | string  |   **Yes** | Image's ID or custom ID which is you were assigned|

data/README/image_docs.md

@@ -0,0 +1,119 @@
+## Images class
+  
+We're going to explant about parameter for creation and example of use
+
+# Table of Content
+- [Choice class](#choice-class)
+- [Closed Question class](#closed-question-class)
+- [Image message class](#image-messages-class)
+- [Photo tags class](#photo-tags-class)
+- [Common function](#common-function)
+
+## Choice class
+Description: Yes or No Question from Image (30 mins response time) - This model used for create select list on a moderator screen and let's they answer your question on what they're seeing. Answer can be only one or multiple  choice
+
+#### Create 
+
+```ruby
+params = { ..., token: '_token' }
+Datawow.image_choice.create(params)
+```
+#### params 
+
+|Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| instruction| string|**Yes**| Tell moderator what answer you expected and what image is|
+|categories | Array[string]|**Yes** | List of answers that you were expected. sparate by use space |
+| data |string | **Yes** |URL of image|
+| postback_url| string|No| URL for answer callback once image has been checked|
+| postback_method|string | No |Configuration HTTP method GET POST PUT PATCH|
+| allow_empty| boolean|No|Allow answer can be blank. default is `false`|
+|multiple | boolean | No | Configuration for multiple selection of category to answer default is `false` |
+| custom_id | string | No |Custom ID that used for search|
+---
+
+
+## Closed Question class
+Description: Standard Criteria (5 mins response time) - Answer can be only approved, declined or ban
+### Create
+```ruby
+params = { ..., token: '_token' }
+Datawow.image_closed_question.create(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| data     | 	string | **Yes** |URL of image|
+| postback_url	     | string      | No | URL for answer callback once image has been checked|
+| postback_method     | 	string | No |Configuration HTTP method GET POST PUT PATCH|
+| custom_id	     | string      |   No |Custom ID that used for search|
+---
+
+
+
+## Image messages class
+Description: Message Question from Image (30 mins response time) - Allow a moderator to typing a answer on what they're seeing.
+
+### Create
+```ruby
+params = { ..., token: '_token' }
+Datawow.image_message.create(params)
+```
+
+
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| instruction	     | string      |   **Yes** | Tell moderator what answer you expected and what image is|
+| data     | 	string | **Yes** |URL of image|
+| postback_url	     | string      | No | URL for answer callback once image has been checked|
+| postback_method     | 	string | No |Configuration HTTP method GET POST PUT PATCH|
+| custom_id	     | string      |   No |Custom ID that used for search|
+
+---
+
+  
+## Photo tags class
+Description: Identifying an object in the image (60 mins response time) - This model is used for identifying the object within the hand drawn rectangle from the moderator, following any instructions given by the customer.
+
+### Create
+```python
+>>> from datawow.images import PhotoTag as photo_tag
+>>> result = photo_tag("PROJECT KEY").create(params=param)
+```
+
+#### params
+| Field | Type| Required | Description |
+| ------------- |:-------------:| :-----:| :-----|
+|instruction| string|**Yes** |Tell moderator what answer you expected and what image is|
+|data|string| **Yes** |URL of image|
+|postback_url|string| No |URL for answer callback once image has been checked|
+|postback_method|string | No |Configuration HTTP method GET POST PUT PATCH|
+|custom_id|string|No|Custom ID that used for search|
+
+---
+# Common function
+For every classes there are common functions to get list of data and find by ID. We're going to show you how to use it.
+
+## Query list of data by  `all()`
+
+```ruby
+params = { ..., token: '_token' }
+Datawow.[model].all(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| page     | 	interger | No | default 0|
+| per_page 	     | string      | No | default 20 |
+
+
+## Find data with ID by  `find_by()`
+```ruby
+params = { id: '_id', token: '_token' }
+Datawow.[model].find_by(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| id	     | string  |   **Yes** | Image's ID or custom ID which is you were assigned|

data/README/text_docs.md

@@ -0,0 +1,83 @@
+## Texts class
+  
+We're going to explant about parameter for creation and example of use
+
+# Table of Content
+- [Category class](#category-class)
+- [Closed Question class](#closed-question-class)
+- [Conversation class](#conversation-class)
+- [Common function](#common-function)
+
+
+## Category class
+Description: Classify type in many level of category type
+```ruby
+params = { ..., token: '_token' }
+Datawow.text_category.create(params)
+```
+
+|Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| conversation| array of dict|**Yes**| Example: `[{ "name": "...", "message": "..." }]`|
+|title|string|**Yes**|Title of conversation|
+|allow_empty |bool| |No|Answer can be empty|
+|postback_url|string|No|URL for callback|
+|postback_method| string|No| Configuration HTTP method GET POST PUT PATCH|
+|custom_id| string|No| Custom ID that used for search|
+
+
+## Closed Question class
+Description: Classify inappropriate conversation
+```ruby
+params = { ..., token: '_token' }
+Datawow.text_closed_question.create(params)
+```
+
+|Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+|data|string|**Yes**|Stream of text to moderate|
+|postback_url|string|No|URL for callback|
+|postback_method| string|No| Configuration HTTP method GET POST PUT PATCH|
+|custom_id| string|No| Custom ID that used for search|
+
+
+## Conversation class
+Description: Classify conversation
+```ruby
+params = { ..., token: '_token' }
+Datawow.text_conversation.create(params)
+```
+
+|Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+|conversation| array of dict|**Yes**| Example: `["foo", "bar"]`|
+|custom_conversation_ids|string|**Yes**|Example: `['1','2']`|
+|postback_url|string|No|URL for callback|
+|postback_method| string|No| Configuration HTTP method GET POST PUT PATCH|
+|custom_id| string|No| Custom ID that used for search|
+
+# Common function 
+For every classes there are common functions to get list of data and find by ID. We're going to show you how to use it.
+
+## Query list of data by  `all()`
+
+```ruby 
+params = { ..., token: '_token' }
+Datawow.[model].all(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| page     | 	interger | No | default 0|
+| per_page 	     | string      | No | default 20 |
+
+
+## Find data with ID by  `find_id()`
+```ruby
+params = { id: '_id', token: '_token' }
+Datawow.[model].find_by(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| id	     | string  |   **Yes** | Text's ID or custom ID which is you were assigned|

data/README/video_docs.md

@@ -0,0 +1,53 @@
+## Videos class
+  
+We're going to explant about parameter for creation and example of use
+
+# Table of Content
+- [Video classification class](#video-classification-class)
+- [Common function](#common-function)
+
+## Video Classification class
+Description: Video classification - Answer can be only approved, declined or ban
+### Create
+```ruby
+params = { ..., token: '_token' }
+Datawow.video_classification.create(params)
+```
+
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| data     | 	string | **Yes** |URL of Video|
+| play_at | float |No |Setting video start time|
+| allow_seeking |bool| No |Allow seeking video player (default `true`)|
+|muted |bool|No| Mute video on start (default: `true`)|
+| postback_url	     | string      | No | URL for answer callback once video has been checked|
+| postback_method     | 	string | No |Configuration HTTP method GET POST PUT PATCH|
+| custom_id	     | string      |   No |Custom ID that used for search|
+
+---
+# Common function
+For every classes there are common functions to get list of data and find by ID. We're going to show you how to use it.
+
+## Query list of data by  `all()`
+
+```ruby
+params = { ..., token: '_token' }
+Datawow.[model].all(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| page     | 	interger | No | default 0|
+| per_page 	     | string      | No | default 20 |
+
+
+## Find data with ID by  `find_by()`
+```ruby
+params = { id: '_id', token: '_token' }
+Datawow.[model].find_by(params)
+```
+#### params
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| id	     | string  |   **Yes** | Video's ID or custom ID which is you were assigned|

data/README.md

@@ -0,0 +1,160 @@
+# Datawow-ruby
+
+HTTP RESTFul for calling DataWow APIs
+
+###### support or question support@datawow.io
+
+# Installation
+```ruby
+gem 'datawow', '~> 1.2.0'
+```
+
+#### Generate setting
+
+```console
+$ rails generate datawow:install
+```
+The generator will install an initializer which describes ALL of library's configuration options. It is *imperative* that you take a look at it. When you are done, you are ready to call it to any of your codes.
+
+**Note**: Our library work with Rails 4.1 or above
+
+# Usage
+
+To call our module use `Datawow` and follow by class of APIs which we're going to explain what API we have
+
+## Class explanation
+#### Image classe `Datawow.image_*`
+There are 4 APIs for image class
+
+```ruby
+Datawow.image_closed_question
+Datawow.image_photo_tag
+Datawow.image_choice
+Datawow.image_message
+```
+---
+
+#### Video classe `Datawow.video_*`
+There is 1 API for video class
+
+```ruby
+Datawow.video_classification
+```
+---
+#### Text classe `Datawow.text_*`
+There are 3 APIs for text class
+
+```ruby
+Datawow.text_closed_question
+Datawow.text_category
+Datawow.text_conversation
+```
+---
+
+#### Prediction classe `Datawow.prediction`
+There are 1 API for prediction class
+
+```ruby
+Datawow.prediction
+```
+---
+## Calling APIs
+Every classes there are 3 function that is `create`, `find_by` and `all`
+#### `create`
+```ruby
+Datawow.[class].create({data: "image URL", token: '_token'})
+```
+
+#### `find_by`
+```ruby
+Datawow.[class].find_by({id: "_image_id", token: '_token'})
+```
+
+#### `all`
+```ruby
+Datawow.[class].all({token: '_token'})
+```
+---
+## Nanameue with Consensus
+#### `create`
+```ruby
+Datawow::NanameueHuman.new('_token').create({data: "image URL"})
+```
+
+#### `find_by`
+```ruby
+Datawow::NanameueHuman.new('_token').find_by({id: "_image_id"})
+```
+
+#### `all`
+```ruby
+Datawow::NanameueHuman.new('_token').all({page: '_page', per_page: '_per_page'})
+```
+
+# Setting default token
+
+If you have only one token that use on your project, you could config auto append or set token by default. This for Ruby On Rails project.
+
+`config/initializers/datawow.rb`
+
+```ruby
+Datawow.setup do |config|
+  # ==> Secret key Configuration
+  # You can change it below and use your own secret key.
+  config.project_key = 'your token'
+end
+```
+
+After configuration has been set. You can calling APIs by not insert token like this
+```ruby
+Datawow.[class].create({data: "image URL"})
+```
+The system will be looking for your token by automatically
+
+# Response
+
+Response is a module and it contain such as meta-data, message, status and data.
+#### Example of response module
+```ruby
+<Datawow::Response @status=200, @message="success" @meta={"code"=>200, "message"=>"success"}, @data={...}, />
+```
+you can use data whit calling `data` property and you will be get data like a example below
+
+```json
+{
+  "data": {
+    "image": {
+      "id": "5a40be59fb9d7f27354c5efa",
+      "answer": "approved",
+      "credit_charged": 1,
+      "custom_id": "custom_id",
+      "data": "image_url",
+      "postback_url": "postback_url",
+      "processed_at": "2017-12-25T16:02:00.599+07:00",
+      "project_id": "project_id",
+      "status": "processed"
+    }
+  },
+  "status": 200,
+  "message": "success",
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### Checking status with `successful?`
+```ruby
+if response.successful?
+  # Do stuff
+else
+  log.error("Request was not successful, something went wrong.")
+end
+```
+
+# Demo and Usage
+ - Image Documentation [link](README/image_docs.md)
+ - Video Documentation [link](README/video_docs.md)
+ - Text Documentation [link](README/text_docs.md)
+ - AI/Prediction Documentation [link](README/ai_docs.md)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/datawow.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'datawow'
+  s.version       = '1.2.0'
+  s.date          = '2018-11-27'
+  s.summary       = 'HTTP RESTFul for calling DataWow APIs'
+  s.description   = 'Moderation suite'
+  s.post_install_message = File.read('INSTALL.md') if File.exist?('INSTALL.md')
+  s.authors       = ['Jesdakorn Samittiauttakorn']
+  s.email         = 'ton@nanameue.jp'
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = 'https://datawow.io'
+  s.license       = 'Commercial'
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'faraday',            '~> 0.13.1', '>= 0.13.1'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.12.2', '>= 0.12.2'
+  s.add_runtime_dependency 'json',               '~> 1.8',    '>= 1.8.3'
+  s.add_development_dependency 'minitest',       '~> 5.11', '>= 5.11.3'
+  s.add_development_dependency 'pry-byebug',     '~> 3.6'
+  s.add_development_dependency 'rake',           '~> 12.3'
+  s.add_development_dependency 'simplecov',      '~> 0.15.1'
+  s.add_development_dependency 'webmock',        '~> 3.3'
+end