aspose_ocr_cloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37de5f2a1a4442e062698043eb125c1490c85fa9
+  data.tar.gz: bfd021e2fedf22f660c45279c04d33f9436c51ba
+SHA512:
+  metadata.gz: bbfa94f09ef9ee52346991ae891422094805db864b26bb8282b1bf00f9e63366c7cbc3d7a7d413d7ff782860d8a1ccc0de86cfae3d05e3abdb6fc06a15d14d24
+  data.tar.gz: 62c80c8d526181bfcfc9f5652130cc7888e9db8196e4a1666abea9975d8c068e71b53b86b1d8a69f989119f38304b6c1e12bcc1f16894ffc67254d06b7e7eb85

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2001-2016 Aspose Pty Ltd
+
+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,48 @@
+# Aspose.OCR Cloud SDK For Ruby
+This SDK lets you use [Aspose Cloud OCR APIs](http://www.aspose.com/cloud/ocr-api.aspx) in your Ruby web apps.
+
+## Installing
+You can simply install Aspose OCR Cloud SDK with gem:
+
+`gem install aspose_ocr_cloud`
+
+## Usage
+APIs of this SDK can be called as follows:
+
+```ruby
+require 'aspose_ocr_cloud'
+
+class OCRUsage
+  
+  include AsposeOCRCloud
+  include AsposeStorageCloud
+	
+  def initialize
+    #Get App key and App SID from https://cloud.aspose.com
+    AsposeApp.app_key_and_sid("APP_KEY", "APP_SID")
+    @ocr_api = OcrApi.new  
+  end
+
+  def upload_file(file_name)
+    @storage_api = StorageApi.new
+    response = @storage_api.put_create(file_name, File.open("data/" << file_name,"r") { |io| io.read } )
+  end
+  
+  def get_recognize_document
+    #Recognize image text, language and text region can be selected, default dictionaries can be used for correction.
+    file_name = "Sampleocr.bmp"
+    upload_file(file_name)
+    
+    response = @ocr_api.get_recognize_document(file_name)
+  end
+  
+end
+```
+## Unit Tests
+Aspose OCR SDK includes a suite of unit tests within the [test](https://github.com/asposeocr/Aspose_OCR_Cloud/blob/master/SDKs/Aspose.OCR_Cloud_SDK_for_Ruby/test/ocr_tests.rb) subdirectory. These Unit Tests also serves as examples of how to use the Aspose OCR SDK.
+
+## Contact
+Your feedback is very important to us. Please email us all your queries and feedback at marketplace@aspose.com.
+
+## License
+Aspose OCR SDK is available under the MIT license. See the [LICENSE](https://github.com/asposeocr/Aspose_OCR_Cloud/blob/master/SDKs/Aspose.OCR_Cloud_SDK_for_Ruby/LICENSE) file for more info.

data/aspose_ocr_cloud.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "aspose_ocr_cloud/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aspose_ocr_cloud"
+  s.version     = AsposeOCRCloud::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["M. Sohail Ismail"]
+  s.email       = ["muhammad.sohail@aspose.com"]
+  s.homepage    = "http://www.aspose.com/cloud/ocr-api.aspx"
+  s.summary     = %q{Aspose.OCR for Cloud}
+  s.description = %q{Aspose.OCR for Cloud is a cloud-based REST API for optical character recognition and document scanning. It allows you to scan documents and recognize characters. Recognize text in English and other languages, and recognize text in only part of an image. Aspose.OCR for Cloud supports a variety of fonts in different styles, like regular, bold, and italic, and different image formats. You can use Aspose.OCR for Cloud in many scenarios, for example, extracting text and saving to a database.}
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'typhoeus', '~> 0.8'
+  s.add_runtime_dependency 'json', '~> 1.7'
+  s.add_runtime_dependency 'aspose_storage_cloud', '~> 1.0', '>= 1.0.0'
+
+  s.add_development_dependency 'minitest', '~> 5.8'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/aspose_ocr_cloud.rb

@@ -0,0 +1,36 @@
+require 'aspose_storage_cloud'
+
+# Common files
+require_relative 'aspose_ocr_cloud/api_client'
+require_relative 'aspose_ocr_cloud/api_error'
+require_relative 'aspose_ocr_cloud/version'
+require_relative 'aspose_ocr_cloud/configuration'
+
+# Models
+require_relative 'aspose_ocr_cloud/models/base_object'
+require_relative 'aspose_ocr_cloud/models/ocr_response'
+require_relative 'aspose_ocr_cloud/models/parts_info'
+require_relative 'aspose_ocr_cloud/models/pages_info'
+require_relative 'aspose_ocr_cloud/models/part_info'
+require_relative 'aspose_ocr_cloud/models/page'
+
+# APIs
+require_relative 'aspose_ocr_cloud/api/ocr_api'
+
+module AsposeOCRCloud
+  class << self
+    # Configure sdk using block.
+    # AsposeOCRCloud.configure do |config|
+    #   config.username = "xxx"
+    #   config.password = "xxx"
+    # end
+    # If no block given, return the configuration singleton instance.
+    def configure
+      if block_given?
+        yield Configuration.instance
+      else
+        Configuration.instance
+      end
+    end
+  end
+end

data/lib/aspose_ocr_cloud/api/ocr_api.rb

@@ -0,0 +1,137 @@
+require "uri"
+
+module AsposeOCRCloud
+  class OcrApi
+    attr_accessor :api_client
+
+    def initialize(api_client = nil)
+      @api_client = api_client || Configuration.api_client
+    end
+
+    # Recognize image text from some url if provided or from the request body content, language can be selected, default dictionaries can be used for correction.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :url The image file url.
+    # @option opts [String] :language Language of the document.
+    # @option opts [BOOLEAN] :use_default_dictionaries Use default dictionaries for result correction.
+    # @option opts [File] :file 
+    # @return [OCRResponse]
+    def post_ocr_from_url_or_content(opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: OcrApi#post_ocr_from_url_or_content ..."
+      end
+      
+      # resource path
+      path = "/ocr/recognize".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'url'] = opts[:'url'] if opts[:'url']
+      query_params[:'language'] = opts[:'language'] if opts[:'language']
+      query_params[:'useDefaultDictionaries'] = opts[:'use_default_dictionaries'] if opts[:'use_default_dictionaries']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = ['multipart/form-data']
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+      form_params["file"] = opts[:'file'] if opts[:'file']
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OCRResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: OcrApi#post_ocr_from_url_or_content. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # Recognize image text, language and text region can be selected, default dictionaries can be used for correction.
+    # 
+    # @param name Name of the file to recognize.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :language Language of the document.
+    # @option opts [Integer] :rect_x Top left point X coordinate of Rectangle to recognize text inside.
+    # @option opts [Integer] :rect_y Top left point Y coordinate of Rectangle to recognize text inside.
+    # @option opts [Integer] :rect_width Width of Rectangle to recognize text inside.
+    # @option opts [Integer] :rect_height Height of Rectangle to recognize text inside.
+    # @option opts [BOOLEAN] :use_default_dictionaries Use default dictionaries for result correction.
+    # @option opts [String] :storage Image's storage.
+    # @option opts [String] :folder Image's folder.
+    # @return [OCRResponse]
+    def get_recognize_document(name, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: OcrApi#get_recognize_document ..."
+      end
+      
+      # verify the required parameter 'name' is set
+      fail "Missing the required parameter 'name' when calling get_recognize_document" if name.nil?
+      
+      # resource path
+      path = "/ocr/{name}/recognize".sub('{format}','json').sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'language'] = opts[:'language'] if opts[:'language']
+      query_params[:'rectX'] = opts[:'rect_x'] if opts[:'rect_x']
+      query_params[:'rectY'] = opts[:'rect_y'] if opts[:'rect_y']
+      query_params[:'rectWidth'] = opts[:'rect_width'] if opts[:'rect_width']
+      query_params[:'rectHeight'] = opts[:'rect_height'] if opts[:'rect_height']
+      query_params[:'useDefaultDictionaries'] = opts[:'use_default_dictionaries'] if opts[:'use_default_dictionaries']
+      query_params[:'storage'] = opts[:'storage'] if opts[:'storage']
+      query_params[:'folder'] = opts[:'folder'] if opts[:'folder']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'text/json', 'application/xml', 'text/xml', 'text/javascript']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = []
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OCRResponse')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: OcrApi#get_recognize_document. Result: #{result.inspect}"
+      end
+      return result
+    end
+  end
+end
+
+
+
+

data/lib/aspose_ocr_cloud/api_client.rb

@@ -0,0 +1,335 @@
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+require 'openssl'
+require 'base64'
+require 'rexml/document'
+
+module AsposeOCRCloud
+  class ApiClient
+    
+    include AsposeStorageCloud
+    
+    attr_accessor :host
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    # Stores the HTTP response from the last API call using this API client.
+    attr_accessor :last_response
+
+    def initialize(host = nil)
+      @host = host || Configuration.base_url
+      @format = 'json'
+      @user_agent = "ruby-swagger-#{VERSION}"
+      @default_headers = {
+        'Content-Type' => "application/#{@format.downcase}",
+        'User-Agent' => @user_agent
+      }
+    end
+
+    def call_api(http_method, path, opts = {})
+      request = build_request(http_method, path, opts)
+      response = request.run
+
+      # record as last response
+      @last_response = response
+
+      if Configuration.debugging
+        Configuration.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      unless response.success?
+        fail ApiError.new(:code => response.code,
+                          :response_headers => response.headers,
+                          :response_body => response.body),
+             response.status_message
+      end
+
+      if opts[:return_type]
+        deserialize(response, opts[:return_type])
+      else
+        nil
+      end
+    end
+
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path)
+      http_method = http_method.to_sym.downcase
+      
+      header_params = @default_headers.merge(opts[:header_params] || {})
+      query_params = {}
+      form_params = opts[:form_params] || {}
+
+      req_opts = {
+        :method => http_method,
+        :headers => header_params,
+        :params => query_params,
+        :ssl_verifypeer => Configuration.verify_ssl,
+        :sslcert => Configuration.cert_file,
+        :sslkey => Configuration.key_file,
+        :cainfo => Configuration.ssl_ca_cert,
+        :verbose => Configuration.debugging
+      }
+
+      if [:post, :patch, :put, :delete].include?(http_method)
+        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_opts.update :body => req_body
+        if Configuration.debugging
+          Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
+      end
+      
+      url = sign(url, opts[:query_params])
+      Typhoeus::Request.new(url, req_opts)
+
+    end
+    
+    # Signs a URI with your appSID and Key.
+    # * :url describes the URL to sign
+    
+    def sign(url, query_params)
+        
+      fail "Please set Aspose App key and SID first. You can get App key and App SID from https://cloud.aspose.com" if AsposeApp.app_key.nil? || AsposeApp.app_sid.nil?
+      
+      url = url[0..-2] if url[-1].eql? '/'
+
+      unless query_params.empty?
+        url = "#{url}?"
+        query_params.each { |key, value|
+          url = "#{url}#{key}=#{value}&"
+        }
+        url = url[0..-2]
+      end
+
+      url = URI.escape(url)
+      parsed_url = URI.parse(url)
+        
+      url_to_sign = "#{parsed_url.scheme}://#{parsed_url.host}#{parsed_url.path}"
+      url_to_sign += "?#{parsed_url.query}" if parsed_url.query
+      if parsed_url.query
+        url_to_sign += "&appSID=#{AsposeApp.app_sid}"
+      else
+        url_to_sign += "?appSID=#{AsposeApp.app_sid}"
+      end  
+        
+      # create a signature using the private key and the URL
+      raw_signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), AsposeApp.app_key, url_to_sign)
+        
+      #Convert raw to encoded string
+      signature = Base64.strict_encode64(raw_signature).tr('+/', '-_')
+        
+      #remove invalid character
+      signature = signature.gsub(/[=_-]/, '=' => '', '_' => '%2f', '-' => '%2b')
+        
+      #Define expression
+      pat = Regexp.new('%[0-9a-f]{2}')
+        
+      #Replace the portion matched to the above pattern to upper case
+      6.times do
+        signature = signature.sub(pat, pat.match(signature).to_s.upcase)
+      end
+      
+      # prepend the server and append the signature.
+      url_to_sign + "&signature=#{signature}"
+
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    def deserialize(response, return_type)
+      body = response.body
+      return nil if body.nil? || body.empty?
+
+      # handle file downloading - save response body into a tmp file and return the File instance
+      return download_file(response) if return_type == 'File'
+
+      # ensuring a default content type
+      content_type = response.headers['Content-Type'] || 'application/json'
+
+      unless content_type.start_with?('application/json')
+        fail "Content-Type is not supported: #{content_type}"
+      end
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type data, return_type
+    end
+
+    # Convert data to the given return type.
+    def convert_to_type(data, return_type)
+      return nil if data.nil?
+      case return_type
+      when 'String'
+        data.to_s
+      when 'Integer'
+        data.to_i
+      when 'Float'
+        data.to_f
+      when 'BOOLEAN'
+        data == true
+      when 'DateTime'
+        # parse date time (expecting ISO 8601 format)
+        DateTime.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object, return directly
+        data
+      when /\AArray<(.+)>\z/
+        # e.g. Array<Pet>
+        sub_type = $1
+        data.map {|item| convert_to_type(item, sub_type) }
+      when /\AHash\<String, (.+)\>\z/
+        # e.g. Hash<String, Integer>
+        sub_type = $1
+        {}.tap do |hash|
+          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+        end
+      else
+        # models, e.g. Pet
+        AsposeOCRCloud.const_get(return_type).new.tap do |model|
+          model.build_from_hash data
+        end
+      end
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    #
+    # @see Configuration#temp_folder_path
+    # @return [File] the file downloaded
+    def download_file(response)
+      tmp_file = Tempfile.new '', Configuration.temp_folder_path
+      content_disposition = response.headers['Content-Disposition']
+
+      if content_disposition
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        path = File.join File.dirname(tmp_file), filename
+      else
+        path = tmp_file.path
+      end
+      # close and delete temp file
+      tmp_file.close!
+
+      File.open(path, 'w') { |file| file.write(response.body) }
+      Configuration.logger.info "File written to #{path}. Please move the file to a proper "\
+                                "folder for further processing and delete the temp afterwards"
+      File.new(path)
+    end
+
+    def build_request_url(path)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      URI.encode(host + path)
+    end
+
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        
+        data = form_params.dup
+        data.each do |key, value|
+          if key.eql? "file"
+            data = value
+            break
+          else
+            data[key] = value.to_s if value && !value.is_a?(File)
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Update hearder and query params based on authentication settings.
+    def update_params_for_auth!(header_params, query_params, auth_names)
+      Array(auth_names).each do |auth_name|
+        auth_setting = Configuration.auth_settings[auth_name]
+        next unless auth_setting
+        case auth_setting[:in]
+        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        end
+      end
+    end
+
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+      @default_headers['User-Agent'] = @user_agent
+    end
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      if accepts.empty?
+        return
+      elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
+        'application/json' # look for json data by default
+      else
+        accepts.join(',')
+      end
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      if content_types.empty?
+        'application/json' # use application/json by default
+      elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
+        'application/json' # use application/json if it's included
+      else
+        content_types[0] # otherwise, use the first one
+      end
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return if model.nil?
+      _body = nil
+      if model.is_a?(Array)
+        _body = model.map{|m| object_to_hash(m) }
+      else
+        _body = object_to_hash(model)
+      end
+      _body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+     
+    
+  end
+end

data/lib/aspose_ocr_cloud/api_error.rb

@@ -0,0 +1,24 @@
+module AsposeOCRCloud
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        arg.each do |k, v|
+          if k.to_s == 'message'
+            super v
+          else
+            instance_variable_set "@#{k}", v
+          end
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/aspose_ocr_cloud/configuration.rb

@@ -0,0 +1,166 @@
+require 'uri'
+require 'singleton'
+
+module AsposeOCRCloud
+  class Configuration
+
+    include Singleton
+
+    # Default api client
+    attr_accessor :api_client
+
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    ### TLS/SSL
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    class << self
+      def method_missing(method_name, *args, &block)
+        config = Configuration.instance
+        if config.respond_to?(method_name)
+          config.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    def initialize
+      @scheme = 'http'
+      @host = 'api.aspose.com'
+      @base_path = '/v1.1'
+      @api_key = {}
+      @api_key_prefix = {}
+      @verify_ssl = true
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def api_client
+      @api_client ||= ApiClient.new
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "" if @base_path == "/"
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+      }
+    end
+  end
+end

data/lib/aspose_ocr_cloud/models/base_object.rb

@@ -0,0 +1,86 @@
+require 'date'
+
+module AsposeOCRCloud
+  # base class containing fundamental method such as to_hash, build_from_hash and more
+  class BaseObject
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      else # model
+        _model = AsposeOCRCloud.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        if value.is_a?(Array)
+          hash[param] = value.compact.map{ |v| _to_hash(v) }
+        else
+          hash[param] = _to_hash(value)
+        end
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/models/ocr_response.rb

