gini-api 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48a332c434967ccd2d8906da4f64f7a8a27346b3
-  data.tar.gz: a3143decf245e1ef61800716558726431d9601e3
+  metadata.gz: 0a949ae559fd91862b4eda06e33bd99d717e923c
+  data.tar.gz: ef662694c99fd59112f90c6e0a2b35a316e5e858
 SHA512:
-  metadata.gz: 33f11fa2e20aefb5e51e68fa495445c1b5da7eb6f46612ef4ed3dcbc513d071753bd2241b0e8220c9b217cbfbbf141931927a17827c3813c1f359eb54741cee2
-  data.tar.gz: 9819589db65cde5ddb460ac6e75887d1adf976be5bffc58707b5daf413b5999e4234e7d951d8615e02d5a0b07f219b37eba9346b13f47bb23763b9c81d8bf82c
+  metadata.gz: 585493d99b5060412222a182df04d84a0613532826c5f2178380c061ffd943059ae76a74ea710bef0e42057d1c904039a95324b49f36b0af3cd87683f732d223
+  data.tar.gz: 02360f6508c2d1df34ddae1d969c16924f29d26412ed5ff46bda906c539eb741a257c5a43dc907a2b1b0ac9f7922acd561ad87a0e6d12e5011e4b16073c87046

data/README.md

@@ -57,6 +57,10 @@ doc.id
 # => "123456789-abcd-ef12-000000000000"
 doc.progress
 # => "COMPLETED"
+doc.completed?
+# => true
+doc.successful?
+# => true
 ```
 
 ### List

data/lib/gini-api/document.rb

@@ -67,6 +67,22 @@ module Gini
         end
       end
 
+      # Indicate if the document has been processed
+      #
+      # @return [Boolean] true if progress == PENDING
+      #
+      def completed?
+        @progress != 'PENDING'
+      end
+
+      # Was the document processed successfully?
+      #
+      # @return [Boolean] true/false based on @progress
+      #
+      def successful?
+        @progress == 'COMPLETED'
+      end
+
       # Get processed document
       #
       # @return [data] The binary representation of the processed document (pdf, jpg, png, ...)

data/lib/gini-api/version.rb

@@ -1,5 +1,5 @@
 module Gini
   module Api
-    VERSION = "0.9.3"
+    VERSION = "0.9.4"
   end
 end

data/spec/gini-api/document_spec.rb

@@ -48,6 +48,8 @@ describe Gini::Api::Document do
   it { should respond_to(:extractions) }
   it { should respond_to(:layout) }
   it { should respond_to(:pages) }
+  it { should respond_to(:completed?) }
+  it { should respond_to(:successful?) }
 
   it 'does accept duration' do
     expect(document.duration).to be_nil
@@ -99,6 +101,86 @@ describe Gini::Api::Document do
 
   end
 
+  describe '#completed?' do
+
+    context 'with state = PENDING' do
+
+      let(:response) do
+        double('Response', {
+          status: 200,
+          headers: { 'content-type' => header },
+          body: {
+            progress: 'PENDING'
+          }.to_json
+        })
+      end
+
+      it do
+        expect(document.completed?).to be_false
+      end
+
+    end
+
+    context 'with state != PENDING' do
+
+      let(:response) do
+        double('Response', {
+          status: 200,
+          headers: { 'content-type' => header },
+          body: {
+            progress: 'COMPLETED'
+          }.to_json
+        })
+      end
+
+      it do
+        expect(document.completed?).to be_true
+      end
+
+    end
+
+  end
+
+  describe '#successful?' do
+
+    context 'with state = COMPLETED' do
+
+      let(:response) do
+        double('Response', {
+          status: 200,
+          headers: { 'content-type' => header },
+          body: {
+            progress: 'COMPLETED'
+          }.to_json
+        })
+      end
+
+      it do
+        expect(document.successful?).to be_true
+      end
+
+    end
+
+    context 'with state == ERROR' do
+
+      let(:response) do
+        double('Response', {
+          status: 200,
+          headers: { 'content-type' => header },
+          body: {
+            progress: 'ERROR'
+          }.to_json
+        })
+      end
+
+      it do
+        expect(document.successful?).to be_false
+      end
+
+    end
+
+  end
+
   describe '#processed' do
 
     let(:pd_response) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gini-api
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Daniel Kerwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2