k_sequencing 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d38d05e17bb22c6bf7ec736722da69b54555ae9
-  data.tar.gz: '07101888d8eae7e3860519d74c732cb6b3e9de77'
+  metadata.gz: df1243bea4f2e8e973f371694330aca7c80b0a90
+  data.tar.gz: 2432af1d3d4969ffd5481f713b391c49784b1cbb
 SHA512:
-  metadata.gz: c08761067a7c6e8c3a49fdfc86a31e264a3e1de43ffc5a5017d6ea07af548c9dd03049f6f5753079798ef693f4c63b14563e17210183d1808144dafde4aa553c
-  data.tar.gz: 7c045178511bb72c3b186acc4ad94717b86672026cf85ff96d54ed0cd7d3d5e9e890aa3490122ced7b9c30ea626b886e95caa1c0917d99b683c2b4235c4a3ed3
+  metadata.gz: 32622a0b1747ce257f7f18d61e73d018d78b2d40660bd3d923a0c91dd66fcb1824b6bbc6aa67c7b9144261e1d1a0fcda0e4873b10f4875fcb4e9dbe9a2d8ae30
+  data.tar.gz: 2ed1358f4bd62ab9a05f9f277e58cdd07304d842d998457542450400ee56db0cd7ab62050557c0e89b894bf5394379fbf10344d10bb76669b6e46935a1072a21

data/README.md

@@ -1,6 +1,16 @@
-# k_sequencing_gem
+# Image and content moderation services.
+
+
+## There are 5 avalable for API 
+* Closed questions - Answer can be only approved, declined or ban(kenta).
+* Choices - This model use to ask question with multiple choice. Anwser can be one or multiple.
+* Photo tags - This model use to create a selection area to find where answer is, by drag the area on image from webpage.
+* Messages - This model allow moderator type the anwser on what they see.
+* Predictions - Use AI to prediction the result
+
+##### Please see more usage [documentation](docs/documentation.md) for details on our guideline.
+
 
-Image and content moderation services.
 
 ## Getting Started
 
