split storages in own adapter classes, added redis adapter
authorVolker Zöpfel <volker@zoepfel.de>
Thu, 14 Nov 2013 14:50:06 +0000 (15:50 +0100)
committerVolker Zöpfel <volker@zoepfel.de>
Thu, 14 Nov 2013 14:50:06 +0000 (15:50 +0100)
google-api-client.gemspec
lib/google/api_client/auth/storage.rb [moved from lib/google/api_client/auth/file_storage.rb with 73% similarity]
lib/google/api_client/auth/storages/file_store.rb [new file with mode: 0644]
lib/google/api_client/auth/storages/redis_store.rb [new file with mode: 0644]

index 6b91979a958e97f9aed11ca778cbe0adc88e6013..00489b92a111459430dc4c4033b0843ba70266b0 100644 (file)
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.email = "sbazyl@google.com"
   s.executables = ["google-api"]
   s.extra_rdoc_files = ["README.md"]
-  s.files = ["lib/cacerts.pem", "lib/compat", "lib/compat/multi_json.rb", "lib/google", "lib/google/api_client", "lib/google/api_client.rb", "lib/google/api_client/auth", "lib/google/api_client/auth/compute_service_account.rb", "lib/google/api_client/auth/file_storage.rb", "lib/google/api_client/auth/installed_app.rb", "lib/google/api_client/auth/jwt_asserter.rb", "lib/google/api_client/auth/key_utils.rb", "lib/google/api_client/auth/pkcs12.rb", "lib/google/api_client/batch.rb", "lib/google/api_client/client_secrets.rb", "lib/google/api_client/discovery", "lib/google/api_client/discovery.rb", "lib/google/api_client/discovery/api.rb", "lib/google/api_client/discovery/media.rb", "lib/google/api_client/discovery/method.rb", "lib/google/api_client/discovery/resource.rb", "lib/google/api_client/discovery/schema.rb", "lib/google/api_client/environment.rb", "lib/google/api_client/errors.rb", "lib/google/api_client/gzip.rb", "lib/google/api_client/logging.rb", "lib/google/api_client/media.rb", "lib/google/api_client/railtie.rb", "lib/google/api_client/reference.rb", "lib/google/api_client/request.rb", "lib/google/api_client/result.rb", "lib/google/api_client/service_account.rb", "lib/google/api_client/version.rb", "lib/google/inflection.rb", "spec/fixtures", "spec/fixtures/files", "spec/fixtures/files/privatekey.p12", "spec/fixtures/files/sample.txt", "spec/fixtures/files/secret.pem", "spec/google", "spec/google/api_client", "spec/google/api_client/batch_spec.rb", "spec/google/api_client/discovery_spec.rb", "spec/google/api_client/gzip_spec.rb", "spec/google/api_client/media_spec.rb", "spec/google/api_client/request_spec.rb", "spec/google/api_client/result_spec.rb", "spec/google/api_client/service_account_spec.rb", "spec/google/api_client_spec.rb", "spec/spec_helper.rb", "tasks/gem.rake", "tasks/git.rake", "tasks/metrics.rake", "tasks/spec.rake", "tasks/wiki.rake", "tasks/yard.rake", "CHANGELOG.md", "CONTRIBUTING.md", "Gemfile", "LICENSE", "README.md", "Rakefile", "bin/google-api"]
+  s.files = ["lib/cacerts.pem", "lib/compat", "lib/compat/multi_json.rb", "lib/google", "lib/google/api_client", "lib/google/api_client.rb", "lib/google/api_client/auth", "lib/google/api_client/auth/compute_service_account.rb", "lib/google/api_client/auth/storage.rb", "lib/google/api_client/auth/storages/*.rb", "lib/google/api_client/auth/installed_app.rb", "lib/google/api_client/auth/jwt_asserter.rb", "lib/google/api_client/auth/key_utils.rb", "lib/google/api_client/auth/pkcs12.rb", "lib/google/api_client/batch.rb", "lib/google/api_client/client_secrets.rb", "lib/google/api_client/discovery", "lib/google/api_client/discovery.rb", "lib/google/api_client/discovery/api.rb", "lib/google/api_client/discovery/media.rb", "lib/google/api_client/discovery/method.rb", "lib/google/api_client/discovery/resource.rb", "lib/google/api_client/discovery/schema.rb", "lib/google/api_client/environment.rb", "lib/google/api_client/errors.rb", "lib/google/api_client/gzip.rb", "lib/google/api_client/logging.rb", "lib/google/api_client/media.rb", "lib/google/api_client/railtie.rb", "lib/google/api_client/reference.rb", "lib/google/api_client/request.rb", "lib/google/api_client/result.rb", "lib/google/api_client/service_account.rb", "lib/google/api_client/version.rb", "lib/google/inflection.rb", "spec/fixtures", "spec/fixtures/files", "spec/fixtures/files/privatekey.p12", "spec/fixtures/files/sample.txt", "spec/fixtures/files/secret.pem", "spec/google", "spec/google/api_client", "spec/google/api_client/batch_spec.rb", "spec/google/api_client/discovery_spec.rb", "spec/google/api_client/gzip_spec.rb", "spec/google/api_client/media_spec.rb", "spec/google/api_client/request_spec.rb", "spec/google/api_client/result_spec.rb", "spec/google/api_client/service_account_spec.rb", "spec/google/api_client_spec.rb", "spec/spec_helper.rb", "tasks/gem.rake", "tasks/git.rake", "tasks/metrics.rake", "tasks/spec.rake", "tasks/wiki.rake", "tasks/yard.rake", "CHANGELOG.md", "CONTRIBUTING.md", "Gemfile", "LICENSE", "README.md", "Rakefile", "bin/google-api"]
   s.homepage = "http://code.google.com/p/google-api-ruby-client/"
   s.licenses = ["Apache 2.0"]
   s.rdoc_options = ["--main", "README.md"]
