google-cloud-spanner 1.2.0 → 1.3.1

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

@@ -237,6 +237,8 @@ module Google
           validate_single_use_args! single_use
           ensure_service!
 
+          params, types = Convert.to_input_params_and_types params, types
+
           single_use_tx = single_use_transaction single_use
           results = nil
           @pool.with_session do |session|
@@ -245,7 +247,7 @@ module Google
           end
           results
         end
-        alias_method :query, :execute
+        alias query execute
 
         ##
         # Read rows from a database table, as a simple alternative to
@@ -349,6 +351,9 @@ module Google
           validate_single_use_args! single_use
           ensure_service!
 
+          columns = Array(columns).map(&:to_s)
+          keys = Convert.to_key_set keys
+
           single_use_tx = single_use_transaction single_use
           results = nil
           @pool.with_session do |session|
@@ -414,7 +419,7 @@ module Google
             session.upsert table, rows
           end
         end
-        alias_method :save, :upsert
+        alias save upsert
 
         ##
         # Inserts new rows in a table. If any of the rows already exist, the
@@ -654,7 +659,7 @@ module Google
         #   end
         #
         def commit &block
-          fail ArgumentError, "Must provide a block" unless block_given?
+          raise ArgumentError, "Must provide a block" unless block_given?
 
           @pool.with_session do |session|
             session.commit(&block)
@@ -721,10 +726,10 @@ module Google
         #     end
         #   end
         #
-        def transaction deadline: 120, &block
+        def transaction deadline: 120
           ensure_service!
           unless Thread.current[:transaction_id].nil?
-            fail "Nested transactions are not allowed"
+            raise "Nested transactions are not allowed"
           end
 
           deadline = validate_deadline deadline
@@ -734,7 +739,7 @@ module Google
           @pool.with_transaction do |tx|
             begin
               Thread.current[:transaction_id] = tx.transaction_id
-              block.call tx
+              yield tx
               commit_resp = @project.service.commit \
                 tx.session.path, tx.mutations, transaction_id: tx.transaction_id
               return Convert.timestamp_to_time commit_resp.commit_timestamp
@@ -751,7 +756,7 @@ module Google
               # Create new transaction on the session and retry the block
               tx = tx.session.create_transaction
               retry
-            rescue => err
+            rescue StandardError => err
               # Rollback transaction when handling unexpected error
               tx.session.rollback tx.transaction_id
               # Return nil if raised with rollback.
@@ -829,7 +834,7 @@ module Google
 
           ensure_service!
           unless Thread.current[:transaction_id].nil?
-            fail "Nested snapshots are not allowed"
+            raise "Nested snapshots are not allowed"
           end
 
           @pool.with_session do |session|
@@ -945,7 +950,8 @@ module Google
           ensure_service!
           grpc = @project.service.create_session \
             Admin::Database::V1::DatabaseAdminClient.database_path(
-              project_id, instance_id, database_id)
+              project_id, instance_id, database_id
+            )
           Session.from_grpc(grpc, @project.service)
         end
 
@@ -966,22 +972,22 @@ module Google
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless @project.service
+          raise "Must have active connection to service" unless @project.service
         end
 
         ##
         # Check for valid snapshot arguments
         def validate_single_use_args! opts
           return true if opts.nil? || opts.empty?
-          valid_keys = [:strong, :timestamp, :read_timestamp, :staleness,
-                        :exact_staleness, :bounded_timestamp,
-                        :min_read_timestamp, :bounded_staleness, :max_staleness]
+          valid_keys = %i[strong timestamp read_timestamp staleness
+                          exact_staleness bounded_timestamp
+                          min_read_timestamp bounded_staleness max_staleness]
           if opts.keys.count == 1 && valid_keys.include?(opts.keys.first)
             return true
           end
-          fail ArgumentError,
-               "Must provide only one of the following single_use values: " \
-               "#{valid_keys}"
+          raise ArgumentError,
+                "Must provide only one of the following single_use values: " \
+                "#{valid_keys}"
         end
 
         ##
@@ -1018,9 +1024,10 @@ module Google
           valid_args_count = [strong, timestamp, read_timestamp, staleness,
                               exact_staleness].compact.count
           return true if valid_args_count <= 1
-          fail ArgumentError,
-               "Can only provide one of the following arguments: " \
-               "(strong, timestamp, read_timestamp, staleness, exact_staleness)"
+          raise ArgumentError,
+                "Can only provide one of the following arguments: " \
+                "(strong, timestamp, read_timestamp, staleness, " \
+                "exact_staleness)"
         end
 
         def validate_deadline deadline
@@ -1050,7 +1057,7 @@ module Google
           end
           # No metadata? Try the inner error
           delay_from_aborted(err.cause)
-        rescue
+        rescue StandardError
           # Any error indicates the backoff should be handled elsewhere
           return nil
         end

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

@@ -105,7 +105,7 @@ module Google
           end
           rows
         end
-        alias_method :save, :upsert
+        alias save upsert
 
         ##
         # Inserts new rows in a table. If any of the rows already exist, the