@@ -21,31 +31,40 @@ The generator will install an initializer which describes ALL of KSequencing's c
 You have to contact us [Datawow](https://datawow.io/pages/contact) to get your token. With this token you'll be able to use our gem properly.
 
 ## Usage
-### Operations about Images
-Get image
+There are 3 oparations of each model as the same name see example below
+
+#### Get image
 ```ruby
-KSequencing.client.get_image_closed_question()
+KSequencing.[model].find_by()
 ```
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
+|token | string     |    Yes | Project token |
 | id	     | string      |   No | Image id|
-|custom_id | string     |    No | Client's image id |
+|custom_id | string     |    No | Client's image id |\
 
 Note: You must choose id or custom_id for search. Not both.
 
-Sample request
+###### Sample request
+
 ```ruby
-KSequencing.client.get_image_closed_question(
+KSequencing.[model].find_by({
+  token: "[you_token]",
   id: "59311194e99991b2ca8979f1"
-)
+})
 ```
 
-```
-curl --request GET -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" "https://k-sequencing.datawow.io/api/images/closed_question?id=59311194e99991b2ca8979f1"
+or
+
+```ruby
+KSequencing.[model].find_by({
+  token: "[you_token]",
+  custom_id: "59311194e99991b2ca8979f1"
+})
 ```
 
-Sample results
+###### Sample results
 ```json
 {
   "data": {
@@ -68,31 +87,33 @@ Sample results
   }
 }
 ```
+<Enter>
+---
+#### Create images
 
-Create images
 ```ruby
-KSequencing.client.create_image_closed_questions()
+KSequencing.[model].create()
 ```
+
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
+|token | string     |    Yes | Project token |
 | data     | 	string | Yes |Data for moderate|
 | postback_url	     | string      | No | Image postback url|
 | postback_method     | 	string | No |Postback method|
 | custom_id	     | string      |   No |Custom's id|
 
-Sample request
+###### Sample request
 
 ```ruby
-KSequencing.client.create_image_closed_questions(
+KSequencing.[model].create({
+  token: "[you_token]"
   data: "image_url"
-)
+  ....
+})
 ```
 
-```
-curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "data=image_url" "http://k-sequencing.datawow.io/api/images/closed_questions"
-```
-
-Sample results
+###### Sample results
 ```json
 {
   "data": {
@@ -113,14 +134,67 @@ Sample results
   }
 }
 ```
+<Enter>
 ---
-#### Image moderation can set 4 kinds of answer
-* Closed question - Answer can be only approved, declined or ban.
-* Choices - User can set multiple choices for select. It can be radio or checkbox.
-* Photo tag - User can create box-like overlays on top of your image and assign messages to each box.
-* Message - User can set messages for answer.
 
-For more usage, please read [documentation](docs/documentation.md) for details on our code.
+#### Get list of images
+```ruby
+KSequencing.[model].all()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+|token | string     |    Yes | Project token |
+| page	     | integer       |   No | Image id|
+|per_page | integer      |    No | Client's image id |\
+
+Note: You must choose id or custom_id for search. Not both.
+
+###### Sample request
+
+```ruby
+KSequencing.[model].all({
+  token: "[you_token]"
+})
+```
+
+
+###### Sample results
+```json
+{
+  "data": {
+    "images": [
+      {
+        "id": "5a0d5a0c0deb540ab9c56e4e",
+        "allow_empty": false,
+        "answer": [],
+        "categories": ["face", "eye"],
+        "credit_charged": 0,
+        "custom_id": null,
+        "data": "image_url",
+        "instruction": "face",
+        "multiple": false,
+        "postback_url": "www.example.com",
+        "processed_at": null,
+        "project_id": 94,
+        "status": "unprocess"
+      }
+    ]
+  },
+  "meta": {
+    "code": 200,
+    "message": "success",
+    "current_page": 1,
+    "next_page": 2,
+    "prev_page": -1,
+    "total_pages": 13,
+    "total_count": 13
+  }
+}
+```
+<Enter>
+
+However `token: "[you_token]"` you can config in configuration file is not necessary to send to method every time you request, if you have one project token we recommeded this approach
 
 ## License
 

data/docs/documentation.md

@@ -1,15 +1,16 @@
 ## Usage
 ### Operations about Images
 #### Image moderation can set 4 kinds of answer
-* [Closed questions](#closed-questions)- Answer can be only approved, declined or ban.
-* [Choices](#choices) - User can set multiple choices for select. It can be radio or checkbox.
-* [Photo tags](#photo-tags) - User can create box-like overlays on top of your image and assign messages to each box.
-* [Messages](#messages) - User can set messages for answer.
+* [Closed questions](#closed-questions) - Answer can be only approved, declined or ban(kenta).
+* [Choices](#choices) - This model use to ask question with multiple choice. Anwser can be one or multiple.
+* [Photo tags](#photo-tags) - This model use to create a selection area to find where answer is by drag the area on image from web page.
+* [Messages](#messages) - This model allow moderator type the anwser on what they see.
+* [Prediction](#messages) - Use AI to prediction the result
 ---
-#### Closed questions
+### Closed questions
 Get image
 ```ruby
-KSequencing.client.get_image_closed_question()
+KSequencing.image_closed_question.find_by()
 ```
 
 | Field        | Type           | Required  | Description |
@@ -19,15 +20,12 @@ KSequencing.client.get_image_closed_question()
 
 Note: You must choose id or custom_id for search. Not both.
 
-Sample request
+--- Sample request
 ```ruby
-KSequencing.client.get_image_closed_question(
+KSequencing.image_closed_question.find_by({
+  token: "[you_token]",
   id: "59311194e99991b2ca8979f1"
-)
-```
-
-```
-curl --request GET -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" "https://k-sequencing.datawow.io/api/images/closed_question?id=59311194e99991b2ca8979f1"
+})
 ```
 
 Sample results
@@ -56,7 +54,7 @@ Sample results
 
 Create images
 ```ruby
-KSequencing.client.create_image_closed_questions()
+KSequencing.image_closed_questions.create()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -67,13 +65,10 @@ KSequencing.client.create_image_closed_questions()
 
 Sample request
 ```ruby
-KSequencing.client.create_image_closed_questions(
+KSequencing.image_closed_questions.create({
+  token: "[you_token]",
   data: "image_url"
-)
-```
-
-```
-curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "data=image_url" "http://k-sequencing.datawow.io/api/images/closed_questions"
+})
 ```
 
 Sample results
@@ -101,7 +96,7 @@ Sample results
 #### Choices
 Get image
 ```ruby
-KSequencing.client.get_image_choice()
+KSequencing.image_choice.find_by()
 ```
 
 | Field        | Type           | Required  | Description |
@@ -113,13 +108,10 @@ Note: You must choose id or custom_id for search. Not both.
 
 Sample request
 ```ruby
-KSequencing.client.get_image_choice(
+KSequencing.image_choice.find_by({
+  token: "[you_token]",
   id: "59311194e99991b2ca8979f1"
-)
-```
-
-```
-curl --request GET -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" "https://k-sequencing.datawow.io/api/images/choice?id=59311194e99991b2ca8979f1"
+})
 ```
 
 Sample results
@@ -156,7 +148,7 @@ Sample results
 
 Create new choices
 ```ruby
-KSequencing.client.create_image_choices()
+KSequencing.image_choices.create()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -167,6 +159,8 @@ KSequencing.client.create_image_choices()
 |multiple | boolean   |    No | true for multiple answer and false for one answer |
 | postback_method     | 	string | No |Postback method|
 | custom_id	     | string      |   No |Custom's id|
+| allow_empty	     | boolean      |   No |Allow sent answer with empty choice. default is `false`|
+ 
 
 Note: Answer can choose only one is default. If you want answer to be multiple, you need to set multiple to true.
 
@@ -174,24 +168,22 @@ Sample request
 
 For one answer
 ```ruby
-KSequencing.client.create_image_choices(
+KSequencing.image_choices.create({
+  token: "[you_token]",
   instruction: "question",
   categories: "options1 options2 options3",
   data: "image_url"
-)
+})
 ```
 For multiple answer
 ```ruby
-KSequencing.client.create_image_choices(
+KSequencing.image_choices.create({
+  token: "[you_token]",
   instruction: "question",
   categories: "options1 options2 options3",
   data: "image_url",
   multiple: true
-)
-```
-
-```
-curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "instruction=question&categories=option1%20options2%20options3&data=image_url" "http://k-sequencing.datawow.io/api/images/choices"
+})
 ```
 
 Sample results
@@ -227,7 +219,7 @@ Sample results
 #### Messages
 Get image
 ```ruby
-KSequencing.client.get_image_message()
+KSequencing.image_message.find_by()
 ```
 
 | Field        | Type           | Required  | Description |
@@ -239,13 +231,10 @@ Note: You must choose id or custom_id for search. Not both.
 
 Sample request
 ```ruby
-KSequencing.client.get_image_message(
+KSequencing.image_message.find_by({
+  token: "[you_token]",
   id: "592fbfce1b9d8f69e4178688"
-)
-```
-
-```
-curl --request GET -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" "https://k-sequencing.datawow.io/api/images/message?id=592fbfce1b9d8f69e4178688"
+})
 ```
 
 Sample results
@@ -275,7 +264,7 @@ Sample results
 
 Create new message
 ```ruby
-KSequencing.client.create_image_messages()
+KSequencing.image_messages.create()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -287,14 +276,10 @@ KSequencing.client.create_image_messages()
 
 Sample request
 ```ruby
-KSequencing.client.create_image_messages(
+KSequencing.image_messages.create({
   instruction: "question",
   data: "image_url"
-)
-```
-
-```
-curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "instruction=question&data=image_url" "http://k-sequencing.datawow.io/api/images/messages"
+})
 ```
 
 Sample results
@@ -323,7 +308,7 @@ Sample results
 #### Photo tags
 Get image
 ```ruby
-KSequencing.client.get_image_photo_tag()
+KSequencing.image_photo_tag.find_by()
 ```
 
 | Field        | Type           | Required  | Description |
@@ -335,13 +320,9 @@ Note: You must choose id or custom_id for search. Not both.
 
 Sample request
 ```ruby
-KSequencing.client.get_image_photo_tag(
+KSequencing.image_photo_tag.find_by({
   id: "592fbfec1b9d8f69e4178689"
-)
-```
-
-```
-curl --request GET -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" "https://k-sequencing.datawow.io/api/images/photo_tag?id=592fbfec1b9d8f69e4178689"
+})
 ```
 
 Sample results
@@ -371,7 +352,7 @@ Sample results
 
 Create new photo tag
 ```ruby
-KSequencing.client.create_image_photo_tags()
+KSequencing.client.image_photo_tags.create()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -383,15 +364,12 @@ KSequencing.client.create_image_photo_tags()
 
 Sample request
 ```ruby
-KSequencing.client.create_image_photo_tags(
+KSequencing.client.image_photo_tags.create(
   instruction: "question",
   data: "image_url"
 )
 ```
 
-```
-curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" --H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "instruction=question&data=image_url" "http://k-sequencing.datawow.io/api/images/photo_tags"
-```
 
 Sample results
 ```json
@@ -416,3 +394,108 @@ Sample results
 }
 ```
 ---
+
+
+#### Prediction
+Get prediction
+```ruby
+KSequencing.prediction.find_by()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| id	     | string      |   No | Image id|
+|custom_id | string     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
+Sample request
+```ruby
+KSequencing.prediction.find_by({
+  id: "592fbfec1b9d8f69e4178689"
+})
+```
+
+Sample results
+```json
+{
+  "data": {
+    "image": {
+      "id": "5a0d3a8c0deb540ab9c56e33",
+      "answer": null,
+      "credit_charged": 0,
+      "custom_id": null,
+      "data": "www.example.com",
+      "postback_url": "www.example.com",
+      "processed_at": null,
+      "project_id": 96,
+      "status": "processing"
+    }
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+
+Create prediction
+```ruby
+KSequencing.prediction.create()
+```
+| 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|
+
+Sample request
+```ruby
+KSequencing.prediction.create(
+  token: "[your_token]",
+  data: "image_url"
+)
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": "5a0e49d00deb540ab9c56e4f",
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "www.example.com",
+    "postback_url": "www.example.com",
+    "processed_at": null,
+    "project_id": 96,
+    "status": "processing"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+<enter>
+---
+
+As you see above all API have a same name just change model name and paramter, however if you would like to list all of your data just use all() see example below 
+
+#### Get list of data 
+
+```ruby
+KSequencing.[model].all()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| page     | 	interger | No | default 0|
+| per_page 	     | string      | No | default 20 |
+
+Sample request
+```ruby
+KSequencing.[model].all(
+  token: "[your_token]"
+)
+```

data/k_sequencing.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name          = 'k_sequencing'
-  s.version       = '0.1.21'
+  s.version       = '0.1.22'
   s.date          = '2017-10-31'
   s.summary       = 'KSequencing is a moderator service for your online content'
   s.description   = 'Moderation suite'

data/lib/k_sequencing/connection.rb

@@ -34,7 +34,7 @@ module KSequencing
 
     def connection
       options = {
-        url: 'https://kseq.datawow.io'
+        url: 'https://k-sequencing.datawow.io/'
       }
 
       @connection ||= Faraday::Connection.new(options) do |connection|

data/lib/k_sequencing/image_choices.rb

@@ -0,0 +1,28 @@
+module KSequencing
+  # :nodoc:
+  class ImageChoice
+
+    def create(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.post('/api/images/choices', options)
+    end
+
+    def all(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/choices', options)
+    end
+
+    def find_by(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/choice', options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing/image_closed_questions.rb

@@ -0,0 +1,28 @@
+module KSequencing
+  # :nodoc:
+  class ImageClosedQuestion
+
+    def create(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.post('/api/images/closed_questions', options)
+    end
+
+    def find_by(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/closed_question', options)
+    end
+
+    def all(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/closed_questions', options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing/image_messages.rb

@@ -0,0 +1,28 @@
+module KSequencing
+  # :nodoc:
+  class ImageMessage
+
+    def create(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.post('/api/images/messages', options)
+    end
+
+    def all(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/messages', options)
+    end
+
+    def find_by(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/message', options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing/image_photo_tags.rb

@@ -0,0 +1,28 @@
+module KSequencing
+  # :nodoc:
+  class ImagePhotoTag
+
+    def all(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/photo_tags', options)
+    end
+
+    def find_by(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/images/photo_tag', options)
+    end
+
+    def create(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.post('/api/images/photo_tags', options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing/predictions.rb

@@ -0,0 +1,28 @@
+module KSequencing
+  # :nodoc:
+  class Prediction
+
+    def create(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.post('/api/prime/predictions', options)
+    end
+
+    def all(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get('/api/prime/predictions', options)
+    end
+
+    def find_by(options = {})
+      options[:token] ||= KSequencing.project_key
+      connection.get("/api/prime/predictions/#{options[:id]}", options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing.rb

@@ -3,7 +3,11 @@ require_relative 'k_sequencing/client_response'
 require_relative 'k_sequencing/connection'
 require_relative 'k_sequencing/error'
 require_relative 'k_sequencing/version'
-
+require_relative 'k_sequencing/image_closed_questions'
+require_relative 'k_sequencing/image_photo_tags'
+require_relative 'k_sequencing/image_choices'
+require_relative 'k_sequencing/image_messages'
+require_relative 'k_sequencing/predictions'
 # :nodoc:
 module KSequencing
   mattr_accessor :user_key, :project_key
@@ -16,5 +20,27 @@ module KSequencing
     def client
       Client.new
     end
+
+    def image_closed_question
+      ImageClosedQuestion.new
+    end
+
+    def image_photo_tag
+      ImagePhotoTag.new
+    end
+
+    def image_choice
+      ImageChoice.new
+    end
+
+    def image_message
+      ImageMessage.new
+    end
+
+    def prediction
+      Prediction.new
+    end
+
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_sequencing
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Jesdakorn Samittiauttakorn
@@ -92,6 +92,11 @@ files:
 - lib/k_sequencing/connection.rb
 - lib/k_sequencing/error.rb
 - lib/k_sequencing/faraday/raise_http_exception.rb
+- lib/k_sequencing/image_choices.rb
+- lib/k_sequencing/image_closed_questions.rb
+- lib/k_sequencing/image_messages.rb
+- lib/k_sequencing/image_photo_tags.rb
+- lib/k_sequencing/predictions.rb
 - lib/k_sequencing/version.rb
 homepage: https://datawow.io
 licenses: