Merge commit '3b735dd9330e0989f51a76771c3303031154154e' into 21158-wf-page-list
[arvados.git] / sdk / ruby-google-api-client / lib / google / api_client / auth / file_storage.rb
1 # Copyright 2013 Google Inc.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #      http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 require 'signet/oauth_2/client'
16 require_relative 'storage'
17 require_relative 'storages/file_store'
18
19 module Google
20   class APIClient
21
22     ##
23     # Represents cached OAuth 2 tokens stored on local disk in a
24     # JSON serialized file. Meant to resemble the serialized format
25     # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
26     #
27     # @deprecated
28     #  Use {Google::APIClient::Storage} and {Google::APIClient::FileStore} instead
29     #
30     class FileStorage
31
32       attr_accessor :storage
33
34       def initialize(path)
35         store = Google::APIClient::FileStore.new(path)
36         @storage = Google::APIClient::Storage.new(store)
37         @storage.authorize
38       end
39
40       def load_credentials
41         storage.authorize
42       end
43
44       def authorization
45         storage.authorization
46       end
47
48       ##
49       # Write the credentials to the specified file.
50       #
51       # @param [Signet::OAuth2::Client] authorization
52       #    Optional authorization instance. If not provided, the authorization
53       #    already associated with this instance will be written.
54       def write_credentials(auth=nil)
55         storage.write_credentials(auth)
56       end
57     end
58   end
59 end