rename file_store
[arvados.git] / 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     # DEPRECATED WARNING
24     # This class is deprecated use Storage and FileStore as
25     # mentioned in the samples
26     #
27     # Represents cached OAuth 2 tokens stored on local disk in a
28     # JSON serialized file. Meant to resemble the serialized format
29     # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
30     #
31     class FileStorage
32
33       attr_accessor :storage,
34                     :path
35
36       def initialize(path)
37         @path = path
38         store = Google::APIClient::FileStore.new(@path)
39         @storage = Google::APIClient::Storage.new(store)
40       end
41
42       def authorization
43         storage.authorization
44       end
45
46       ##
47       # Write the credentials to the specified file.
48       #
49       # @param [Signet::OAuth2::Client] authorization
50       #    Optional authorization instance. If not provided, the authorization
51       #    already associated with this instance will be written.
52       def write_credentials(auth=nil)
53         self.authorization = auth unless auth.nil?
54         storage.write_credentials(self.authorization)
55       end
56     end
57   end
58 end