googleauth 0.8.0 → 0.8.1

data/lib/googleauth/signet.rb

@@ -27,7 +27,7 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-require 'signet/oauth_2/client'
+require "signet/oauth_2/client"
 
 module Signet
   # OAuth2 supports OAuth2 authentication.
@@ -38,24 +38,24 @@ module Signet
     # This reopens Client to add #apply and #apply! methods which update a
     # hash with the fetched authentication token.
     class Client
-      def configure_connection(options)
+      def configure_connection options
         @connection_info =
           options[:connection_builder] || options[:default_connection]
         self
       end
 
       # Updates a_hash updated with the authentication token
-      def apply!(a_hash, opts = {})
+      def apply! a_hash, opts = {}
         # fetch the access token there is currently not one, or if the client
         # has expired
-        fetch_access_token!(opts) if access_token.nil? || expires_within?(60)
+        fetch_access_token! opts if access_token.nil? || expires_within?(60)
         a_hash[AUTH_METADATA_KEY] = "Bearer #{access_token}"
       end
 
       # Returns a clone of a_hash updated with the authentication token
-      def apply(a_hash, opts = {})
+      def apply a_hash, opts = {}
         a_copy = a_hash.clone
-        apply!(a_copy, opts)
+        apply! a_copy, opts
         a_copy
       end
 
@@ -65,18 +65,18 @@ module Signet
         lambda(&method(:apply))
       end
 
-      def on_refresh(&block)
+      def on_refresh &block
         @refresh_listeners ||= []
         @refresh_listeners << block
       end
 
       alias orig_fetch_access_token! fetch_access_token!
-      def fetch_access_token!(options = {})
+      def fetch_access_token! options = {}
         unless options[:connection]
           connection = build_default_connection
-          options = options.merge(connection: connection) if connection
+          options = options.merge connection: connection if connection
         end
-        info = orig_fetch_access_token!(options)
+        info = orig_fetch_access_token! options
         notify_refresh_listeners
         info
       end
@@ -84,7 +84,7 @@ module Signet
       def notify_refresh_listeners
         listeners = @refresh_listeners || []
         listeners.each do |block|
-          block.call(self)
+          block.call self
         end
       end
 
@@ -98,15 +98,13 @@ module Signet
         end
       end
 
-      def retry_with_error(max_retry_count = 5)
+      def retry_with_error max_retry_count = 5
         retry_count = 0
 
         begin
           yield
-        rescue => e
-          if e.is_a?(Signet::AuthorizationError) || e.is_a?(Signet::ParseError)
-            raise e
-          end
+        rescue StandardError => e
+          raise e if e.is_a?(Signet::AuthorizationError) || e.is_a?(Signet::ParseError)
 
           if retry_count < max_retry_count
             retry_count += 1
@@ -114,7 +112,7 @@ module Signet
             retry
           else
             msg = "Unexpected error: #{e.inspect}"
-            raise(Signet::AuthorizationError, msg)
+            raise Signet::AuthorizationError, msg
           end
         end
       end

data/lib/googleauth/stores/file_token_store.rb

@@ -27,8 +27,8 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-require 'yaml/store'
-require 'googleauth/token_store'
+require "yaml/store"
+require "googleauth/token_store"
 
 module Google
   module Auth
@@ -39,24 +39,24 @@ module Google
         #
         # @param [String, File] file
         #  Path to storage file
-        def initialize(options = {})
+        def initialize options = {}
           path = options[:file]
-          @store = YAML::Store.new(path)
+          @store = YAML::Store.new path
         end
 
         # (see Google::Auth::Stores::TokenStore#load)
-        def load(id)
+        def load id
           @store.transaction { @store[id] }
         end
 
         # (see Google::Auth::Stores::TokenStore#store)
-        def store(id, token)
+        def store id, token
           @store.transaction { @store[id] = token }
         end
 
         # (see Google::Auth::Stores::TokenStore#delete)
-        def delete(id)
-          @store.transaction { @store.delete(id) }
+        def delete id
+          @store.transaction { @store.delete id }
         end
       end
     end

