ocrsdk 0.2.0 → 0.3.0

data/README.md

@@ -25,6 +25,14 @@ Configuration
 OCRSDK.setup do |config|
   config.application_id = '99bottlesofbeer'
   config.password = '98bottlesofbeer'
+
+  # How much time in seconds wait between requests
+  config.default_poll_time = 3 # default
+
+  # How many times retry before rendering request as failed
+  config.number_or_retries = 3 # default
+  # How much time wait before retries
+  config.retry_wait_time   = 3 # default 
 end
 ```
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ocrsdk.rb

@@ -1,6 +1,7 @@
 require 'cgi'
 require 'uri'
 require 'nokogiri'
+require 'retryable'
 require 'pdf-reader'
 require 'rest-client'
 require 'active_support/inflector'
@@ -11,14 +12,31 @@ require 'active_support/configurable'
 module OCRSDK
   include ActiveSupport::Configurable
 
-  DEFAULT_POLL_TIME = 3
-  SERVICE_URL = 'cloud.ocrsdk.com'
-
   def self.setup
     yield config
   end
 end
 
+# Default configuration values
+OCRSDK.setup do |config|
+  # These two should be set by user
+  config.application_id = nil
+  config.password       = nil
+
+  # Generally this is not the thing you would want to change
+  # but in some rare cases like access to test servers
+  # it might be useful
+  config.service_url = 'cloud.ocrsdk.com'
+
+  # How much time in seconds wait between requests
+  config.default_poll_time = 3 # seconds
+
+  # How many times retry before rendering request as failed
+  config.number_or_retries = 3 # times
+  # How much time wait before retries
+  config.retry_wait_time   = 3 # seconds
+end
+
 require 'ocrsdk/errors'
 require 'ocrsdk/verifiers'
 require 'ocrsdk/abstract_entity'

data/lib/ocrsdk/abstract_entity.rb

@@ -6,6 +6,6 @@ class OCRSDK::AbstractEntity
 private
 
   def prepare_url(app_id, pass)
-    URI("http://#{CGI.escape app_id}:#{CGI.escape pass}@#{OCRSDK::SERVICE_URL}")
+    URI("http://#{CGI.escape app_id}:#{CGI.escape pass}@#{OCRSDK.config.service_url}")
   end
 end

data/lib/ocrsdk/image.rb

@@ -14,7 +14,7 @@ class OCRSDK::Image < OCRSDK::AbstractEntity
     OCRSDK::Promise.from_response xml_string
   end
 
-  def as_text_sync(languages, wait_interval=OCRSDK::DEFAULT_POLL_TIME)
+  def as_text_sync(languages, wait_interval=OCRSDK.config.default_poll_time)
     as_text(languages).wait(wait_interval).result.force_encoding('utf-8')
   end
 
@@ -24,7 +24,7 @@ class OCRSDK::Image < OCRSDK::AbstractEntity
     OCRSDK::Promise.from_response xml_string
   end
 
-  def as_pdf_sync(languages, out_path=nil, wait_interval=OCRSDK::DEFAULT_POLL_TIME)
+  def as_pdf_sync(languages, out_path=nil, wait_interval=OCRSDK.config.default_poll_time)
     result = as_pdf(languages).wait(wait_interval).result
 
     if out_path.nil?

data/lib/ocrsdk/mock.rb

@@ -1,3 +1,4 @@
+require 'ocrsdk'
 require 'webmock'
 
 module OCRSDK::Mock

data/lib/ocrsdk/promise.rb

@@ -36,8 +36,10 @@ class OCRSDK::Promise < OCRSDK::AbstractEntity
     self
   end
 
-  def update
-    parse_response api_update_status
+  def update(retry_sleep=OCRSDK.config.retry_wait_time)
+    retryable tries: OCRSDK.config.number_or_retries, on: OCRSDK::NetworkError, sleep: retry_sleep do
+      parse_response api_update_status
+    end
   end
 
   def completed?
@@ -52,12 +54,14 @@ class OCRSDK::Promise < OCRSDK::AbstractEntity
     [:submitted, :queued, :in_progress].include? @status
   end
 
-  def result
+  def result(retry_sleep=OCRSDK.config.retry_wait_time)
     raise OCRSDK::ProcessingFailed  if failed?
-    api_get_result
+    retryable tries: OCRSDK.config.number_or_retries, on: OCRSDK::NetworkError, sleep: retry_sleep do
+      api_get_result
+    end
   end
 
-  def wait(seconds=OCRSDK::DEFAULT_POLL_TIME)
+  def wait(seconds=OCRSDK.config.default_poll_time)
     while processing? do
       sleep seconds
       update

data/ocrsdk.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "nokogiri"
   s.add_runtime_dependency "pdf-reader"
   s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "retryable"
 
   s.add_development_dependency "rake", ">= 0.8"
   if RUBY_VERSION >= '1.9'

data/spec/ocrsdk/image_spec.rb

@@ -79,7 +79,7 @@ describe OCRSDK::Image do
 
     it "should do a post request with correct url and file attached" do
       RestClient.stub(:post) do |uri, params|
-        uri.to_s.should == "http://app_id:pass@#{OCRSDK::SERVICE_URL}/processImage?language=Russian%2CEnglish&exportFormat=txt&profile=documentConversion"
+        uri.to_s.should == "http://app_id:pass@cloud.ocrsdk.com/processImage?language=Russian%2CEnglish&exportFormat=txt&profile=documentConversion"
         params[:upload][:file].should be_kind_of(File)
       end
       RestClient.should_receive(:post).once

data/spec/ocrsdk/promise_spec.rb

@@ -60,6 +60,15 @@ describe OCRSDK::Promise do
 
     its(:task_id) { should == 'update-task-id' }
     its(:status)  { should == :in_progress }
+
+    it "should raise a NetworkError in case REST request fails, and retry 3 times" do
+      RestClient.stub(:get) {|url| raise RestClient::ExceptionWithResponse }
+      RestClient.should_receive(:get).exactly(3)
+
+      expect {
+        subject.result(0)
+      }.to raise_error(OCRSDK::NetworkError)
+    end
   end
 
   describe ".api_update_status" do
@@ -67,7 +76,7 @@ describe OCRSDK::Promise do
 
     it "should make an api call with correct url" do
       RestClient.stub(:get) do |url| 
-        url.to_s.should == "http://app_id:pass@#{OCRSDK::SERVICE_URL}/getTaskStatus?taskId=test"
+        url.to_s.should == "http://app_id:pass@cloud.ocrsdk.com/getTaskStatus?taskId=test"
       end
       RestClient.should_receive(:get).once
       subject.instance_eval { api_update_status }
@@ -90,12 +99,12 @@ describe OCRSDK::Promise do
 
       its(:result) { should == 'meow' }
 
-      it "should raise NetworkError in case getting file fails" do
+      it "should raise NetworkError in case getting file fails, but retry 3 times before failing" do
         RestClient.stub(:get) {|url| raise RestClient::ExceptionWithResponse }
-        RestClient.should_receive(:get).once
+        RestClient.should_receive(:get).exactly(3)
 
         expect {
-          subject.result
+          subject.result(0)
         }.to raise_error(OCRSDK::NetworkError)        
       end
     end

data/spec/ocrsdk_spec.rb

@@ -2,10 +2,6 @@
 require 'spec_helper'
 
 describe OCRSDK do
-  it "should have service url" do 
-    OCRSDK::SERVICE_URL.length.should > 0
-  end
-
   it "should be configurable" do
     OCRSDK.setup do |config|
       config.application_id = 'meow'
@@ -15,4 +11,4 @@ describe OCRSDK do
     OCRSDK.config.application_id.should == 'meow'
     OCRSDK.config.password.should == 'purr'
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocrsdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement