gini-api 0.9.2

data/spec/gini-api/oauth_spec.rb

@@ -0,0 +1,412 @@
+require 'spec_helper'
+
+describe Gini::Api::OAuth do
+
+  let(:user)          { 'user@gini.net' }
+  let(:pass)          { 'secret' }
+  let(:auth_code)     { '1234567890' }
+  let(:state)         { '1234567890' }
+  let(:code)          { 'abcdefghij'}
+  let(:redirect)      { 'http://localhost' }
+  let(:status)        { 303 }
+  let(:token_status)  { 200 }
+  let(:token_body)    { 'client_id=cid&client_secret=sec&code=1234567890&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost' }
+  let(:header)        { { 'location' => "https://api.gini.net?code=#{code}&state=#{state}" } }
+  let(:oauth_site)    { 'https://user.gini.net' }
+  let(:authorize_uri) { "#{oauth_site}/authorize?client_id=cid&redirect_uri=#{redirect}&response_type=code&state=#{state}" }
+  let(:api) do
+    double('API',
+      client_id: 'cid',
+      client_secret: 'sec',
+      oauth_site: oauth_site,
+      oauth_redirect: redirect
+    )
+  end
+
+  describe '#new' do
+
+    context 'login with username/password' do
+
+      before do
+        allow(SecureRandom).to \
+          receive(:hex) { state }
+
+        stub_request(:post,
+          authorize_uri
+        ).to_return(
+          status: status,
+          headers: header,
+          body: {}
+        )
+
+        stub_request(:post,
+          "#{oauth_site}/token"
+        ).to_return(
+          status: token_status,
+          headers: {
+            'content-type' => 'application/json'
+          },
+          body: {
+            access_token: '123-456',
+            token_type: 'bearer',
+            expires_in: 300,
+            refresh_token: '987-654'
+          }.to_json
+        )
+      end
+
+      subject(:oauth) do
+        Gini::Api::OAuth.new(api,
+          username: user,
+          password: pass
+        )
+      end
+
+      it { should respond_to(:login_with_credentials) }
+      it { should respond_to(:exchange_code_for_token) }
+      it { should respond_to(:destroy) }
+
+      it 'does set token' do
+        expect(oauth.token.token).to eql('123-456')
+      end
+
+      context 'with invalid credentials' do
+
+        let(:status) { 500 }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /Failed to acquire auth_code/)
+        end
+
+      end
+
+      context 'with non-redirect status code' do
+
+        let(:status) { 200 }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /API login failed/)
+        end
+      end
+
+      context 'with invalid location header' do
+
+        let(:header) { { location: 'https://api.gini.net' } }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /Failed to parse location header/)
+        end
+
+      end
+
+      context 'with CSRF token mismatch' do
+
+        let(:header) { { location: "https://rspec.gini.net?code=#{code}&state=hacked"} }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /CSRF token mismatch detected/)
+        end
+
+      end
+
+      context 'without code' do
+
+        let(:header) { { location: "https://api.gini.net?state=#{state}"} }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /Failed to extract code from location/)
+        end
+
+      end
+
+      context 'with invalid client credentials' do
+
+        let(:token_status) { 401 }
+
+        it do
+          expect {
+            Gini::Api::OAuth.new(
+              api,
+              username: user,
+              password: pass
+            ) }.to raise_error(Gini::Api::OAuthError, /Failed to exchange auth_code/)
+        end
+
+      end
+
+    end
+
+    context 'login with auth_code' do
+
+      before do
+        stub_request(:post,
+          "#{oauth_site}/token"
+        ).with(
+          body: 'client_id=cid&client_secret=sec&code=1234567890&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost'
+        ).to_return(
+          status: token_status,
+          headers: {
+            'content-type' => 'application/json'
+          },
+          body: {
+            access_token: '123-456',
+            token_type: 'bearer',
+            expires_in: 300,
+            refresh_token: '987-654'
+          }.to_json
+        )
+      end
+
+      subject(:oauth) { Gini::Api::OAuth.new(api, auth_code: auth_code) }
+
+      it 'does set token' do
+        expect(oauth.token.token).to eql('123-456')
+      end
+
+      context 'overrides #refresh!' do
+
+        it do
+          expect(oauth.token).to respond_to(:refresh!)
+        end
+
+      end
+
+      context 'overrides #request' do
+
+        it do
+          expect(oauth.token).to respond_to(:request)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '#destroy' do
+
+    let(:status) { 204 }
+    let(:refresh_token) { false }
+
+    before do
+      stub_request(:post,
+        "#{oauth_site}/token"
+      ).with(
+        body: 'client_id=cid&client_secret=sec&code=1234567890&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost'
+      ).to_return(
+        status: token_status,
+        headers: {
+          'content-type' => 'application/json'
+        },
+        body: {
+          access_token: '123-456',
+          token_type: 'bearer',
+          expires_in: 300,
+          refresh_token: '987-654'
+        }.to_json
+      )
+
+      stub_request(
+        :delete,
+        %r{/accessToken/123-456}
+      ).to_return(status: status)
+
+      oauth.token.stub(:refresh_token).and_return(refresh_token)
+    end
+
+    subject(:oauth) { Gini::Api::OAuth.new(api, auth_code: auth_code) }
+
+    context 'with refresh token' do
+
+      let(:refresh_token) { true }
+
+      it 'does a refresh first' do
+        expect(oauth.token).to receive(:refresh_token)
+        expect(oauth.token).to receive(:refresh!)
+        expect(oauth.destroy).to be_nil
+      end
+
+    end
+
+    context 'without refresh token' do
+
+      it 'destroys token directly' do
+        expect(oauth.token).to receive(:refresh_token)
+        expect(oauth.token).not_to receive(:refresh!)
+        expect(oauth.destroy).to be_nil
+      end
+    end
+
+    context 'with invalid token' do
+
+      let(:status) { 404 }
+
+      it do
+        expect{oauth.destroy}.to raise_error Gini::Api::OAuthError, /Failed to destroy token/
+      end
+    end
+
+    context 'with unexpected http status code' do
+
+      let(:status) { 200 }
+
+      it do
+        expect{oauth.destroy}.to raise_error Gini::Api::OAuthError, /Failed to destroy token/
+      end
+    end
+  end
+
+  describe 'overridden AccessToken#refresh!' do
+
+    before do
+      stub_request(:post,
+        "#{oauth_site}/token"
+      ).with(
+        body: 'client_id=cid&client_secret=sec&code=1234567890&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost'
+      ).to_return(
+        status: token_status,
+        headers: {
+          'content-type' => 'application/json'
+        },
+        body: {
+          access_token: '123-456',
+          token_type: 'bearer',
+          expires_in: 300,
+          refresh_token: '987-654'
+        }.to_json
+      )
+    end
+
+    subject(:oauth) { Gini::Api::OAuth.new(api, auth_code: auth_code) }
+
+
+    it do
+      expect(oauth.token.token).to eql('123-456')
+
+      stub_request(
+        :post,
+        "#{oauth_site}/token"
+      ).to_return(
+        status: 200,
+        headers: {
+          'content-type' => 'application/json'
+        },
+        body: {
+          access_token: '42-42-42',
+          token_type: 'bearer',
+          expires_in: 300,
+          refresh_token: '987-654'
+        }.to_json
+      )
+
+      oauth.token.refresh!
+      expect(oauth.token.token).to eql('42-42-42')
+    end
+
+  end
+
+  describe 'overridden AccessToken#request' do
+
+    before do
+      stub_request(:post,
+        "#{oauth_site}/token"
+      ).with(
+        body: 'client_id=cid&client_secret=sec&code=1234567890&grant_type=authorization_code&redirect_uri=http%3A%2F%2Flocalhost'
+      ).to_return(
+        status: token_status,
+        headers: {
+          'content-type' => 'application/json'
+        },
+        body: {
+          access_token: '123-456',
+          token_type: 'bearer',
+          expires_in: 300,
+          refresh_token: '987-654'
+        }.to_json
+      )
+    end
+
+    subject(:oauth) { Gini::Api::OAuth.new(api, auth_code: auth_code) }
+
+
+    context 'with expired token' do
+
+      it 'does call refresh!' do
+        stub_request(:get, "https://user.gini.net/a")
+        stub_request(
+          :post,
+          "#{oauth_site}/token"
+        ).to_return(
+          status: 200,
+          headers: {
+            'content-type' => 'application/json'
+          },
+          body: {
+            access_token: '42-42-42',
+            token_type: 'bearer',
+            expires_in: -10,
+            refresh_token: '987-654'
+          }.to_json
+        )
+
+        expect(oauth.token).to receive(:refresh!)
+        oauth.token.request(:get, '/a')
+      end
+
+    end
+
+    context 'with valid token' do
+
+      it 'does not call refresh!' do
+
+        stub_request(:get, "https://user.gini.net/a")
+        stub_request(
+          :post,
+          "#{oauth_site}/token"
+        ).to_return(
+          status: 200,
+          headers: {
+            'content-type' => 'application/json'
+          },
+          body: {
+            access_token: '42-42-42',
+            token_type: 'bearer',
+            expires_in: 300,
+            refresh_token: '987-654'
+          }.to_json
+        )
+
+        expect(oauth.token).not_to receive(:refresh!)
+        oauth.token.request(:get, '/a')
+      end
+
+    end
+
+  end
+
+end

