k_sequencing 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1c8b30eacc43a71ebaf56c5d83b8d1d20ff9d2d
-  data.tar.gz: c7c27265ef43c139dff1731efc1218b4f74f2564
+  metadata.gz: 414c884c2a6378b04c87a4bb7596d1a814c07089
+  data.tar.gz: d44b2deee17b7fb26bbf2d1281c476856bf6ba27
 SHA512:
-  metadata.gz: 3b22a5b7de6d957077cf376ce76fd0c516c3013f6d703f621db38925d10225717ff51fd81944bfecd9a6a6567ea60be508b97f167ba9afff7746ca1ff1ba80b3
-  data.tar.gz: 105a48c085ba2988fde81a0530e9b7eebbf819384a088c9478793aa39e531b330c357c39a2ec5e22da9cd82583419ef872ce6885ab52548108071e2816373f05
+  metadata.gz: 0cf5b038df68fcb995e169144cdb5c90d68231cd36547498596c43341402817932a797697850dbb49c0d685aebe99152286b604c6bdda00bf4911d56c479bdeb
+  data.tar.gz: c6166361a1e83077ca1fb16fc00603ccbbeec33a4fc6de35c8706faed44895a2def7230f0082562cbce3576a4f07cc5f1c5f14c77e171568411e3d5120823940

data/.gitignore

@@ -1 +1,2 @@
 *.gem
+*.DS_Store

data/README.md

@@ -4,12 +4,20 @@ Image and content moderation services.
 
 ## Getting Started
 
-KSequencing 0.1.3 works with Rails 4.1 onwards. You can add it to your Gemfile with:
+KSequencing 0.1.4 works with Rails 4.1 onwards. You can add it to your Gemfile with:
 ```ruby
 gem 'k_sequencing'
 ```
 Then run bundle install
 
+Next, you need to run the generator:
+
+```console
+$ rails generate k_sequencing:install
+```
+
+The generator will install an initializer which describes ALL of KSequencing's configuration options. It is *imperative* that you take a look at it. When you are done, you are ready to add KSqeuencing to any of your codes.
+
 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
@@ -21,7 +29,6 @@ KSequencing.client.get_image_closed_question()
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
-| token     | 	string | Yes |Project Authorization Token|
 | id	     | string      |   No | Image id|
 |custom_id | string     |    No | Client's image id |
 
@@ -30,7 +37,6 @@ Note: You must choose id or custom_id for search. Not both.
 Sample request
 ```ruby
 KSequencing.client.get_image_closed_question(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   id: "59311194e99991b2ca8979f1"
 )
 ```
@@ -69,7 +75,6 @@ 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      | No | Image postback url|
 | postback_method     | 	string | No |Postback method|
@@ -79,7 +84,6 @@ Sample request
 
 ```ruby
 KSequencing.client.create_image_closed_questions(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   data: "image_url"
 )
 ```

data/docs/documentation.md

@@ -14,7 +14,6 @@ KSequencing.client.get_image_closed_question()
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
-| token     | 	string | Yes |Project Authorization Token|
 | id	     | string      |   No | Image id|
 | custom_id | string     |    No | Client's image id |
 
@@ -23,7 +22,6 @@ Note: You must choose id or custom_id for search. Not both.
 Sample request
 ```ruby
 KSequencing.client.get_image_closed_question(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   id: "59311194e99991b2ca8979f1"
 )
 ```
@@ -62,7 +60,6 @@ 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      | No | Image postback url|
 | postback_method     | 	string | No |Postback method|
@@ -71,7 +68,6 @@ KSequencing.client.create_image_closed_questions()
 Sample request
 ```ruby
 KSequencing.client.create_image_closed_questions(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   data: "image_url"
 )
 ```
@@ -110,7 +106,6 @@ KSequencing.client.get_image_choice()
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
-| token     | 	string | Yes |Project Authorization Token|
 | id	     | string  |   No | Image id|
 |custom_id | string |    No | Client's image id |
 
@@ -119,7 +114,6 @@ Note: You must choose id or custom_id for search. Not both.
 Sample request
 ```ruby
 KSequencing.client.get_image_choice(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   id: "59311194e99991b2ca8979f1"
 )
 ```
