Fixed some YARD documentation issues and changed how the user-agent is built.
This commit is contained in:
parent
6205c8e67c
commit
321533455c
|
@ -24,6 +24,7 @@ require 'google/api_client/discovery'
|
|||
require 'google/api_client/reference'
|
||||
require 'google/api_client/result'
|
||||
|
||||
|
||||
module Google
|
||||
# TODO(bobaman): Document all this stuff.
|
||||
|
||||
|
@ -47,8 +48,9 @@ module Google
|
|||
# @option options [String] :host ("www.googleapis.com")
|
||||
# The API hostname used by the client. This rarely needs to be changed.
|
||||
# @option options [String] :application_name
|
||||
# The name and version of the application using the client. This should
|
||||
# be given in the form `"{name}/{version}"`.
|
||||
# The name of the application using the client.
|
||||
# @option options [String] :application_version
|
||||
# The version number of the application using the client.
|
||||
# @option options [String] :user_agent
|
||||
# ("{app_name} google-api-ruby-client/{version} {os_name}/{os_version}")
|
||||
# The user agent used by the client. Most developers will want to
|
||||
|
@ -63,10 +65,16 @@ module Google
|
|||
self.host = options["host"] || 'www.googleapis.com'
|
||||
# Most developers will want to leave this value alone and use the
|
||||
# application_name option.
|
||||
application_string = (
|
||||
options["application_name"] ? (
|
||||
"#{options["application_name"]}/" +
|
||||
"#{options["application_version"] || '0.0.0'}"
|
||||
) : ""
|
||||
)
|
||||
self.user_agent = options["user_agent"] || (
|
||||
(options["application_name"] || '')
|
||||
'google-api-ruby-client/' + VERSION::STRING +
|
||||
' ' + ENV::OS_VERSION
|
||||
"#{application_string} " +
|
||||
"google-api-ruby-client/#{VERSION::STRING} " +
|
||||
ENV::OS_VERSION
|
||||
).strip
|
||||
# The writer method understands a few Symbols and will generate useful
|
||||
# default authentication mechanisms.
|
||||
|
@ -148,7 +156,7 @@ module Google
|
|||
##
|
||||
# The application's API key issued by the API console.
|
||||
#
|
||||
# @return [String] The API key..
|
||||
# @return [String] The API key.
|
||||
attr_accessor :key
|
||||
|
||||
##
|
||||
|
|
|
@ -19,6 +19,7 @@ require 'google/inflection'
|
|||
require 'google/api_client/discovery/resource'
|
||||
require 'google/api_client/discovery/method'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
##
|
||||
|
|
|
@ -18,6 +18,7 @@ require 'addressable/template'
|
|||
|
||||
require 'google/api_client/errors'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
##
|
||||
|
|
|
@ -18,6 +18,7 @@ require 'addressable/uri'
|
|||
require 'google/inflection'
|
||||
require 'google/api_client/discovery/method'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
##
|
||||
|
|
|
@ -23,6 +23,7 @@ require 'addressable/template'
|
|||
require 'google/inflection'
|
||||
require 'google/api_client/errors'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module Schema
|
||||
|
|
|
@ -1,3 +1,18 @@
|
|||
# Copyright 2010 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.
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module ENV
|
||||
|
|
|
@ -15,6 +15,7 @@
|
|||
|
||||
require 'json'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module Parser
|
||||
|
|
|
@ -15,6 +15,7 @@
|
|||
|
||||
require 'google/api_client/parsers/json_parser'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module JSON
|
||||
|
|
|
@ -15,6 +15,7 @@
|
|||
|
||||
require 'google/api_client/parsers/json_parser'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module JSON
|
||||
|
|
|
@ -16,6 +16,7 @@
|
|||
require 'json'
|
||||
require 'google/api_client/parser'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
##
|
||||
|
|
|
@ -12,11 +12,13 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
require 'stringio'
|
||||
require 'json'
|
||||
require 'addressable/uri'
|
||||
require 'google/api_client/discovery'
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
class Reference
|
||||
|
|
|
@ -12,6 +12,7 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
##
|
||||
|
|
|
@ -15,6 +15,8 @@
|
|||
|
||||
# Used to prevent the class/module from being loaded more than once
|
||||
if !defined?(::Google::APIClient::VERSION)
|
||||
|
||||
|
||||
module Google
|
||||
class APIClient
|
||||
module VERSION
|
||||
|
|
Loading…
Reference in New Issue