data/lib/googleauth/stores/redis_token_store.rb

@@ -27,8 +27,8 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-require 'redis'
-require 'googleauth/token_store'
+require "redis"
+require "googleauth/token_store"
 
 module Google
   module Auth
@@ -37,7 +37,7 @@ module Google
       # are stored as JSON using the supplied key, prefixed with
       # `g-user-token:`
       class RedisTokenStore < Google::Auth::TokenStore
-        DEFAULT_KEY_PREFIX = 'g-user-token:'.freeze
+        DEFAULT_KEY_PREFIX = "g-user-token:".freeze
 
         # Create a new store with the supplied redis client.
         #
@@ -48,34 +48,34 @@ module Google
         # @note If no redis instance is provided, a new one is created and
         #  the options passed through. You may include any other keys accepted
         #  by `Redis.new`
-        def initialize(options = {})
-          redis = options.delete(:redis)
-          prefix = options.delete(:prefix)
+        def initialize options = {}
+          redis = options.delete :redis
+          prefix = options.delete :prefix
           @redis = case redis
                    when Redis
                      redis
                    else
-                     Redis.new(options)
+                     Redis.new options
                    end
           @prefix = prefix || DEFAULT_KEY_PREFIX
         end
 
         # (see Google::Auth::Stores::TokenStore#load)
-        def load(id)
-          key = key_for(id)
-          @redis.get(key)
+        def load id
+          key = key_for id
+          @redis.get key
         end
 
         # (see Google::Auth::Stores::TokenStore#store)
-        def store(id, token)
-          key = key_for(id)
-          @redis.set(key, token)
+        def store id, token
+          key = key_for id
+          @redis.set key, token
         end
 
         # (see Google::Auth::Stores::TokenStore#delete)
-        def delete(id)
-          key = key_for(id)
-          @redis.del(key)
+        def delete id
+          key = key_for id
+          @redis.del key
         end
 
         private
@@ -86,7 +86,7 @@ module Google
         #  ID of the token
         # @return [String]
         #  Redis key
-        def key_for(id)
+        def key_for id
           @prefix + id
         end
       end

data/lib/googleauth/token_store.rb

@@ -43,8 +43,8 @@ module Google
       #  ID of token data to load.
       # @return [String]
       #  The loaded token data.
-      def load(_id)
-        raise 'Not implemented'
+      def load _id
+        raise "Not implemented"
       end
 
       # Put the token data into storage for the given ID.
@@ -53,16 +53,16 @@ module Google
       #  ID of token data to store.
       # @param [String] token
       #  The token data to store.
-      def store(_id, _token)
-        raise 'Not implemented'
+      def store _id, _token
+        raise "Not implemented"
       end
 
       # Remove the token data from storage for the given ID.
       #
       # @param [String] id
       #  ID of the token data to delete
-      def delete(_id)
-        raise 'Not implemented'
+      def delete _id
+        raise "Not implemented"
       end
     end
   end

data/lib/googleauth/user_authorizer.rb

@@ -27,10 +27,10 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-require 'uri'
-require 'multi_json'
-require 'googleauth/signet'
-require 'googleauth/user_refresh'
+require "uri"
+require "multi_json"
+require "googleauth/signet"
+require "googleauth/user_refresh"
 
 module Google
   module Auth
@@ -53,11 +53,11 @@ module Google
     #     ...
     class UserAuthorizer
       MISMATCHED_CLIENT_ID_ERROR =
-        'Token client ID of %s does not match configured client id %s'.freeze
-      NIL_CLIENT_ID_ERROR = 'Client id can not be nil.'.freeze
-      NIL_SCOPE_ERROR = 'Scope can not be nil.'.freeze
-      NIL_USER_ID_ERROR = 'User ID can not be nil.'.freeze
-      NIL_TOKEN_STORE_ERROR = 'Can not call method if token store is nil'.freeze
+        "Token client ID of %s does not match configured client id %s".freeze
+      NIL_CLIENT_ID_ERROR = "Client id can not be nil.".freeze
+      NIL_SCOPE_ERROR = "Scope can not be nil.".freeze
+      NIL_USER_ID_ERROR = "User ID can not be nil.".freeze
+      NIL_TOKEN_STORE_ERROR = "Can not call method if token store is nil".freeze
       MISSING_ABSOLUTE_URL_ERROR =
         'Absolute base url required for relative callback url "%s"'.freeze
 