@@ -166,7 +160,6 @@ KSequencing.client.create_image_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|
@@ -182,7 +175,6 @@ Sample request
 For one answer
 ```ruby
 KSequencing.client.create_image_choices(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   categories: ["options1", "options2", "options3"],
   data: "image_url"
@@ -191,7 +183,6 @@ KSequencing.client.create_image_choices(
 For multiple answer
 ```ruby
 KSequencing.client.create_image_choices(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   categories: ["options1", "options2", "options3"],
   data: "image_url"
@@ -241,7 +232,6 @@ KSequencing.client.get_image_message()
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
-| token     | 	string | Yes |Project Authorization Token|
 | id	     | string      |   No | Image id|
 |custom_id | string     |    No | Client's image id |
 
@@ -250,7 +240,6 @@ Note: You must choose id or custom_id for search. Not both.
 Sample request
 ```ruby
 KSequencing.client.get_image_message(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   id: "592fbfce1b9d8f69e4178688"
 )
 ```
@@ -290,7 +279,6 @@ KSequencing.client.create_image_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      | No | Image postback url|
@@ -300,7 +288,6 @@ KSequencing.client.create_image_messages()
 Sample request
 ```ruby
 KSequencing.client.create_image_messages(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   data: "image_url"
 )
@@ -341,7 +328,6 @@ KSequencing.client.get_image_photo_tag()
 
 | Field        | Type           | Required  | Description |
 | ------------- |:-------------:| :----:| :-----|
-| token     | 	string | Yes |Project Authorization Token|
 | id	     | string      |   No | Image id|
 |custom_id | string     |    No | Client's image id |
 
@@ -350,7 +336,6 @@ Note: You must choose id or custom_id for search. Not both.
 Sample request
 ```ruby
 KSequencing.client.get_image_photo_tag(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   id: "592fbfec1b9d8f69e4178689"
 )
 ```
@@ -390,7 +375,6 @@ KSequencing.client.create_image_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      | No | Image postback url|
@@ -400,7 +384,6 @@ KSequencing.client.create_image_photo_tags()
 Sample request
 ```ruby
 KSequencing.client.create_image_photo_tags(
-  token: "9UPmGGWEwBsJrVnw6844tfpd",
   instruction: "question",
   data: "image_url"
 )

data/k_sequencing.gemspec

@@ -1,10 +1,11 @@
 # 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.1.3'
+  s.version       = '0.1.4'
   s.date          = '2017-05-24'
   s.summary       = 'KSequencing is a moderator service for your online content'
   s.description   = 'Moderation suite'

data/lib/generators/k_sequencing/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+require 'securerandom'
+
+module KSequencing
+  module Generators
+    # :nodoc:
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a KSequencing initializer
+       and copy locale files to your application.'
+
+      def copy_initializer
+        template 'k_sequencing.rb', 'config/initializers/k_sequencing.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/k_sequencing.rb

@@ -0,0 +1,5 @@
+KSequencing.setup do |config|
+  # ==> Secret key Configuration
+  # You can change it below and use your own secret key.
+  config.project_key = 'Project token key'
+end

data/lib/k_sequencing/client.rb

@@ -1,37 +1,44 @@
 module KSequencing
-
+  # :nodoc:
   class Client
-
     def create_image_choices(options = {})
-      connection.post("/api/images/choices", options)
+      options[:token] = KSequencing.project_key
+      connection.post('/api/images/choices', options)
     end
 
     def create_image_closed_questions(options = {})
-      connection.post("/api/images/closed_questions", options)
+      options[:token] = KSequencing.project_key
+      connection.post('/api/images/closed_questions', options)
     end
 
     def create_image_messages(options = {})
-      connection.post("/api/images/messages", options)
+      options[:token] = KSequencing.project_key
+      connection.post('/api/images/messages', options)
     end
 
     def create_image_photo_tags(options = {})
-      connection.post("/api/images/photo_tags", options)
+      options[:token] = KSequencing.project_key
+      connection.post('/api/images/photo_tags', options)
     end
 
     def get_image_choice(options = {})
-      connection.get("/api/images/choice", options)
+      options[:token] = KSequencing.project_key
+      connection.get('/api/images/choice', options)
     end
 
     def get_image_closed_question(options = {})
-      connection.get("/api/images/closed_question", options)
+      options[:token] = KSequencing.project_key
+      connection.get('/api/images/closed_question', options)
     end
 
     def get_image_message(options = {})
-      connection.get("/api/images/message", options)
+      options[:token] = KSequencing.project_key
+      connection.get('/api/images/message', options)
     end
 
     def get_image_photo_tag(options = {})
-      connection.get("/api/images/photo_tag", options)
+      options[:token] = KSequencing.project_key
+      connection.get('/api/images/photo_tag', options)
     end
 
     private
@@ -39,7 +46,5 @@ module KSequencing
     def connection
       @connection ||= Connection.new
     end
-
   end
-
 end

data/lib/k_sequencing/connection.rb

@@ -1,19 +1,18 @@
-require File.expand_path("../faraday/raise_http_exception.rb", __FILE__)
-require File.expand_path("../client_response.rb", __FILE__)
+require File.expand_path('../faraday/raise_http_exception.rb', __FILE__)
+require File.expand_path('../client_response.rb', __FILE__)
 require 'active_support/all'
 
 module KSequencing
-
+  # :nodoc:
   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.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))
+      Response.new(data(response), true, response.status, 'success', meta(response), total(response))
     rescue Error, Faraday::Error => e
       handle_error(e)
     end
@@ -21,8 +20,8 @@ module KSequencing
     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.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
@@ -49,29 +48,27 @@ module KSequencing
     end
 
     def meta(response)
-      response.body["meta"]
+      response.body['meta']
     end
 
     def total(response)
-      meta(response)["count"] if meta(response).present?
+      meta(response)['count'] if meta(response).present?
     end
 
     def data(response)
-      response.body["data"]
+      response.body['data']
     end
 
     def handle_error(exception)
       if exception.is_a?(Faraday::ConnectionFailed)
         code = 599
-        message = "Connection Failed"
+        message = 'Connection Failed'
       else
-        code = exception.to_s.partition(":").first
-        message = exception.to_s.partition(":").last
+        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/version.rb

@@ -1,3 +1,3 @@
 module KSequencing
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'.freeze
 end

data/lib/k_sequencing.rb

@@ -4,8 +4,17 @@ require_relative 'k_sequencing/connection'
 require_relative 'k_sequencing/error'
 require_relative 'k_sequencing/version'
 
+# :nodoc:
 module KSequencing
-  def self.client
-    Client.new
+  mattr_accessor :user_key, :project_key
+
+  class << self
+    def setup
+      yield self
+    end
+
+    def client
+      Client.new
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: k_sequencing
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jesdakorn Samittiauttakorn
@@ -98,6 +98,8 @@ files:
 - Rakefile
 - docs/documentation.md
 - k_sequencing.gemspec
+- lib/generators/k_sequencing/install_generator.rb
+- lib/generators/templates/k_sequencing.rb
 - lib/k_sequencing.rb
 - lib/k_sequencing/client.rb
 - lib/k_sequencing/client_response.rb