posmoni 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3aee8e47665f588407207860ceeffcc18ebd020ed7c553c40b037d4fb51a7428
+  data.tar.gz: c9f85312236758626d9637d2fad95e783fde80d74eef8265ba09908391be229a
+SHA512:
+  metadata.gz: f27a45ffecd3364b7ea645e866145619b13af7f70d660f12a44f5f4f05e20c9b1d1a21c131c610528bbeb4179ff29452ca60198e34f137cf791481b23023fc68
+  data.tar.gz: ec64c2d8da687b6ede05b35dbf2c32f44226e9706b75349d490ad5f286ff89568ede37ac22f0208f140d6a1a4bcd949a440a1ae155ec6b5cff3ab4cb7ed2c4e0

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+datawow-*
+tags

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,42 @@
+PATH
+  remote: .
+  specs:
+    posmoni (0.0.5)
+      json (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    hashdiff (1.0.0)
+    json (2.2.0)
+    minitest (5.13.0)
+    public_suffix (4.0.1)
+    rake (12.3.3)
+    safe_yaml (1.0.5)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (3.7.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.11, >= 5.11.3)
+  posmoni!
+  rake (~> 12.3)
+  simplecov (~> 0.15.1)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.17.1

data/INSTALL.md

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

data/README.md

@@ -0,0 +1,184 @@
+# Content Moderation Ruby Client
+
+# Installation
+
+Installing via rubygems:
+
+```ruby
+gem 'posmoni', '~> 0.0.5'
+```
+
+### Rails
+
+```bash
+$ rails generate posmoni:install
+```
+
+# Configuration
+
+First configure your project key:
+
+```ruby
+require 'posmoni'
+
+Posmoni.project_key = YOUR_PROJECT_KEY
+```
+# Usage
+
+There are 3 methods available in moderation class (`create`, `all`, `find_by`). Each
+method returns a response of type `Posmoni::Response`, which has two attributes,
+`body` and `code`. You can simply access response's body by calling `.body`
+
+### Create
+```ruby
+require 'posmoni'
+
+Posmoni.project_key = YOUR_PROJECT_KEY
+params = {
+  data: data,
+  postback_url: postback_url,
+  postback_method: postback_method,
+  custom_id: custom_id
+}
+Posmoni.moderation.create(params)
+```
+
+`data` could be text or image's url depends on your project's template.
+
+#### 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 |
+
+#### result
+```
+response = Posmoni.moderation.create({
+  data: YOUR_DATA,
+  custom_id: 'data-1'
+})
+
+print(response.body)
+```
+
+You will receive response like below, once you created moderation successfully.
+
+```ruby
+{
+  "data" => {
+    "id" => "5dbab19ebbadfc32kefb56bf",
+    "type" => "moderation",
+    "attributes" => {
+      "custom_id" => "data-1",
+      "data" => YOUR_DATA,
+      "postback" => false,
+      "postback_url" => YOUR_POSTBACK_URL,
+      "postback_method" => YOUR_POSTBACK_METHOD,
+      "answer" => nil,
+      "created_at" => "2019-10-31T17:04:14.540+07:00",
+      "processed_at" => nil,
+      "status" => "unprocessed",
+      "id" => "5dbab19ebbadfc32kefb56bf",
+      "project_template" => YOUR_PROJECT_TEMPLATE,
+      "project_id" => YOUR_PROJECT_ID
+    }
+  },
+  "meta" => {
+    "code" => 201,
+    "message" => "Created"
+  }
+}
+```
+
+### All
+Method `all` is used to retrieve all of your moderations
+
+```ruby
+require  'posmoni'
+
+Posmoni.project_key = YOUR_PROJECT_KEY
+Posmoni.moderation.all
+```
+
+#### result
+```ruby
+{
+  "data" => [
+    {
+      "id" => "5dbab19ebbadfc32kefb56bf",
+      "type" => "moderation",
+      "attributes" => {
+        "custom_id" => "data-1",
+        "data" => YOUR_DATA,
+        "postback" => false,
+        "postback_url" => YOUR_POSTBACK_URL,
+        "postback_method" => YOUR_POSTBACK_METHOD,
+        "answer" => "approved",
+        "project_template" => YOUR_PROJECT_TEMPLATE,
+        "created_at" => "2019-10-31T17:15:15.302+07:00",
+        "processed_at" => "2019-10-31T17:16:15.814+07:00",
+        "status" => "processed",
+        "id" => "5dbab19ebbadfc32kefb56bf",
+        "project_template" => YOUR_PROJECT_TEMPLATE,
+        "project_id" => YOUR_PROJECT_ID,
+      }
+    }
+  ],
+  "meta" => {
+    "code" => 200,
+    "message" => "OK"
+  }
+}
+```
+
+Fields `result` and `processed_at` will be present if your data was successfully processed.
+
+### Find by
+Method `find_by` is used to find a particular moderation. You can use either its
+ID or Custom ID. This method will return only moderation with fully matched ID.
+
+```ruby
+require 'posmoni'
+
+Posmoni.project_key = YOUR_PROJECT_KEY
+id = 'data-1' # or use an ID from creation response (example: '5dbab19ebbadfc32kefb56bf')
+Posmoni.moderation.find_by(id: id)
+```
+
+#### params
+
+| Field        | Type           | Required  | Description |
+| ------------- |:-------------:| :-----:| :-----|
+| id | string | **Yes** | ID or Custom ID of a moderation |
+
+#### result
+```ruby
+{
+  "data" => {
+    "id" => "5dbab19ebbadfc32kefb56bf",
+    "type" => "moderation",
+    "attributes" => {
+      "custom_id" => "tp-1",
+      "data" => YOUR_DATA,
+      "postback" => false,
+      "postback_url" => YOUR_POSTBACK_URL,
+      "postback_method" => YOUR_POSTBACK_METHOD,
+      "answer" => "approved",
+      "project_template" => YOUR_PROJECT_TEMPLATE,
+      "created_at" => "2019-10-31T17:04:14.540+07:00",
+      "processed_at" => "2019-10-31T17:05:16.243+07:00",
+      "status" => "processed",
+      "id" => "5dbab19ebbadfc32kefb56bf",
+      "project_template" => YOUR_PROJECT_TEMPLATE,
+      "project_id" => YOUR_PROJECT_ID,
+    }
+  },
+  "meta" => {
+    "code" => 200,
+    "message" => "OK"
+  }
+}
+```

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/lib/generators/posmoni/install_generator.rb

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

data/lib/generators/templates/posmoni_api.rb

@@ -0,0 +1,7 @@
+require 'posmoni'
+
+Posmoni.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/posmoni.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'posmoni/response'
+require_relative 'posmoni/connector'
+require_relative 'posmoni/error'
+require_relative 'posmoni/version'
+require_relative 'posmoni/interface'
+
+require_relative 'posmoni/moderation'
+
+# :nodoc:
+module Posmoni
+  extend self
+
+  attr_accessor :project_key
+
+  class << self
+    def setup
+      yield self
+    end
+
+    def moderation
+      Moderation.new
+    end
+  end
+end

data/lib/posmoni/connector.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+require File.expand_path('response.rb', __dir__)
+
+module Posmoni
+  # :nodoc:
+  class Connector
+    def initialize(path, type, token: '', version_api: 'v1')
+      @version_api = version_api
+      @type = type
+      @path = path
+      @token = token
+      @method = :GET
+    end
+
+    def post(data = {})
+      @method = :POST
+      response = send_request(data)
+      response_body = JSON.parse response.body
+      Response.new(response_body, response.code)
+    end
+
+    def get(data = {}, query_str = true)
+      @method = :GET
+      response = send_request(data, query_str)
+      response_body = JSON.parse response.body
+      Response.new(response_body, response.code)
+    end
+
+    def put(data = {})
+      @method = :PUT
+      response = send_request(data)
+      response_body = JSON.parse response.body
+      Response.new(response_body, response.code)
+    end
+
+    def delete(data = {}, query_str = true)
+      @method = :DELETE
+      response = send_request(data, query_str)
+      response_body = JSON.parse response.body
+      Response.new(response_body, response.code)
+    end
+
+    private
+
+    def send_request(data = {}, query_str = true)
+      base_uri = base_point(@type)
+      url_base = "#{base_uri}/#{@version_api}/#{@path}"
+      uri = URI.parse(url_base)
+
+      if @method == :GET
+        if query_str
+          uri.query = URI.encode_www_form(data)
+        else
+          url_base = "#{url_base}/#{data[:id]}"
+          uri = URI.parse(url_base)
+        end
+      end
+
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+      request = build_request(uri)
+      request.body = data.to_json
+      https.request(request)
+    end
+
+    def build_request(uri)
+      request = {}
+      token = @token || Posmoni.project_key
+
+      if (token || '').empty?
+        raise ArgumentError, 'project\'s token has missed. To config about token check our document'
+      end
+
+      case @method
+      when :POST
+        request = Net::HTTP::Post.new(uri.request_uri)
+      when :GET
+        request = Net::HTTP::Get.new(uri.request_uri)
+      when :PUT
+        request = Net::HTTP::Put.new(uri.request_uri)
+      when :DELETE
+        request = Net::HTTP::Delete.new(uri.request_uri)
+      else
+        raise ArgumentError, 'HTTP method is not exist, We allowed GET, POST, PUT, DELET only'
+      end
+
+      request['User-Agent'] = 'Posmoni Ruby gem client'
+      request['Accept'] = 'application/json'
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = token
+
+      request
+    end
+
+    def base_point(type)
+      {
+        moderation: 'https://api.posmoni.com/api'
+      }[type]
+    end
+  end
+end

data/lib/posmoni/error.rb

@@ -0,0 +1,15 @@
+module Posmoni
+
+  # 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