idp_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f634f75943a1968dc490b1a312c66cba30edd8f8853ab8fd5620fbba53f4dea
+  data.tar.gz: e5fa3c006d4bd66695dc839b53126e3f877939efd4973786526ffbe308b60608
+SHA512:
+  metadata.gz: b8c3b1133d1af8512dd8da7bf0af857e5be2eacf8f7360aad2a7594631bad5288d72a357505239acd20a9762820b8eea6b7463c429ed16cc9cc445ea3e9b0088
+  data.tar.gz: f49db71a6c7016d1686527c15ecc3cfc0c59d8b0baab9e4610dd2e2d87de9366c55e3b366a620b141e18f8ae28d7b4dcce8a250b8ada1f931e8265f7dd3ee043

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at anyang@6estates.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in idp_ruby.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 “anyang”
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# 6Estates idp-ruby
+
+A Ruby SDK for communicating with the 6Estates Intelligent Document Processing(IDP) Platform.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add idp_sdk_ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install idp_sdk_ruby
+
+## Documentation
+The documentation for the 6Estates IDP API can be found via https://idp-sea.6estates.com/docs
+
+
+## Usage
+
+### 1. Initialize the 6Estates IDP Client
+6E API Access Token(Deprecated)
+
+```ruby
+    require 'idp_sdk_ruby'
+    
+    c=IdpSdkRuby::Client.new(region:"your-region", token:'your-token-here')
+```
+
+6E API Authorization based on oauth 2.0
+```ruby
+    require 'idp_sdk_ruby'
+    
+    oauth=IdpSdkRuby::oauthutil(region:"your-region", authorization: "your-authorization-here")
+    c=IdpSdkRuby::Client.new(region:"your-region", token:oauth, isOauth:true)
+
+```
+### 2. To Extract Fields in Synchronous Way
+If you just need to do one file at a time
+
+```ruby
+    require 'idp_sdk_ruby'
+    c=IdpSdkRuby::Client.new(region:"test", token:'your-token-here')
+    task_result=c.extraction_task.run_simple_task(file:File.new('path-to-the-file',"rb"), file_type:IdpSdkRuby::FileType.new().full_name_of_the_file_type)
+```
+
+### 3. To Extract Fields in Asynchronous Way
+If you need to do a batch of files
+
+```ruby
+    require 'idp_sdk_ruby'
+    c=IdpSdkRuby::Client.new(region:"test", token:'your-token-here')
+    task=c.extraction_task.create(file:File.new('path-to-the-file',"rb"), file_type:IdpSdkRuby::FileType.new().full_name_of_the_file_type)
+    task_result = result(task.task_id)
+    while(task_result.status=='Doing' or task_result.status=='Init')
+        sleep(3)
+        task_result = result(task.task_id)
+    end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "idp_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/idp_ruby.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/idp_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "idp_ruby"
+  spec.version       = IdpRuby::VERSION
+  spec.authors       = ["“anyang”"]
+  spec.email         = ["anyang@6estates.com"]
+
+  spec.summary       = "idp_sdk_ruby"
+  spec.description   = "idp_sdk_ruby"
+  spec.homepage      = "https://rubygems.org/gems/idp_ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/idp_ruby/version.rb

@@ -0,0 +1,3 @@
+module IdpRuby
+  VERSION = "0.1.0"
+end

data/lib/idp_ruby.rb

@@ -0,0 +1,258 @@
+#idp-sdk-ruby.rb
+# -*- coding: UTF-8 -*-
+
+require 'rest_client'
+require 'json'
+require_relative 'idp_sdk_ruby/version'
+
+module IdpSdkRuby
+    class FileType
+        def bank_statement
+            return 'CBKS'
+        end
+        def invoice
+            return 'CINV'
+        end
+        def cheque
+            return 'CHQ'
+        end
+        def credit_bureau_singapore
+            return 'CBS'
+        end
+        def receipt
+            return 'RCPT'
+        end
+        def payslip
+            return 'PS'
+        end
+        def packing_list
+            return 'PL'
+        end
+        def bill_of_lading
+            return 'BL'
+        end
+        def air_waybill
+            return 'AWBL'
+        end
+        def kartu_tanda_penduduk
+            return 'KTP'
+        end
+        def hong_kong_annual_return
+            return 'HKAR'
+        end
+        def purchase_order
+            return 'PO'
+        end
+        def delivery_order
+            return 'DO'
+        end
+        def FileType
+            return ['CBKS','CINV','CHQ','CBS','RCPT','PS','PL','BL','AWBL','KTP','HKAR','PO','DO']
+        end
+    end
+
+    class IDPException < StandardError
+    end
+
+    class IDPConfigurationException < StandardError
+    end
+
+    class Task
+        def initialize(json=nil)
+            @raw=json
+        end
+
+        def task_id
+            return @raw['data']
+        end
+
+    end
+
+    class TaskResultField
+        def initialize(json=nil)
+            @raw=json
+        end
+
+        def field_code
+            return @raw['field_code']
+        end
+
+        def field_name
+            return @raw['field_name']
+        end
+
+        def value
+            return @raw['value']
+        end
+
+        def type
+            return @raw['type']
+        end
+    end
+
+    class TaskResult
+        def initialize(json=nil)
+            # puts json
+            @raw=json
+        end
+        def raw
+            # puts raw
+            return @raw
+        end
+        def status
+            # puts @raw['data']['taskStatus']
+            return @raw['data']['taskStatus']
+        end
+        def fields
+            fields=Array.new(0)
+            for x in @raw['data']['fields']
+                fields[fields.length]=TaskResultField.new(x)
+            end
+            return fields
+        end
+    end
+
+    class ExtractionTaskClient
+        def initialize(token:nil,region:nil, isOauth:nil)
+            @token=token
+            @region=region
+            @isOauth=isOauth
+
+            if region === 'test'
+                region = ''
+            else
+                region = '-'+region
+            end
+            @url_post = "https://idp"+region + \
+                ".6estates.com/customer/extraction/fields/async"
+            @url_get = "https://idp"+region + \
+                ".6estates.com/customer/extraction/field/async/result/"
+        end
+
+        def create(file:nil, file_type:nil, lang:nil,
+            customer:nil, customer_param:nil, callback:nil,
+            auto_callback:nil, callback_mode:nil, hitl:nil)
+            if FileType.new().FileType.count {|x|x==file_type} == 0
+                raise IDPException.new("Invalid file type")
+            end
+            if file.nil?
+                raise IDPException.new("File is required")
+            end
+            if @isOauth
+                headers = {"Authorization"=> @token}
+            else
+                headers = {"X-ACCESS-TOKEN"=> @token}
+            end
+            # files = {"file": file}
+            data = {'fileType'=> file_type, 'lang'=> lang, 'customer'=> customer,
+                    'customerParam'=> customer_param, 'callback'=> callback,
+                    'autoCallback'=>auto_callback, 'callbackMode'=> callback_mode,
+                    'hitl'=> hitl, "file"=>file}
+            data=data.delete_if{|key,value|value.nil?}
+
+            r = JSON.parse(RestClient.post(@url_post, data, headers))
+            if r['status']==200
+                return Task.new(r)
+            end
+            raise IDPException.new(r['message'])
+        end
+
+        def result(task_id=nil)
+            if task_id.nil?
+                raise IDPConfigurationException.new('Task ID is required')
+            end
+            if @isOauth
+                headers = {"Authorization"=> @token}
+            else
+                headers = {"X-ACCESS-TOKEN"=> @token}
+            end
+            r = JSON.parse(RestClient.get(@url_get+task_id.to_s, headers))
+
+            if r['status']==200
+                return TaskResult.new(r)
+            end
+            raise IDPException.new(r['message'])
+        end
+
+        def run_simple_task(file:nil, file_type:nil, poll_interval:3, timeout:600)
+            """
+                Run simple extraction task 
+                :param file: Pdf/image file. Only one file is allowed to be uploaded each time
+                :type file: file
+                :param file_type: The code of the file type (e.g., CBKS). Please see details of File Type Code.
+                :type file_type: FileType
+                :param poll_interval: Interval to poll the result from api, in seconds
+                :type poll_interval: float
+                :param timeout: Timeout in seconds
+                :type timeout: float
+            """
+            ct=timeout/poll_interval
+            task = create(file:file, file_type:file_type)
+            task_result = result(task.task_id)
+            while(task_result.status=='Doing' or task_result.status=='Init')
+                if (ct-=1) == 0
+                    raise IDPException.new('Task timeout exceeded: {timeout}')
+                end
+                puts "Task is doing. Please wait."
+                sleep(poll_interval)
+                task_result = result(task.task_id)
+                
+                if task_result.status == 'Done'
+                    return task_result
+                end
+            end
+            return task_result
+        end
+    end
+
+    class Client
+        def initialize(token:nil,region:nil, isOauth:false)
+            if token.nil?
+                raise IDPConfigurationException.new('Token is required')
+            end
+            if ["test", "sea"].count {|x|x==region} == 0
+                raise IDPConfigurationException.new(
+                    "Region is required and limited in ['test','sea']")
+            end
+
+            @token=token
+            @region=region
+            @isOauth=isOauth
+            @extraction_task=ExtractionTaskClient.new(token:token,region:region, isOauth:isOauth)
+
+        end
+        def extraction_task
+            return @extraction_task
+        end
+    end
+           
+    def IdpSdkRuby.oauthutil(region:nil, authorization:nil)
+        if authorization.nil?
+            raise IDPConfigurationException.new('Authorization is required')
+        end
+        if ["test", "sea"].count {|x|x==region} == 0
+            raise IDPConfigurationException.new(
+                    "Region is required and limited in ['test','sea']")
+        end
+        if region === 'test'
+               region = '-onp'
+        else
+               region = '-'+region
+        end
+        url_post = "https://oauth"+region + \
+                ".6estates.com/oauth/token?grant_type=client_bind"
+        
+        headers = {"Authorization" => authorization}
+  
+        r = JSON.parse(RestClient.post(url_post, nil, headers))
+        if r['status'] != 200
+            raise IDPException.new(r['message'])
+            return 
+        end
+
+        if r['data']['expired']
+            raise IDPException.new("This IDP Authorization is expired, please re-send the request to get new IDP Authorization.")
+        end
+        return r['data']['value']
+    end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: idp_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "“anyang”"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-13 00:00:00.000000000 Z
+dependencies: []
+description: idp_sdk_ruby
+email:
+- anyang@6estates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- idp_ruby.gemspec
+- lib/idp_ruby.rb
+- lib/idp_ruby/version.rb
+homepage: https://rubygems.org/gems/idp_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/idp_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: idp_sdk_ruby
+test_files: []