k_sequencing 0.0.5 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b20f45a086a84380c31617587d242641e383a87e
-  data.tar.gz: 06446bf4a6330b14c37ad26bf6ffee8414ff9459
+  metadata.gz: ac8d1a9191c7b01681bd8321fecbd7a0e47b7e29
+  data.tar.gz: b8a434c282ed4b1b988f25c126b0fbed3e781712
 SHA512:
-  metadata.gz: 166202a8c8e48ac76985347cac735c14bdd0254d0d7249b6e0556e54352d6237f219e36b7d1c4b548edca0dc7646fa529a964b1f12b493965d4de9187e3dfdea
-  data.tar.gz: b73b976f4e5d1c62fcf72e6071fdebf123d27c83623cee3b22fe226efd43ad20e2cd544702d2b3623db2d7de5c88efcaf9a6585756854db4e01448ae5eefa64e
+  metadata.gz: bb745ec30b822eb9964fc59338de20f256a83d5ebc9f7769a6457975c790e637bb328ec16fe4b1ed9222daec34c37aef05a42f2ae70bc9dd394fa11d82b568ac
+  data.tar.gz: 2aa1a039ba1f82efebb629e5e154076c495a082cdd91b36f3da2da06aad9a9795f995f54487ccd4e45dace122fe5d1c6d83dcf985610b10c359406ad44fce35d

data/README.md

@@ -4,7 +4,7 @@ Image and content moderation services.
 
 ## Getting Started
 
-KSequencing 0.0.5 works with Rails 4.1 onwards. You can add it to your Gemfile with:
+KSequencing 0.1 works with Rails 4.1 onwards. You can add it to your Gemfile with:
 ```ruby
 gem 'k_sequencing'
 ```
@@ -14,6 +14,19 @@ You have to contact us [Datawow](https://datawow.io/pages/contact) to get your t
 
 ## Usage
 ### Operations about Images
+Get image
+```ruby
+KSequencing.client.get_image_closed_questions()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| id	     | integer      |   No | Image id|
+|custom_id | integer     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
 Create images
 ```ruby
 KSequencing.client.create_image_closed_questions()

data/docs/documentation.md

@@ -7,6 +7,19 @@
 * [Messages](#messages) - User can set messages for answer.
 ---
 #### Closed questions
+Get image
+```ruby
+KSequencing.client.get_image_closed_questions()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| id	     | integer      |   No | Image id|
+|custom_id | integer     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
 Create images
 ```ruby
 KSequencing.client.create_image_closed_questions()
@@ -57,9 +70,22 @@ Sample results
 ```
 ---
 #### Choices
+Get image
+```ruby
+KSequencing.client.get_image_choices()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| id	     | integer      |   No | Image id|
+|custom_id | integer     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
 Create new choices
 ```ruby
-KSequencing.client.create_choices()
+KSequencing.client.create_image_choices()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -78,7 +104,7 @@ Sample request
 
 For one answer
 ```ruby
-KSequencing.client.create_choices(
+KSequencing.client.create_image_choices(
   token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   categories: ["options1", "options2", "options3"],
@@ -87,7 +113,7 @@ KSequencing.client.create_choices(
 ```
 For multiple answer
 ```ruby
-KSequencing.client.create_choices(
+KSequencing.client.create_image_choices(
   token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   categories: ["options1", "options2", "options3"],
@@ -134,9 +160,22 @@ Sample results
 ```
 ---
 #### Messages
+Get image
+```ruby
+KSequencing.client.get_image_messages()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| id	     | integer      |   No | Image id|
+|custom_id | integer     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
 Create new message
 ```ruby
-KSequencing.client.create_messages()
+KSequencing.client.create_image_messages()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -149,7 +188,7 @@ KSequencing.client.create_messages()
 
 Sample request
 ```ruby
-KSequencing.client.create_messages(
+KSequencing.client.create_image_messages(
   token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   data: "image_url"
@@ -187,9 +226,22 @@ Sample results
 ```
 ---
 #### Photo tags
+Get image
+```ruby
+KSequencing.client.get_image_photo_tags()
+```
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| id	     | integer      |   No | Image id|
+|custom_id | integer     |    No | Client's image id |
+
+Note: You must choose id or custom_id for search. Not both.
+
 Create new photo tag
 ```ruby
-KSequencing.client.create_photo_tags()
+KSequencing.client.create_image_photo_tags()
 ```
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :-----:| :-----|
@@ -202,7 +254,7 @@ KSequencing.client.create_photo_tags()
 
 Sample request
 ```ruby
-KSequencing.client.create_photo_tags(
+KSequencing.client.create_image_photo_tags(
   token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   data: "image_url"

data/k_sequencing.gemspec

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

data/lib/k_sequencing/client.rb

@@ -2,7 +2,7 @@ module KSequencing
 
   class Client
 
-    def create_choices(options = {})
+    def create_image_choices(options = {})
       connection.post("/api/images/choices", options)
     end
 
@@ -10,14 +10,30 @@ module KSequencing
       connection.post("/api/images/closed_questions", options)
     end
 
-    def create_messages(options = {})
+    def create_image_messages(options = {})
       connection.post("/api/images/messages", options)
     end
 
-    def create_photo_tags(options = {})
+    def create_image_photo_tags(options = {})
       connection.post("/api/images/photo_tags", options)
     end
 
+    def get_image_choices(options = {})
+      connection.get("/api/images/choice", options)
+    end
+
+    def get_image_closed_questions(options = {})
+      connection.get("/api/images/closed_question", options)
+    end
+
+    def get_image_messages(options = {})
+      connection.get("/api/images/message", options)
+    end
+
+    def get_image_photo_tags(options = {})
+      connection.get("/api/images/photo_tag", options)
+    end
+
     private
 
     def connection

data/lib/k_sequencing/connection.rb

@@ -6,6 +6,18 @@ module KSequencing
 
   class Connection
 
+    def get(path, options = {})
+      response = connection.get do |request|
+        request.url(path)
+        request.headers["Content-Type"] = "application/json"
+        request.headers["Authorization"] = options[:token] unless options[:token].nil?
+        request.params = options
+      end
+      Response.new(data(response), true, response.status, "success", meta(response), total(response))
+    rescue Error, Faraday::Error => e
+      handle_error(e)
+    end
+
     def post(path, options = {}, query_params = {})
       response = connection.post do |request|
         request.path = path

data/lib/k_sequencing/version.rb

@@ -1,3 +1,3 @@
 module KSequencing
-  VERSION = '0.0.5'
+  VERSION = '0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_sequencing
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: '0.1'
 platform: ruby
 authors:
 - Jesdakorn Samittiauttakorn