🚨 Linting

Author: pboling

CHANGELOG.md

@@ -309,7 +309,7 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
 ## [0.0.5] - 2010-04-23 ([tag][0.0.5t])
 
 ## [0.0.4] - 2010-04-22 ([tag][0.0.4t])
- 
+
 ## [0.0.3] - 2010-04-22 ([tag][0.0.3t])
 
 ## [0.0.2] - 2010-04-22 ([tag][0.0.2t])

Dangerfile

@@ -5,11 +5,11 @@
 #   e.g. github.pr_title.include? "#trivial"
 
 # Make it more obvious that a PR is a work in progress and shouldn't be merged yet
-warn('PR is classed as Work in Progress') if github.pr_title.include? '[WIP]'
+warn("PR is classed as Work in Progress") if github.pr_title.include?("[WIP]")
 
 # Warn when there is a big PR
-warn('Big PR') if git.lines_of_code > 500
+warn("Big PR") if git.lines_of_code > 500
 
 # Don't let testing shortcuts get into main by accident
-raise('fdescribe left in tests') if `grep -r fdescribe specs/ `.length > 1
-raise('fit left in tests') if `grep -r fit specs/ `.length > 1
+raise("fdescribe left in tests") if %x(grep -r fdescribe specs/).length > 1
+raise("fit left in tests") if %x(grep -r fit specs/).length > 1

lib/oauth2.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 # includes modules from stdlib
-require 'cgi'
-require 'time'
+require "cgi"
+require "time"
 
 # third party gems
-require 'snaky_hash'
-require 'version_gem'
+require "snaky_hash"
+require "version_gem"
 
 # includes gem files
-require 'oauth2/version'
-require 'oauth2/filtered_attributes'
-require 'oauth2/error'
-require 'oauth2/authenticator'
-require 'oauth2/client'
-require 'oauth2/strategy/base'
-require 'oauth2/strategy/auth_code'
-require 'oauth2/strategy/implicit'
-require 'oauth2/strategy/password'
-require 'oauth2/strategy/client_credentials'
-require 'oauth2/strategy/assertion'
-require 'oauth2/access_token'
-require 'oauth2/response'
+require "oauth2/version"
+require "oauth2/filtered_attributes"
+require "oauth2/error"
+require "oauth2/authenticator"
+require "oauth2/client"
+require "oauth2/strategy/base"
+require "oauth2/strategy/auth_code"
+require "oauth2/strategy/implicit"
+require "oauth2/strategy/password"
+require "oauth2/strategy/client_credentials"
+require "oauth2/strategy/assertion"
+require "oauth2/access_token"
+require "oauth2/response"
 
 # The namespace of this library
 module OAuth2

lib/oauth2/access_token.rb

@@ -76,19 +76,21 @@ def initialize(client, token, opts = {})
           error = Error.new(opts)
           raise(error)
         else
-          warn('OAuth2::AccessToken has no token')
+          warn("OAuth2::AccessToken has no token")
         end
       end
       # @option opts [Fixnum, String] :expires is deprecated
-      @expires_in ||= opts.delete('expires')
+      @expires_in ||= opts.delete("expires")
       @expires_in &&= @expires_in.to_i
       @expires_at &&= convert_expires_at(@expires_at)
       @expires_latency &&= @expires_latency.to_i
       @expires_at ||= Time.now.to_i + @expires_in if @expires_in && !@expires_in.zero?
       @expires_at -= @expires_latency if @expires_latency
-      @options = {mode: opts.delete(:mode) || :header,
-                  header_format: opts.delete(:header_format) || 'Bearer %s',
-                  param_name: opts.delete(:param_name) || 'access_token'}
+      @options = {
+        mode: opts.delete(:mode) || :header,
+        header_format: opts.delete(:header_format) || "Bearer %s",
+        param_name: opts.delete(:param_name) || "access_token",
+      }
       @params = opts
     end
 
@@ -118,9 +120,9 @@ def expired?
     # @return [AccessToken] a new AccessToken
     # @note options should be carried over to the new AccessToken
     def refresh(params = {}, access_token_opts = {})
-      raise('A refresh_token is not available') unless refresh_token
+      raise("A refresh_token is not available") unless refresh_token
 
-      params[:grant_type] = 'refresh_token'
+      params[:grant_type] = "refresh_token"
       params[:refresh_token] = refresh_token
       new_token = @client.get_token(params, access_token_opts)
       new_token.options = options
@@ -133,7 +135,7 @@ def refresh(params = {}, access_token_opts = {})
     end
     # A compatibility alias
     # @note does not modify the receiver, so bang is not the default method
-    alias refresh! refresh
+    alias_method :refresh!, :refresh
 
     # Convert AccessToken to a hash which can be used to rebuild itself with AccessToken.from_hash
     #
@@ -190,7 +192,7 @@ def delete(path, opts = {}, &block)
 
     # Get the headers hash (includes Authorization token)
     def headers
-      {'Authorization' => options[:header_format] % token}
+      {"Authorization" => options[:header_format] % token}
     end
 
   private

lib/oauth2/authenticator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'base64'
+require "base64"
 
 module OAuth2
   class Authenticator
@@ -49,16 +49,16 @@ def self.encode_basic_auth(user, password)
     # already set.
     def apply_params_auth(params)
       result = {}
-      result['client_id'] = id unless id.nil?
-      result['client_secret'] = secret unless secret.nil?
+      result["client_id"] = id unless id.nil?
+      result["client_secret"] = secret unless secret.nil?
       result.merge(params)
     end
 
     # When using schemes that don't require the client_secret to be passed i.e TLS Client Auth,
     # we don't want to send the secret
     def apply_client_id(params)
       result = {}
-      result['client_id'] = id unless id.nil?
+      result["client_id"] = id unless id.nil?
       result.merge(params)
     end
 
@@ -72,7 +72,7 @@ def apply_basic_auth(params)
 
     # @see https://datatracker.ietf.org/doc/html/rfc2617#section-2
     def basic_auth_header
-      {'Authorization' => self.class.encode_basic_auth(id, secret)}
+      {"Authorization" => self.class.encode_basic_auth(id, secret)}
     end
   end
 end

lib/oauth2/client.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'logger'
+require "faraday"
+require "logger"
 
 if Faraday::Utils.respond_to?(:default_space_encoding)
   # This setting doesn't exist in faraday 0.x
-  Faraday::Utils.default_space_encoding = '%20'
+  Faraday::Utils.default_space_encoding = "%20"
 end
 
 module OAuth2
@@ -49,10 +49,10 @@ def initialize(client_id, client_secret, options = {}, &block)
       @secret = client_secret
       @site = opts.delete(:site)
       ssl = opts.delete(:ssl)
-      warn('OAuth2::Client#initialize argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class`.') if opts[:extract_access_token]
+      warn("OAuth2::Client#initialize argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class`.") if opts[:extract_access_token]
       @options = {
-        authorize_url: 'oauth/authorize',
-        token_url: 'oauth/token',
+        authorize_url: "oauth/authorize",
+        token_url: "oauth/token",
         token_method: :post,
         auth_scheme: :basic_auth,
         connection_opts: {},
@@ -81,8 +81,8 @@ def connection
           if options[:connection_build]
             options[:connection_build].call(builder)
           else
-            builder.request :url_encoded             # form-encode POST params
-            builder.adapter Faraday.default_adapter  # make requests with Net::HTTP
+            builder.request(:url_encoded)             # form-encode POST params
+            builder.adapter(Faraday.default_adapter)  # make requests with Net::HTTP
           end
         end
     end
@@ -131,7 +131,7 @@ def request(verb, url, opts = {}, &block)
           verb = :get
           opts.delete(:body)
         end
-        location = response.headers['location']
+        location = response.headers["location"]
         if location
           full_location = response.response.env.url.merge(location)
           request(verb, full_location, opts)
@@ -165,7 +165,7 @@ def request(verb, url, opts = {}, &block)
     # @yield [req] @see Faraday::Connection#run_request
     # @return [AccessToken] the initialized AccessToken
     def get_token(params, access_token_opts = {}, extract_access_token = nil, &block)
-      warn('OAuth2::Client#get_token argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class` on #initialize.') if extract_access_token
+      warn("OAuth2::Client#get_token argument `extract_access_token` will be removed in oauth2 v3. Refactor to use `access_token_class` on #initialize.") if extract_access_token
       extract_access_token ||= options[:extract_access_token]
       parse, snaky, params, headers = parse_snaky_params_headers(params)
 
@@ -178,13 +178,13 @@ def get_token(params, access_token_opts = {}, extract_access_token = nil, &block
 
         # NOTE: If proliferation of request types continues we should implement a parser solution for Request,
         #       just like we have with Response.
-        request_opts[:body] = if headers['Content-Type'] == 'application/json'
-                                params.to_json
-                              else
-                                params
-                              end
+        request_opts[:body] = if headers["Content-Type"] == "application/json"
+          params.to_json
+        else
+          params
+        end
 
-        request_opts[:headers] = {'Content-Type' => 'application/x-www-form-urlencoded'}
+        request_opts[:headers] = {"Content-Type" => "application/x-www-form-urlencoded"}
       else
         request_opts[:params] = params
         request_opts[:headers] = {}
@@ -261,7 +261,7 @@ def assertion
     # @return [Hash] the params to add to a request or URL
     def redirection_params
       if options[:redirect_uri]
-        {'redirect_uri' => options[:redirect_uri]}
+        {"redirect_uri" => options[:redirect_uri]}
       else
         {}
       end
@@ -358,7 +358,7 @@ def build_access_token_legacy(response, access_token_opts, extract_access_token)
     end
 
     def oauth_debug_logging(builder)
-      builder.response :logger, options[:logger], bodies: true if ENV['OAUTH_DEBUG'] == 'true'
+      builder.response(:logger, options[:logger], bodies: true) if ENV["OAUTH_DEBUG"] == "true"
     end
   end
 end

lib/oauth2/error.rb

@@ -11,18 +11,18 @@ def initialize(response)
       @response = response
       if response.respond_to?(:parsed)
         if response.parsed.is_a?(Hash)
-          @code = response.parsed['error']
-          @description = response.parsed['error_description']
+          @code = response.parsed["error"]
+          @description = response.parsed["error_description"]
         end
       elsif response.is_a?(Hash)
-        @code = response['error']
-        @description = response['error_description']
+        @code = response["error"]
+        @description = response["error_description"]
       end
       @body = if response.respond_to?(:body)
-                response.body
-              else
-                @response
-              end
+        response.body
+      else
+        @response
+      end
       message_opts = parse_error_description(@code, @description)
       super(error_message(@body, message_opts))
     end
@@ -35,11 +35,11 @@ def error_message(response_body, opts = {})
       lines << opts[:error_description] if opts[:error_description]
 
       error_string = if response_body.respond_to?(:encode) && opts[:error_description].respond_to?(:encoding)
-                       script_encoding = opts[:error_description].encoding
-                       response_body.encode(script_encoding, invalid: :replace, undef: :replace)
-                     else
-                       response_body
-                     end
+        script_encoding = opts[:error_description].encoding
+        response_body.encode(script_encoding, invalid: :replace, undef: :replace)
+      else
+        response_body
+      end
 
       lines << error_string
 
@@ -49,7 +49,7 @@ def error_message(response_body, opts = {})
     def parse_error_description(code, description)
       return {} unless code || description
 
-      error_description = ''
+      error_description = ""
       error_description += "#{code}: " if code
       error_description += description if description
 

lib/oauth2/filtered_attributes.rb

@@ -25,7 +25,7 @@ def inspect
           "#{var}=#{instance_variable_get(var).inspect}"
         end
       end
-      "#<#{self.class}:#{object_id} #{inspected_vars.join(', ')}>"
+      "#<#{self.class}:#{object_id} #{inspected_vars.join(", ")}>"
     end
   end
 end

lib/oauth2/response.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'multi_xml'
-require 'rack'
+require "json"
+require "multi_xml"
+require "rack"
 
 module OAuth2
   # OAuth2::Response class
@@ -23,8 +23,8 @@ class Response
 
     # Content type assignments for various potential HTTP content types.
     @@content_types = {
-      'application/x-www-form-urlencoded' => :query,
-      'text/plain' => :text,
+      "application/x-www-form-urlencoded" => :query,
+      "text/plain" => :text,
     }
 
     # Adds a new content type parser.
@@ -68,7 +68,7 @@ def status
 
     # The HTTP response body
     def body
-      response.body || ''
+      response.body || ""
     end
 
     # The {#response} {#body} as parsed by {#parser}.
@@ -97,9 +97,9 @@ def parsed
 
     # Attempts to determine the content type of the response.
     def content_type
-      return nil unless response.headers
+      return unless response.headers
 
-      ((response.headers.values_at('content-type', 'Content-Type').compact.first || '').split(';').first || '').strip.downcase
+      ((response.headers.values_at("content-type", "Content-Type").compact.first || "").split(";").first || "").strip.downcase
     end
 
     # Determines the parser (a Proc or other Object which responds to #call)
@@ -133,16 +133,16 @@ def parser
   end
 end
 
-OAuth2::Response.register_parser(:xml, ['text/xml', 'application/rss+xml', 'application/rdf+xml', 'application/atom+xml', 'application/xml']) do |body|
+OAuth2::Response.register_parser(:xml, ["text/xml", "application/rss+xml", "application/rdf+xml", "application/atom+xml", "application/xml"]) do |body|
   next body unless body.respond_to?(:to_str)
 
   MultiXml.parse(body)
 end
 
-OAuth2::Response.register_parser(:json, ['application/json', 'text/javascript', 'application/hal+json', 'application/vnd.collection+json', 'application/vnd.api+json', 'application/problem+json']) do |body|
+OAuth2::Response.register_parser(:json, ["application/json", "text/javascript", "application/hal+json", "application/vnd.collection+json", "application/vnd.api+json", "application/problem+json"]) do |body|
   next body unless body.respond_to?(:to_str)
 
-  body = body.dup.force_encoding(::Encoding::ASCII_8BIT) if body.respond_to?(:force_encoding)
+  body = body.dup.force_encoding(Encoding::ASCII_8BIT) if body.respond_to?(:force_encoding)
 
-  ::JSON.parse(body)
+  JSON.parse(body)
 end