similarity index 73%
rename from lib/google/api_client/auth/file_storage.rb
rename to lib/google/api_client/auth/storage.rb
index 880259dd16418e694b8ff04d75d63e9b9678207d..2fa18eab8d634c31d78379b5c53d974a6fd3f1ab 100644 (file)
@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'json'
 require 'signet/oauth_2/client'
 
 module Google
@@ -22,34 +21,31 @@ module Google
     # JSON serialized file. Meant to resemble the serialized format
     # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
     #
-    class FileStorage
+    class Storage
 
       AUTHORIZATION_URI = 'https://accounts.google.com/o/oauth2/auth'
       TOKEN_CREDENTIAL_URI = 'https://accounts.google.com/o/oauth2/token'
 
-      # @return [String] Path to the credentials file.
-      attr_accessor :path
+      # @return [Object] Storage object.
+      attr_accessor :store
 
-      # @return [Signet::OAuth2::Client] Path to the credentials file.
+
+      # @return [Signet::OAuth2::Client]
       attr_reader :authorization
 
       ##
-      # Initializes the FileStorage object.
+      # Initializes the Storage object.
       #
-      # @param [String] path
-      #    Path to the credentials file.
-      def initialize(path)
-        @path= path
+      # @params [Object] Storage object
+      def initialize(store)
+        @store= store
         self.authorize
       end
 
       ##
-      # Attempt to read in credentials from the specified file.
+      # Attempt to read in credentials from the specified store.
       def load_credentials
-        if File.exists?(@path) && File.readable?(@path) && File.writable?(@path)
-          credentials = File.open(path, 'r') { |f| JSON.parse(f.read) }
-        end
-        credentials
+        store.load_credentials
       end
 
       def authorize
@@ -62,12 +58,14 @@ module Google
       end
 
       ##
-      # refresh credentials and save them to file
+      # refresh credentials and save them to store
       def refresh_authorization
         @authorization.refresh!
-        self.write_credentials(@authorization)
+        self.write_credentials
       end
 
+      ##
+      # @return [Hash] with credentials
       def credentials_hash
         {
           :access_token          => @authorization.access_token,
@@ -82,17 +80,15 @@ module Google
       end
 
       ##
-      # Write the credentials to the specified file.
+      # Write the credentials to the specified store.
       #
-      # @param [Signet::OAuth2::Client] authorization
+      # @params [Signet::OAuth2::Client] authorization
       #    Optional authorization instance. If not provided, the authorization
       #    already associated with this instance will be written.
       def write_credentials(authorization=nil)
         @authorization = authorization if authorization
         if @authorization.refresh_token
-          File.open(self.path, 'w') do |file|
-            file.write(credentials_hash.to_json)
-          end
+          store.write_credentials(credentials_hash)
         end
       end
     end
diff --git a/lib/google/api_client/auth/storages/file_store.rb b/lib/google/api_client/auth/storages/file_store.rb
new file mode 100644 (file)
index 0000000..1b8ad4a
--- /dev/null
@@ -0,0 +1,59 @@
+# Copyright 2013 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 'json'
+
+module Google
+  class APIClient
+    ##
+    # Represents cached OAuth 2 tokens stored on local disk in a
+    # JSON serialized file. Meant to resemble the serialized format
+    # http://google-api-python-client.googlecode.com/hg/docs/epy/oauth2client.file.Storage-class.html
+    #
+    class FileStore
+
+      attr_accessor :path
+
+      ##
+      # Initializes the FileStorage object.
+      #
+      # @param [String] path
+      #    Path to the credentials file.
+      def initialize(path)
+        @path= path
+      end
+
+      ##
+      # Attempt to read in credentials from the specified file.
+      def load_credentials
+        if File.exists?(path) && File.readable?(path) && File.writable?(path)
+          credentials = File.open(path, 'r') { |f| JSON.parse(f.read) }
+        end
+        credentials
+      end
+
+      ##
+      # Write the credentials to the specified file.
+      #
+      # @param [Signet::OAuth2::Client] authorization
+      #    Optional authorization instance. If not provided, the authorization
+      #    already associated with this instance will be written.
+      def write_credentials(credentials_hash)
+        File.open(self.path, 'w') do |file|
+          file.write(credentials_hash.to_json)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/google/api_client/auth/storages/redis_store.rb b/lib/google/api_client/auth/storages/redis_store.rb
new file mode 100644 (file)
index 0000000..715ab5d
--- /dev/null
@@ -0,0 +1,51 @@
+# Copyright 2013 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 'json'
+
+module Google
+  class APIClient
+    class RedisStore
+
+      attr_accessor :redis
+
+      ##
+      # Initializes the RedisStore object.
+      #
+      # @params [Object] Redis instance
+      def initialize(redis)
+        @redis= redis
+      end
+
+      ##
+      # Attempt to read in credentials from redis.
+      def load_credentials
+        credentials = redis.get redis_credentials_key
+        JSON.parse(credentials) if credentials
+      end
+
+      def redis_credentials_key
+        "google_api_credentials"
+      end
+
+      ##
+      # Write the credentials to redis.
+      #
+      # @params [Hash] credentials
+      def write_credentials(credentials_hash)
+        redis.set(redis_credentials_key, credentials_hash.to_json)
+      end
+    end
+  end
+end