signet 0.12.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80485d96774a5d31447471f38ed3f976ed3cbc751f26d9758798adee4e3fced
-  data.tar.gz: 70a563487e412a15c01799c09ec1fed027152e024053272c15858743cf4a58ca
+  metadata.gz: 13bd869943add17b04e66089d5c1a5d34a8d6053c55fb4dc389bc9e3a83c36ae
+  data.tar.gz: 17a0094e4ef483d07ea945155956d81a06423a8d57abc725d326b49c2cb62171
 SHA512:
-  metadata.gz: e004219f1e71c272772bb4892574d8bcc2725fc8f3fb0b474612839661f0a272400ffff50149499b27f91d6287aaeb41fe1065d7bd2652a0f58cdd9f2f12e1da
-  data.tar.gz: 046c9e719091f1f8d17fc324762558b2e6cb00d9b74c0ad66ec4da5bda5d8ba2a2ba6f2e070baacd6af2853d2ca30c1ea198c8ec59bb6fcdf9f63ac11929df9c
+  metadata.gz: c6817470226e95dd4535bb7316b98c2b95d6ef70a8b9a1466656018fc9e642a02901390e0b40562e7ac7ea3a6acfefdb07d3317c6879453bb23ca07090bd9643
+  data.tar.gz: d49ad82ef1cbf8fab14b74370f07e3567c3f2594045e3cf82ec5f72f69f93ebe47954bff340fe7c472fb31f6269bbe012fec8e24f369167e59a519bfc02ff13b

data/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title=Signet
+--markup markdown
+--markup-provider redcarpet
+
+./lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+# Release History
+
+### 0.17.0 (2022-06-23)
+
+* Updated minimum Ruby version to 2.6
+
+### 0.16.1 (2022-02-24)
+
+#### Bug Fixes
+
+* Support Faraday 2
+
+### 0.16.0 (2021-09-03)
+
+#### Features
+
+* Support for fetching an access token with basic auth
+
+#### Bug Fixes
+
+* Remove extraneous files from the gem
+* Require addressable 2.8 to remediate vulnerability
+
+### 0.15.0 (2021-03-04)
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
+### 0.14.1 / 2021-01-27
+
+* Fix OAuth1 signature with duplicate query param names
+
+### 0.14.0 / 2020-03-31
+
+* Support for fetching ID tokens from google oauth2 endpoint.
+
+### 0.13.2 / 2020-03-25
+
+Rerelease of 0.13.1.
+
+### 0.13.1 / 2020-03-24
+
+* Update github url
+
+### 0.13.0 / 2020-02-24
+
+* Support Faraday 1.x
+
 ### 0.12.0 / 2019-10-08
 
 * This version now requires Ruby 2.4.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project,
+and in the interest of fostering an open and welcoming community,
+we pledge to respect all people who contribute through reporting issues,
+posting feature requests, updating documentation,
+submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project
+a harassment-free experience for everyone,
+regardless of level of experience, gender, gender identity and expression,
+sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information,
+such as physical or electronic
+addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct.
+By adopting this Code of Conduct,
+project maintainers commit themselves to fairly and consistently
+applying these principles to every aspect of managing this project.
+Project maintainers who do not follow or enforce the Code of Conduct
+may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by opening an issue
+or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
+available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/README.md

@@ -8,7 +8,6 @@
 </dl>
 
 [![Gem Version](https://badge.fury.io/rb/signet.svg)](https://badge.fury.io/rb/signet)
-[![Build Status](https://secure.travis-ci.org/google/signet.png)](http://travis-ci.org/google/signet)
 
 ## Description
 
@@ -32,8 +31,8 @@ require 'signet/oauth_2/client'
 client = Signet::OAuth2::Client.new(
   :authorization_uri => 'https://accounts.google.com/o/oauth2/auth',
   :token_credential_uri =>  'https://oauth2.googleapis.com/token',
-  :client_id => '44410190108-74nkm6jc5e3vvjqis803frkvmu88cu3a.apps.googleusercontent.com',
-  :client_secret => 'X1NUhvO-rQr9sm8uUSMY8i7v',
+  :client_id => "#{YOUR_CLIENT_ID}.apps.googleusercontent.com",
+  :client_secret => YOUR_CLIENT_SECRET,
   :scope => 'email profile',
   :redirect_uri => 'https://example.client.com/oauth'
 )
@@ -60,8 +59,11 @@ Be sure `https://rubygems.org` is in your gem sources.
 
 ## Supported Ruby Versions
 
-This library requires Ruby 2.4 or later.
-In general, this library supports Ruby versions that are considered current and
-supported by Ruby Core (that is, Ruby versions that are either in normal
-maintenance or in security maintenance).
-See https://www.ruby-lang.org/en/downloads/branches/ for further details.
+This library is supported on Ruby 2.5+.
+
+Google provides official support for Ruby versions that are actively supported
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
+security maintenance, and not end of life. Currently, this means Ruby 2.5 and
+later. Older versions of Ruby _may_ still work, but are unsupported and not
+recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
+about the Ruby support schedule.

data/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
+
+The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
+
+We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

data/lib/signet/oauth_1/client.rb

@@ -89,7 +89,7 @@ module Signet
       # @see Signet::OAuth1::Client#initialize
       def update! options = {}
         # Normalize key to String to allow indifferent access.
-        options = options.each_with_object({}) { |(k, v), accu| accu[k.to_s] = v; }
+        options = options.to_h.transform_keys(&:to_s)
         self.temporary_credential_uri = options["temporary_credential_uri"]
         self.authorization_uri = options["authorization_uri"]
         self.token_credential_uri = options["token_credential_uri"]
@@ -128,12 +128,12 @@ module Signet
       #   new_temporary_credential_uri
       #   The temporary credentials URI.
       def temporary_credential_uri= new_temporary_credential_uri
-        if !new_temporary_credential_uri.nil?
+        if new_temporary_credential_uri.nil?
+          @temporary_credential_uri = nil
+        else
           new_temporary_credential_uri =
             Addressable::URI.parse new_temporary_credential_uri
           @temporary_credential_uri = new_temporary_credential_uri
-        else
-          @temporary_credential_uri = nil
         end
       end
       alias request_token_uri= temporary_credential_uri=
@@ -163,14 +163,14 @@ module Signet
       # @param [Addressable::URI, String, #to_str] new_authorization_uri
       #   The authorization URI.
       def authorization_uri= new_authorization_uri
-        if !new_authorization_uri.nil?
+        if new_authorization_uri.nil?
+          @authorization_uri = nil
+        else
           new_authorization_uri = Addressable::URI.send(
             new_authorization_uri.is_a?(Hash) ? :new : :parse,
             new_authorization_uri
           )
           @authorization_uri = new_authorization_uri
-        else
-          @authorization_uri = nil
         end
       end
 
@@ -189,14 +189,14 @@ module Signet
       # @param [Addressable::URI, Hash, String, #to_str] new_token_credential_uri
       #   The token credential URI.
       def token_credential_uri= new_token_credential_uri
-        if !new_token_credential_uri.nil?
+        if new_token_credential_uri.nil?
+          @token_credential_uri = nil
+        else
           new_token_credential_uri = Addressable::URI.send(
             new_token_credential_uri.is_a?(Hash) ? :new : :parse,
             new_token_credential_uri
           )
           @token_credential_uri = new_token_credential_uri
-        else
-          @token_credential_uri = nil
         end
       end
       alias access_token_uri= token_credential_uri=
@@ -217,8 +217,7 @@ module Signet
         elsif !client_credential_key && !client_credential_secret
           nil
         else
-          raise ArgumentError,
-                "The client credential key and secret must be set."
+          raise ArgumentError, "The client credential key and secret must be set."
         end
       end
       alias consumer_token client_credential
@@ -229,7 +228,10 @@ module Signet
       # @param [Signet::OAuth1::Credential] new_client_credential
       #   The client credentials.
       def client_credential= new_client_credential
-        if !new_client_credential.nil?
+        if new_client_credential.nil?
+          @client_credential_key = nil
+          @client_credential_secret = nil
+        else
           unless new_client_credential.is_a? ::Signet::OAuth1::Credential
             raise TypeError,
                   "Expected Signet::OAuth1::Credential, " \
@@ -237,9 +239,6 @@ module Signet
           end
           @client_credential_key = new_client_credential.key
           @client_credential_secret = new_client_credential.secret
-        else
-          @client_credential_key = nil
-          @client_credential_secret = nil
         end
       end
       alias consumer_token= client_credential=
@@ -259,15 +258,15 @@ module Signet
       # @param [String, #to_str] new_client_credential_key
       #   The client credential key.
       def client_credential_key= new_client_credential_key
-        if !new_client_credential_key.nil?
+        if new_client_credential_key.nil?
+          @client_credential_key = nil
+        else
           unless new_client_credential_key.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_client_credential_key.class} into String."
           end
           new_client_credential_key = new_client_credential_key.to_str
           @client_credential_key = new_client_credential_key
-        else
-          @client_credential_key = nil
         end
       end
       alias consumer_key= client_credential_key=
@@ -287,7 +286,9 @@ module Signet
       # @param [String, #to_str] new_client_credential_secret
       #   The client credential secret.
       def client_credential_secret= new_client_credential_secret
-        if !new_client_credential_secret.nil?
+        if new_client_credential_secret.nil?
+          @client_credential_secret = nil
+        else
           unless new_client_credential_secret.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_client_credential_secret.class} " \
@@ -295,8 +296,6 @@ module Signet
           end
           new_client_credential_secret = new_client_credential_secret.to_str
           @client_credential_secret = new_client_credential_secret
-        else
-          @client_credential_secret = nil
         end
       end
       alias consumer_secret= client_credential_secret=
@@ -311,12 +310,10 @@ module Signet
             temporary_credential_key,
             temporary_credential_secret
           )
-        elsif !temporary_credential_key &&
-              !temporary_credential_secret
+        elsif !temporary_credential_key && !temporary_credential_secret
           nil
         else
-          raise ArgumentError,
-                "The temporary credential key and secret must be set."
+          raise ArgumentError, "The temporary credential key and secret must be set."
         end
       end
       alias request_token temporary_credential
@@ -327,7 +324,10 @@ module Signet
       # @param [Signet::OAuth1::Credential] new_temporary_credential
       #   The temporary credentials.
       def temporary_credential= new_temporary_credential
-        if !new_temporary_credential.nil?
+        if new_temporary_credential.nil?
+          @temporary_credential_key = nil
+          @temporary_credential_secret = nil
+        else
           unless new_temporary_credential.is_a? ::Signet::OAuth1::Credential
             raise TypeError,
                   "Expected Signet::OAuth1::Credential, " \
@@ -335,9 +335,6 @@ module Signet
           end
           @temporary_credential_key = new_temporary_credential.key
           @temporary_credential_secret = new_temporary_credential.secret
-        else
-          @temporary_credential_key = nil
-          @temporary_credential_secret = nil
         end
       end
       alias request_token= temporary_credential=
@@ -357,7 +354,9 @@ module Signet
       # @param [String, #to_str] new_temporary_credential_key
       #   The temporary credential key.
       def temporary_credential_key= new_temporary_credential_key
-        if !new_temporary_credential_key.nil?
+        if new_temporary_credential_key.nil?
+          @temporary_credential_key = nil
+        else
           unless new_temporary_credential_key.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_temporary_credential_key.class} " \
@@ -365,8 +364,6 @@ module Signet
           end
           new_temporary_credential_key = new_temporary_credential_key.to_str
           @temporary_credential_key = new_temporary_credential_key
-        else
-          @temporary_credential_key = nil
         end
       end
       alias request_token_key= temporary_credential_key=
@@ -386,7 +383,9 @@ module Signet
       # @param [String, #to_str] new_temporary_credential_secret
       #   The temporary credential secret.
       def temporary_credential_secret= new_temporary_credential_secret
-        if !new_temporary_credential_secret.nil?
+        if new_temporary_credential_secret.nil?
+          @temporary_credential_secret = nil
+        else
           unless new_temporary_credential_secret.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_temporary_credential_secret.class} " \
@@ -395,8 +394,6 @@ module Signet
           new_temporary_credential_secret =
             new_temporary_credential_secret.to_str
           @temporary_credential_secret = new_temporary_credential_secret
-        else
-          @temporary_credential_secret = nil
         end
       end
       alias request_token_secret= temporary_credential_secret=
@@ -411,12 +408,10 @@ module Signet
             token_credential_key,
             token_credential_secret
           )
-        elsif !token_credential_key &&
-              !token_credential_secret
+        elsif !token_credential_key && !token_credential_secret
           nil
         else
-          raise ArgumentError,
-                "The token credential key and secret must be set."
+          raise ArgumentError, "The token credential key and secret must be set."
         end
       end
       alias access_token token_credential
@@ -427,7 +422,10 @@ module Signet
       # @param [Signet::OAuth1::Credential] new_token_credential
       #   The token credentials.
       def token_credential= new_token_credential
-        if !new_token_credential.nil?
+        if new_token_credential.nil?
+          @token_credential_key = nil
+          @token_credential_secret = nil
+        else
           unless new_token_credential.is_a? ::Signet::OAuth1::Credential
             raise TypeError,
                   "Expected Signet::OAuth1::Credential, " \
@@ -435,9 +433,6 @@ module Signet
           end
           @token_credential_key = new_token_credential.key
           @token_credential_secret = new_token_credential.secret
-        else
-          @token_credential_key = nil
-          @token_credential_secret = nil
         end
       end
       alias access_token= token_credential=
@@ -457,7 +452,9 @@ module Signet
       # @param [String, #to_str] new_token_credential_key
       #   The token credential key.
       def token_credential_key= new_token_credential_key
-        if !new_token_credential_key.nil?
+        if new_token_credential_key.nil?
+          @token_credential_key = nil
+        else
           unless new_token_credential_key.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_token_credential_key.class} " \
@@ -465,8 +462,6 @@ module Signet
           end
           new_token_credential_key = new_token_credential_key.to_str
           @token_credential_key = new_token_credential_key
-        else
-          @token_credential_key = nil
         end
       end
       alias access_token_key= token_credential_key=
@@ -486,7 +481,9 @@ module Signet
       # @param [String, #to_str] new_token_credential_secret
       #   The token credential secret.
       def token_credential_secret= new_token_credential_secret
-        if !new_token_credential_secret.nil?
+        if new_token_credential_secret.nil?
+          @token_credential_secret = nil
+        else
           unless new_token_credential_secret.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_token_credential_secret.class} " \
@@ -495,8 +492,6 @@ module Signet
           new_token_credential_secret =
             new_token_credential_secret.to_str
           @token_credential_secret = new_token_credential_secret
-        else
-          @token_credential_secret = nil
         end
       end
       alias access_token_secret= token_credential_secret=
@@ -515,15 +510,15 @@ module Signet
       # @param [String, #to_str] new_callback
       #   The OAuth callback.
       def callback= new_callback
-        if !new_callback.nil?
+        if new_callback.nil?
+          @callback = nil
+        else
           unless new_callback.respond_to? :to_str
             raise TypeError,
                   "Can't convert #{new_callback.class} into String."
           end
           new_callback = new_callback.to_str
           @callback = new_callback
-        else
-          @callback = nil
         end
       end
 
@@ -556,7 +551,7 @@ module Signet
       # @note A serialized client contains sensitive information. Persist or transmit with care.
       #
       # @return [String] A serialized JSON representation of the client.
-      def to_json
+      def to_json *_args
         MultiJson.dump(
           "temporary_credential_uri"    => temporary_credential_uri,
           "authorization_uri"           => authorization_uri,
@@ -571,8 +566,6 @@ module Signet
           "token_credential_secret"     => token_credential_secret
         )
       end
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
 
       ##
       # Generates a request for temporary credentials.
@@ -635,8 +628,6 @@ module Signet
           req.headers = Faraday::Utils::Headers.new headers
         end
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
       alias generate_request_token_request generate_temporary_credential_request
 
       ##
@@ -709,8 +700,6 @@ module Signet
         self.temporary_credential = credential
       end
       alias fetch_request_token! fetch_temporary_credential!
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
 
       ##
       # Generates a request for token credentials.
@@ -776,7 +765,6 @@ module Signet
           req.headers = Faraday::Utils::Headers.new headers
         end
       end
-      # rubocop:enable Metrics/MethodLength
       alias generate_access_token_request generate_token_credential_request
 
       ##
@@ -818,7 +806,6 @@ module Signet
           message, request: request, response: response
         )
       end
-      # rubocop:enable Metrics/AbcSize
       alias fetch_access_token fetch_token_credential
 
       ##
@@ -846,10 +833,6 @@ module Signet
         self.token_credential = credential
       end
       alias fetch_access_token! fetch_token_credential!
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/PerceivedComplexity
 
       ##
       # Generates an authenticated request for protected resources.
@@ -943,14 +926,14 @@ module Signet
 
         content_type = request["Content-Type"].to_s
         content_type = content_type.split(";", 2).first if content_type.index ";"
-        if request.method == :post && content_type == "application/x-www-form-urlencoded"
+        if request.http_method == :post && content_type == "application/x-www-form-urlencoded"
           # Serializes the body in case a hash/array was passed. Noop if already string like
           encoder = Faraday::Request::UrlEncoded.new(->(_env) {})
           encoder.call env
           request.body = env[:body]
 
           post_parameters = Addressable::URI.form_unencode env[:body]
-          parameters = parameters.concat post_parameters
+          parameters.concat post_parameters
         end
 
         # No need to attach URI query parameters, the .sign_parameters
@@ -970,10 +953,6 @@ module Signet
         request["Cache-Control"] = "no-store"
         request
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/PerceivedComplexity
 
       ##
       # Transmits a request for a protected resource.

data/lib/signet/oauth_1/credential.rb

@@ -12,14 +12,9 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-module Signet #:nodoc:
+module Signet # :nodoc:
   module OAuth1
     class Credential
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/PerceivedComplexity
-
       ##
       # Creates a token object from a key and secret.
       #
@@ -95,12 +90,9 @@ module Signet #:nodoc:
         raise TypeError, "Expected String, got #{@secret.class}." unless @secret.respond_to? :to_str
         @secret = @secret.to_str
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/PerceivedComplexity
 
-      attr_accessor :key, :secret
+      attr_accessor :key
+      attr_accessor :secret
 
       def to_hash
         {