@@ -72,14 +72,14 @@ module Google
       # @param [String] callback_uri
       #  URL (either absolute or relative) of the auth callback.
       #  Defaults to '/oauth2callback'
-      def initialize(client_id, scope, token_store, callback_uri = nil)
+      def initialize client_id, scope, token_store, callback_uri = nil
         raise NIL_CLIENT_ID_ERROR if client_id.nil?
         raise NIL_SCOPE_ERROR if scope.nil?
 
         @client_id = client_id
         @scope = Array(scope)
         @token_store = token_store
-        @callback_uri = callback_uri || '/oauth2callback'
+        @callback_uri = callback_uri || "/oauth2callback"
       end
 
       # Build the URL for requesting authorization.
@@ -97,20 +97,20 @@ module Google
       #  nil.
       # @return [String]
       #  Authorization url
-      def get_authorization_url(options = {})
+      def get_authorization_url options = {}
         scope = options[:scope] || @scope
         credentials = UserRefreshCredentials.new(
-          client_id: @client_id.id,
+          client_id:     @client_id.id,
           client_secret: @client_id.secret,
-          scope: scope
+          scope:         scope
         )
-        redirect_uri = redirect_uri_for(options[:base_url])
-        url = credentials.authorization_uri(access_type: 'offline',
-                                            redirect_uri: redirect_uri,
-                                            approval_prompt: 'force',
-                                            state: options[:state],
+        redirect_uri = redirect_uri_for options[:base_url]
+        url = credentials.authorization_uri(access_type:            "offline",
+                                            redirect_uri:           redirect_uri,
+                                            approval_prompt:        "force",
+                                            state:                  options[:state],
                                             include_granted_scopes: true,
-                                            login_hint: options[:login_hint])
+                                            login_hint:             options[:login_hint])
         url.to_s
       end
 
@@ -123,28 +123,26 @@ module Google
       #  the requested scopes
       # @return [Google::Auth::UserRefreshCredentials]
       #  Stored credentials, nil if none present
-      def get_credentials(user_id, scope = nil)
-        saved_token = stored_token(user_id)
+      def get_credentials user_id, scope = nil
+        saved_token = stored_token user_id
         return nil if saved_token.nil?
-        data = MultiJson.load(saved_token)
+        data = MultiJson.load saved_token
 
-        if data.fetch('client_id', @client_id.id) != @client_id.id
-          raise sprintf(MISMATCHED_CLIENT_ID_ERROR,
-                        data['client_id'], @client_id.id)
+        if data.fetch("client_id", @client_id.id) != @client_id.id
+          raise format(MISMATCHED_CLIENT_ID_ERROR,
+                       data["client_id"], @client_id.id)
         end
 
         credentials = UserRefreshCredentials.new(
-          client_id: @client_id.id,
+          client_id:     @client_id.id,
           client_secret: @client_id.secret,
-          scope: data['scope'] || @scope,
-          access_token: data['access_token'],
-          refresh_token: data['refresh_token'],
-          expires_at: data.fetch('expiration_time_millis', 0) / 1000
+          scope:         data["scope"] || @scope,
+          access_token:  data["access_token"],
+          refresh_token: data["refresh_token"],
+          expires_at:    data.fetch("expiration_time_millis", 0) / 1000
         )
         scope ||= @scope
-        if credentials.includes_scope?(scope)
-          return monitor_credentials(user_id, credentials)
-        end
+        return monitor_credentials user_id, credentials if credentials.includes_scope? scope
         nil
       end
 
@@ -163,20 +161,20 @@ module Google
       #  callback uri is a relative.
       # @return [Google::Auth::UserRefreshCredentials]
       #  Credentials if exchange is successful
