Resolve merge conflict, update rspec syntax and docs
[arvados.git] / lib / google / api_client / auth / storages / redis_store.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 'json'
16
17 module Google
18   class APIClient
19     class RedisStore
20
21       DEFAULT_REDIS_CREDENTIALS_KEY = "google_api_credentials"
22
23       attr_accessor :redis
24
25       ##
26       # Initializes the RedisStore object.
27       #
28       # @params [Object] Redis instance
29       def initialize(redis, key = nil)
30         @redis= redis
31         @redis_credentials_key = key
32       end
33
34       ##
35       # Attempt to read in credentials from redis.
36       def load_credentials
37         credentials = redis.get redis_credentials_key
38         JSON.parse(credentials) if credentials
39       end
40
41       def redis_credentials_key
42         @redis_credentials_key || DEFAULT_REDIS_CREDENTIALS_KEY
43       end
44
45       ##
46       # Write the credentials to redis.
47       #
48       # @params [Hash] credentials
49       def write_credentials(credentials_hash)
50         redis.set(redis_credentials_key, credentials_hash.to_json)
51       end
52     end
53   end
54 end