gini-api 0.9.2

data/spec/gini-api/document/extraction_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Gini::Api::Document::Extractions do
+
+  before do
+    expect(Gini::Api::OAuth).to \
+      receive(:new) { oauth }
+
+    api.login(auth_code: '1234567890')
+    api.token.stub(:get).with(
+      location,
+      {
+        headers: {
+          accept: header
+        }
+      }
+    ).and_return(OAuth2::Response.new(response))
+  end
+
+  let(:api) do
+    Gini::Api::Client.new(
+      client_id: 'gini-rspec',
+      client_secret: 'secret',
+      oauth_site: 'https://rspec-oauth.gini.net',
+      log: (Logger.new '/dev/null'),
+    )
+  end
+
+  let(:oauth) do
+    double('Gini::Api::OAuth',
+      :token => 'TOKEN',
+      :destroy => nil
+    )
+  end
+
+  let(:header)   { 'application/vnd.gini.v1+json' }
+  let(:location) { 'https://api.gini.net/document/aaa-bbb-ccc/extractions' }
+  let(:response) do
+    double('Response',
+      status: 200,
+      headers: {
+        'content-type' => header
+      },
+      body: {
+        extractions: {
+          payDate: {
+            entity: 'date',
+            value: '2012-06-20',
+            candidates: 'dates'
+          }
+        },
+        candidates: {
+          dates: [
+            {
+              entity: 'date',
+              value: '2012-06-20'
+            },
+            {
+              entity: 'date',
+              value: '2012-05-10'
+            },
+          ]
+        }
+      }.to_json
+    )
+  end
+
+  subject(:extractions) { Gini::Api::Document::Extractions.new(api, location) }
+
+  it { should respond_to(:update) }
+  it { should respond_to(:[]) }
+  it { should respond_to(:raw) }
+
+  describe '#update' do
+
+    it 'populates instance vars' do
+      expect(extractions.payDate).to be_a(Hash)
+      expect(extractions.payDate[:entity]).to eq('date')
+      extractions.update
+    end
+
+    it 'saves raw response' do
+      expect(extractions.raw).to eql(JSON.parse(response.body, symbolize_names: true))
+      extractions.update
+    end
+
+    context 'failed extraction fetch' do
+
+      let(:response) { double('Response', :status => 404, env: {}, body: {}) }
+
+      it 'raises exception' do
+        expect { extractions.update }.to \
+          raise_error(Gini::Api::DocumentError, /Failed to fetch extractions from #{location}/)
+      end
+
+    end
+
+  end
+
+  describe '#[]' do
+
+    context 'with invalid key' do
+
+      it 'raises exception' do
+        expect { extractions[:unknown] }.to \
+          raise_error(Gini::Api::DocumentError, /Invalid extraction key unknown/)
+      end
+
+    end
+
+    context 'with valid key' do
+
+      it 'returns extraction value' do
+        expect(extractions[:payDate]).to eql('2012-06-20')
+      end
+
+    end
+
+  end
+
+end

data/spec/gini-api/document/layout_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Gini::Api::Document::Layout do
+
+  let(:status)   { 200 }
+  let(:body)     { '' }
+  let(:api)      { double('API', :request => response) }
+  let(:location) { 'http://api.gini.net/document/aaa-bbb-ccc/extractions' }
+  let(:response) do
+    double('Response',
+      status: status,
+      body: body
+    )
+  end
+
+  subject(:layout) { Gini::Api::Document::Layout.new(api, location) }
+
+  it { should respond_to(:to_xml) }
+  it { should respond_to(:to_json) }
+
+  describe '#to_xml' do
+
+    let(:body) { '<XML>' }
+
+    before do
+      expect(api).to \
+        receive(:request).with(
+          :get,
+          location,
+          type: 'xml'
+        ) { response }
+    end
+
+    it do
+      expect(layout.to_xml).to eql('<XML>')
+    end
+
+    context 'without layout' do
+
+      let(:status) { 404 }
+
+      it do
+        expect(layout.to_xml).to be_nil
+      end
+
+    end
+
+  end
+
+  describe '#to_json' do
+
+    let(:body) { '{JSON}' }
+
+    before do
+      expect(api).to \
+        receive(:request).with(
+          :get,
+          location
+        )
+    end
+
+    it do
+      expect(layout.to_json).to eql('{JSON}')
+    end
+
+    context 'without layout' do
+
+      let(:status) { 404 }
+
+      it do
+        expect(layout.to_json).to be_nil
+      end
+
+    end
+
+  end
+
+end

data/spec/gini-api/document_spec.rb

@@ -0,0 +1,289 @@
+require 'spec_helper'
+
+describe Gini::Api::Document do
+
+  before do
+    expect(Gini::Api::OAuth).to receive(:new) do
+      double('Gini::Api::OAuth', token: 'TOKEN', destroy: nil)
+    end
+    api.login(auth_code: '1234567890')
+    api.token.stub(:get).with(
+      location,
+      { headers: { accept: header } }
+    ).and_return(OAuth2::Response.new(response))
+  end
+
+  let(:api) do
+    Gini::Api::Client.new(
+      client_id: 'gini-rspec',
+      client_secret: 'secret',
+      log: Logger.new('/dev/null')
+    )
+  end
+
+  let(:header)   { 'application/vnd.gini.v1+json' }
+  let(:location) { 'https://api.gini.net/documents/aaa-bbb-ccc' }
+  let(:response) do
+    double('Response', {
+      status: 200,
+      headers: { 'content-type' => header },
+      body: {
+        a: 1,
+        b: 2,
+        progress: 'PENDING',
+        _links: {
+          extractions: "#{location}/extractions",
+          layout: "#{location}/layout",
+          processed: "#{location}/processed"
+        }
+      }.to_json
+    })
+  end
+
+  subject(:document) { Gini::Api::Document.new(api, location) }
+
+  it { should respond_to(:update) }
+  it { should respond_to(:poll) }
+  it { should respond_to(:processed) }
+  it { should respond_to(:extractions) }
+  it { should respond_to(:layout) }
+  it { should respond_to(:pages) }
+
+  it 'does accept duration' do
+    expect(document.duration).to be_nil
+    document.duration = 'test'
+    expect(document.duration).to eql('test')
+  end
+
+  describe '#update' do
+
+    it 'does set instance vars' do
+      expect(document.a).to eql(1)
+      expect(document.b).to eql(2)
+    end
+
+    context 'with unknown document' do
+
+      let(:response) { double('Response', status: 404, env: {}, body: {}) }
+
+      it do
+        expect { Gini::Api::Document.new(api, location) }.to \
+          raise_error(Gini::Api::DocumentError, /Failed to fetch document data/)
+      end
+
+    end
+
+  end
+
+  describe '#poll' do
+
+    context 'without code block' do
+      let(:response) do
+        double('Response', {
+          status: 200,
+          headers: { 'content-type' => header },
+          body: {
+            a: 1,
+            b: 2,
+            progress: 'COMPLETED',
+            _links: { extractions: 'ex', layout: 'lay' }
+          }.to_json
+        })
+      end
+
+      it do
+        expect(document.poll(0)).to be_nil
+      end
+
+    end
+
+  end
+
+  describe '#processed' do
+
+    let(:pd_response) do
+      double('Response', {
+        status: 200,
+        headers: { 'content-type' => 'application/octet-stream' },
+        body: '1001'
+      })
+    end
+
+    it do
+      api.token.stub(:get).with(
+        "#{location}/processed",
+        { headers: { accept: 'application/octet-stream' } }
+      ).and_return(OAuth2::Response.new(pd_response))
+      expect(document.processed).to eql('1001')
+    end
+
+    context 'with status != 200' do
+
+      let(:pd_response) do
+        double('Response', {
+          status: 500,
+          headers: { 'content-type' => 'application/octet-stream' },
+          body: {},
+          env: {}
+        })
+      end
+
+      it do
+        api.token.stub(:get).with(
+          "#{location}/processed",
+          { headers: { accept: 'application/octet-stream' } }
+        ).and_return(OAuth2::Response.new(pd_response))
+        expect { document.processed }.to raise_error(Gini::Api::DocumentError)
+      end
+
+    end
+
+  end
+
+  describe '#extractions' do
+
+    let(:ex_response) do
+      double('Response', {
+        status: 200,
+        headers: { 'content-type' => header },
+        body: {
+          extractions: { payDate: {} },
+          candidates: {}
+        }.to_json
+      })
+    end
+
+    it do
+      api.token.stub(:get).with(
+        "#{location}/extractions",
+        { headers: { accept: header } }
+      ).and_return(OAuth2::Response.new(ex_response))
+      expect(document.extractions).to be_a(Gini::Api::Document::Extractions)
+    end
+
+  end
+
+  describe '#layout' do
+
+    it do
+      expect(document.layout).to be_a Gini::Api::Document::Layout
+    end
+
+  end
+
+  describe '#pages' do
+
+    let(:response) do
+      double('Response', {
+        status: 200,
+        headers: { 'content-type' => header },
+        body: {
+          pages: [
+            {
+              :pageNumber => 1,
+              :images =>
+              {
+                :"750x900"   => "750x900",
+                :"1280x1810" => "1280x1810"
+              }
+            },
+            {
+              :pageNumber => 2,
+              :images => {
+                :"750x900"   => "750x900",
+                :"1280x1810" => "1280x1810"
+              }
+            }
+          ]
+        }.to_json
+      })
+    end
+
+    it do
+      expect(document.pages).to be_an(Array)
+      expect(document.pages[0][:"750x900"]).to eql("750x900")
+      expect(document.pages[1][:"750x900"]).to eql("750x900")
+      expect{document.pages[2][:"750x900"]}.to raise_error(NoMethodError)
+    end
+
+  end
+
+  describe '#submit_feedback' do
+
+    let(:response) do
+      double('Response', {
+        status: 200,
+        headers: { 'content-type' => header },
+        body: {
+          a: 1,
+          b: 2,
+          progress: 'PENDING',
+          _links: {
+            extractions: "#{location}/extractions"
+          }
+        }.to_json
+      })
+    end
+
+    context 'succeeds' do
+
+      let(:fb_response) { double('Response', status: 204) }
+
+      it do
+        document.stub(:extractions) { double('Extractions').as_null_object }
+        api.token.stub(:put).with(
+          "#{location}/extractions/bic",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'XXXXXXXX' }.to_json
+          }
+        ).and_return(OAuth2::Response.new(fb_response))
+
+        expect(document.submit_feedback(:bic, 'XXXXXXXX')).to be_nil
+      end
+
+    end
+
+    context 'failes' do
+
+      let(:fb_response) { double('Response', status: 204) }
+
+      it 'on invalid label' do
+        document.stub(:extractions) { double('Extractions', bic: nil) }
+        api.token.stub(:put).with(
+          "#{location}/extractions/bic",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'XXXXXXXX' }.to_json
+          }
+        ).and_return(OAuth2::Response.new(fb_response))
+
+        expect { document.submit_feedback(:bic, 'XXXXXXXX') }.to \
+          raise_error(Gini::Api::DocumentError, /Unknown label bic/)
+      end
+
+    end
+
+    context 'failes' do
+
+      let(:fb_response) { double('Response', status: 404, body: {}, env: {}) }
+
+      it 'on invalid http code' do
+        document.stub(:extractions) { double('Extractions').as_null_object }
+        api.token.stub(:put).with(
+          "#{location}/extractions/bic",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'XXXXXXXX' }.to_json
+          }
+        ).and_return(OAuth2::Response.new(fb_response))
+
+        expect { document.submit_feedback(:bic, 'XXXXXXXX') }.to \
+          raise_error(Gini::Api::DocumentError, /Failed to submit feedback for label bic/)
+      end
+
+    end
+
+  end
+
+end

data/spec/gini-api/documentset_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Gini::Api::DocumentSet do
+
+  before do
+    allow(Gini::Api::Document).to \
+      receive(:new) { Gini::Api::Document }
+  end
+
+  let(:api) { double('API') }
+  let(:data) do
+    { totalCount: 2,
+      documents:[
+        {
+          _links: { document: 'dummy' }
+        },
+        {
+          _links: { document: 'dummy' }
+        }
+      ]
+    }
+  end
+
+  subject(:set) { Gini::Api::DocumentSet.new(api, data) }
+
+  it { should respond_to(:total) }
+  it { should respond_to(:documents) }
+  it { should respond_to(:each) }
+  it { should respond_to(:sort) }
+
+  it do
+    expect(set.total).to eql(2)
+  end
+
+  it do
+    expect(set.documents.length).to eql(2)
+    expect(set.documents[0]).to eql(Gini::Api::Document)
+  end
+
+  it '#each yields documents' do
+    expect { |b| set.each(&b) }.to yield_successive_args(Gini::Api::Document, Gini::Api::Document)
+  end
+end

data/spec/gini-api/error_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe Gini::Api::Error do
+
+  let(:location) { 'https://api.rspec/v0/documents/aaa-bbb-ccc' }
+  let(:api) do
+    double('API',
+      token: double('Token')
+    )
+  end
+  let(:response) do
+    double('Response',
+      status: 200,
+      body: {
+        a: 1,
+        b: 2,
+        progress: 'PENDING',
+        _links: {
+          extractions: 'ex',
+          layout: 'lay'
+        }
+      }.to_json
+    )
+  end
+
+  before do
+    api.token.stub(:get).and_return(response)
+  end
+
+  context 'without request obj' do
+
+    subject(:ex) { Gini::Api::Error.new('Error message') }
+
+    it do
+      expect(ex.message).to eql('Error message')
+    end
+
+    it do
+      expect(ex.api_response).to be_nil
+      should respond_to(:api_response)
+    end
+
+    it do
+      expect(ex.api_method).to be_nil
+      should respond_to(:api_method)
+    end
+
+    it do
+      expect(ex.api_url).to be_nil
+      should respond_to(:api_url)
+    end
+
+    it do
+      expect(ex.api_status).to be_nil
+      should respond_to(:api_status)
+    end
+
+    it do
+      expect(ex.api_message).to be_nil
+      should respond_to(:api_message)
+    end
+
+    it do
+      expect(ex.api_request_id).to be_nil
+      should respond_to(:api_request_id)
+    end
+
+    it do
+      expect(ex.docid).to be_nil
+      should respond_to(:docid)
+    end
+
+    it 'does accept docid' do
+      expect(ex.docid).to be_nil
+      ex.docid = 'abc-123'
+      expect(ex.docid).to eql('abc-123')
+    end
+
+  end
+
+  context 'with request obj' do
+
+    let(:request) do
+      double('Request',
+        status: 500,
+        body: {
+          message: 'Validation of the request entity failed',
+          requestId: '8896f9dc-260d-4133-9848-c54e5715270f'
+        }.to_json,
+        env: {
+          method: :post,
+          url: 'https://api.gini.net/abc-123',
+        }
+      )
+    end
+
+    subject(:ex) { Gini::Api::Error.new('Error message', request) }
+
+    it do
+      expect(ex.api_response).to eql(request)
+    end
+
+    it do
+      expect(ex.api_method).to eql(:post)
+    end
+
+    it do
+      expect(ex.api_status).to eql(500)
+    end
+
+    it do
+      expect(ex.api_url).to \
+        eql('https://api.gini.net/abc-123')
+    end
+
+    it do
+      expect(ex.api_message).to \
+        eql('Validation of the request entity failed')
+    end
+
+    it do
+      expect(ex.api_request_id).to \
+        eql('8896f9dc-260d-4133-9848-c54e5715270f')
+    end
+
+    it do
+      expect(ex.api_error).to \
+        eql('POST https://api.gini.net/abc-123 : 500 - Validation of the request entity failed (request Id: 8896f9dc-260d-4133-9848-c54e5715270f)')
+    end
+
+  end
+
+  context 'with unparsable body' do
+
+    let(:request) do
+      double('Request',
+        status: 500,
+        body: 'NO Json. Sorry',
+        env: {
+          method: :post,
+          url: 'https://api.gini.net/abc-123',
+        }
+      )
+    end
+
+    subject(:ex) { Gini::Api::Error.new('Error message', request) }
+
+    it 'ignores message and request_id' do
+      expect(ex.api_message).to eql('undef')
+      expect(ex.api_request_id).to eql('undef')
+    end
+
+  end
+
+end