k_sequencing 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93ef61a650856980af253bb1d454f311411fbaad
+  data.tar.gz: a70ad95c23d79ce0be95b7fe1f59aa0074f1635c
+SHA512:
+  metadata.gz: 206fcbb162c220285719976891445cd37e03b14f2e0b618983548e5043ad9393623df5f33d976a7c97931bee17249427532a04ade88353e6491321f01117d796
+  data.tar.gz: 5d20e6a370f8c783aceac48dca626bde26622d887fc8e3a726bea4d544405b9025972753d948424f814969f2df6461b0107baee348010db44b0ffaa4ddd433fc

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# k_sequencing_gem
+
+Image and content moderation services.
+
+## Getting Started
+
+KSequencing 0.0.2 works with Rails 4.1 onwards. You can add it to your Gemfile with:
+```ruby
+gem 'k_sequencing'
+```
+Then run bundle install
+
+You have to contact us [Kiyo](http://kiyo.tech/pages/contact) to get your token. With this token you'll be able to use our gem properly.
+
+## Usage
+### Operations about Images
+Create images
+```ruby
+KSequencing.client.create_image_closed_questions()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| token     | 	string | Yes |User Authorization Token|
+| data     | 	string | Yes |Data for moderate|
+| postback_url	     | string      |   Yes | Image postback url|
+| postback_method     | 	string | No |Postback method|
+| custom_id	     | string      |   No |Custom's id|
+
+Sample request
+
+```ruby
+KSequencing.client.create_image_closed_questions(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  data: "image_url",
+  postback_url: "www.example.com"
+)
+```
+
+```
+curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "data=image_url&postback_url=www.example.com" "http://k-sequencing.datawow.io/api/images/closed_questions"
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": {
+      "$oid": "58c7a9f412c09f1c0fa78390"
+    },
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "image_url",
+    "deadline_at": "2017-03-14T08:29:40.697+00:00",
+    "postback_url": "www.example.com",
+    "process": false,
+    "processed_at": null,
+    "project_id": null,
+    "staff_id": null,
+    "created_at": "2017-03-14T08:29:40.696Z",
+    "updated_at": "2017-03-14T08:29:40.696Z"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### 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.
+
+## License
+
+This project is licensed under datawowio

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/docs/documentation.md

@@ -0,0 +1,254 @@
+## 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
+Create images
+```ruby
+KSequencing.client.create_image_closed_questions()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| data     | 	string | Yes |Data for moderate|
+| postback_url	     | string      |   Yes | Image postback url|
+| postback_method     | 	string | No |Postback method|
+| custom_id	     | string      |   No |Custom's id|
+
+Sample request
+```ruby
+KSequencing.client.create_image_closed_questions(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  data: "image_url",
+  postback_url: "www.example.com"
+)
+```
+
+```
+curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "data=image_url&postback_url=www.example.com" "http://k-sequencing.datawow.io/api/images/closed_questions"
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": {
+      "$oid": "58c7a9f412c09f1c0fa78390"
+    },
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "image_url",
+    "deadline_at": "2017-03-14T08:29:40.697+00:00",
+    "postback_url": "www.example.com",
+    "process": false,
+    "processed_at": null,
+    "project_id": 1,
+    "staff_id": null,
+    "created_at": "2017-03-14T08:29:40.696Z",
+    "updated_at": "2017-03-14T08:29:40.696Z"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### Choices
+Create new choices
+```ruby
+KSequencing.client.create_choices()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| instruction	     | string      |   Yes | Image instruction|
+|categories | Array[string]     |    Yes | Categories of answers |
+| data     | 	string | Yes |Data for attachment|
+| postback_url	     | string      |   Yes | Image instruction|
+|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|
+
+Note: Answer can choose only one is default. If you want answer to be multiple, you need to set multiple to true.
+
+Sample request
+
+For one answer
+```ruby
+KSequencing.client.create_choices(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  instruction: "question",
+  categories: ["options1", "options2", "options3"],
+  data: "image_url",
+  postback_url: "www.example.com"
+)
+```
+For multiple answer
+```ruby
+KSequencing.client.create_choices(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  instruction: "question",
+  categories: ["options1", "options2", "options3"],
+  data: "image_url",
+  postback_url: "www.example.com",
+  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&postback_url=www.example.com" "http://k-sequencing.datawow.io/api/images/choices"
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": {
+      "$oid": "58c8c39012c09f1c0fa78391"
+    },
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "image_url",
+    "deadline_at": "2017-03-15T04:31:12.601+00:00",
+    "postback_url": "www.example.com",
+    "process": false,
+    "instruction": "question",
+    "categories": [
+      "option1",
+      "option2",
+      "option3"
+    ],
+    "project_id": 1,
+    "multiple": false,
+    "processed_at": null,
+    "staff_id": null,
+    "created_at": "2017-03-15T04:31:12.600Z",
+    "updated_at": "2017-03-15T04:31:12.600Z"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+
+```
+---
+#### Messages
+Create new message
+```ruby
+KSequencing.client.create_messages()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| instruction	     | string      |   Yes | Image instruction|
+| data     | 	string | Yes |Data for attachment|
+| postback_url	     | string      |   Yes | Image postback url|
+| postback_method     | 	string | No |Postback method|
+| custom_id	     | string      |   No |Custom's id|
+
+Sample request
+```ruby
+KSequencing.client.create_messages(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  instruction: "question",
+  data: "image_url",
+  postback_url: "www.example.com"
+)
+```
+
+```
+curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" -H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "instruction=question&data=image_url&postback_url=www.example.com" "http://k-sequencing.datawow.io/api/images/messages"
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": {
+      "$oid": "58c8c3ef12c09f1c0fa78392"
+    },
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "image_url",
+    "deadline_at": "2017-03-15T04:32:47.763+00:00",
+    "postback_url": "www.example.com",
+    "process": false,
+    "instruction": "question",
+    "project_id": 1,
+    "processed_at": null,
+    "staff_id": null,
+    "created_at": "2017-03-15T04:32:47.762Z",
+    "updated_at": "2017-03-15T04:32:47.762Z"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---
+#### Photo tags
+Create new photo tag
+```ruby
+KSequencing.client.create_photo_tags()
+```
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| token     | 	string | Yes |Project Authorization Token|
+| instruction	     | string      |   Yes | Image instruction|
+| data     | 	string | Yes |Data for attachment|
+| postback_url	     | string      |   Yes | Image postback url|
+| postback_method     | 	string | No |Postback method|
+| custom_id	     | string      |   No |Custom's id|
+
+Sample request
+```ruby
+KSequencing.client.create_photo_tags(
+  token: "9UPmGGWEwBsJrVnw6844tfpd",
+  instruction: "question",
+  data: "image_url",
+  postback_url: "www.example.com"
+)
+```
+
+```
+curl --request POST -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json" --H "Authorization: 9UPmGGWEwBsJrVnw6844tfpd" --data "instruction=question&data=image_url&postback_url=www.example.com" "http://k-sequencing.datawow.io/api/images/photo_tags"
+```
+
+Sample results
+```json
+{
+  "data": {
+    "id": {
+      "$oid": "58c8c45c12c09f1c0fa78394"
+    },
+    "answer": null,
+    "credit_charged": 0,
+    "custom_id": null,
+    "data": "image_url",
+    "deadline_at": "2017-03-15T04:34:36.231+00:00",
+    "postback_url": "www.example.com",
+    "process": false,
+    "instruction": "question",
+    "project_id": 1,
+    "processed_at": null,
+    "staff_id": null,
+    "created_at": "2017-03-15T04:34:36.230Z",
+    "updated_at": "2017-03-15T04:34:36.230Z"
+  },
+  "meta": {
+    "code": 200,
+    "message": "success"
+  }
+}
+```
+---

data/k_sequencing.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'k_sequencing'
+  s.version       = '0.0.2'
+  s.date          = '2017-05-24'
+  s.summary       = 'KSequencing is a moderator service for your online content'
+  s.description   = 'Moderation suite'
+  s.authors       = ['Jesdakorn Samittiauttakorn']
+  s.email         = 'ton@nanameue.jp'
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = 'https://kiyo.tech'
+  s.license       = 'Commercial'
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+  s.add_runtime_dependency 'activesupport', '4.1'
+  s.add_runtime_dependency 'faraday', '~> 0.9.2'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.10.0'
+  s.add_runtime_dependency 'faraday_middleware-active_support_json', '~> 0.0.3'
+end

data/lib/k_sequencing/client.rb

@@ -0,0 +1,29 @@
+module KSequencing
+
+  class Client
+
+    def create_choices(options = {})
+      connection.post("/api/images/choices", options)
+    end
+
+    def create_image_closed_questions(options = {})
+      connection.post("/api/images/closed_questions", options)
+    end
+
+    def create_messages(options = {})
+      connection.post("/api/images/messages", options)
+    end
+
+    def create_photo_tags(options = {})
+      connection.post("/api/images/photo_tags", options)
+    end
+
+    private
+
+    def connection
+      @connection ||= Connection.new
+    end
+
+  end
+
+end

data/lib/k_sequencing/client_response.rb

@@ -0,0 +1,23 @@
+module KSequencing
+
+  class Response
+
+    attr_reader :count, :message, :status
+    attr_accessor :value, :meta
+
+    def initialize(value, success, response_code = "", response_message = "success", meta = nil, total = 0)
+      @value = value
+      @success = success
+      @status = response_code
+      @message = response_message
+      @total = total
+      @meta = meta
+    end
+
+    def successful?
+      !something.nil?
+    end
+
+  end
+
+end

data/lib/k_sequencing/connection.rb

@@ -0,0 +1,65 @@
+require File.expand_path("../faraday/raise_http_exception.rb", __FILE__)
+require File.expand_path("../client_response.rb", __FILE__)
+require 'active_support/all'
+
+module KSequencing
+
+  class Connection
+
+    def post(path, options = {}, query_params = {})
+      response = connection.post do |request|
+        request.path = path
+        request.headers["Content-Type"] = "application/json"
+        request.headers["Authorization"] = options[:token] unless options[:token].nil?
+        request.params = query_params
+        request.body = options unless options.empty?
+      end
+      Response.new(data(response), true, response.status)
+    rescue Error, Faraday::Error => e
+      handle_error(e)
+    end
+
+    private
+
+    def connection
+      options = {
+        url: 'http://localhost:3001'
+      }
+
+      @connection ||= Faraday::Connection.new(options) do |connection|
+        connection.request :url_encoded
+        connection.request :json
+        connection.response :json
+        connection.use KSequencing::FaradayMiddleware::RaiseHttpException
+        connection.use :gzip
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def meta(response)
+      response.body["meta"]
+    end
+
+    def total(response)
+      meta(response)["count"] if meta(response).present?
+    end
+
+    def data(response)
+      response.body["data"]
+    end
+
+    def handle_error(exception)
+      if exception.is_a?(Faraday::ConnectionFailed)
+        code = 599
+        message = "Connection Failed"
+      else
+        code = exception.to_s.partition(":").first
+        message = exception.to_s.partition(":").last
+      end
+
+      Response.new(nil, false, code, message, 0)
+    end
+
+  end
+
+end

data/lib/k_sequencing/error.rb

@@ -0,0 +1,15 @@
+module KSequencing
+
+  # Custom error class for rescuing from all API errors
+  class Error < StandardError; end
+
+  # Raised when API returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when API returns the HTTP status code 403
+  class NotPermitted < Error; end
+
+  # Raised when API returns the HTTP status code 404
+  class NotFound < Error; end
+
+end

data/lib/k_sequencing/faraday/raise_http_exception.rb

@@ -0,0 +1,46 @@
+require 'faraday_middleware'
+
+module KSequencing
+
+  module FaradayMiddleware
+
+    class RaiseHttpException < Faraday::Middleware
+
+      def call(request_env)
+        @app.call(request_env).on_complete do |response|
+          case response[:status].to_i
+          when 200, 201
+            # nothing to do here
+          when 400
+            error_message = error_message(response[:body])
+            raise BadRequest, "#{response[:status]}: #{error_message}"
+          when 403
+            error_message = error_message(response[:body])
+            raise NotPermitted, "#{response[:status]}: #{error_message}"
+          when 404
+            error_message = error_message(response[:body])
+            raise NotFound, "#{response[:status]}: #{error_message}"
+          else
+            request_method = response[:method].to_s.upcase
+            request_url = response[:url].to_s
+            response_status = response[:status]
+            error_message = error_message(response[:body])
+            raise Error, "#{response_status}: #{request_method} #{request_url} #{error_message}"
+          end
+        end
+      end
+
+      private
+
+      def error_message(response_body)
+        if response_body.present? && response_body.is_a?(String)
+          response_body = JSON.parse(response_body)
+          response_body["message"]
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/k_sequencing/version.rb

@@ -0,0 +1,3 @@
+module KSequencing
+  VERSION = '0.0.2'
+end

data/lib/k_sequencing.rb

@@ -0,0 +1,11 @@
+require_relative 'k_sequencing/client'
+require_relative 'k_sequencing/client_response'
+require_relative 'k_sequencing/connection'
+require_relative 'k_sequencing/error'
+require_relative 'k_sequencing/version'
+
+module KSequencing
+  def self.client
+    Client.new
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: k_sequencing
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jesdakorn Samittiauttakorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-active_support_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: Moderation suite
+email: ton@nanameue.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- docs/documentation.md
+- k_sequencing.gemspec
+- lib/k_sequencing.rb
+- lib/k_sequencing/client.rb
+- lib/k_sequencing/client_response.rb
+- lib/k_sequencing/connection.rb
+- lib/k_sequencing/error.rb
+- lib/k_sequencing/faraday/raise_http_exception.rb
+- lib/k_sequencing/version.rb
+homepage: https://kiyo.tech
+licenses:
+- Commercial
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: KSequencing is a moderator service for your online content
+test_files: []