google-cloud-errors 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecb2a90065a61c805f861e3ee7051f1b3bbae3d32cbe1b3b54a65d17e57f3da4
-  data.tar.gz: fb7394742b7b4180dc1ffe63ce9eab30dcd38134cd3b2270125b895bff633b24
+  metadata.gz: 0ab6400a7d633ba4c9bb30de49bc2b23a5824530fa02a1f88aa151ff328487ab
+  data.tar.gz: 77459bb92f7408eb68b9d02ed6b96cd4d3f183d213c27b1eac36086129957424
 SHA512:
-  metadata.gz: 77e99f727829447b3d77c0ba84bda03671cf5fdab416b9642c2c7ddd0af3c6e8aaf7c81222c03c256dbb524b63598feeada385fc0c7df230cd0a0c81298d1bfe
-  data.tar.gz: 237610df70af008e064b4b39554831d8e3edd806f31d6535fdee6b4f53aeb8a342296efecde7f7da76a41133d5b09c757fa946dfbc5e090a50de7716241d3b62
+  metadata.gz: f9cbd068fecd4fa411fd008bc519460366900be46f774ead0c5e92b399f46c8ec1f9cf02e2971dafdc86106f177e48073720faf2a6135c09f8bc80bf8eded0e6
+  data.tar.gz: 5f54fe580d61ce5e0d1b80b13a461e3d299c888e770646328df796e662093c0e1a1cfae1996a3b5c91307673e372400f267caa0d0bb54c67c5d1fbdb51947b10

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud requires Ruby 2.5+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).
@@ -45,7 +45,7 @@ there is a small amount of setup:
 
    ```sh
    $ cd google-cloud-errors/
-   $ bundle exec rake bundleupdate
+   $ bundle install
    ```
 
 ## Google Cloud Tests
@@ -124,5 +124,4 @@ $ bundle exec rake rubocop
 ## Code of Conduct
 
 Please note that this project is released with a Contributor Code of Conduct. By
-participating in this project you agree to abide by its terms. See
-{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
+participating in this project you agree to abide by its terms. See {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/README.md

@@ -9,11 +9,11 @@ information about Google Cloud gems.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.4+.
+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.4 and
+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/lib/google/cloud/errors/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Errors
-      VERSION = "1.0.1".freeze
+      VERSION = "1.3.0".freeze
     end
   end
 end

data/lib/google/cloud/errors.rb

@@ -23,6 +23,8 @@ module Google
       ##
       # Construct a new Google::Cloud::Error object, optionally passing in a
       # message.
+      #
+      # @param msg [String, nil] an error message
       def initialize msg = nil
         super
       end
@@ -36,7 +38,7 @@ module Google
       #
       # @return [Object, nil]
       def status_code
-        return nil unless cause&.respond_to? :status_code
+        return nil unless cause.respond_to? :status_code
         cause.status_code
       end
 
@@ -49,7 +51,7 @@ module Google
       #
       # @return [Object, nil]
       def body
-        return nil unless cause&.respond_to? :body
+        return nil unless cause.respond_to? :body
         cause.body
       end
 
@@ -62,7 +64,7 @@ module Google
       #
       # @return [Object, nil]
       def header
-        return nil unless cause&.respond_to? :header
+        return nil unless cause.respond_to? :header
         cause.header
       end
 
@@ -75,7 +77,7 @@ module Google
       #
       # @return [Object, nil]
       def code
-        return nil unless cause&.respond_to? :code
+        return nil unless cause.respond_to? :code
         cause.code
       end
 
@@ -88,7 +90,7 @@ module Google
       #
       # @return [Object, nil]
       def details
-        return nil unless cause&.respond_to? :details
+        return nil unless cause.respond_to? :details
         cause.details
       end
 
@@ -101,7 +103,7 @@ module Google
       #
       # @return [Object, nil]
       def metadata
-        return nil unless cause&.respond_to? :metadata
+        return nil unless cause.respond_to? :metadata
         cause.metadata
       end
 
@@ -114,10 +116,72 @@ module Google
       #
       # @return [Object, nil]
       def status_details
-        return nil unless cause&.respond_to? :status_details
+        return nil unless cause.respond_to? :status_details
         cause.status_details
       end
 
+      ##
+      # Returns the `::Google::Rpc::ErrorInfo` object present in the `status_details`
+      # or `details` array, given that the following is true:
+      #   * either `status_details` or `details` exists and is an array
+      #   * there is exactly one `::Google::Rpc::ErrorInfo` object in that array.
+      # Looks in `status_details` first, then in `details`.
+      #
+      # @return [::Google::Rpc::ErrorInfo, nil]
+      def error_info
+        @error_info ||= begin
+          check_property = lambda do |prop|
+            if prop.is_a? Array
+              error_infos = prop.find_all { |status| status.is_a?(::Google::Rpc::ErrorInfo) }
+              if error_infos.length == 1
+                error_infos[0]
+              end
+            end
+          end
+
+          check_property.call(status_details) || check_property.call(details)
+        end
+      end
+
+      ##
+      # Returns the value of `domain` from the `::Google::Rpc::ErrorInfo`
+      # object, if it exists in the `status_details` array.
+      #
+      # This is typically present on errors originating from calls to an API
+      # over gRPC.
+      #
+      # @return [Object, nil]
+      def domain
+        return nil unless error_info.respond_to? :domain
+        error_info.domain
+      end
+
+      ##
+      # Returns the value of `reason` from the `::Google::Rpc::ErrorInfo`
+      # object, if it exists in the `status_details` array.
+      #
+      # This is typically present on errors originating from calls to an API
+      # over gRPC.
+      #
+      # @return [Object, nil]
+      def reason
+        return nil unless error_info.respond_to? :reason
+        error_info.reason
+      end
+
+      ##
+      # Returns the value of `metadata` from the `::Google::Rpc::ErrorInfo`
+      # object, if it exists in the `status_details` array.
+      #
+      # This is typically present on errors originating from calls to an API
+      # over gRPC.
+      #
+      # @return [Hash, nil]
+      def error_metadata
+        return nil unless error_info.respond_to? :metadata
+        error_info.metadata.to_h
+      end
+
       # @private Create a new error object from a client error
       def self.from_error error
         klass = if error.respond_to? :code
@@ -217,12 +281,6 @@ module Google
     class PermissionDeniedError < Error
     end
 
-    ##
-    # Unauthenticated indicates the request does not have valid
-    # authentication credentials for the operation.
-    class UnauthenticatedError < Error
-    end
-
     ##
     # ResourceExhausted indicates some resource has been exhausted, perhaps
     # a per-user quota, or perhaps the entire file system is out of space.
@@ -308,5 +366,11 @@ module Google
     # DataLoss indicates unrecoverable data loss or corruption.
     class DataLossError < Error
     end
+
+    ##
+    # Unauthenticated indicates the request does not have valid
+    # authentication credentials for the operation.
+    class UnauthenticatedError < Error
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-errors
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autotest-suffix
@@ -31,28 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -179,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Error classes for google-cloud-ruby