-      def get_credentials_from_code(options = {})
+      def get_credentials_from_code options = {}
         user_id = options[:user_id]
         code = options[:code]
         scope = options[:scope] || @scope
         base_url = options[:base_url]
         credentials = UserRefreshCredentials.new(
-          client_id: @client_id.id,
+          client_id:     @client_id.id,
           client_secret: @client_id.secret,
-          redirect_uri: redirect_uri_for(base_url),
-          scope: scope
+          redirect_uri:  redirect_uri_for(base_url),
+          scope:         scope
         )
         credentials.code = code
         credentials.fetch_access_token!({})
-        monitor_credentials(user_id, credentials)
+        monitor_credentials user_id, credentials
       end
 
       # Exchanges an authorization code returned in the oauth callback.
@@ -196,9 +194,9 @@ module Google
       #  callback uri is a relative.
       # @return [Google::Auth::UserRefreshCredentials]
       #  Credentials if exchange is successful
-      def get_and_store_credentials_from_code(options = {})
-        credentials = get_credentials_from_code(options)
-        store_credentials(options[:user_id], credentials)
+      def get_and_store_credentials_from_code options = {}
+        credentials = get_credentials_from_code options
+        store_credentials options[:user_id], credentials
       end
 
       # Revokes a user's credentials. This both revokes the actual
@@ -206,11 +204,11 @@ module Google
       #
       # @param [String] user_id
       #  Unique ID of the user for loading/storing credentials.
-      def revoke_authorization(user_id)
-        credentials = get_credentials(user_id)
+      def revoke_authorization user_id
+        credentials = get_credentials user_id
         if credentials
           begin
-            @token_store.delete(user_id)
+            @token_store.delete user_id
           ensure
             credentials.revoke!
           end
@@ -226,15 +224,15 @@ module Google
       #  Unique ID of the user for loading/storing credentials.
       # @param [Google::Auth::UserRefreshCredentials] credentials
       #  Credentials to store.
-      def store_credentials(user_id, credentials)
+      def store_credentials user_id, credentials
         json = MultiJson.dump(
-          client_id: credentials.client_id,
-          access_token: credentials.access_token,
-          refresh_token: credentials.refresh_token,
-          scope: credentials.scope,
+          client_id:              credentials.client_id,
+          access_token:           credentials.access_token,
+          refresh_token:          credentials.refresh_token,
+          scope:                  credentials.scope,
           expiration_time_millis: credentials.expires_at.to_i * 1000
         )
-        @token_store.store(user_id, json)
+        @token_store.store user_id, json
         credentials
       end
 
@@ -245,11 +243,11 @@ module Google
       # @param [String] user_id
       #  Unique ID of the user for loading/storing credentials.
       # @return [String] The saved token from @token_store
-      def stored_token(user_id)
+      def stored_token user_id
         raise NIL_USER_ID_ERROR if user_id.nil?
         raise NIL_TOKEN_STORE_ERROR if @token_store.nil?
 
-        @token_store.load(user_id)
+        @token_store.load user_id
       end
 
       # Begin watching a credential for refreshes so the access token can be
@@ -259,9 +257,9 @@ module Google
       #  Unique ID of the user for loading/storing credentials.
       # @param [Google::Auth::UserRefreshCredentials] credentials
       #  Credentials to store.
-      def monitor_credentials(user_id, credentials)
+      def monitor_credentials user_id, credentials
         credentials.on_refresh do |cred|
-          store_credentials(user_id, cred)
+          store_credentials user_id, cred
         end
         credentials
       end
@@ -272,11 +270,9 @@ module Google
       #  Absolute URL to resolve the callback against if necessary.
       # @return [String]
       #  Redirect URI
-      def redirect_uri_for(base_url)
+      def redirect_uri_for base_url
         return @callback_uri unless URI(@callback_uri).scheme.nil?
-        if base_url.nil? || URI(base_url).scheme.nil?
-          raise sprintf(MISSING_ABSOLUTE_URL_ERROR, @callback_uri)
-        end
+        raise format(MISSING_ABSOLUTE_URL_ERROR, @callback_uri) if base_url.nil? || URI(base_url).scheme.nil?
         URI.join(base_url, @callback_uri).to_s
       end
     end