@@ -308,7 +308,8 @@ module Google
           @mutations += [
             Google::Spanner::V1::Mutation.new(
               delete: Google::Spanner::V1::Mutation::Delete.new(
-                table: table, key_set: key_set(keys))
+                table: table, key_set: key_set(keys)
+              )
             )
           ]
           keys
@@ -326,14 +327,14 @@ module Google
           keys = [keys] unless keys.is_a? Array
           return Google::Spanner::V1::KeySet.new(all: true) if keys.empty?
           if keys_are_ranges? keys
-            keys = [keys] unless keys.is_a? Array
             key_ranges = keys.map do |r|
               Convert.to_key_range(r)
             end
             return Google::Spanner::V1::KeySet.new(ranges: key_ranges)
           end
-          key_list = Array(keys).map do |i|
-            Convert.raw_to_value(Array(i)).list_value
+          key_list = keys.map do |key|
+            key = [key] unless key.is_a? Array
+            Convert.raw_to_value(key).list_value
           end
           Google::Spanner::V1::KeySet.new keys: key_list
         end

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

@@ -258,6 +258,45 @@ module Google
 
             Google::Spanner::V1::KeyRange.new range_opts
           end
+
+          def to_key_set keys
+            return Google::Spanner::V1::KeySet.new(all: true) if keys.nil?
+            keys = [keys] unless keys.is_a? Array
+            return Google::Spanner::V1::KeySet.new(all: true) if keys.empty?
+
+            if keys_are_ranges? keys
+              key_ranges = keys.map { |r| to_key_range(r) }
+              return Google::Spanner::V1::KeySet.new(ranges: key_ranges)
+            end
+
+            key_list = keys.map do |key|
+              key = [key] unless key.is_a? Array
+              raw_to_value(key).list_value
+            end
+            Google::Spanner::V1::KeySet.new keys: key_list
+          end
+
+          def keys_are_ranges? keys
+            keys.each do |key|
+              return true if key.is_a? ::Range
+              return true if key.is_a? Google::Cloud::Spanner::Range
+            end
+            false
+          end
+
+          def to_input_params_and_types params, types
+            input_params = nil
+            input_param_types = nil
+            unless params.nil?
+              input_param_pairs = to_query_params params, types
+              input_params = Google::Protobuf::Struct.new \
+                fields: Hash[input_param_pairs.map { |k, v| [k, v.first] }]
+              input_param_types = Hash[
+                  input_param_pairs.map { |k, v| [k, v.last] }]
+            end
+
+            [input_params, input_param_types]
+          end
         end
 
         # rubocop:enable all

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

@@ -38,20 +38,20 @@ module Google
       #   spanner.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = %w(https://www.googleapis.com/auth/cloud-platform