@@ -0,0 +1,77 @@
+module AsposeOCRCloud
+  # 
+  class OCRResponse < BaseObject
+    attr_accessor :text, :parts_info, :pages_info, :status, :code
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # 
+        :'text' => :'Text',
+        
+        # 
+        :'parts_info' => :'PartsInfo',
+        
+        # 
+        :'pages_info' => :'PagesInfo',
+        
+        # 
+        :'status' => :'Status',
+        
+        # 
+        :'code' => :'Code'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'text' => :'String',
+        :'parts_info' => :'PartsInfo',
+        :'pages_info' => :'PagesInfo',
+        :'status' => :'String',
+        :'code' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'Text']
+        self.text = attributes[:'Text']
+      end
+      
+      if attributes[:'PartsInfo']
+        self.parts_info = attributes[:'PartsInfo']
+      end
+      
+      if attributes[:'PagesInfo']
+        self.pages_info = attributes[:'PagesInfo']
+      end
+      
+      if attributes[:'Status']
+        self.status = attributes[:'Status']
+      end
+      
+      if attributes[:'Code']
+        self.code = attributes[:'Code']
+      end
+      
+    end
+
+    def status=(status)
+      allowed_values = ["Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported"]
+      if status && !allowed_values.include?(status)
+        fail "invalid value for 'status', must be one of #{allowed_values}"
+      end
+      @status = status
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/models/page.rb

