google-api 0.0.1.beta → 0.0.1.rc1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.1.rc1 (2012-09-20)
+
+* Add OAuth2 token encryption.
+
 ## v0.0.1.beta (2012-09-05)
 
 * Full test suite for all classes and modules.

data/README.md

@@ -32,7 +32,8 @@ This gem couldn't be easier to set up. Once you have a Client ID and Secret from
 ```ruby
 GoogleAPI.configure do |config|
   config.client_id = '[CLIENT ID]'
-  config.client_secret = '[Client SECRET]'
+  config.client_secret = '[CLIENT SECRET]'
+  config.encryption_key = '[ENCRYPTION KEY]'
 end
 ```
 
@@ -65,14 +66,14 @@ user.google.drive.files.list
 
 This will fetch all files and folders in the user's Google Drive and return them in an array of hashes.
 
-## What Google APIs can this gem be used for?
+## What Google APIs has this gem be tested against?
 
 * Calendar
 * Drive
 
-## I need to use an API that is not yet included
+## I need to use an API that is not yet tested
 
-Open an issue, and we will do our best to integrate and fully test the API you need. Or, you can submit a pull request with the necessary updates!
+Open an issue, and we will do our best to fully test the API you need. Or, you can submit a pull request with any necessary updates!
 
 ## Contributing
 

data/google-api.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "google-api"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.1.beta"
+  gem.version       = "0.0.1.rc1"
 
   gem.add_runtime_dependency 'mime-types', '~> 1.0'
   gem.add_runtime_dependency 'oauth2', '~> 0.8.0'

data/lib/google-api/active_record_inclusions.rb

@@ -14,14 +14,14 @@ module GoogleAPI
       def oauthable
         define_method :oauth_hash do
           {
-            access_token: oauth_access_token,
-            refresh_token: oauth_refresh_token,
+            access_token: GoogleAPI.decrypt!(oauth_access_token),
+            refresh_token: GoogleAPI.decrypt!(oauth_refresh_token),
             expires_at: oauth_access_token_expires_at
           }
         end
 
         define_method :update_access_token! do |access_token|
-          self.oauth_access_token = access_token
+          self.oauth_access_token = GoogleAPI.encrypt!(access_token)
           self.oauth_access_token_expires_at = 59.minutes.from_now
           self.save
         end

data/lib/google-api/api.rb

@@ -125,7 +125,7 @@ module GoogleAPI
             when 'query'
               query_params << "#{param}=#{options.delete(param)}" if options[param]
             end
-          end
+          end if api_method['parameters']
           url += "?#{query_params.join('&')}" if query_params.length > 0
         end
 

data/lib/google-api.rb

@@ -17,7 +17,7 @@ module GoogleAPI
   # https://github.com/sferik/twitter/blob/v3.6.0/lib/twitter/configurable.rb
   class << self
 
-    attr_accessor :client_id, :client_secret, :development_mode, :logger
+    attr_accessor :client_id, :client_secret, :encryption_key, :development_mode, :logger
 
     # Configuration options:
     #
@@ -26,7 +26,7 @@ module GoogleAPI
     def configure
       yield self
 
-      raise ArgumentError, "GoogleAPI requires both a :client_id and :client_secret configuration option to be set." unless [client_id, client_secret].all?
+      raise ArgumentError, "GoogleAPI requires both a :client_id and :client_secret configuration option to be set." unless [client_id, client_secret, encryption_key].all?
 
       @development_mode ||= false
       @logger ||= defined?(::Rails) ? Rails.logger : stdout_logger
@@ -56,6 +56,14 @@ module GoogleAPI
       @discovered_apis = {}
     end
 
+    def encrypt!(string)
+      Base64.encode64("#{string}#{encryption_key}")
+    end
+
+    def decrypt!(string)
+      Base64.decode64(string).sub(/#{Regexp.escape(encryption_key)}$/, '')
+    end
+
   end
 
 end

data/spec/google-api/api_spec.rb

@@ -20,6 +20,7 @@ describe GoogleAPI::API do
     GoogleAPI.configure do |config|
       config.client_id = 'test id'
       config.client_secret = 'test secret'
+      config.encryption_key = 'encryption key'
     end
     object.authenticated = true
   end

data/spec/google-api/client_spec.rb

@@ -8,6 +8,7 @@ describe GoogleAPI::Client do
     GoogleAPI.configure do |config|
       config.client_id = 'test id'
       config.client_secret = 'test secret'
+      config.encryption_key = 'encryption key'
     end
     object.authenticated = true
     client.client.connection = TEST_CONNECTION

data/spec/google-api_spec.rb

@@ -9,6 +9,7 @@ describe GoogleAPI do
         GoogleAPI.configure do |config|
           config.client_id = nil
           config.client_secret = 'test secret'
+          config.encryption_key = 'encryption key'
         end
       }.to raise_error(ArgumentError)
     end
@@ -18,15 +19,27 @@ describe GoogleAPI do
         GoogleAPI.configure do |config|
           config.client_id = 'test id'
           config.client_secret = nil
+          config.encryption_key = 'encryption key'
         end
       }.to raise_error(ArgumentError)
     end
 
-    it "should raise an error when both the CLIENT ID and SECRET are blank" do
+    it "should raise an error when the ENCRYPTION KEY is blank" do
+      expect {
+        GoogleAPI.configure do |config|
+          config.client_id = 'test id'
+          config.client_secret = 'test secret'
+          config.encryption_key = nil
+        end
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should raise an error when CLIENT ID, CLIENT SECRET, and ENCRYPTION KEY are blank" do
       expect {
         GoogleAPI.configure do |config|
           config.client_id = nil
           config.client_secret = nil
+          config.encryption_key = nil
         end
       }.to raise_error(ArgumentError)
     end
@@ -35,6 +48,7 @@ describe GoogleAPI do
       GoogleAPI.configure do |config|
         config.client_id = 'test id'
         config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
       end
 
       GoogleAPI.development_mode.should be_false
@@ -44,6 +58,7 @@ describe GoogleAPI do
       GoogleAPI.configure do |config|
         config.client_id = 'test id'
         config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
         config.development_mode = true
       end
 
@@ -59,6 +74,7 @@ describe GoogleAPI do
       GoogleAPI.configure do |config|
         config.client_id = 'test id'
         config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
       end
 
     end
@@ -69,6 +85,7 @@ describe GoogleAPI do
       GoogleAPI.configure do |config|
         config.client_id = 'test id'
         config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
       end
     end
 
@@ -99,4 +116,32 @@ describe GoogleAPI do
 
   end
 
+  describe "#encrypt!" do
+
+    it "should return an encrypted version of the string" do
+      GoogleAPI.configure do |config|
+        config.client_id = 'test id'
+        config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
+      end
+
+      GoogleAPI.encrypt!('test').should == "dGVzdGVuY3J5cHRpb24ga2V5\n"
+    end
+
+  end
+
+  describe "#decrypt!" do
+
+    it "should return an decrypted version of the string" do
+      GoogleAPI.configure do |config|
+        config.client_id = 'test id'
+        config.client_secret = 'test secret'
+        config.encryption_key = 'encryption key'
+      end
+
+      GoogleAPI.decrypt!("dGVzdGVuY3J5cHRpb24ga2V5\n").should == 'test'
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta
+  version: 0.0.1.rc1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -155,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2769347911649466323
+      hash: -4437608343180398710
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: