Module: Fog::Google::Shared

Included in:
Compute::Google::Mock, Compute::Google::Real, DNS::Google::Mock, DNS::Google::Real, Monitoring::Mock, Monitoring::Real, Pubsub::Mock, Pubsub::Real, Fog::Google::SQL::Mock, Fog::Google::SQL::Real, Storage::GoogleJSON::Mock, Storage::GoogleJSON::Real
Defined in:
lib/fog/google/shared.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_url ⇒ Object (readonly)

Returns the value of attribute api_url.



4
5
6
 
# File 'lib/fog/google/shared.rb', line 4

def api_url
  @api_url
end

#api_version ⇒ Object (readonly)

Returns the value of attribute api_version.



4
5
6
 
# File 'lib/fog/google/shared.rb', line 4

def api_version
  @api_version
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



4
5
6
 
# File 'lib/fog/google/shared.rb', line 4

def project
  @project
end

Instance Method Details

#build_excon_response(body, status = 200) ⇒ Excon::Response

Builds an Excon response

Parameters:

  • Response (Hash) —

    body

  • Response (Integer) —

    status

Returns:

  • (Excon::Response) —

    Excon response



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/fog/google/shared.rb', line 168

def build_excon_response(body, status = 200)
  response = Excon::Response.new(:body => body, :status => status)
  if body && body.key?("error")
    msg = "Google Cloud did not return an error message"

    if body["error"].is_a?(Hash)
      response.status = body["error"]["code"]
      if body["error"].key?("errors")
        msg = body["error"]["errors"].map { |error| error["message"] }.join(", ")
      elsif body["error"].key?("message")
        msg = body["error"]["message"]
      end
    elsif body["error"].is_a?(Array)
      msg = body["error"].map { |error| error["code"] }.join(", ")
    end

    case response.status
    when 404
      raise Fog::Errors::NotFound.new(msg)
    else
      raise Fog::Errors::Error.new(msg)
    end
  end

  response
end

#create_signing_key(options) ⇒ Object

Creates a Google signing key



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/fog/google/shared.rb', line 74

def create_signing_key(options)
  if options[:google_json_key_location] || options[:google_json_key_string]
    if options[:google_json_key_location]
      json_key_location = File.expand_path(options[:google_json_key_location])
      json_key = File.open(json_key_location, "r", &:read)
    else
      json_key = options[:google_json_key_string]
    end

    json_key_hash = Fog::JSON.decode(json_key)
    unless json_key_hash.key?("client_email") || json_key_hash.key?("private_key")
      raise ArgumentError.new("Invalid Google JSON key")
    end

    options[:google_client_email] = json_key_hash["client_email"]
    ::Google::APIClient::KeyUtils.load_from_pem(json_key_hash["private_key"], "notasecret")
  elsif options[:google_key_location] || options[:google_key_string]
    google_key =
      if options[:google_key_location]
        File.expand_path(options[:google_key_location])
      else
        options[:google_key_string]
      end

    ::Google::APIClient::KeyUtils.load_from_pkcs12(google_key, "notasecret")
  else
    raise ArgumentError.new("Missing required arguments: google_key_location, google_key_string, " \
                            "google_json_key_location or google_json_key_string")
  end
end

#initialize_google_client(options) ⇒ Google::APIClient

Initializes the Google API Client

Parameters:

  • options (Hash) —

    Google API options

Options Hash (options):

  • :google_client_email (String) —

    A @developer.gserviceaccount.com email address to use

  • :google_key_location (String) —

    The location of a pkcs12 key file

  • :google_key_string (String) —

    The content of the pkcs12 key file

  • :google_json_key_location (String) —

    The location of a JSON key file

  • :google_json_key_string (String) —

    The content of the JSON key file

  • :google_api_scope_url (String) —

    The access scope URLs

  • :app_name (String) —

    The app name to set in the user agent

  • :app_version (String) —

    The app version to set in the user agent

  • :google_client (Google::APIClient) —

    Existing Google API Client

  • :google_client_options (Hash) —

    A hash to send adition options to Google API Client

Returns:

  • (Google::APIClient) —

    Google API Client



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fog/google/shared.rb', line 35

def initialize_google_client(options)
  # NOTE: loaded here to avoid requiring this as a core Fog dependency
  begin
    require "google/api_client"
  rescue LoadError => error
    Fog::Logger.warning("Please install the google-api-client gem before using this provider")
    raise error
  end

  # User can provide an existing Google API Client
  client = options[:google_client]
  return client unless client.nil?

  # Create a signing key
  signing_key = create_signing_key(options)

  # Validate required arguments
  unless options[:google_client_email]
    raise ArgumentError.new("Missing required arguments: google_client_email")
  end

  unless options[:google_api_scope_url]
    raise ArgumentError.new("Missing required arguments: google_api_scope_url")
  end

  # Create a new Google API Client
  new_pk12_google_client(
    options[:google_client_email],
    signing_key,
    options[:google_api_scope_url],
    options[:app_name],
    options[:app_version],
    options[:google_client_options] || {}
  )
end

#new_pk12_google_client(google_client_email, signing_key, google_api_scope_url, app_name = nil, app_version = nil, google_client_options = {}) ⇒ Google::APIClient

Create a Google API Client with a user email and a pkcs12 key

Parameters:

  • google_client_email (String) —

    A @developer.gserviceaccount.com. email address to use

  • signing_key (OpenSSL::PKey) —

    The private key for signing

  • google_api_scope_url (String) —

    Access scope URLs

  • app_name (String) (defaults to: nil) —

    The app name to set in the user agent

  • app_version (String) (defaults to: nil) —

    The app version to set in the user agent

  • google_client_options (Hash) (defaults to: {}) —

    additional options to pass to the underlying google client

Returns:

  • (Google::APIClient) —

    a newly-constructed Google API Client



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/fog/google/shared.rb', line 117

def new_pk12_google_client(google_client_email, signing_key, google_api_scope_url, app_name = nil, app_version = nil, google_client_options = {})
  application_name = app_name.nil? ? "fog" : "#{app_name}/#{app_version || '0.0.0'} fog"
  api_client_options = {
    :application_name => application_name,
    :application_version => Fog::Google::VERSION
  }.merge(google_client_options)
  client = ::Google::APIClient.new(api_client_options)

  client.authorization = Signet::OAuth2::Client.new(
    :audience => "https://accounts.google.com/o/oauth2/token",
    :auth_provider_x509_cert_url => "https://www.googleapis.com/oauth2/v1/certs",
    :client_x509_cert_url => "https://www.googleapis.com/robot/v1/metadata/x509/#{google_client_email}",
    :issuer => google_client_email,
    :scope => google_api_scope_url,
    :signing_key => signing_key,
    :token_credential_uri => "https://accounts.google.com/o/oauth2/token"
  )
  client.authorization.fetch_access_token!

  client
end

#request(api_method, parameters, body_object = nil, media = nil) ⇒ Excon::Response

Executes a request and wraps it in a result object

Parameters:

  • api_method (Google::APIClient::Method) —

    The method object or the RPC name of the method being executed

  • parameters (Hash) —

    The parameters to send to the method

  • body_object (Hash) (defaults to: nil) —

    The body object of the request

Returns:

  • (Excon::Response) —

    The result from the API



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/fog/google/shared.rb', line 146

def request(api_method, parameters, body_object = nil, media = nil)
  client_parms = {
    :api_method => api_method,
    :parameters => parameters
  }
  # The Google API complains when given null values for enums, so just don't pass it any null fields
  # XXX It may still balk if we have a nested object, e.g.:
  #   {:a_field => "string", :a_nested_field => { :an_empty_nested_field => nil } }
  client_parms[:body_object] = body_object.reject { |_k, v| v.nil? } if body_object
  client_parms[:media] = media if media

  result = @client.execute(client_parms)

  build_excon_response(result.body.nil? || result.body.empty? ? nil : Fog::JSON.decode(result.body), result.status)
end

#shared_initialize(project, api_version, base_url) ⇒ void

This method returns an undefined value.

Initializes shared attributes

Parameters:

  • project (String) —

    Google Cloud Project

  • api_version (String) —

    Google API version

  • base_url (String) —

    Google API base url



13
14
15
16
17
 
# File 'lib/fog/google/shared.rb', line 13

def shared_initialize(project, api_version, base_url)
  @project = project
  @api_version = api_version
  @api_url = base_url + api_version + "/projects/"
end