google-api-ruby-client/spec/google/api_client/result_spec.rb

# Copyright 2012 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'spec_helper'

require 'google/api_client'
require 'google/api_client/version'

describe Google::APIClient::Result do
  CLIENT = Google::APIClient.new(:application_name => 'API Client Tests') unless defined?(CLIENT)

  describe 'with the plus API' do
    before do
      CLIENT.authorization = nil
      @plus = CLIENT.discovered_api('plus', 'v1')
      @reference = Google::APIClient::Reference.new({
        :api_method => @plus.activities.list,
        :parameters => {
          'userId' => 'me',
          'collection' => 'public',
          'maxResults' => 20
        }
      })
      @request = @reference.to_http_request

      # Response stub
      @response = stub("response")
      @response.stub(:status).and_return(200)
      @response.stub(:headers).and_return({
        'etag' => '12345',
        'x-google-apiary-auth-scopes' =>
          'https://www.googleapis.com/auth/plus.me',
        'content-type' => 'application/json; charset=UTF-8',
        'date' => 'Mon, 23 Apr 2012 00:00:00 GMT',
        'cache-control' => 'private, max-age=0, must-revalidate, no-transform',
        'server' => 'GSE',
        'connection' => 'close'
      })
    end

    describe 'with a next page token' do
      before do
        @response.stub(:body).and_return(
          <<-END_OF_STRING
          {
            "kind": "plus#activityFeed",
            "etag": "FOO",
            "nextPageToken": "NEXT+PAGE+TOKEN",
            "selfLink": "https://www.googleapis.com/plus/v1/people/foo/activities/public?",
            "nextLink": "https://www.googleapis.com/plus/v1/people/foo/activities/public?maxResults=20&pageToken=NEXT%2BPAGE%2BTOKEN",
            "title": "Plus Public Activity Feed for ",
            "updated": "2012-04-23T00:00:00.000Z",
            "id": "123456790",
            "items": []
          }
          END_OF_STRING
        )
        @result = Google::APIClient::Result.new(@reference, @response)
      end

      it 'should indicate a successful response' do
        @result.error?.should be_false
      end

      it 'should return the correct next page token' do
        @result.next_page_token.should == 'NEXT+PAGE+TOKEN'
      end

      it 'should escape the next page token when calling next_page' do
        pending("This is caused by Faraday's encoding of query parameters.")
        reference = @result.next_page
        Hash[reference.parameters].should include('pageToken')
        Hash[reference.parameters]['pageToken'].should == 'NEXT+PAGE+TOKEN'
        url = reference.to_env(Faraday.default_connection)[:url]
        url.to_s.should include('pageToken=NEXT%2BPAGE%2BTOKEN')
      end

      it 'should return content type correctly' do
        @result.media_type.should == 'application/json'
      end

      it 'should return the result data correctly' do
        @result.data?.should be_true
        @result.data.class.to_s.should ==
            'Google::APIClient::Schema::Plus::V1::ActivityFeed'
        @result.data.kind.should == 'plus#activityFeed'
        @result.data.etag.should == 'FOO'
        @result.data.nextPageToken.should == 'NEXT+PAGE+TOKEN'
        @result.data.selfLink.should ==
            'https://www.googleapis.com/plus/v1/people/foo/activities/public?'
        @result.data.nextLink.should ==
            'https://www.googleapis.com/plus/v1/people/foo/activities/public?' +
            'maxResults=20&pageToken=NEXT%2BPAGE%2BTOKEN'
        @result.data.title.should == 'Plus Public Activity Feed for '
        @result.data.id.should == "123456790"
        @result.data.items.should be_empty
      end
    end

    describe 'without a next page token' do
      before do
        @response.stub(:body).and_return(
          <<-END_OF_STRING
          {
            "kind": "plus#activityFeed",
            "etag": "FOO",
            "selfLink": "https://www.googleapis.com/plus/v1/people/foo/activities/public?",
            "title": "Plus Public Activity Feed for ",
            "updated": "2012-04-23T00:00:00.000Z",
            "id": "123456790",
            "items": []
          }
          END_OF_STRING
        )
        @result = Google::APIClient::Result.new(@reference, @response)
      end

      it 'should not return a next page token' do
        @result.next_page_token.should == nil
      end

      it 'should return content type correctly' do
        @result.media_type.should == 'application/json'
      end

      it 'should return the result data correctly' do
        @result.data?.should be_true
        @result.data.class.to_s.should ==
            'Google::APIClient::Schema::Plus::V1::ActivityFeed'
        @result.data.kind.should == 'plus#activityFeed'
        @result.data.etag.should == 'FOO'
        @result.data.selfLink.should ==
            'https://www.googleapis.com/plus/v1/people/foo/activities/public?'
        @result.data.title.should == 'Plus Public Activity Feed for '
        @result.data.id.should == "123456790"
        @result.data.items.should be_empty
      end
    end
    
    describe 'with JSON error response' do
      before do
        @response.stub(:body).and_return(
         <<-END_OF_STRING
         {
          "error": {
           "errors": [
            {
             "domain": "global",
             "reason": "parseError",
             "message": "Parse Error"
            }
           ],
           "code": 400,
           "message": "Parse Error"
          }
         }
         END_OF_STRING
        )
        @response.stub(:status).and_return(400)
        @result = Google::APIClient::Result.new(@reference, @response)
      end
      
      it 'should return error status correctly' do
        @result.error?.should be_true
      end

      it 'should return the correct error message' do
        @result.error_message.should == 'Parse Error'
      end
    end
    
    describe 'with 204 No Content response' do
      before do
        @response.stub(:body).and_return('')
        @response.stub(:status).and_return(204)
        @response.stub(:headers).and_return({})
        @result = Google::APIClient::Result.new(@reference, @response)
      end

      it 'should indicate no data is available' do
        @result.data?.should be_false
      end
      
      it 'should return nil for data' do
        @result.data.should == nil
      end
      
      it 'should return nil for media_type' do
        @result.media_type.should == nil
      end
    end
  end
end