idp_sdk_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e53cbb38374b13e3b090c62a5895b739143803bf11105f67bd2b00d27c98dc17
+  data.tar.gz: aec175d0454da0f0fe3e4d1c6b01f5aa7b41ab016939e62ba84b6cb687b05aae
+SHA512:
+  metadata.gz: dce26e3479f2735fe622008efaf3a3b8ebc0ebc4ddee3667f6868315bb5695066c6687903dffe1bc8e328a98fbc2e6731da739cb13daea805f724f5147fbbcc6
+  data.tar.gz: aa7d20e2aff792703d78582f6a44dffc5ff398e5f496b11d0c35c3034f6f44f4c895c2938e82c4669439d8e536f6a4dbe1ae073ad1d13f2dc249ec4710d01c8f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-06-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in idp_sdk_ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -0,0 +1,29 @@
+# IdpSdkRuby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/idp_sdk_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## 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
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idp_sdk_ruby.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/idp_sdk_ruby.rb

@@ -0,0 +1,218 @@
+#idp-sdk-ruby.rb
+# -*- coding: UTF-8 -*-
+
+require 'rest_client'
+require 'json'
+
+module idp_sdk_ruby
+    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 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)
+            @token=token
+            @region=region
+            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
+
+            headers = {"X-ACCESS-TOKEN"=> @token}
+            # 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?}
+            # print data
+            # puts ""
+
+            r = JSON.parse(RestClient.post(@url_post, data, headers))
+            # puts r
+            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
+            headers = {"X-ACCESS-TOKEN" => @token}
+            r = JSON.parse(RestClient.get(@url_get+task_id.to_s, headers))
+            # puts r
+            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
+                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)
+            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
+            @extraction_task=ExtractionTaskClient.new(token:token,region:region)
+        end
+        def extraction_task
+            return @extraction_task
+        end
+    end
+end
+
+# task = c.extraction_task.create(file:File.new("/home/guo/src/idp-python-sdk/[UOB]202103_UOB_2222.pdf","rb"), file_type:FileType.new().bank_statement)
+# puts task.task_id
+# task_result=c.extraction_task.result(task.task_id)

data/lib/idp_sdk_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IdpSdkRuby
+  VERSION = "0.1.0"
+end

data/lib/idp_sdk_ruby.rb

@@ -0,0 +1,219 @@
+#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 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)
+            @token=token
+            @region=region
+            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
+
+            headers = {"X-ACCESS-TOKEN"=> @token}
+            # 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?}
+            # print data
+            # puts ""
+
+            r = JSON.parse(RestClient.post(@url_post, data, headers))
+            # puts r
+            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
+            headers = {"X-ACCESS-TOKEN" => @token}
+            r = JSON.parse(RestClient.get(@url_get+task_id.to_s, headers))
+            # puts r
+            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
+                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)
+            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
+            @extraction_task=ExtractionTaskClient.new(token:token,region:region)
+        end
+        def extraction_task
+            return @extraction_task
+        end
+    end
+end
+
+# task = c.extraction_task.create(file:File.new("/home/guo/src/idp-python-sdk/[UOB]202103_UOB_2222.pdf","rb"), file_type:FileType.new().bank_statement)
+# puts task.task_id
+# task_result=c.extraction_task.result(task.task_id)

data/sig/idp_sdk_ruby.rbs

@@ -0,0 +1,4 @@
+module IdpSdkRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: idp_sdk_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sihan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: idp_sdk_ruby
+email:
+- sihan.6estates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- "[UOB]202103_UOB_2222.pdf"
+- idp_sdk_ruby.rb
+- lib/idp_sdk_ruby.rb
+- lib/idp_sdk_ruby/version.rb
+- sig/idp_sdk_ruby.rbs
+homepage: https://rubygems.org/gems/idp_sdk_ruby
+licenses: []
+metadata:
+  homepage_uri: https://rubygems.org/gems/idp_sdk_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: idp_sdk_ruby
+test_files: []