googleauth-extras 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56aa20519132423c5f99a9c67fb011bdf44d575ccb60d7109abd0f2f6db17a09
-  data.tar.gz: 6d63aaa0d4dce0256ee828233640f951af9a203a9bf56dc46640ad2994fbe05a
+  metadata.gz: 29ad90b986d4915e183e4592f58eedff84badd6ee70900337981d3173f0c64b2
+  data.tar.gz: 0c69256ea700526a9891d9434338954fec778d99b6f3c927654739dd690f03dd
 SHA512:
-  metadata.gz: a8c1978e55c6d63353823bf771c49c6c94266963774c2db5b9eef32d23f625f5762b08f30e773f71ef897bf53f07840f9e039a5dada27bc6bf7427b17667e3c1
-  data.tar.gz: 78b376acc7c4bfd48b0be54127761a4ef40ec02c28029e0de2d90526116a41f43d8cfe7029b5e877480c582fc9bb46b401f3aa2b8520bc8ce8668a866e523065
+  metadata.gz: 9b3de1122f1a208f337134b30023fef63eb171c5ad3c888a8cc0cb81bc72aa5ae0d476f1c22ff659d4ce4637795ffff5ae1a5e07eee64dd68f9a5f887e9f02bb
+  data.tar.gz: 7eb79ba62b30a7b7a5cc2bab1d00f1079d19f57fd99df98ad52fec2d46d5e77eae781ddb50960c1832e77462e6b2e9d4c729e860db25610b2014432df6505f0d

data/.rubocop.yml

@@ -49,6 +49,9 @@ RSpec/MultipleMemoizedHelpers:
 RSpec/NamedSubject:
   Enabled: false
 
+RSpec/NestedGroups:
+  Max: 5
+
 Style/ModuleFunction:
   EnforcedStyle: extend_self
 

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History
 
