Class: Google::APIClient::ClientSecrets Deprecated

Inherits:
Object
  • Object
show all
Defined in:
lib/google/api_client/client_secrets.rb

Overview

Deprecated.

Use google-auth-library-ruby instead

Manages the persistence of client configuration data and secrets. Format inspired by the Google API Python client.

Examples:

{
  "web": {
    "client_id": "asdfjasdljfasdkjf",
    "client_secret": "1912308409123890",
    "redirect_uris": ["https://www.example.com/oauth2callback"],
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://accounts.google.com/o/oauth2/token"
  }
}
{
  "installed": {
    "client_id": "837647042410-75ifg...usercontent.com",
    "client_secret":"asdlkfjaskd",
    "redirect_uris": ["http://localhost", "urn:ietf:oauth:2.0:oob"],
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://accounts.google.com/o/oauth2/token"
  }
}

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ClientSecrets

Initialize OAuth client settings.

Parameters:

  • options (Hash) (defaults to: {})

    Parsed client secrets files


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/google/api_client/client_secrets.rb', line 82

def initialize(options={})
  # Client auth configuration
  @flow = options[:flow] || options.keys.first.to_s || 'web'
  fdata = options[@flow.to_sym] || options[@flow]
  @client_id = fdata[:client_id] || fdata["client_id"]
  @client_secret = fdata[:client_secret] || fdata["client_secret"]
  @redirect_uris = fdata[:redirect_uris] || fdata["redirect_uris"]
  @redirect_uris ||= [fdata[:redirect_uri] || fdata["redirect_uri"]].compact
  @javascript_origins = (
    fdata[:javascript_origins] ||
    fdata["javascript_origins"]
  )
  @javascript_origins ||= [fdata[:javascript_origin] || fdata["javascript_origin"]].compact
  @authorization_uri = fdata[:auth_uri] || fdata["auth_uri"]
  @authorization_uri ||= fdata[:authorization_uri]
  @token_credential_uri = fdata[:token_uri] || fdata["token_uri"]
  @token_credential_uri ||= fdata[:token_credential_uri]

  # Associated token info
  @access_token = fdata[:access_token] || fdata["access_token"]
  @refresh_token = fdata[:refresh_token] || fdata["refresh_token"]
  @id_token = fdata[:id_token] || fdata["id_token"]
  @expires_in = fdata[:expires_in] || fdata["expires_in"]
  @expires_at = fdata[:expires_at] || fdata["expires_at"]
  @issued_at = fdata[:issued_at] || fdata["issued_at"]
end

Instance Attribute Details

#access_tokenObject (readonly)

Returns the value of attribute access_token


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def access_token
  @access_token
end

#authorization_uriObject (readonly)

Returns the value of attribute authorization_uri


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def authorization_uri
  @authorization_uri
end

#client_idObject (readonly)

Returns the value of attribute client_id


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def client_id
  @client_id
end

#client_secretObject (readonly)

Returns the value of attribute client_secret


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def client_secret
  @client_secret
end

#expires_atObject (readonly)

Returns the value of attribute expires_at


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def expires_at
  @expires_at
end

#expires_inObject (readonly)

Returns the value of attribute expires_in


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def expires_in
  @expires_in
end

#flowObject (readonly)

Returns the value of attribute flow


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def flow
  @flow
end

#id_tokenObject (readonly)

Returns the value of attribute id_token


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def id_token
  @id_token
end

#issued_atObject (readonly)

Returns the value of attribute issued_at


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def issued_at
  @issued_at
end

#javascript_originsObject (readonly)

Returns the value of attribute javascript_origins


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def javascript_origins
  @javascript_origins
end

#redirect_urisObject (readonly)

Returns the value of attribute redirect_uris


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def redirect_uris
  @redirect_uris
end

#refresh_tokenObject (readonly)

Returns the value of attribute refresh_token


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def refresh_token
  @refresh_token
end

#token_credential_uriObject (readonly)

Returns the value of attribute token_credential_uri


109
110
111
# File 'lib/google/api_client/client_secrets.rb', line 109

def token_credential_uri
  @token_credential_uri
end

Class Method Details

.load(filename = nil) ⇒ Google::APIClient::ClientSecrets

Reads client configuration from a file

Parameters:

  • filename (String) (defaults to: nil)

    Path to file to load

Returns:


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/google/api_client/client_secrets.rb', line 56

def self.load(filename=nil)
  if filename && File.directory?(filename)
    search_path = File.expand_path(filename)
    filename = nil
  end
  while filename == nil
    search_path ||= File.expand_path('.')
    if File.exists?(File.join(search_path, 'client_secrets.json'))
      filename = File.join(search_path, 'client_secrets.json')
    elsif search_path == '/' || search_path =~ /[a-zA-Z]:[\/\\]/
      raise ArgumentError,
        'No client_secrets.json filename supplied ' +
        'and/or could not be found in search path.'
    else
      search_path = File.expand_path(File.join(search_path, '..'))
    end
  end
  data = File.open(filename, 'r') { |file| JSON.load(file.read) }
  return self.new(data)
end

Instance Method Details

#to_authorizationObject


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/google/api_client/client_secrets.rb', line 149

def to_authorization
  gem 'signet', '>= 0.4.0'
  require 'signet/oauth_2/client'
  # NOTE: Do not rely on this default value, as it may change
  new_authorization = Signet::OAuth2::Client.new
  new_authorization.client_id = self.client_id
  new_authorization.client_secret = self.client_secret
  new_authorization.authorization_uri = (
    self.authorization_uri ||
    'https://accounts.google.com/o/oauth2/auth'
  )
  new_authorization.token_credential_uri = (
    self.token_credential_uri ||
    'https://accounts.google.com/o/oauth2/token'
  )
  new_authorization.redirect_uri = self.redirect_uris.first

  # These are supported, but unlikely.
  new_authorization.access_token = self.access_token
  new_authorization.refresh_token = self.refresh_token
  new_authorization.id_token = self.id_token
  new_authorization.expires_in = self.expires_in
  new_authorization.issued_at = self.issued_at if self.issued_at
  new_authorization.expires_at = self.expires_at if self.expires_at
  return new_authorization
end

#to_hashObject


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/google/api_client/client_secrets.rb', line 124

def to_hash
  {
    self.flow => ({
      'client_id' => self.client_id,
      'client_secret' => self.client_secret,
      'redirect_uris' => self.redirect_uris,
      'javascript_origins' => self.javascript_origins,
      'auth_uri' => self.authorization_uri,
      'token_uri' => self.token_credential_uri,
      'access_token' => self.access_token,
      'refresh_token' => self.refresh_token,
      'id_token' => self.id_token,
      'expires_in' => self.expires_in,
      'expires_at' => self.expires_at,
      'issued_at' => self.issued_at
    }).inject({}) do |accu, (k, v)|
      # Prunes empty values from JSON output.
      unless v == nil || (v.respond_to?(:empty?) && v.empty?)
        accu[k] = v
      end
      accu
    end
  }
end

#to_jsonString

Serialize back to the original JSON form

Returns:

  • (String)

    JSON


120
121
122
# File 'lib/google/api_client/client_secrets.rb', line 120

def to_json
  return Json.dump(to_hash)
end