ocr 0.0.1 → 0.1.0

data/README.md

@@ -1,10 +1,14 @@
-#Ocr
+#OCR
  OCR web services gateway for Ruby.
 
 #Description
   Recognize text and characters from image files using web services.
 
-##Web services
+##Web services supported
+  - [OCR Web Service](http://www.ocrwebservice.com/)([Online OCR](http://www.onlineocr.net/))
+    * identify: Username and license code as password
+    * languages: :brazilian, :byelorussian, :bulgarian, :catalan, :croatian, :czech, :danish, :dutch, :english, :estonian, :finnish, :french, :german, :greek, :hungarian, :indonesian, :italian, :latin, :latvian, :lithuanian, :moldavian, :polish, :portuguese, :romanian, :russian, :serbian, :slovakian, :slovenian, :spanish, :swedish, :turkish, :ukrainian
+    * output formats: :doc, :pdf, :excel, :html, :txt, :rtf
 
 #Installation
 ##From the command line
@@ -27,5 +31,21 @@ gem 'ocr'
   bundle install
 ```
 
+## Using
+
+### OCR Web Service
+  [OCR Web Service](http://www.ocrwebservice.com/)
+
+```ruby
+  ocr = OCR.use :onlineocr
+
+  ocr.login <YOUR_USER>, <LICENSE_CODE>
+  ocr.file= 'pkg/text_test2.jpg'
+  ocr.recognize
+
+  puts "ERROR: #{ocr.error}" if ocr.error?
+  puts "RESULT: #{ocr.text}" unless ocr.error?
+```
+
 # License
 Released under the MIT license: [http://www.opensource.org/licenses/MIT](http://www.opensource.org/licenses/MIT)

data/lib/ocr.rb

@@ -1,4 +1,13 @@
-module Ocr
-  class Ocr
+require File.expand_path('../ocr/factory', __FILE__)
+require File.expand_path('../ocr/ocr', __FILE__)
+require File.expand_path('../ocrs/dummy', __FILE__)
+require File.expand_path('../ocrs/onlineocr', __FILE__)
+require File.expand_path('../ocrs/onlineocr2', __FILE__)
+require File.expand_path('../ocrs/free_ocr', __FILE__)
+
+
+module OCR
+  def self.use name
+    Factory.create eval name.to_s.capitalize
   end
 end

data/lib/ocr/factory.rb

@@ -0,0 +1,23 @@
+module OCR
+  class Factory
+    attr_reader :args
+
+    class << self
+      protected :new
+    end
+
+    def initialize(*args)
+      self.init(*args) if self.respond_to?(:init)
+    end
+
+    def self.create(type = self.class, *args)
+      raise ArgumentError, "Cannot create instance of #{type} from #{self.name}" if type == self
+      raise ArgumentError, "Type cannot be nil" if type.nil?
+
+      if !type.ancestors.include?(self)
+        raise ArgumentError, "#{type.name} is not a descendant of #{self.name}"
+      end
+      type.new(*args)
+    end
+  end
+end

data/lib/ocr/ocr.rb

@@ -0,0 +1,74 @@
+module OCR
+  class Ocr < OCR::Factory
+    class << self
+      private :create
+    end
+
+    attr_reader :text, :error
+    attr_accessor :username, :password, :extra_login_data
+    attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass
+    attr_accessor :file, :language, :format
+    attr_accessor :debug
+
+    def initialize(*args)
+      init
+    end
+
+    def init
+      clear_error
+      clear_text
+      login false, false
+      proxy false
+      file= false
+      lang= false
+      format= false
+      debug= false
+    end
+
+    def login username, password, extra_login_data = false
+      @username = username
+      @password = password
+      @extra_login_data = extra_login_data
+    end
+
+    def proxy p_addr, p_port = nil, p_user = nil, p_pass = nil
+      @proxy_addr = p_addr
+      @proxy_port = p_port
+      @proxy_user = p_user
+      @proxy_pass = p_pass
+    end
+
+    def error?
+      @error != false
+    end
+
+    def recognize
+      clear_error
+      clear_text
+      return false && set_error("No file") if @file.nil?
+      return false && set_error("File not exists '#{@file}'") unless File.exist?(@file)
+      ocr_recognize
+    end
+
+    private
+      def clear_error
+        @error = false
+      end
+
+      def set_error msg
+        @error = msg
+      end
+
+      def clear_text
+        @text = nil
+      end
+
+      def set_text msg
+        @text = msg
+      end
+
+      def ocr_recognize
+        raise NotImplementedError, 'You should implement this method'
+      end
+  end
+end

data/lib/ocr/version.rb

@@ -1,3 +1,3 @@
-module Ocr
-  VERSION = "0.0.1"
+module OCR
+  VERSION = "0.1.0"
 end

data/lib/ocrs/dummy.rb

@@ -0,0 +1,4 @@
+module OCR
+  class Dummy < Ocr
+  end
+end

data/lib/ocrs/free_ocr.rb

@@ -0,0 +1,58 @@
+require 'soap/wsdlDriver'
+require 'base64'
+
+
+module OCR
+  class Free_ocr < OCR::Ocr
+
+    attr_accessor :convert_to_bw
+
+    private
+    def init
+      super()
+    end
+
+    def ocr_recognize
+      raise Exception, 'You should set image file' unless @file
+#      request = {
+#        'image' => File.open(@file, 'rb') { |f| [f.read].pack('m*') }
+#      }
+#puts request
+#return
+      #client = Savon::Client.new('http://www.free-ocr.co.uk/ocr.asmx?WSDL')
+#puts client.wsdl.soap_actions
+#return
+      #begin
+      #  response = client.request(:analyze) do
+      #    soap.body = request
+      #  end
+      #rescue
+      #  puts "EX"
+      #end
+
+client = SOAP::WSDLDriverFactory.new( 'http://www.free-ocr.co.uk/ocr.asmx?WSDL' ).create_rpc_driver
+result = client.analyze(:image => File.open(@file, 'rb') { |f| [f.read].pack('m*') })
+
+puts response. analyzeResult
+
+puts result
+return
+
+puts
+puts "BODY: #{response.body}"
+
+      return false if have_error? response.body
+puts 'sigue'
+      set_text !response[:ocr_text].nil? ? response[:ocr_text] : ''
+    end
+
+    def have_error? response
+      return true && set_error("No response") unless response.has_key?(:ocr_web_service_recognize_response)
+      return true && set_error("No response") unless response[:ocr_web_service_recognize_response].has_key?(:ocrws_response)
+      return true && set_error("No response") unless response[:ocr_web_service_recognize_response].has_key?(:ocrws_response)
+      return false if response[:ocr_web_service_recognize_response][:ocrws_response][:error_message].nil?
+      set_error response[:ocr_web_service_recognize_response][:ocrws_response][:error_message]
+      true
+    end
+  end
+end

data/lib/ocrs/onlineocr.rb

@@ -0,0 +1,65 @@
+require 'savon'
+require 'base64'
+
+
+module OCR
+  class Onlineocr < OCR::Ocr
+
+    attr_accessor :convert_to_bw
+
+    private
+    def init
+      super()
+      self.language= :english
+      self.format= :txt
+      self.convert_to_bw= false
+    end
+
+    def ocr_recognize
+      raise Exception, 'You should set username and license as password' unless @username && @password
+      request = {
+        'user_name' => @username,
+        'license_code' => @password,
+        'OCRWSInputImage' => {
+          'fileName' => File.basename(@file),
+          'fileData' => File.open(@file, 'rb') { |f| [f.read].pack('m*') }
+        },
+        'OCRWSSetting' => {
+          'ocrLanguages' => self.language.to_s.upcase,
+          'outputDocumentFormat' => self.format.to_s.upcase,
+          'convertToBW' => self.convert_to_bw.to_s,
+          'getOCRText' => true.to_s,
+          'createOutputDocument' => false.to_s,
+          'multiPageDoc' => false.to_s,
+          'ocrWords' => false.to_s
+        },
+      }
+
+      unless debug
+        Savon.configure do |config|
+        #config.log = true           # enable logging
+         config.log = false          # disable logging
+         config.log_level = :error   # changing the log level
+         HTTPI.log = false           # to total silent the logging.
+        end
+      end
+      client = Savon::Client.new('http://www.ocrwebservice.com/services/OCRWebService.asmx?WSDL')
+      response = client.request(:ocr_web_service_recognize) do
+        soap.body = request
+      end
+
+      return false if have_error? response.body
+
+      set_text response[:ocr_web_service_recognize_response][:ocrws_response][:ocr_text][:array_of_string][:string]
+    end
+
+    def have_error? response
+      return true && set_error("No response") unless response.has_key?(:ocr_web_service_recognize_response)
+      return true && set_error("No response") unless response[:ocr_web_service_recognize_response].has_key?(:ocrws_response)
+      return false unless response[:ocr_web_service_recognize_response][:ocrws_response].has_key?(:error_message)
+      return false if response[:ocr_web_service_recognize_response][:ocrws_response][:error_message].nil?
+      set_error response[:ocr_web_service_recognize_response][:ocrws_response][:error_message]
+      true
+    end
+  end
+end

data/lib/ocrs/onlineocr2.rb

@@ -0,0 +1,109 @@
+require 'net/http'
+require 'base64'
+
+
+module OCR
+  class Onlineocr2 < OCR::Ocr
+
+    attr_accessor :convert_to_bw
+
+    private
+    def init
+      super()
+      self.language= :english
+      self.format= :txt
+      self.convert_to_bw= false
+    end
+
+    def ocr_recognize
+      raise Exception, 'You should set username and license as password' unless @username && @password
+      request = {
+        'user_name' => @username,
+        'license_code' => @password,
+        'OCRWSSettings' => {
+#          'ocrLanguages' => [self.language.to_s.upcase],
+          'outputDocumentFormat' => self.format.to_s.upcase,
+          'convertToBW' => self.convert_to_bw,
+          'getOCRText' => true,
+          'createOutputDocument' => false,
+          'multiPageDoc' => false,
+          'ocrWords' => true
+        },
+        'OCRWSInputImage' => {
+          'fileName' => File.basename(@file),
+#          'fileData' => File.open(@file, 'rb') { |f| [f.read].pack('m*') }
+        },
+      }
+#puts request
+#return
+      data =<<EOT
+        <?xml version="1.0" encoding="utf-8"?>
+        <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+          <soap:Body>
+            <OCRWebServiceRecognize xmlns="http://stockservice.contoso.com/wse/samples/2005/10">
+              <user_name>#{@username}</user_name>
+              <license_code>#{@password}</license_code>
+              <OCRWSInputImage>
+                <fileName>string</fileName>
+                <fileData>base64Binary</fileData>
+              </OCRWSInputImage>
+              <OCRWSSetting>
+                <ocrLanguages>#{self.language.to_s.upcase}</ocrLanguages>
+                <outputDocumentFormat>#{self.format.to_s.upcase}</outputDocumentFormat>
+                <convertToBW>#{self.convert_to_bw}</convertToBW>
+                <getOCRText>true</getOCRText>
+                <createOutputDocument>false</createOutputDocument>
+                <multiPageDoc>false</multiPageDoc>
+                <ocrWords>true</ocrWords>
+              </OCRWSSetting>
+            </OCRWebServiceRecognize>
+          </soap:Body>
+        </soap:Envelope>
+EOT
+
+      headers = {
+         'Host' => 'www.ocrwebservice.com',
+         'Content-Type' => 'application/soap+xml; charset=utf-8',
+#         'Content-Type' => 'text/xml',
+         'Content-Length' => "#{data.length}",
+         'SOAPAction' => '"http://stockservice.contoso.com/wse/samples/2005/10/OCRWebServiceRecognize"'
+      }
+
+      host = 'www.ocrwebservice.com'
+      url = '/services/OCRWebService.asmx'
+
+#data = data.squeeze.tr "\n", ''
+puts data
+puts headers
+
+#return
+      http = Net::HTTP.new(host, 80)
+      http.use_ssl = false
+      resp = http.post(url, data, headers)
+
+puts resp
+puts 'Code = ' + resp.code
+puts 'Message = ' + resp.message
+
+
+
+return
+
+puts
+puts "BODY: #{response.body}"
+
+      return false if have_error? response.body
+puts 'sigue'
+      set_text !response[:ocr_text].nil? ? response[:ocr_text] : ''
+    end
+
+    def have_error? response
+      return true && set_error("No response") unless response.has_key?(:ocr_web_service_recognize_response)
+      return true && set_error("No response") unless response[:ocr_web_service_recognize_response].has_key?(:ocrws_response)
+      return true && set_error("No response") unless response[:ocr_web_service_recognize_response].has_key?(:ocrws_response)
+      return false if response[:ocr_web_service_recognize_response][:ocrws_response][:error_message].nil?
+      set_error response[:ocr_web_service_recognize_response][:ocrws_response][:error_message]
+      true
+    end
+  end
+end

data/spec/ocr_spec.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
-root = File.expand_path('../..', __FILE__)
-require File.join(root, %w[lib ocr])
-
-describe Ocr::Ocr do
-  it "should be correct size" do
-  	Ocr::Ocr.new
-  end
-end
+root = File.expand_path('../..', __FILE__)
+require File.join(root, %w[lib ocr])
+
+describe OCR do
+  it "should be correct size" do
+  	OCR.use :dummy
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &19566960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *19566960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16343120 !ruby/object:Gem::Requirement
+  requirement: &19558440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +32,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *16343120
+  version_requirements: *19558440
 description: Recognize text and characters from image files using web services.
 email:
 - mabarroso@mabarroso.com
@@ -30,7 +41,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ocr.rb
+- lib/ocrs/free_ocr.rb
+- lib/ocrs/onlineocr.rb
+- lib/ocrs/dummy.rb
+- lib/ocrs/onlineocr2.rb
 - lib/ocr/version.rb
+- lib/ocr/ocr.rb
+- lib/ocr/factory.rb
 - MIT-LICENSE
 - Rakefile
 - README.md