google-api-client 0.4.3 → 0.4.4

data/spec/google/api_client/discovery_spec.rb

@@ -1,3 +1,5 @@
+# encoding:utf-8
+
 # Copyright 2010 Google Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,6 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require 'spec_helper'
 
 gem 'faraday', '~> 0.7.0'
@@ -139,6 +142,12 @@ describe Google::APIClient do
       ).name.should == 'delete'
     end
 
+    it 'should define the origin API in discovered methods' do
+      @client.discovered_method(
+        'prediction.training.insert', 'prediction', 'v1.2'
+      ).api.name.should == 'prediction'
+    end
+
     it 'should not find methods that are not in the discovery document' do
       @client.discovered_method(
         'prediction.bogus', 'prediction', 'v1.2'
@@ -162,6 +171,10 @@ describe Google::APIClient do
       @client.preferred_version(:prediction).version.should_not == 'v1'
     end
 
+    it 'should return a batch path' do
+      @client.discovered_api('prediction', 'v1.2').batch_path.should_not be_nil
+    end
+
     it 'should generate valid requests' do
       request = @client.generate_request(
         :api_method => @prediction.training.insert,
@@ -289,7 +302,7 @@ describe Google::APIClient do
       result = @client.execute(
         @prediction.training.insert,
         {},
-        MultiJson.encode({"id" => "bucket/object"}),
+        MultiJson.dump({"id" => "bucket/object"}),
         {'Content-Type' => 'application/json'}
       )
       result.request.headers['Content-Type'].should == 'application/json'
@@ -321,6 +334,12 @@ describe Google::APIClient do
       ).name.should == 'list'
     end
 
+    it 'should define the origin API in discovered methods' do
+      @client.discovered_method(
+        'plus.activities.list', 'plus'
+      ).api.name.should == 'plus'
+    end
+
     it 'should not find methods that are not in the discovery document' do
       @client.discovered_method('plus.bogus', 'plus').should == nil
     end
@@ -378,12 +397,22 @@ describe Google::APIClient do
       @client.discovered_api('latitude').version.should == 'v1'
     end
 
+    it 'should return a batch path' do
+      @client.discovered_api('latitude').batch_path.should_not be_nil
+    end
+
     it 'should find methods that are in the discovery document' do
       @client.discovered_method(
         'latitude.currentLocation.get', 'latitude'
       ).name.should == 'get'
     end
 
+    it 'should define the origin API in discovered methods' do
+      @client.discovered_method(
+        'latitude.currentLocation.get', 'latitude'
+      ).api.name.should == 'latitude'
+    end
+
     it 'should not find methods that are not in the discovery document' do
       @client.discovered_method('latitude.bogus', 'latitude').should == nil
     end
@@ -437,10 +466,20 @@ describe Google::APIClient do
       ).name.should == 'get'
     end
 
+    it 'should define the origin API in discovered methods' do
+      @client.discovered_method(
+        'moderator.profiles.get', 'moderator'
+      ).api.name.should == 'moderator'
+    end
+
     it 'should not find methods that are not in the discovery document' do
       @client.discovered_method('moderator.bogus', 'moderator').should == nil
     end
 
+    it 'should return a batch path' do
+      @client.discovered_api('moderator').batch_path.should_not be_nil
+    end
+
     it 'should generate requests against the correct URIs' do
       request = @client.generate_request(
         :api_method => 'moderator.profiles.get',
@@ -470,4 +509,153 @@ describe Google::APIClient do
       result.response.status.should == 401
     end
   end
+
+  describe 'with the adsense API' do
+    before do
+      @client.authorization = nil
+      @adsense = @client.discovered_api('adsense', 'v1')
+    end
+
+    it 'should correctly determine the discovery URI' do
+      @client.discovery_uri('adsense').should ===
+        'https://www.googleapis.com/discovery/v1/apis/adsense/v1/rest'
+    end
+
+    it 'should find APIs that are in the discovery document' do
+      @client.discovered_api('adsense').name.should == 'adsense'
+      @client.discovered_api('adsense').version.should == 'v1'
+    end
+
+    it 'should return a batch path' do
+      @client.discovered_api('adsense').batch_path.should_not be_nil
+    end
+
+    it 'should find methods that are in the discovery document' do
+      @client.discovered_method(
+        'adsense.reports.generate', 'adsense'
+      ).name.should == 'generate'
+    end
+
+    it 'should not find methods that are not in the discovery document' do
+      @client.discovered_method('adsense.bogus', 'adsense').should == nil
+    end
+
+    it 'should generate requests against the correct URIs' do
+      request = @client.generate_request(
+        :api_method => 'adsense.adclients.list',
+        :authenticated => false
+      )
+      request.to_env(Faraday.default_connection)[:url].should ===
+        'https://www.googleapis.com/adsense/v1/adclients'
+    end
+
+    it 'should generate requests against the correct URIs' do
+      request = @client.generate_request(
+        :api_method => @adsense.adclients.list,
+        :authenticated => false
+      )
+      request.to_env(Faraday.default_connection)[:url].should ===
+        'https://www.googleapis.com/adsense/v1/adclients'
+    end
+
+    it 'should not be able to execute requests without authorization' do
+      result = @client.execute(
+        :api_method => 'adsense.adclients.list',
+        :authenticated => false
+      )
+      result.response.status.should == 401
+    end
+
+    it 'should fail when validating missing required parameters' do
+      (lambda do
+        @client.generate_request(
+          :api_method => @adsense.reports.generate,
+          :authenticated => false
+        )
+      end).should raise_error(ArgumentError)
+    end
+
+    it 'should succeed when validating parameters in a correct call' do
+      (lambda do
+        @client.generate_request(
+          :api_method => @adsense.reports.generate,
+          :parameters => {
+            'startDate' => '2000-01-01',
+            'endDate' => '2010-01-01',
+            'dimension' => 'DATE',
+            'metric' => 'PAGE_VIEWS'
+          },
+          :authenticated => false
+        )
+      end).should_not raise_error
+    end
+
+    it 'should fail when validating parameters with invalid values' do
+      (lambda do
+        @client.generate_request(
+          :api_method => @adsense.reports.generate,
+          :parameters => {
+            'startDate' => '2000-01-01',
+            'endDate' => '2010-01-01',
+            'dimension' => 'BAD_CHARACTERS=-&*(£&',
+            'metric' => 'PAGE_VIEWS'
+          },
+          :authenticated => false
+        )
+      end).should raise_error(ArgumentError)
+    end
+
+    it 'should succeed when validating repeated parameters in a correct call' do
+      (lambda do
+        @client.generate_request(
+          :api_method => @adsense.reports.generate,
+          :parameters => {
+            'startDate' => '2000-01-01',
+            'endDate' => '2010-01-01',
+            'dimension' => ['DATE', 'PRODUCT_CODE'],
+            'metric' => ['PAGE_VIEWS', 'CLICKS']
+          },
+          :authenticated => false
+        )
+      end).should_not raise_error
+    end
+
+    it 'should fail when validating incorrect repeated parameters' do
+      (lambda do
+        @client.generate_request(
+          :api_method => @adsense.reports.generate,
+          :parameters => {
+            'startDate' => '2000-01-01',
+            'endDate' => '2010-01-01',
+            'dimension' => ['DATE', 'BAD_CHARACTERS=-&*(£&'],
+            'metric' => ['PAGE_VIEWS', 'CLICKS']
+          },
+          :authenticated => false
+        )
+      end).should raise_error(ArgumentError)
+    end
+  end
+  
+  describe 'with the Drive API' do
+    before do
+      @client.authorization = nil
+      @drive = @client.discovered_api('drive', 'v1')
+    end
+    
+    it 'should include media upload info methods' do
+      @drive.files.insert.media_upload.should_not == nil
+    end
+    
+    it 'should include accepted media types' do
+      @drive.files.insert.media_upload.accepted_types.should_not be_empty
+    end
+    
+    it 'should have an upload path' do
+      @drive.files.insert.media_upload.uri_template.should_not == nil
+    end
+    
+    it 'should have a max file size' do
+      @drive.files.insert.media_upload.max_size.should_not == nil
+    end
+  end
 end

data/spec/google/api_client/media_spec.rb

@@ -0,0 +1,136 @@
+# 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'
+
+fixtures_path = File.expand_path('../../../fixtures', __FILE__)
+
+describe Google::APIClient::UploadIO do
+  it 'should reject invalid file paths' do
+    (lambda do
+      media = Google::APIClient::UploadIO.new('doesnotexist', 'text/plain')
+    end).should raise_error
+  end
+  
+  describe 'with a file' do
+    before do
+      @file = File.expand_path('files/sample.txt', fixtures_path)
+      @media = Google::APIClient::UploadIO.new(@file, 'text/plain')
+    end
+    
+    it 'should report the correct file length' do
+      @media.length.should == File.size(@file)
+    end
+    
+    it 'should have a mime type' do
+      @media.content_type.should == 'text/plain'
+    end
+  end
+  
+  describe 'with StringIO' do
+    before do
+      @content = "hello world"
+      @media = Google::APIClient::UploadIO.new(StringIO.new(@content), 'text/plain', 'test.txt')
+    end
+
+    it 'should report the correct file length' do
+      @media.length.should == @content.length
+    end
+    
+    it 'should have a mime type' do
+      @media.content_type.should == 'text/plain'
+    end
+  end
+end
+
+describe Google::APIClient::ResumableUpload do
+  before do
+    @client = Google::APIClient.new
+    @drive = @client.discovered_api('drive', 'v1')
+    @file = File.expand_path('files/sample.txt', fixtures_path)
+    @media = Google::APIClient::UploadIO.new(@file, 'text/plain')
+    @uploader = Google::APIClient::ResumableUpload.new(
+      mock_result(308),
+      @media,
+      'https://www.googleapis.com/upload/drive/v1/files/12345')
+  end
+  
+  it 'should consider 20x status as complete' do
+    api_client = stub('api', :execute => mock_result(200))
+    @uploader.send_chunk(api_client)
+    @uploader.complete?.should == true
+  end
+
+  it 'should consider 30x status as incomplete' do
+    api_client = stub('api', :execute => mock_result(308))
+    @uploader.send_chunk(api_client)
+    @uploader.complete?.should == false
+    @uploader.expired?.should == false
+  end
+
+  it 'should consider 40x status as fatal' do
+    api_client = stub('api', :execute => mock_result(404))
+    @uploader.send_chunk(api_client)
+    @uploader.expired?.should == true
+  end
+
+  it 'should detect changes to location' do
+    api_client = stub('api', :execute => mock_result(308, 'location' => 'https://www.googleapis.com/upload/drive/v1/files/abcdef'))
+    @uploader.send_chunk(api_client)
+    @uploader.location.should == 'https://www.googleapis.com/upload/drive/v1/files/abcdef'
+  end
+  
+  it 'should resume from the saved range reported by the server' do 
+    api_client = mock('api')
+    api_client.should_receive(:execute).and_return(mock_result(308, 'range' => '0-99'))
+    api_client.should_receive(:execute).with(
+      hash_including(:headers => hash_including(
+        "Content-Range" => "bytes 100-299/#{@media.length}",
+        "Content-Length" => "200"
+      ))).and_return(mock_result(308))
+
+    @uploader.chunk_size = 200
+    @uploader.send_chunk(api_client) # Send bytes 0-199, only 0-99 saved
+    @uploader.send_chunk(api_client) # Send bytes 100-299
+  end
+  
+  it 'should resync the offset after 5xx errors' do
+    api_client = mock('api')
+    api_client.should_receive(:execute).and_return(mock_result(500))
+    api_client.should_receive(:execute).with(
+      hash_including(:headers => hash_including(
+        "Content-Range" => "bytes */#{@media.length}",
+        "Content-Length" => "0"
+      ))).and_return(mock_result(308, 'range' => '0-99'))
+    api_client.should_receive(:execute).with(
+      hash_including(:headers => hash_including(
+        "Content-Range" => "bytes 100-299/#{@media.length}",
+        "Content-Length" => "200"
+      ))).and_return(mock_result(308))
+
+    @uploader.chunk_size = 200
+    @uploader.send_chunk(api_client) # 500, invalidate
+    @uploader.send_chunk(api_client) # Just resyncs, doesn't actually upload
+    @uploader.send_chunk(api_client) # Send next chunk at correct range
+  end
+
+  def mock_result(status, headers = {})
+    reference = Google::APIClient::Reference.new(:api_method => @drive.files.insert)
+    stub('result', :status => status, :headers => headers, :reference => reference)
+  end
+  
+end

data/spec/google/api_client/result_spec.rb

@@ -0,0 +1,150 @@
+# 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
+  before do
+    @client = Google::APIClient.new
+  end
+
+  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_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": "tag:google.com,2010:/plus/people/foo/activities/public",
+            "items": []
+          }
+          END_OF_STRING
+        )
+        @result = Google::APIClient::Result.new(@reference, @request, @response)
+      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
+        reference = @result.next_page
+        reference.parameters.should include('pageToken')
+        reference.parameters['pageToken'].should == 'NEXT+PAGE+TOKEN'
+        path = reference.to_request.path.to_s
+        path.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 ==
+            'tag:google.com,2010:/plus/people/foo/activities/public'
+        @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": "tag:google.com,2010:/plus/people/foo/activities/public",
+            "items": []
+          }
+          END_OF_STRING
+        )
+        @result = Google::APIClient::Result.new(@reference, @request, @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 ==
+            'tag:google.com,2010:/plus/people/foo/activities/public'
+        @result.data.items.should be_empty
+      end
+    end
+  end
+end