-                   https://www.googleapis.com/auth/spanner.data)
-        PATH_ENV_VARS = %w(SPANNER_CREDENTIALS
+        SCOPE = %w[https://www.googleapis.com/auth/cloud-platform
+                   https://www.googleapis.com/auth/spanner.data].freeze
+        PATH_ENV_VARS = %w[SPANNER_CREDENTIALS
                            SPANNER_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS
                            GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(SPANNER_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[SPANNER_CREDENTIALS_JSON
                            SPANNER_KEYFILE_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -80,7 +80,7 @@ module Google
         # @return [Array<Object>] An array containing the values.
         #
         def values
-          keys.count.times.map { |i| self[i] }
+          Array.new(keys.count) { |i| self[i] }
         end
 
         ##
@@ -113,8 +113,8 @@ module Google
                                         @grpc_fields[key].type)
           end
           name_count = @grpc_fields.find_all { |f| f.name == String(key) }.count
-          return nil if name_count == 0
-          fail DuplicateNameError if name_count > 1
+          return nil if name_count.zero?
+          raise DuplicateNameError if name_count > 1
           index = @grpc_fields.find_index { |f| f.name == String(key) }
           Convert.value_to_raw(@grpc_values[index], @grpc_fields[index].type)
         end
@@ -148,7 +148,7 @@ module Google
         #   or indexes and corresponding values.
         #
         def to_h
-          fail DuplicateNameError if fields.duplicate_names?
+          raise DuplicateNameError if fields.duplicate_names?
           hashified_pairs = pairs.map do |key, value|
             if value.is_a? Data
               [key, value.to_h]
@@ -171,7 +171,7 @@ module Google
         def to_s
           named_values = pairs.map do |key, value|
             if key.is_a? Integer
-              "#{value.inspect}"
+              value.inspect
             else
               "(#{key})#{value.inspect}"
             end

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

@@ -48,7 +48,11 @@ module Google
       #   job.reload! # API call
       #   job.done? #=> true
       #
-      #   database = instance.database "my-new-database"
+      #   if job.error?
+      #     status = job.error
+      #   else
+      #     database = job.database
+      #   end
       #
       class Database
         ##
@@ -101,7 +105,7 @@ module Google
 
         ##
         # The database is still being created. Operations on the database may
-        # fail with `FAILED_PRECONDITION` in this state.
+        # raise with `FAILED_PRECONDITION` in this state.
         # @return [Boolean]
         def creating?
           state == :CREATING
@@ -260,7 +264,7 @@ module Google
           policy = Policy.from_grpc grpc
           return policy unless block_given?
           yield policy
-          self.policy = policy
+          update_policy policy
         end
 
         ##
@@ -290,14 +294,15 @@ module Google
         #
         #   policy.add "roles/owner", "user:owner@example.com"
         #
-        #   database.policy = policy # API call
+        #   database.update_policy policy # API call
         #
-        def policy= new_policy
+        def update_policy new_policy
           ensure_service!
           grpc = service.set_database_policy \
             instance_id, database_id, new_policy.to_grpc
           Policy.from_grpc grpc
         end
+        alias policy= update_policy
 
         ##
         # Tests the specified permissions against the [Cloud
@@ -361,12 +366,13 @@ module Google
         # @private Raise an error unless an active connection to the service is
         # available.
         def ensure_service!
-          fail "Must have active connection to service" unless service
+          raise "Must have active connection to service" unless service
         end
 
         def session_path instance_id, database_id, session_id
           V1::SpannerClient.session_path(
-            project_id, instance_id, database_id, session_id)
+            project_id, instance_id, database_id, session_id
+          )
         end
       end
     end

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

@@ -41,7 +41,12 @@ module Google
         #   job.done? #=> false
         #   job.reload! # API call
         #   job.done? #=> true
-        #   database = job.database
+        #
+        #   if job.error?
+        #     status = job.error
+        #   else
+        #     database = job.database
+        #   end
         #
         class Job
           ##
@@ -169,7 +174,7 @@ module Google
             @grpc.reload!
             self
           end
-          alias_method :refresh!, :reload!
+          alias refresh! reload!
 
           ##
           # Reloads the job until the operation is complete. The delay between

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

@@ -162,7 +162,7 @@ module Google
           ##
           # Raise an error unless an active service is available.
           def ensure_service!
-            fail "Must have active connection" unless @service
+            raise "Must have active connection" unless @service
           end
         end
       end

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

@@ -53,7 +53,7 @@ module Google
               @fields << field(type)
             end
           else
-            fail ArgumentError, "can only accept Array or Hash"
+            raise ArgumentError, "can only accept Array or Hash"
           end
         end
 
@@ -135,8 +135,8 @@ module Google
         def [] key
           return types[key] if key.is_a? Integer
           name_count = @fields.find_all { |f| f.name == String(key) }.count
-          return nil if name_count == 0
-          fail DuplicateNameError if name_count > 1
+          return nil if name_count.zero?
+          raise DuplicateNameError if name_count > 1
           index = @fields.find_index { |f| f.name == String(key) }
           types[index]
         end
@@ -151,7 +151,8 @@ module Google
         # @return [Array<Symbol>] An array containing the type codes.
         #
         def to_a
-          keys.count.times.map { |i| self[i] }.map do |field|
+          Array.new(keys.count) do |i|
+            field = self[i]
             if field.is_a? Fields
               field.to_h
             elsif field.is_a? Array
@@ -169,7 +170,7 @@ module Google
         #   or indexes and corresponding types.
         #
         def to_h
-          fail DuplicateNameError if duplicate_names?
+          raise DuplicateNameError if duplicate_names?
           hashified_pairs = pairs.map do |key, value|
             if value.is_a? Fields
               [key, value.to_h]
@@ -189,7 +190,7 @@ module Google
           values = data.map { |datum| Convert.raw_to_value datum }
           Data.from_grpc values, @fields
         end
-        alias_method :new, :data
+        alias new data
 
         # @private
         def == other
@@ -201,7 +202,7 @@ module Google
         def to_s
           named_types = pairs.map do |key, type|
             if key.is_a? Integer
-              "#{type.inspect}"
+              type.inspect
             else
               "(#{key})#{type.inspect}"
             end
@@ -228,22 +229,25 @@ module Google
         def field pair
           if pair.is_a?(Array)
             unless pair.count == 2
-              fail ArgumentError, "can only accept pairs of name and type"
+              raise ArgumentError, "can only accept pairs of name and type"
             end
             if pair.first.nil? || pair.first.is_a?(Integer)
               Google::Spanner::V1::StructType::Field.new(
-                type: Google::Spanner::V1::Type.new(code: pair.last))
+                type: Google::Spanner::V1::Type.new(code: pair.last)
+              )
             else
               Google::Spanner::V1::StructType::Field.new(
                 name: String(pair.first),
-                type: Google::Spanner::V1::Type.new(code: pair.last))
+                type: Google::Spanner::V1::Type.new(code: pair.last)
+              )
             end
           else
             unless pair.is_a?(Symbol)
-              fail ArgumentError, "type must be a symbol"
+              raise ArgumentError, "type must be a symbol"
             end
             Google::Spanner::V1::StructType::Field.new(
-              type: Google::Spanner::V1::Type.new(code: pair))
+              type: Google::Spanner::V1::Type.new(code: pair)
+            )
           end
         end
       end