data/spec/integration/api_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+# Disable coverage for integration tests
+ENV['COVERAGE'] = nil
+
+# Cancel integration test when mandatory env vars are missing
+['GINI_API_USER', 'GINI_API_PASS', 'GINI_CLIENT_SECRET'].each do |m|
+  fail "Unset ENV variable #{m}. Tests aborted" unless ENV.has_key?(m)
+end
+
+# Let's make some REAL requests
+WebMock.allow_net_connect!
+
+describe 'Gini::Api integration test' do
+
+  before :all do
+    @user    = ENV['GINI_API_USER']
+    @pass    = ENV['GINI_API_PASS']
+    @testdoc = "#{File.dirname(__FILE__)}/files/test.pdf"
+    @api     = Gini::Api::Client.new(
+      client_id: ENV['GINI_CLIENT_ID'],
+      client_secret: ENV['GINI_CLIENT_SECRET'],
+      oauth_site: 'https://user.gini.net/',
+      api_uri: 'https://api.gini.net',
+      log: Logger.new('/dev/null')
+    )
+  end
+
+  context 'OAuth' do
+
+    it '#login sets token' do
+      @api.login(username: @user, password: @pass)
+      expect(@api.token.token).to match(/\w+-\w+/)
+      expect(@api.token.expired?).to be_false
+    end
+
+    it '#logout destroys token' do
+      expect(@api.token.get("/accessToken/#{@api.token.token}").status).to eql(200)
+      @api.logout
+      expect { @api.token.get("/accessToken/#{@api.token.token}") }.to raise_error(OAuth2::Error)
+    end
+
+  end
+
+  context 'document' do
+
+    before do
+      @api.login(username: @user, password: @pass)
+      @doc = @api.upload(@testdoc)
+    end
+
+    it '#upload returns Gini::Api::Doucment' do
+      @api.logout
+      expect(@doc.id).to match(/\w+-\w+/)
+      @api.delete(@doc.id)
+    end
+
+    it '#get returns Gini::Api::Doucment' do
+      doc_get = @api.get(@doc.id)
+      expect(@doc.id).to eql(doc_get.id)
+      @api.delete(@doc.id)
+      @api.logout
+    end
+
+    it '#list returns Gini::Api::DocumentSet' do
+      list = @api.list
+      expect(list).to be_a(Gini::Api::DocumentSet)
+      expect(list.total).to eql(1)
+      expect(list.documents[0]).to be_a(Gini::Api::Document)
+      @api.delete(@doc.id)
+      @api.logout
+    end
+
+    it '#delete returns true' do
+      expect(@api.delete(@doc.id)).to be_true
+      expect { @api.get(@doc.id) }.to raise_error(Gini::Api::RequestError)
+      @api.logout
+    end
+
+    context 'data' do
+
+      after do
+        @api.delete(@doc.id)
+        @api.logout
+      end
+
+      context 'extractions' do
+
+        subject(:extractions) { @doc.extractions }
+
+        it '#extractions populates instance vars' do
+          expect(extractions).to be_kind_of(Gini::Api::Document::Extractions)
+          expect(extractions.candidates).to be_kind_of(Hash)
+          expect(extractions).to respond_to(:amountToPay)
+          expect(extractions[:amountToPay]).to eql('1039.87:EUR')
+        end
+
+        it '#[] returns data' do
+          expect(extractions[:docType]).to eql('Invoice')
+        end
+
+      end
+
+      context 'layout' do
+
+        subject(:layout) { @doc.layout }
+
+        it '#to_xml returns XML string' do
+          expect(layout).to be_kind_of(Gini::Api::Document::Layout)
+          expect(layout.to_xml).to match(/xml/)
+        end
+
+        it '#to_json returns JSON string' do
+          expect(layout).to be_kind_of(Gini::Api::Document::Layout)
+          expect(layout.to_json).to satisfy { |json| JSON.parse(json).is_a?(Hash) }
+        end
+
+      end
+
+    end
+
+  end
+
+end