abbyy-ruby 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc6450ad5597fc12860b98eb3d6cbe931700f156178f2253c1689a492bd5d79a
+  data.tar.gz: bed1bfaf806bd81e34bb5220d5c1365a6d1b48b9a2e2b0f4de09eabfe4444650
+SHA512:
+  metadata.gz: 41f2a33b5a258e8ee91002e5249b1198e04906c7cc15b6c363842458f1618a2920dc71624f26f9aadc0c0aaa6e4ecc771b55cbe6b8156982dbf09194d8577150
+  data.tar.gz: 71543ac82d519ecc44b05fef53819396220db6c6d00a0e4dc1e7dab506be872e5052ebefbec58bc72c563758c8291d55a160a09e02dd9cc3a741470d41e118dd

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.6.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in abbyy.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,94 @@
+# abbyy-ruby
+
+Simple Ruby wrapper for Abbyy Cloud OCR SDK
+The initial code was borrowed from https://github.com/silex-pro/abbyy
+
+[![Build Status](https://img.shields.io/travis/silex-pro/abbyy-ruby.svg)](https://travis-ci.org/silex-pro/abbyy-ruby)
+[![Gem](https://img.shields.io/gem/v/abbyy-ruby.svg)](https://rubygems.org/gems/abbyy-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abbyy-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abbyy-ruby
+
+### Example
+
+```ruby
+client = Abbyy::Client.new(APPLICATION_ID, PASSWORD)
+client.process_business_card "business_card.png", exportFormat: 'xml', imageSource: 'photo'
+client.get_task_status
+client.get
+```
+
+### Example with Ruby on Rails
+
+    $ touch config/initializers/abbyy.rb
+
+```ruby
+require 'abbyy'
+
+Abbyy.configure do |config|
+  config.application_id = APPLICATION_ID
+  config.password = PASSWORD
+end
+```
+
+Everywhere in your rails application, you can access Abbyy without crendentials:
+
+```ruby
+client = Abbyy::Client.new
+client.process_image "image.png"
+```
+
+### Example with Resque
+
+Create new worker ImageScanner:
+
+    $ touch app/workers/image_scanner.rb
+
+```ruby
+class ImageScanner
+  @queue = :scanner
+
+  def self.perform(attachment_id)
+    attachment = Attachment.find_by_id(attachment_id)
+    client = Abbyy::Client.new
+    client.process_business_card attachment.full_filename, exportFormat: 'xml', imageSource: 'photo'
+    while %w(Queued InProgress).include?(client.task[:status])
+      sleep(client.task[:estimatedProcessingTime].to_i)
+      client.get_task_status
+    end
+    if client.task[:status] == 'Completed'
+      xml_data = REXML::Document.new(client.get)
+      ...
+    else
+      ...
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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`.
+
+## Contributing
+
+1. Fork it ( https://github.com/silex-pro/abbyy-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task :default => :spec

data/abbyy-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abbyy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "abbyy-ruby"
+  spec.version       = Abbyy::VERSION
+  spec.authors       = ["Adrien Rambert"]
+  spec.email         = ["contact@silex.pro"]
+  spec.summary       = %q{A Ruby wrapper for the Abbyy Cloud OCR SDK API.}
+  spec.homepage      = "https://github.com/silex-pro/abbyy-ruby"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "pry-doc", "~> 0"
+
+  spec.add_dependency "rest-client", ">= 2.0.0"
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "abbyy"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/abbyy.rb

@@ -0,0 +1,21 @@
+require 'rest-client'
+require 'rexml/document'
+require 'cgi'
+
+require 'abbyy/version'
+require 'abbyy/client'
+require 'abbyy/exceptions'
+
+module Abbyy
+  extend self
+
+  attr_accessor :application_id, :password
+
+  # Abbyy.configure do |config|
+  #   config.application_id = 'application_id'
+  #   config.password = 'password'
+  # end
+  def configure
+    yield self
+  end
+end

data/lib/abbyy/api.rb

@@ -0,0 +1,61 @@
+module Abbyy
+  class API < SimpleDelegator
+    def execute(meth, *args, &block)
+      send meth, *args, &block
+    rescue RestClient::BlockedByWindowsParentalControls => ex
+      raise Abbyy::IncorrectParameters.new(parse_error(ex).message)
+    rescue RestClient::RequestFailed => ex
+      raise Abbyy::ProcessingFailed.new(parse_error(ex).message)
+    end
+
+    # https://www.ocrsdk.com/documentation/api-reference/get-application-info-method/
+    def application_info
+      RestClient.get("#{url}/getApplicationInfo")
+    end
+
+    # http://ocrsdk.com/documentation/apireference/getTaskStatus/
+    def get_task_status(task_id = task[:id])
+      RestClient.get("#{url}/getTaskStatus?taskId=#{task_id}")
+    end
+
+    # http://ocrsdk.com/documentation/apireference/processBusinessCard/
+    def process_business_card(image_path, options = {})
+      RestClient.post("#{url}/processBusinessCard", options.merge(:upload => { :file => File.new(image_path, 'r') }))
+    end
+
+    # http://ocrsdk.com/documentation/apireference/processDocument/
+    def process_document(task_id = task[:id], options={})
+      RestClient.get("#{url}/processDocument?taskId=#{task_id}", params: options)
+    end
+
+    # http://ocrsdk.com/documentation/apireference/processFields/
+    def process_fields(file_path, task_id = task[:id], options = {})
+      RestClient.post("#{url}/processFields?taskId=#{task_id}", options.merge(:upload => { :file => File.new(file_path, 'r') }))
+    end
+
+    # https://www.ocrsdk.com/documentation/api-reference/process-image-method/
+    def process_image(image_path, options = {})
+      RestClient.post("#{url}/processImage", options.merge(:upload => { :file => File.new(image_path, 'r') }))
+    end
+
+    # https://www.ocrsdk.com/documentation/api-reference/process-mrz-method/
+    def process_mrz(image_path, options = {})
+      RestClient.post("#{url}/processMRZ", options.merge(:upload => { :file => File.new(image_path, 'r') }))
+    end
+
+    # https://www.ocrsdk.com/documentation/api-reference/process-receipt-method/
+    def process_receipt(receipt_path, options = {})
+      RestClient.post("#{url}/processReceipt", options.merge(:upload => { :file => File.new(receipt_path, 'r') }))
+    end
+
+    # http://ocrsdk.com/documentation/apireference/processTextField/
+    def process_text_field(image_path, options = {})
+      RestClient.post("#{url}/processTextField", options.merge(:upload => { :file => File.new(image_path, 'r') }))
+    end
+
+    # http://ocrsdk.com/documentation/apireference/submitImage/
+    def submit_image(image_path, options = {})
+      RestClient.post("#{url}/submitImage", options.merge(:upload => { :file => File.new(image_path, 'r') }))
+    end
+  end
+end

data/lib/abbyy/client.rb

@@ -0,0 +1,58 @@
+require 'abbyy/api'
+require 'abbyy/xml'
+require 'abbyy/task'
+
+module Abbyy
+  class Client
+    include Abbyy::XML
+    include Abbyy::Task
+
+    API_ENDPOINT = "cloud.ocrsdk.com"
+
+    attr_reader :task
+
+    def initialize(application_id = Abbyy.application_id, password = Abbyy.password)
+      @appliction_id = application_id
+      @password = password
+      @task = {}
+    end
+
+    # @return [String] the api url with credentials
+    def url
+      @url ||= begin
+        uri = URI::HTTP.build host: API_ENDPOINT
+        uri.user = CGI.escape @appliction_id.to_s
+        uri.password = CGI.escape @password.to_s if uri.user
+        uri.to_s
+      end
+    end
+
+    alias_method :current_task, :task
+
+    # Retrieve the result of processing task
+    #
+    # @param [String] the url of the task result
+    # @return [String] the xml representation
+    def get(url = task[:resultUrl])
+      RestClient.get(url)
+    end
+
+    # http://ocrsdk.com/documentation/apireference/listTasks/
+    # @return [Array] the list of tasks created
+    def list_tasks
+      parse_task get("#{url}/listTasks")
+    end
+
+    def method_missing(meth, *args, &block)
+      api = API.new self
+      self.resource = api.execute meth, *args, &block
+      current_task
+    end
+
+    private
+
+    def resource=(resource)
+      @task = parse_task(resource)
+    end
+  end
+end

data/lib/abbyy/exceptions.rb

@@ -0,0 +1,4 @@
+module Abbyy
+  IncorrectParameters = Class.new(StandardError)
+  ProcessingFailed    = Class.new(StandardError)
+end

data/lib/abbyy/inflector.rb

@@ -0,0 +1,5 @@
+module Abbyy::Inflector
+  def camelize(str)
+    str[0,1] << str.split('_').map{|w| w.capitalize}.join[1..-1]
+  end
+end

data/lib/abbyy/task.rb

@@ -0,0 +1,15 @@
+require 'abbyy/inflector'
+
+module Abbyy
+  module Task
+    include Inflector
+
+    @@attributes = %w(id status result_url registration_time error description estimated_processing_time credits files_count status_change_time)
+
+    @@attributes.each do |attribute|
+      define_method("current_task_#{attribute}") do
+        current_task[camelize(attribute).to_sym]
+      end
+    end
+  end
+end

data/lib/abbyy/version.rb

@@ -0,0 +1,3 @@
+module Abbyy
+  VERSION = "0.2.2"
+end

data/lib/abbyy/xml.rb

@@ -0,0 +1,43 @@
+module Abbyy
+  module XML
+    def parse_task(resource)
+      xml_data = REXML::Document.new(resource)
+      if xml_data.elements["response"].size > 1
+        Array.new.tap do |tasks|
+          xml_data.elements["response"].each { |response| tasks << build_task(response) }
+        end
+      else
+        build_task(xml_data.elements["response/task"])
+      end
+    end
+
+    AbbyyXmlError = Struct.new(:code, :message)
+
+    def parse_error(resource)
+      AbbyyXmlError.new.tap do |error|
+        xml_data = REXML::Document.new(resource.http_body)
+        error.code = resource.http_code
+        error.message = xml_data.elements["error/message"].text
+      end
+    end
+
+    private
+
+    def build_task(xml_data)
+      Hash.new.tap do |task|
+        task[:id] = xml_data.attributes["id"]
+        task[:status] = xml_data.attributes["status"]
+        task[:resultUrl] = xml_data.attributes["resultUrl"]
+        task[:resultUrl2] = xml_data.attributes["resultUrl2"] rescue nil
+        task[:resultUrl3] = xml_data.attributes["resultUrl3"] rescue nil
+        task[:estimatedProcessingTime] = xml_data.attributes["estimatedProcessingTime"]
+        task[:description] = xml_data.attributes["description"]
+        task[:error] = xml_data.attributes["error"]
+        task[:credits] = xml_data.attributes["credits"]
+        task[:filesCount] = xml_data.attributes["filesCount"]
+        task[:statusChangeTime] = xml_data.attributes["statusChangeTime"]
+        task[:registrationTime] = xml_data.attributes["registrationTime"]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: abbyy-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Adrien Rambert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: 
+email:
+- contact@silex.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- abbyy-ruby.gemspec
+- bin/console
+- bin/setup
+- lib/abbyy.rb
+- lib/abbyy/api.rb
+- lib/abbyy/client.rb
+- lib/abbyy/exceptions.rb
+- lib/abbyy/inflector.rb
+- lib/abbyy/task.rb
+- lib/abbyy/version.rb
+- lib/abbyy/xml.rb
+homepage: https://github.com/silex-pro/abbyy-ruby
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Abbyy Cloud OCR SDK API.
+test_files: []