1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
70
71
72
73
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
104
105
106
107
108
109
110
|
# Copyright 2014 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 "multi_json"
require "googleauth/credentials_loader"
require "googleauth/errors"
module Google
module Auth
##
# Representation of an application's identity for user authorization flows.
#
class ClientId
# Toplevel JSON key for the an installed app configuration.
# Must include client_id and client_secret subkeys if present.
INSTALLED_APP = "installed".freeze
# Toplevel JSON key for the a webapp configuration.
# Must include client_id and client_secret subkeys if present.
WEB_APP = "web".freeze
# JSON key for the client ID within an app configuration.
CLIENT_ID = "client_id".freeze
# JSON key for the client secret within an app configuration.
CLIENT_SECRET = "client_secret".freeze
# An error message raised when none of the expected toplevel properties
# can be found.
MISSING_TOP_LEVEL_ELEMENT_ERROR =
"Expected top level property 'installed' or 'web' to be present.".freeze
##
# Text identifier of the client ID
# @return [String]
#
attr_reader :id
##
# Secret associated with the client ID
# @return [String]
#
attr_reader :secret
class << self
attr_accessor :default
end
##
# Initialize the Client ID. Both id and secret must be non-nil.
#
# @param [String] id
# Text identifier of the client ID
# @param [String] secret
# Secret associated with the client ID
# @note Direct instantiation is discouraged to avoid embedding IDs
# and secrets in source. See {#from_file} to load from
# `client_secrets.json` files.
# @raise [Google::Auth::InitializationError] If id or secret is nil
#
def initialize id, secret
raise InitializationError, "Client id can not be nil" if id.nil?
raise InitializationError, "Client secret can not be nil" if secret.nil?
@id = id
@secret = secret
end
##
# Constructs a Client ID from a JSON file downloaded from the
# Google Developers Console.
#
# @param [String, File] file
# Path of file to read from
# @return [Google::Auth::ClientID]
# @raise [Google::Auth::InitializationError] If file is nil
#
def self.from_file file
raise InitializationError, "File can not be nil." if file.nil?
File.open file.to_s do |f|
json = f.read
config = MultiJson.load json
from_hash config
end
end
##
# Constructs a Client ID from a previously loaded JSON file. The hash
# structure should match the expected JSON format.
#
# @param [hash] config
# Parsed contents of the JSON file
# @return [Google::Auth::ClientID]
# @raise [Google::Auth::InitializationError] If config is nil or missing required elements
#
def self.from_hash config
raise InitializationError, "Hash can not be nil." if config.nil?
raw_detail = config[INSTALLED_APP] || config[WEB_APP]
raise InitializationError, MISSING_TOP_LEVEL_ELEMENT_ERROR if raw_detail.nil?
ClientId.new raw_detail[CLIENT_ID], raw_detail[CLIENT_SECRET]
end
end
end
end
|