+0.4.0
+----------
+
+- Support setting a quota project. ([#11](https://github.com/persona-id/googleauth-extras/pull/11))
+
+- Update gemspec for new RuboCop settings. ([#12](https://github.com/persona-id/googleauth-extras/pull/12))
+
 0.3.0
 -----
 

data/googleauth-extras.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'addressable', '~> 2.8'
-  spec.add_runtime_dependency 'faraday', '>= 1.0', '< 3.0'
-  spec.add_runtime_dependency 'google-apis-iamcredentials_v1'
-  spec.add_runtime_dependency 'googleauth', '~> 1.3'
-  spec.add_runtime_dependency 'signet', '>= 0.17.0', '< 0.19.0'
+  spec.add_dependency 'addressable', '~> 2.8'
+  spec.add_dependency 'faraday', '>= 1.0', '< 3.0'
+  spec.add_dependency 'google-apis-iamcredentials_v1'
+  spec.add_dependency 'googleauth', '~> 1.3'
+  spec.add_dependency 'signet', '>= 0.17.0', '< 0.19.0'
 end

data/lib/google/auth/extras/impersonated_credential.rb

@@ -7,6 +7,8 @@ module Google
       class ImpersonatedCredential < Signet::OAuth2::Client
         include IdentityCredentialRefreshPatch
 
+        attr_reader :quota_project_id
+
         # A credential that impersonates a service account.
         #
         # The `email_address` of the service account to impersonate may be the exact
@@ -36,6 +38,10 @@ module Google
         #   additional API call.
         #   Only supported when not using a target_audience.
         #
+        # @param quota_project_id [String]
+        #   The project ID used for quota and billing. This project may be different from
+        #   the project used to create the credentials.
+        #
         # @param scope [String, Array<String>]
         #   The OAuth 2 scopes to request. Can either be formatted as a comma seperated string or array.
         #   Only supported when not using a target_audience.
@@ -54,6 +60,7 @@ module Google
           delegate_email_addresses: nil,
           include_email: nil,
           lifetime: nil,
+          quota_project_id: nil,
           scope: nil,
           target_audience: nil
         )
@@ -90,6 +97,8 @@ module Google
           end
 
           @impersonate_name = transform_email_to_name(email_address)
+
+          @quota_project_id = quota_project_id
         end
 
         def fetch_access_token(*)
@@ -135,6 +144,7 @@ module Google
               " @impersonate_delegates=#{@impersonate_delegates.inspect}" \
               " @impersonate_include_email=#{@impersonate_include_email.inspect}" \
               " @impersonate_name=#{@impersonate_name.inspect}" \
+              " @quota_project_id=#{@quota_project_id.inspect}" \
               " @target_audience=#{@target_audience.inspect}" \
               '>'
           else
@@ -144,6 +154,7 @@ module Google
               " @impersonate_delegates=#{@impersonate_delegates.inspect}" \
               " @impersonate_lifetime=#{@impersonate_lifetime.inspect}" \
               " @impersonate_name=#{@impersonate_name.inspect}" \
+              " @quota_project_id=#{@quota_project_id.inspect}" \
               '>'
           end
         end

data/lib/google/auth/extras/static_credential.rb

@@ -7,17 +7,25 @@ module Google
       class StaticCredential < Signet::OAuth2::Client
         class AuthorizationExpired < StandardError; end
 
+        attr_reader :quota_project_id
+
         # A credential using a static access token.
         #
         # @param access_token [String]
         #   The access token to use.
         #
-        def initialize(access_token:)
+        # @param quota_project_id [String]
+        #   The project ID used for quota and billing. This project may be different from
+        #   the project used to create the credentials.
+        #
+        def initialize(access_token:, quota_project_id: nil)
           super(
             access_token: access_token,
             expires_at: TokenInfo.lookup_access_token(access_token).fetch('exp'),
             issued_at: nil,
           )
+
+          @quota_project_id = quota_project_id
         end
 
         def fetch_access_token(*)
@@ -28,7 +36,11 @@ module Google
         end
 
         def inspect
-          "#<#{self.class.name} @access_token=[REDACTED] @expires_at=#{expires_at.inspect}>"
+          "#<#{self.class.name}" \
+            ' @access_token=[REDACTED]' \
+            " @expires_at=#{expires_at.inspect}" \
+            " @quota_project_id=#{@quota_project_id.inspect}" \
+            '>'
         end
       end
     end

data/lib/google/auth/extras/version.rb

@@ -3,7 +3,7 @@
 module Google
   module Auth
     module Extras
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

data/lib/google/auth/extras.rb

@@ -50,6 +50,10 @@ module Google
       #   additional API call.
       #   Only supported when not using a target_audience.
       #
+      # @param quota_project_id [String]
+      #   The project ID used for quota and billing. This project may be different from
+      #   the project used to create the credentials.
+      #
       # @param scope [String, Array<String>]
       #   The OAuth 2 scopes to request. Can either be formatted as a comma seperated string or array.
       #   Only supported when not using a target_audience.
@@ -67,6 +71,7 @@ module Google
         delegate_email_addresses: nil,
         include_email: nil,
         lifetime: nil,
+        quota_project_id: nil,
         scope: nil,
         target_audience: nil
       )
@@ -76,6 +81,7 @@ module Google
           email_address: email_address,
           include_email: include_email,
           lifetime: lifetime,
+          quota_project_id: quota_project_id,
           scope: scope,
           target_audience: target_audience,
         )
@@ -106,6 +112,10 @@ module Google
       #   additional API call.
       #   Only supported when not using a target_audience.
       #
+      # @param quota_project_id [String]
+      #   The project ID used for quota and billing. This project may be different from
+      #   the project used to create the credentials.
+      #
       # @param scope [String, Array<String>]
       #   The OAuth 2 scopes to request. Can either be formatted as a comma seperated string or array.
       #   Only supported when not using a target_audience.
@@ -123,6 +133,7 @@ module Google
         delegate_email_addresses: nil,
         include_email: nil,
         lifetime: nil,
+        quota_project_id: nil,
         scope: nil,
         target_audience: nil
       )
@@ -133,6 +144,7 @@ module Google
             email_address: email_address,
             include_email: include_email,
             lifetime: lifetime,
+            quota_project_id: quota_project_id,
             scope: scope,
             target_audience: target_audience,
           ),
@@ -145,10 +157,15 @@ module Google
       # @param token [String]
       #   The access token to use.
       #
+      # @param quota_project_id [String]
+      #   The project ID used for quota and billing. This project may be different from
+      #   the project used to create the credentials.
+      #
+      #
       # @return [Google::Auth::Extras::StaticCredential]
       #
-      def static_authorization(token)
-        StaticCredential.new(access_token: token)
+      def static_authorization(token, quota_project_id: nil)
+        StaticCredential.new(access_token: token, quota_project_id: quota_project_id)
       end
 
       # A credential using a static access token. For usage with the newer
@@ -157,10 +174,14 @@ module Google
       # @param token [String]
       #   The access token to use.
       #
+      # @param quota_project_id [String]
+      #   The project ID used for quota and billing. This project may be different from
+      #   the project used to create the credentials.
+      #
       # @return [Google::Auth::Credential<Google::Auth::Extras::StaticCredential>]
       #
-      def static_credential(token)
-        wrap_authorization(static_authorization(token))
+      def static_credential(token, quota_project_id: nil)
+        wrap_authorization(static_authorization(token, quota_project_id: quota_project_id))
       end
 
       # Take an authorization and turn it into a credential, primarily used

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googleauth-extras
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Persona Identities
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable