Class: Google::Apis::Core::BaseService

Inherits:

Object

Object
Google::Apis::Core::BaseService

show all

Includes:: Logging

Defined in:: lib/google/apis/core/base_service.rb

Overview

Base service for all APIs. Not to be used directly.

Direct Known Subclasses

Instance Attribute Summary collapse

#authorization ⇒ Signet::OAuth2::Client
OAuth2 credentials.
#base_path ⇒ Addressable::URI
Additional path prefix for all API methods.
#batch_path ⇒ Addressable::URI
Alternate path prefix for all batch methods.
#client ⇒ HTTPClient
Get the current HTTP client.
#client_options ⇒ Google::Apis::ClientOptions
General settings.
#request_options ⇒ Google::Apis::RequestOptions
Default options for all requests.
#root_url ⇒ Addressable::URI
Root URL (host/port) for the API.
#upload_path ⇒ Addressable::URI
Alternate path prefix for media uploads.

Instance Method Summary collapse

#batch(options = nil) {|self| ... }
Perform a batch request.
#batch_upload(options = nil) {|self| ... }
Perform a batch upload request.
#fetch_all(max: nil, items: :items, cache: true, response_page_token: :next_page_token) {|token, service| ... } ⇒ Enumerble
Executes a given query with paging, automatically retrieving additional pages as necessary.
#http(method, url, params: nil, body: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ String
Simple escape hatch for making API requests directly to a given URL.
#initialize(root_url, base_path) ⇒ BaseService constructor private
A new instance of BaseService.

Methods included from Logging

#logger

Constructor Details

#initialize(root_url, base_path) ⇒ `BaseService`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BaseService

Parameters:

root_url (String, Addressable::URI) —
Root URL for the API
base_path (String, Addressable::URI) —
Additional path prefix for all API methods

# File 'lib/google/apis/core/base_service.rb', line 128

def initialize(root_url, base_path)
  self.root_url = root_url
  self.base_path = base_path
  self.upload_path = "upload/#{base_path}"
  self.batch_path = 'batch'
  self.client_options = Google::Apis::ClientOptions.default.dup
  self.request_options = Google::Apis::RequestOptions.default.dup
end

Instance Attribute Details

#authorization ⇒ `Signet::OAuth2::Client`

Returns OAuth2 credentials

Returns:

(Signet::OAuth2::Client) —
OAuth2 credentials



140
141
142

# File 'lib/google/apis/core/base_service.rb', line 140

def authorization=(authorization)
  request_options.authorization = authorization
end

#base_path ⇒ `Addressable::URI`

Additional path prefix for all API methods

Returns:

(Addressable::URI)



101
102
103

# File 'lib/google/apis/core/base_service.rb', line 101

def base_path
  @base_path
end

#batch_path ⇒ `Addressable::URI`

Alternate path prefix for all batch methods

Returns:

(Addressable::URI)



109
110
111

# File 'lib/google/apis/core/base_service.rb', line 109

def batch_path
  @batch_path
end

#client ⇒ `HTTPClient`

Get the current HTTP client

Returns:

(HTTPClient)



113
114
115

# File 'lib/google/apis/core/base_service.rb', line 113

def client
  @client
end

#client_options ⇒ `Google::Apis::ClientOptions`

General settings

Returns:

(Google::Apis::ClientOptions)



117
118
119

# File 'lib/google/apis/core/base_service.rb', line 117

def client_options
  @client_options
end

#request_options ⇒ `Google::Apis::RequestOptions`

Default options for all requests

Returns:

(Google::Apis::RequestOptions)



121
122
123

# File 'lib/google/apis/core/base_service.rb', line 121

def request_options
  @request_options
end

#root_url ⇒ `Addressable::URI`

Root URL (host/port) for the API

Returns:

(Addressable::URI)



97
98
99

# File 'lib/google/apis/core/base_service.rb', line 97

def root_url
  @root_url
end

#upload_path ⇒ `Addressable::URI`

Alternate path prefix for media uploads

Returns:

(Addressable::URI)



105
106
107

# File 'lib/google/apis/core/base_service.rb', line 105

def upload_path
  @upload_path
end

Instance Method Details

#batch(options = nil) {|self| ... }

This method returns an undefined value.

Perform a batch request. Calls made within the block are sent in a single network request to the server.

Examples:

service.batch do |s|
  s.get_item(id1) do |res, err|
    # process response for 1st call
  end
  # ...
  s.get_item(idN) do |res, err|
    # process response for Nth call
  end
end

Parameters:

options (Hash, Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(self)

# File 'lib/google/apis/core/base_service.rb', line 168

def batch(options = nil)
  batch_command = BatchCommand.new(:post, Addressable::URI.parse(root_url + batch_path))
  batch_command.options = request_options.merge(options)
  apply_command_defaults(batch_command)
  begin
    start_batch(batch_command)
    yield self
  ensure
    end_batch
  end
  batch_command.execute(client)
end

#batch_upload(options = nil) {|self| ... }

This method returns an undefined value.

Perform a batch upload request. Calls made within the block are sent in a single network request to the server. Batch uploads are useful for uploading multiple small files. For larger files, use single requests which use a resumable upload protocol.

Examples:

service.batch do |s|
  s.insert_item(upload_source: 'file1.txt') do |res, err|
    # process response for 1st call
  end
  # ...
  s.insert_item(upload_source: 'fileN.txt') do |res, err|
    # process response for Nth call
  end
end

Parameters:

options (Hash, Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(self)

# File 'lib/google/apis/core/base_service.rb', line 200

def batch_upload(options = nil)
  batch_command = BatchUploadCommand.new(:put, Addressable::URI.parse(root_url + upload_path))
  batch_command.options = request_options.merge(options)
  apply_command_defaults(batch_command)
  begin
    start_batch(batch_command)
    yield self
  ensure
    end_batch
  end
  batch_command.execute(client)
end

#fetch_all(max: nil, items: :items, cache: true, response_page_token: :next_page_token) {|token, service| ... } ⇒ `Enumerble`

Executes a given query with paging, automatically retrieving additional pages as necessary. Requires a block that returns the result set of a page. The current page token is supplied as an argument to the block.

Note: The returned enumerable also contains a last_result field containing the full result of the last query executed.

Examples:

Retrieve all files,

file_list = service.fetch_all { |token, s| s.list_files(page_token: token) }
file_list.each { |f| ... }

Parameters:

max (Fixnum) —
Maximum number of items to iterate over. Defaults to nil -- no upper bound.
items (Symbol) —
Name of the field in the result containing the items. Defaults to :items
cache (Boolean) —
True (default) if results should be cached so multiple iterations can be used.

Yields:

(token, service) —
Current page token & service instance

Yield Parameters:

token (String) —
Current page token to be used in the query

Returns:

(Enumerble)

Since:

0.9.4

# File 'lib/google/apis/core/base_service.rb', line 281

def fetch_all(max: nil, items: :items, cache: true, response_page_token: :next_page_token, &block)
  fail "fetch_all may not be used inside a batch" if batch?
  return PagedResults.new(self, max: max, items: items, cache: cache, response_page_token: response_page_token, &block)
end

#http(method, url, params: nil, body: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `String`

Simple escape hatch for making API requests directly to a given URL. This is not intended to be used as a generic HTTP client and should be used only in cases where no service method exists (e.g. fetching an export link for a Google Drive file.)

Parameters:

method (Symbol) —
HTTP method as symbol (e.g. :get, :post, :put, ...)
url (String) —
URL to call
params (Hash<String,String>) —
Optional hash of query parameters
body (#read) —
Optional body for POST/PUT
download_dest (IO, String) —
IO stream or filename to receive content download
options (Google::Apis::RequestOptions) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (String) —
HTTP response body
err (StandardError) —
error object if request failed

Returns:

(String) —
HTTP response body

# File 'lib/google/apis/core/base_service.rb', line 243

def http(method, url, params: nil, body: nil, download_dest: nil, options: nil, &block)
  if download_dest
    command = DownloadCommand.new(method, url, body: body)
  else
    command = HttpCommand.new(method, url, body: body)
  end
  command.options = request_options.merge(options)
  apply_command_defaults(command)
  command.query.merge(Hash(params))
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::Core::BaseService

Overview

Direct Known Subclasses

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

Constructor Details

#initialize(root_url, base_path) ⇒ BaseService

Instance Attribute Details

#authorization ⇒ Signet::OAuth2::Client

#base_path ⇒ Addressable::URI

#batch_path ⇒ Addressable::URI

#client ⇒ HTTPClient

#client_options ⇒ Google::Apis::ClientOptions

#request_options ⇒ Google::Apis::RequestOptions

#root_url ⇒ Addressable::URI

#upload_path ⇒ Addressable::URI

Instance Method Details

#batch(options = nil) {|self| ... }

#batch_upload(options = nil) {|self| ... }

#fetch_all(max: nil, items: :items, cache: true, response_page_token: :next_page_token) {|token, service| ... } ⇒ Enumerble

#http(method, url, params: nil, body: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ String

#initialize(root_url, base_path) ⇒ `BaseService`

#authorization ⇒ `Signet::OAuth2::Client`

#base_path ⇒ `Addressable::URI`

#batch_path ⇒ `Addressable::URI`

#client ⇒ `HTTPClient`

#client_options ⇒ `Google::Apis::ClientOptions`

#request_options ⇒ `Google::Apis::RequestOptions`

#root_url ⇒ `Addressable::URI`

#upload_path ⇒ `Addressable::URI`

#fetch_all(max: nil, items: :items, cache: true, response_page_token: :next_page_token) {|token, service| ... } ⇒ `Enumerble`

#http(method, url, params: nil, body: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `String`