ocrsdk 0.1.2 → 0.2.0

data/README.md

@@ -76,6 +76,34 @@ else
 end
 ```
 
+Testing
+-------
+
+In order to make tests determenistic and fast you might want to mock all network interactions. For this purpose OCRSDK introduce Mock module built on top of [Webmock](https://github.com/bblimke/webmock) gem. It can be used with any testing environment including RSpec, Capybara, Cucumber. To mock all gem request you need to call on of those functions before running tests:  
+
+* `OCRSDK::Mock.success` - image was correctly submitted, promise will return `:completed` status and you will be able to retrieve a result;  
+* `OCRSDK::Mock.in_progress` - image was correctly submitted, promise will return `:in_progress` status for every request, which means you wouldn't be able to get the result;  
+* `OCRSDK::Mock.not_enough_credits` - submission of image would raise `OCRSDK::NotEnoughCredits` error.  
+
+For example you can mock ocrsdk in controller test like this:  
+
+```ruby
+# spec_helper.rb
+require 'ocrsdk/mock'
+
+# some_controller_spec.rb
+
+require 'spec_helper'
+
+describe SomeController do
+  before { OCRSDK::Mock.success }
+
+  describe "POST recognize" do
+    # ...
+  end
+end
+```
+
 Copyright
 =========
 Copytright © 2012 Andrey Korzhuev. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/ocrsdk/mock.rb

@@ -0,0 +1,46 @@
+require 'webmock'
+
+module OCRSDK::Mock
+  MOCKS_PATH = File.realpath(File.join(File.dirname(__FILE__), '..', '..', 'mocks'))
+
+  class << self
+    def success
+      stub_process_image response(:process_image, :success)
+      stub_get_task_status response(:get_task_status, :completed)
+      stub_result response(:result, :simple)
+    end
+
+    def in_progress
+      success
+      stub_get_task_status response(:get_task_status, :in_progress)
+    end
+
+    def not_enough_credits
+      success
+      stub_process_image response(:process_image, :not_enough_credits)
+      stub_get_task_status response(:get_task_status, :not_enough_credits)
+    end
+
+    def stub_process_image(response)
+      WebMock::API.stub_request(:post, /.*:.*@cloud.ocrsdk.com\/processImage/).to_return(body: response)
+    end
+
+    def stub_get_task_status(response)
+      WebMock::API.stub_request(:get,  /.*:.*@cloud.ocrsdk.com\/getTaskStatus\?taskId=.*/).to_return(body: response)
+    end
+
+    def stub_result(response)
+      WebMock::API.stub_request(:get, 'http://cloud.ocrsdk.com/result_url').to_return(body: response)
+    end
+
+    def response(method, status)
+      path = File.join(MOCKS_PATH, method.to_s, "#{status.to_s}.xml")
+
+      unless File.exist? path
+        warn "No predefined xml response for #{method}/#{status} found. Path: #{path}"
+      end
+
+      File.new(path).read
+    end    
+  end
+end

data/mocks/get_task_status/completed.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="update-task-id"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-03-01T13:18:22Z"
+    status="Completed"
+    error="{An error message.}"
+    filesCount="10"
+    credits="10"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/get_task_status/failed.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="update-task-id"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-03-01T13:18:22Z"
+    status="ProcessingFailed"
+    error="{An error message.}"
+    filesCount="10"
+    credits="10"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/get_task_status/in_progress.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="update-task-id"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-02-01T13:18:22Z"
+    status="InProgress"
+    error="{An error message.}"
+    filesCount="10"
+    credits="10"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/get_task_status/not_enough_credits.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="22345200-abe8-4f60-90c8-0d43c5f6c0f6"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-01-01T13:18:22Z"
+    status="NotEnoughCredits"
+    error="{An error message.}"
+    filesCount="10"
+    credits="0"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/get_task_status/submitted.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="22345200-abe8-4f60-90c8-0d43c5f6c0f6"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-01-01T13:18:22Z"
+    status="Submitted"
+    error="{An error message.}"
+    filesCount="10"
+    credits="10"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/process_image/success.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<response>
+  <task id="22345200-abe8-4f60-90c8-0d43c5f6c0f6"
+    registrationTime="2001-01-01T13:18:22Z"
+    statusChangeTime="2001-01-01T13:18:22Z"
+    status="Submitted"
+    error="{An error message.}"
+    filesCount="10"
+    credits="10"
+    estimatedProcessingTime="3600"
+    resultUrl="http://cloud.ocrsdk.com/result_url"
+    description="My first OCR task"/>
+  <task/>
+</response>

data/mocks/result/simple.xml

@@ -0,0 +1 @@
+meow

data/mocks/test/test.xml

@@ -0,0 +1 @@
+meow

data/spec/ocrsdk/image_spec.rb

@@ -6,40 +6,31 @@ describe OCRSDK::Image do
     OCRSDK.setup do |config|
       config.application_id = 'app_id'
       config.password = 'pass'
-    end    
+    end
+    OCRSDK::Mock.success
   end
 
+  subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
+
   describe ".as_text" do
-    subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
-    before { mock_ocrsdk }
-    
     it "should call api and return Promise" do
       subject.as_text([:russian]).should be_kind_of(OCRSDK::Promise)
     end
   end
 
   describe ".as_text_sync" do
-    subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
-    before { mock_ocrsdk }
-
     it "should wait till Promise is done and return result" do
       subject.as_text_sync([:russian], 0).should == 'meow'
     end
   end
 
   describe ".as_pdf" do
-    subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
-    before { mock_ocrsdk }
-    
     it "should call api and return Promise" do
       subject.as_pdf([:russian]).should be_kind_of(OCRSDK::Promise)
     end
   end
 
   describe ".as_pdf_sync" do
-    subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
-    before { mock_ocrsdk }
-
     it "should wait till Promise is done and return result if output file isn't specified" do
       subject.as_pdf_sync([:russian], nil, 0).should == 'meow'
     end
@@ -53,8 +44,6 @@ describe OCRSDK::Image do
   end
 
   describe ".api_process_image" do
-    subject { OCRSDK::Image.new TestFiles.russian_jpg_path }
-
     it "should raise UnsupportedLanguage on unsupported language" do
       expect {
         subject.instance_eval { api_process_image TestFiles.russian_jpg_path, [:meow] }

data/spec/ocrsdk/mock_spec.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe OCRSDK::Mock do
+
+  describe ".response" do
+    it "should read response from file" do
+      OCRSDK::Mock.response(:test, :test).should == 'meow'
+    end
+
+    it "should raise an exception if response is not found" do
+      expect {
+        OCRSDK::Mock.response(:test, :non_existant_file)
+      }.to raise_error(Errno::ENOENT)
+    end
+  end
+
+end

data/spec/ocrsdk/promise_spec.rb

@@ -11,7 +11,7 @@ describe OCRSDK::Promise do
 
   describe ".parse_response" do
     context "correct response" do
-      subject { OCRSDK::Promise.new(nil).parse_response process_image_response }
+      subject { OCRSDK::Promise.new(nil).parse_response OCRSDK::Mock.response(:get_task_status, :submitted) }
 
       its(:task_id)    { should == '22345200-abe8-4f60-90c8-0d43c5f6c0f6' }
       its(:status)     { should == :submitted }
@@ -35,14 +35,14 @@ describe OCRSDK::Promise do
 
       it "should raise an OCRSDK::NotEnoughCredits error" do
         expect {
-          subject.parse_response process_image_response_credits
+          subject.parse_response OCRSDK::Mock.response(:get_task_status, :not_enough_credits)
         }.to raise_error(OCRSDK::NotEnoughCredits)
       end
     end
   end 
 
   describe "self.from_response" do
-    subject { OCRSDK::Promise.from_response process_image_response }
+    subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :submitted) }
 
     its(:task_id)    { should == '22345200-abe8-4f60-90c8-0d43c5f6c0f6' }
     its(:status)     { should == :submitted }
@@ -54,7 +54,7 @@ describe OCRSDK::Promise do
   describe ".update" do
     subject { OCRSDK::Promise.new 'update-task-id' }
     before do
-      subject.stub(:api_update_status) { process_image_updated_response }
+      OCRSDK::Mock.in_progress
       subject.update
     end
 
@@ -85,21 +85,10 @@ describe OCRSDK::Promise do
 
   describe ".result" do
     context "processing completed without errors" do
-      subject { OCRSDK::Promise.from_response process_image_completed_response }
+      before { OCRSDK::Mock.success }
+      subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :completed) }
 
-      it "should call api method" do
-        subject.should_receive(:api_get_result).once
-        subject.result
-      end
-
-      it "should get file with coorect url and return its contents" do
-        RestClient.stub(:get) do |url| 
-          url.to_s.should == "http://cloud.ocrsdk.com/result_url"
-          "meow"
-        end
-        RestClient.should_receive(:get).once
-        subject.result.should == 'meow'
-      end
+      its(:result) { should == 'meow' }
 
       it "should raise NetworkError in case getting file fails" do
         RestClient.stub(:get) {|url| raise RestClient::ExceptionWithResponse }
@@ -112,7 +101,7 @@ describe OCRSDK::Promise do
     end
 
     context "processing failed" do
-      subject { OCRSDK::Promise.from_response process_image_failed_response }
+      subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :failed) }
 
       it "should raise an ProcessingFailed" do
         expect {
@@ -124,7 +113,7 @@ describe OCRSDK::Promise do
 
   describe ".completed? and .failed?" do
     context "processed job" do
-      subject { OCRSDK::Promise.from_response process_image_updated_response }
+      subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :in_progress) }
 
       its(:processing?) { should be_true }
       its(:completed?)  { should be_false }
@@ -132,7 +121,7 @@ describe OCRSDK::Promise do
     end
 
     context "completed job" do
-      subject { OCRSDK::Promise.from_response process_image_completed_response }
+      subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :completed) }
 
       its(:processing?) { should be_false }
       its(:completed?)  { should be_true }
@@ -140,7 +129,7 @@ describe OCRSDK::Promise do
     end
 
     context "failed job" do
-      subject { OCRSDK::Promise.from_response process_image_failed_response }
+      subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :failed) }
 
       its(:processing?) { should be_false }
       its(:completed?)  { should be_false }
@@ -149,13 +138,13 @@ describe OCRSDK::Promise do
   end
 
   describe ".wait" do
-    subject { OCRSDK::Promise.from_response process_image_response }
+    subject { OCRSDK::Promise.from_response OCRSDK::Mock.response(:get_task_status, :in_progress) }
 
     it "should check the status as many times as needed waiting while ocr is completed" do
       called_once = false
       subject.stub(:update) do
         if called_once
-          subject.parse_response process_image_completed_response
+          subject.parse_response OCRSDK::Mock.response(:get_task_status, :completed)
         else
           called_once = true
         end

data/spec/spec_helper.rb

@@ -5,5 +5,5 @@ end
 require 'rspec'
 require 'webmock/rspec'
 require 'ocrsdk'
-require 'helpers/ocrsdk_helpers'
+require 'ocrsdk/mock'
 require 'support/test_files'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocrsdk
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2012-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -159,6 +159,7 @@ files:
 - lib/ocrsdk/document.rb
 - lib/ocrsdk/errors.rb
 - lib/ocrsdk/image.rb
+- lib/ocrsdk/mock.rb
 - lib/ocrsdk/pdf.rb
 - lib/ocrsdk/promise.rb
 - lib/ocrsdk/verifiers.rb
@@ -166,6 +167,14 @@ files:
 - lib/ocrsdk/verifiers/language.rb
 - lib/ocrsdk/verifiers/profile.rb
 - lib/ocrsdk/verifiers/status.rb
+- mocks/get_task_status/completed.xml
+- mocks/get_task_status/failed.xml
+- mocks/get_task_status/in_progress.xml
+- mocks/get_task_status/not_enough_credits.xml
+- mocks/get_task_status/submitted.xml
+- mocks/process_image/success.xml
+- mocks/result/simple.xml
+- mocks/test/test.xml
 - ocrsdk.gemspec
 - spec/abstract_entity_spec.rb
 - spec/fixtures/files/lorem.complex.pdf
@@ -174,8 +183,8 @@ files:
 - spec/fixtures/files/recognizeable.pdf
 - spec/fixtures/files/russian.jpg
 - spec/fixtures/files/searchable.malformed.pdf
-- spec/helpers/ocrsdk_helpers.rb
 - spec/ocrsdk/image_spec.rb
+- spec/ocrsdk/mock_spec.rb
 - spec/ocrsdk/pdf_spec.rb
 - spec/ocrsdk/promise_spec.rb
 - spec/ocrsdk/verifiers/format_spec.rb
@@ -219,8 +228,8 @@ test_files:
 - spec/fixtures/files/recognizeable.pdf
 - spec/fixtures/files/russian.jpg
 - spec/fixtures/files/searchable.malformed.pdf
-- spec/helpers/ocrsdk_helpers.rb
 - spec/ocrsdk/image_spec.rb
+- spec/ocrsdk/mock_spec.rb
 - spec/ocrsdk/pdf_spec.rb
 - spec/ocrsdk/promise_spec.rb
 - spec/ocrsdk/verifiers/format_spec.rb

data/spec/helpers/ocrsdk_helpers.rb

@@ -1,106 +0,0 @@
-module OCRSDKHelpers
-
-  def process_image_response
-    <<-XML
-      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-      <response>
-        <task id="22345200-abe8-4f60-90c8-0d43c5f6c0f6"
-          registrationTime="2001-01-01T13:18:22Z"
-          statusChangeTime="2001-01-01T13:18:22Z"
-          status="Submitted"
-          error="{An error message.}"
-          filesCount="10"
-          credits="10"
-          estimatedProcessingTime="3600"
-          resultUrl="http://cloud.ocrsdk.com/result_url"
-          description="My first OCR task"/>
-        <task/>
-      </response>
-    XML
-  end
-
-  def process_image_response_credits
-    <<-XML
-      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-      <response>
-        <task id="22345200-abe8-4f60-90c8-0d43c5f6c0f6"
-          registrationTime="2001-01-01T13:18:22Z"
-          statusChangeTime="2001-01-01T13:18:22Z"
-          status="NotEnoughCredits"
-          error="{An error message.}"
-          filesCount="10"
-          credits="0"
-          estimatedProcessingTime="3600"
-          resultUrl="http://cloud.ocrsdk.com/result_url"
-          description="My first OCR task"/>
-        <task/>
-      </response>
-    XML
-  end
-
-  def process_image_updated_response
-    <<-XML
-      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-      <response>
-        <task id="update-task-id"
-          registrationTime="2001-01-01T13:18:22Z"
-          statusChangeTime="2001-02-01T13:18:22Z"
-          status="InProgress"
-          error="{An error message.}"
-          filesCount="10"
-          credits="10"
-          estimatedProcessingTime="3600"
-          resultUrl="http://cloud.ocrsdk.com/result_url"
-          description="My first OCR task"/>
-        <task/>
-      </response>
-    XML
-  end
-
-  def process_image_completed_response
-    <<-XML
-      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-      <response>
-        <task id="update-task-id"
-          registrationTime="2001-01-01T13:18:22Z"
-          statusChangeTime="2001-03-01T13:18:22Z"
-          status="Completed"
-          error="{An error message.}"
-          filesCount="10"
-          credits="10"
-          estimatedProcessingTime="3600"
-          resultUrl="http://cloud.ocrsdk.com/result_url"
-          description="My first OCR task"/>
-        <task/>
-      </response>
-    XML
-  end
-
-  def process_image_failed_response
-    <<-XML
-      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-      <response>
-        <task id="update-task-id"
-          registrationTime="2001-01-01T13:18:22Z"
-          statusChangeTime="2001-03-01T13:18:22Z"
-          status="ProcessingFailed"
-          error="{An error message.}"
-          filesCount="10"
-          credits="10"
-          estimatedProcessingTime="3600"
-          resultUrl="http://cloud.ocrsdk.com/result_url"
-          description="My first OCR task"/>
-        <task/>
-      </response>
-    XML
-  end
-
-  def mock_ocrsdk
-    stub_request(:post, /.*:.*@cloud.ocrsdk.com\/processImage/).to_return(body: process_image_response)
-    stub_request(:get,  /.*:.*@cloud.ocrsdk.com\/getTaskStatus\?taskId=.*/).to_return(body: process_image_completed_response )
-    stub_request(:get, 'http://cloud.ocrsdk.com/result_url').to_return(body: 'meow')
-  end
-
-end
-
-RSpec.configuration.include OCRSDKHelpers