google-cloud-spanner 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d52caffdd789f039f91609da3f8dba633459c82
-  data.tar.gz: ecc7cca28368c261123342f43e9b055f13c22d70
+  metadata.gz: 58a2867ec67cc68fb7e895762160e57037f00ca5
+  data.tar.gz: 12452e56b67a6c1aab33dc22c82367524ab9bf5b
 SHA512:
-  metadata.gz: cfd38cc3172d32788a6891d78e44e349b8410c23285bcaa2bd79b582a58a48ce167f45251fec7ceff4df44b8f9fc6484f83d4feb7d744958ca6d8c99b1f2d457
-  data.tar.gz: 41f84f6f1432833bc79ca731f8b99d29ea6edd70bc71ebdc6b34afe7a7b16f0b1709968d2d358aee5ba6df91f052cd6324a53590a6d7c5d8d73e544b42f5b9df
+  metadata.gz: 7aed04532cb3a027b83ee3f07ea5da86a0fa6915b384af19b716b670bd0ce0f09daa4e2a7c8fb14143f2ffda229d3f16bfd89f65e78711eacb5c5d6c0f99e2ba
+  data.tar.gz: 2ba0d3b5c978d323f4ceebcb7355d28ce013f120a209c8caae4733238fb0a1492b8615dbd573e96857fa3e01f0eee363647b49deab374431b74d49b52dbe550e

data/lib/google/cloud/spanner/database/job.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "google/cloud/spanner/status"
 
 module Google
   module Cloud
@@ -121,6 +122,30 @@ module Google
             @grpc.error?
           end
 
+          ##
+          # The status if the operation associated with this job produced an
+          # error.
+          #
+          # @return [Google::Cloud::Spanner::Status, nil] A status object with
+          #   the status code and message, or `nil` if no error occurred.
+          #
+          # @example
+          #   require "google/cloud/spanner"
+          #
+          #   spanner = Google::Cloud::Spanner.new
+          #
+          #   job = spanner.create_database "my-instance",
+          #                                 "my-new-database"
+          #
+          #   job.error? # true
+          #
+          #   error = job.error
+          #
+          def error
+            return nil unless error?
+            Google::Cloud::Spanner::Status.from_grpc @grpc.error
+          end
+
           ##
           # Reloads the job with current data from the long-running,
           # asynchronous processing of a database operation.

data/lib/google/cloud/spanner/instance/job.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "google/cloud/spanner/status"
 
 module Google
   module Cloud
@@ -133,6 +134,33 @@ module Google
             @grpc.error?
           end
 
+          ##
+          # The status if the operation associated with this job produced an
+          # error.
+          #
+          # @return [Google::Cloud::Spanner::Status, nil] A status object with
+          #   the status code and message, or `nil` if no error occurred.
+          #
+          # @example
+          #   require "google/cloud/spanner"
+          #
+          #   spanner = Google::Cloud::Spanner.new
+          #
+          #   job = spanner.create_instance "my-new-instance",
+          #                                 name: "My New Instance",
+          #                                 config: "regional-us-central1",
+          #                                 nodes: 5,
+          #                                 labels: { production: :env }
+          #
+          #   job.error? # true
+          #
+          #   error = job.error
+          #
+          def error
+            return nil unless error?
+            Google::Cloud::Spanner::Status.from_grpc @grpc.error
+          end
+
           ##
           # Reloads the job with current data from the long-running,
           # asynchronous processing of an instance operation.

data/lib/google/cloud/spanner/status.rb

@@ -0,0 +1,81 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/spanner/errors"
+
+module Google
+  module Cloud
+    module Spanner
+      ##
+      # # Status
+      #
+      # Represents a logical error model from the Spanner service, containing an
+      # error code, an error message, and optional error details.
+      #
+      # @attr [Integer] code The status code, which should be an enum value of
+      #   [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto).
+      # @attr [String] description The human-readable description for the status
+      #   code, which should be an enum value of
+      #   [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto).
+      #   For example, `INVALID_ARGUMENT`.
+      # @attr [String] message A developer-facing error message, which should be
+      #   in English.
+      # @attr [Array, nil] details A list of messages that carry the error
+      #   details.
+      #
+      # @example
+      #   require "google/cloud/spanner"
+      #
+      #   spanner = Google::Cloud::Spanner.new
+      #
+      #   job = spanner.create_database "my-instance",
+      #                                 "my-new-database"
+      #
+      #   job.error? # true
+      #
+      #   status = job.error
+      #
+      class Status
+        attr_reader :code, :description, :message, :details
+
+        ##
+        # @private Creates a Status object.
+        def initialize code, description, message, details
+          @code = code
+          @description = description
+          @message = message
+          @details = details
+        end
+
+        ##
+        # @private New Status from a Google::Rpc::Status object.
+        def self.from_grpc grpc
+          new grpc.code, description_for(grpc.code), grpc.message, grpc.details
+        end
+
+        # @private Get a descriptive symbol for a google.rpc.Code integer
+        def self.description_for code
+          descriptions = %w(
+            OK CANCELLED UNKNOWN INVALID_ARGUMENT DEADLINE_EXCEEDED NOT_FOUND
+            ALREADY_EXISTS PERMISSION_DENIED RESOURCE_EXHAUSTED
+            FAILED_PRECONDITION ABORTED OUT_OF_RANGE UNIMPLEMENTED INTERNAL
+            UNAVAILABLE DATA_LOSS UNAUTHENTICATED
+          )
+          descriptions[code]
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "0.22.0"
+      VERSION = "0.23.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -256,6 +256,7 @@ files:
 - lib/google/cloud/spanner/service.rb
 - lib/google/cloud/spanner/session.rb
 - lib/google/cloud/spanner/snapshot.rb
+- lib/google/cloud/spanner/status.rb
 - lib/google/cloud/spanner/transaction.rb
 - lib/google/cloud/spanner/v1.rb
 - lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb