signet 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13bd869943add17b04e66089d5c1a5d34a8d6053c55fb4dc389bc9e3a83c36ae
-  data.tar.gz: 17a0094e4ef483d07ea945155956d81a06423a8d57abc725d326b49c2cb62171
+  metadata.gz: 430b4ec8945e95be77f454a8103b93cbaf6ec2e2ff5d8ea875a96686e5c877d0
+  data.tar.gz: 672370d6c1769532dc02b34f4c89a8c2aac7613bd5aab71e1f182e0ceba2ea0c
 SHA512:
-  metadata.gz: c6817470226e95dd4535bb7316b98c2b95d6ef70a8b9a1466656018fc9e642a02901390e0b40562e7ac7ea3a6acfefdb07d3317c6879453bb23ca07090bd9643
-  data.tar.gz: d49ad82ef1cbf8fab14b74370f07e3567c3f2594045e3cf82ec5f72f69f93ebe47954bff340fe7c472fb31f6269bbe012fec8e24f369167e59a519bfc02ff13b
+  metadata.gz: cdd439206b52e37418e88c8010df6943f3d826277e222c4444f2bf351d1787040cc14192346125d8935d7ff8ac167b2f93d849aa32bda81524be9c041196e857
+  data.tar.gz: 9fc07647d3c15cfbd6526baaa589ec7f6e09083c92a0a299e47b2e07937e593dec6df78638796160a110a68a30c453064d86e0fac0dba349807ac3316618dbef

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 0.18.0 (2023-09-01)
+
+#### Features
+
+* Expose Granted Scopes while fetching credentials ([#230](https://github.com/googleapis/signet/issues/230)) 
+
 ### 0.17.0 (2022-06-23)
 
 * Updated minimum Ruby version to 2.6

data/README.md

@@ -59,11 +59,11 @@ Be sure `https://rubygems.org` is in your gem sources.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 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.
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or
+in security maintenance, and not end of life. 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/lib/signet/oauth_1/credential.rb

@@ -75,7 +75,7 @@ module Signet # :nodoc:
             args = args.first.to_ary
           end
           if args.all? { |value| value.is_a? Array }
-            parameters = args.each_with_object({}) { |(k, v), h| h[k] = v; }
+            parameters = args.each_with_object({}) { |(k, v), h| h[k] = v }
             @key = key_from_hash.call parameters
             @secret = secret_from_hash.call parameters
           elsif args.size == 2

data/lib/signet/oauth_1.rb

@@ -350,7 +350,7 @@ module Signet # :nodoc:
       query_values = parsed_uri.query_values || {}
       if options[:additional_parameters]
         query_values = query_values.merge(
-          options[:additional_parameters].each_with_object({}) { |(k, v), h| h[k] = v; }
+          options[:additional_parameters].each_with_object({}) { |(k, v), h| h[k] = v }
         )
       end
       query_values["oauth_token"] = temporary_credential_key if temporary_credential_key

data/lib/signet/oauth_2/client.rb

@@ -32,52 +32,54 @@ module Signet
       #
       # @param [Hash] options
       #   The configuration parameters for the client.
-      #   - <code>:authorization_uri</code> -
+      #   - `:authorization_uri` -
       #     The authorization server's HTTP endpoint capable of
       #     authenticating the end-user and obtaining authorization.
-      #   - <code>:token_credential_uri</code> -
+      #   - `:token_credential_uri` -
       #     The authorization server's HTTP endpoint capable of issuing
       #     tokens and refreshing expired tokens.
-      #   - <code>:client_id</code> -
+      #   - `:client_id` -
       #     A unique identifier issued to the client to identify itself to the
       #     authorization server.
-      #   - <code>:client_secret</code> -
+      #   - `:client_secret` -
       #     A shared symmetric secret issued by the authorization server,
       #     which is used to authenticate the client.
-      #   - <code>:scope</code> -
+      #   - `:scope` -
       #     The scope of the access request, expressed either as an Array
       #     or as a space-delimited String.
-      #   - <code>:target_audience</code> -
+      #   - `:target_audience` -
       #     The final target audience for ID tokens fetched by this client,
       #     as a String.
-      #   - <code>:state</code> -
+      #   - `:state` -
       #     An arbitrary string designed to allow the client to maintain state.
-      #   - <code>:code</code> -
+      #   - `:code` -
       #     The authorization code received from the authorization server.
-      #   - <code>:redirect_uri</code> -
+      #   - `:redirect_uri` -
       #     The redirection URI used in the initial request.
-      #   - <code>:username</code> -
+      #   - `:username` -
       #     The resource owner's username.
-      #   - <code>:password</code> -
+      #   - `:password` -
       #     The resource owner's password.
-      #   - <code>:issuer</code> -
+      #   - `:issuer` -
       #     Issuer ID when using assertion profile
-      #   - <code>:person</code> -
+      #   - `:person` -
       #     Target user for assertions
-      #   - <code>:expiry</code> -
+      #   - `:expiry` -
       #     Number of seconds assertions are valid for
-      #   - <code>:signing_key</code> -
+      #   - `:signing_key` -
       #     Signing key when using assertion profile
-      #   - <code>:refresh_token</code> -
+      #   - `:refresh_token` -
       #     The refresh token associated with the access token
       #     to be refreshed.
-      #   - <code>:access_token</code> -
+      #   - `:access_token` -
       #     The current access token for this client.
-      #   - <code>:id_token</code> -
+      #   - `:id_token` -
       #     The current ID token for this client.
-      #   - <code>:extension_parameters</code> -
+      #   - `:extension_parameters` -
       #     When using an extension grant type, this the set of parameters used
       #     by that extension.
+      #   - `:granted_scopes` -
+      #     All scopes granted by authorization server.
       #
       # @example
       #   client = Signet::OAuth2::Client.new(
@@ -109,6 +111,7 @@ module Signet
         @state                = nil
         @username             = nil
         @access_type          = nil
+        @granted_scopes       = nil
         update! options
       end
 
@@ -117,56 +120,58 @@ module Signet
       #
       # @param [Hash] options
       #   The configuration parameters for the client.
-      #   - <code>:authorization_uri</code> -
+      #   - `:authorization_uri` -
       #     The authorization server's HTTP endpoint capable of
       #     authenticating the end-user and obtaining authorization.
-      #   - <code>:token_credential_uri</code> -
+      #   - `:token_credential_uri` -
       #     The authorization server's HTTP endpoint capable of issuing
       #     tokens and refreshing expired tokens.
-      #   - <code>:client_id</code> -
+      #   - `:client_id` -
       #     A unique identifier issued to the client to identify itself to the
       #     authorization server.
-      #   - <code>:client_secret</code> -
+      #   - `:client_secret` -
       #     A shared symmetric secret issued by the authorization server,
       #     which is used to authenticate the client.
-      #   - <code>:scope</code> -
+      #   - `:scope` -
       #     The scope of the access request, expressed either as an Array
       #     or as a space-delimited String.
-      #   - <code>:target_audience</code> -
+      #   - `:target_audience` -
       #     The final target audience for ID tokens fetched by this client,
       #     as a String.
-      #   - <code>:state</code> -
+      #   - `:state` -
       #     An arbitrary string designed to allow the client to maintain state.
-      #   - <code>:code</code> -
+      #   - `:code` -
       #     The authorization code received from the authorization server.
-      #   - <code>:redirect_uri</code> -
+      #   - `:redirect_uri` -
       #     The redirection URI used in the initial request.
-      #   - <code>:username</code> -
+      #   - `:username` -
       #     The resource owner's username.
-      #   - <code>:password</code> -
+      #   - `:password` -
       #     The resource owner's password.
-      #   - <code>:issuer</code> -
+      #   - `:issuer` -
       #     Issuer ID when using assertion profile
-      #   - <code>:audience</code> -
+      #   - `:audience` -
       #     Target audience for assertions
-      #   - <code>:person</code> -
+      #   - `:person` -
       #     Target user for assertions
-      #   - <code>:expiry</code> -
+      #   - `:expiry` -
       #     Number of seconds assertions are valid for
-      #   - <code>:signing_key</code> -
+      #   - `:signing_key` -
       #     Signing key when using assertion profile
-      #   - <code>:refresh_token</code> -
+      #   - `:refresh_token` -
       #     The refresh token associated with the access token
       #     to be refreshed.
-      #   - <code>:access_token</code> -
+      #   - `:access_token` -
       #     The current access token for this client.
-      #   - <code>:access_type</code> -
+      #   - `:access_type` -
       #     The current access type parameter for #authorization_uri.
-      #   - <code>:id_token</code> -
+      #   - `:id_token` -
       #     The current ID token for this client.
-      #   - <code>:extension_parameters</code> -
+      #   - `:extension_parameters` -
       #     When using an extension grant type, this is the set of parameters used
       #     by that extension.
+      #   - `:granted_scopes` -
+      #     All scopes granted by authorization server.
       #
       # @example
       #   client.update!(
@@ -253,7 +258,7 @@ module Signet
         self.access_token = options[:access_token] if options.key? :access_token
         self.refresh_token = options[:refresh_token] if options.key? :refresh_token
         self.id_token = options[:id_token] if options.key? :id_token
-
+        self.granted_scopes = options[:granted_scopes] if options.key? :granted_scopes
         self
       end
 
@@ -611,7 +616,7 @@ module Signet
       # @param [Integer, String] new_expiry
       #   Assertion expiry, in seconds
       def expiry= new_expiry
-        @expiry = new_expiry ? new_expiry.to_i : nil
+        @expiry = new_expiry&.to_i
       end
 
       ##
@@ -823,6 +828,33 @@ module Signet
         @expires_at = normalize_timestamp new_expires_at
       end
 
+      ##
+      # Returns the scopes granted by the authorization server.
+      #
+      # @return [Array, nil] The scope of access returned by the authorization server.
+      def granted_scopes
+        @granted_scopes
+      end
+
+      ##
+      # Sets the scopes returned by authorization server for this client.
+      #
+      # @param [String, Array, nil] new_granted_scopes
+      #   The scope of access returned by authorization server. This will
+      #   ideally be expressed as space-delimited String.
+      def granted_scopes= new_granted_scopes
+        case new_granted_scopes
+        when Array
+          @granted_scopes = new_granted_scopes
+        when String
+          @granted_scopes = new_granted_scopes.split
+        when nil
+          @granted_scopes = nil
+        else
+          raise TypeError, "Expected Array or String, got #{new_granted_scopes.class}"
+        end
+      end
+
       ##
       # Returns true if the access token has expired.
       # Returns false if the token has not expired or has an nil @expires_at.
@@ -857,6 +889,7 @@ module Signet
         @code = nil
         @issued_at = nil
         @expires_at = nil
+        @granted_scopes = nil
       end
 
       ##
@@ -916,27 +949,28 @@ module Signet
       # @return [String] A serialized JSON representation of the client.
       def to_json *_args
         MultiJson.dump(
-          "authorization_uri"    => authorization_uri ? authorization_uri.to_s : nil,
-          "token_credential_uri" => token_credential_uri ? token_credential_uri.to_s : nil,
+          "authorization_uri"    => authorization_uri&.to_s,
+          "token_credential_uri" => token_credential_uri&.to_s,
           "client_id"            => client_id,
           "client_secret"        => client_secret,
           "scope"                => scope,
           "target_audience"      => target_audience,
           "state"                => state,
           "code"                 => code,
-          "redirect_uri"         => redirect_uri ? redirect_uri.to_s : nil,
+          "redirect_uri"         => redirect_uri&.to_s,
           "username"             => username,
           "password"             => password,
           "issuer"               => issuer,
           "audience"             => audience,
           "person"               => person,
           "expiry"               => expiry,
-          "expires_at"           => expires_at ? expires_at.to_i : nil,
+          "expires_at"           => expires_at&.to_i,
           "signing_key"          => signing_key,
           "refresh_token"        => refresh_token,
           "access_token"         => access_token,
           "id_token"             => id_token,
-          "extension_parameters" => extension_parameters
+          "extension_parameters" => extension_parameters,
+          "granted_scopes"       => granted_scopes
         )
       end
 
@@ -1020,19 +1054,22 @@ module Signet
           content_type = response.header[:content_type]
         end
 
-        return ::Signet::OAuth2.parse_credentials body, content_type if status == 200
-
         message = "  Server message:\n#{response.body.to_s.strip}" unless body.to_s.strip.empty?
+
         if [400, 401, 403].include? status
           message = "Authorization failed.#{message}"
           raise ::Signet::AuthorizationError.new message, response: response
         elsif status.to_s[0] == "5"
           message = "Remote server error.#{message}"
           raise ::Signet::RemoteServerError, message
-        else
+        elsif status != 200
           message = "Unexpected status code: #{response.status}.#{message}"
           raise ::Signet::UnexpectedStatusError, message
         end
+        # status == 200
+        parsed_response = ::Signet::OAuth2.parse_credentials body, content_type
+        parsed_response["granted_scopes"] = parsed_response.delete("scope") if parsed_response
+        parsed_response
       end
 
       def fetch_access_token! options = {}

data/lib/signet/version.rb

@@ -13,5 +13,5 @@
 #    limitations under the License.
 
 module Signet
-  VERSION = "0.17.0".freeze
+  VERSION = "0.18.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signet
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Bob Aman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Signet is an OAuth 1.0 / OAuth 2.0 implementation.