@@ -0,0 +1,47 @@
+module AsposeOCRCloud
+  # 
+  class Page < BaseObject
+    attr_accessor :page_text, :parts
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # 
+        :'page_text' => :'PageText',
+        
+        # 
+        :'parts' => :'Parts'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'page_text' => :'String',
+        :'parts' => :'Array<PartInfo>'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'PageText']
+        self.page_text = attributes[:'PageText']
+      end
+      
+      if attributes[:'Parts']
+        if (value = attributes[:'Parts']).is_a?(Array)
+          self.parts = value
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/models/pages_info.rb

@@ -0,0 +1,39 @@
+module AsposeOCRCloud
+  # 
+  class PagesInfo < BaseObject
+    attr_accessor :pages
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # 
+        :'pages' => :'Pages'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'pages' => :'Array<Page>'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'Pages']
+        if (value = attributes[:'Pages']).is_a?(Array)
+          self.pages = value
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/models/part_info.rb

@@ -0,0 +1,37 @@
+module AsposeOCRCloud
+  # 
+  class PartInfo < BaseObject
+    attr_accessor :text
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # 
+        :'text' => :'Text'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'text' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'Text']
+        self.text = attributes[:'Text']
+      end
+      
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/models/parts_info.rb

@@ -0,0 +1,39 @@
+module AsposeOCRCloud
+  # 
+  class PartsInfo < BaseObject
+    attr_accessor :parts
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # 
+        :'parts' => :'Parts'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'parts' => :'Array<PartInfo>'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'Parts']
+        if (value = attributes[:'Parts']).is_a?(Array)
+          self.parts = value
+        end
+      end
+      
+    end
+
+  end
+end

data/lib/aspose_ocr_cloud/version.rb

@@ -0,0 +1,3 @@
+module AsposeOCRCloud
+  VERSION = "1.0.0"
+end

data/test/ocr_tests.rb

@@ -0,0 +1,41 @@
+require "minitest/autorun"
+require "minitest/unit"
+
+require_relative '../lib/aspose_ocr_cloud'
+
+class OCRTests < Minitest::Test
+	include MiniTest::Assertions
+	include AsposeOCRCloud
+	include AsposeStorageCloud
+	
+	def setup
+        #Get App key and App SID from https://cloud.aspose.com
+        AsposeApp.app_key_and_sid("", "")
+		@ocr_api = OcrApi.new
+	end
+
+	def teardown
+	end
+
+	def upload_file(file_name)
+        @storage_api = StorageApi.new
+		response = @storage_api.put_create(file_name, File.open("data/" << file_name,"r") { |io| io.read } )
+		assert(response, message="Failed to upload {file_name} file.")
+	end
+
+	def test_post_ocr_from_url_or_content
+		opts = {url: "http://s017.radikal.ru/i406/1202/7b/70183bef7a09.jpg", use_default_dictionaries: true}
+        
+        response = @ocr_api.post_ocr_from_url_or_content(opts)
+	 	assert(response, message="Failed to recognize image text from some url if provided or from the request body content.")
+	end
+    
+    def test_get_recognize_document
+    	file_name = "Sampleocr.bmp"
+    	upload_file(file_name)
+
+    	response = @ocr_api.get_recognize_document(file_name)
+    	assert(response, message="Failed to recognize image text.")
+    end
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: aspose_ocr_cloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- M. Sohail Ismail
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: aspose_storage_cloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Aspose.OCR for Cloud is a cloud-based REST API for optical character
+  recognition and document scanning. It allows you to scan documents and recognize
+  characters. Recognize text in English and other languages, and recognize text in
+  only part of an image. Aspose.OCR for Cloud supports a variety of fonts in different
+  styles, like regular, bold, and italic, and different image formats. You can use
+  Aspose.OCR for Cloud in many scenarios, for example, extracting text and saving
+  to a database.
+email:
+- muhammad.sohail@aspose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- aspose_ocr_cloud.gemspec
+- lib/aspose_ocr_cloud.rb
+- lib/aspose_ocr_cloud/api/ocr_api.rb
+- lib/aspose_ocr_cloud/api_client.rb
+- lib/aspose_ocr_cloud/api_error.rb
+- lib/aspose_ocr_cloud/configuration.rb
+- lib/aspose_ocr_cloud/models/base_object.rb
+- lib/aspose_ocr_cloud/models/ocr_response.rb
+- lib/aspose_ocr_cloud/models/page.rb
+- lib/aspose_ocr_cloud/models/pages_info.rb
+- lib/aspose_ocr_cloud/models/part_info.rb
+- lib/aspose_ocr_cloud/models/parts_info.rb
+- lib/aspose_ocr_cloud/version.rb
+- test/data/Sampleocr.bmp
+- test/ocr_tests.rb
+homepage: http://www.aspose.com/cloud/ocr-api.aspx
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Aspose.OCR for Cloud
+test_files:
+- test/data/Sampleocr.bmp
+- test/ocr_tests.rb