google-cloud-firestore 0.24.2 → 0.25.0

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1beta1/credentials"
+require "google/cloud/firestore/v1/credentials"
 
 module Google
   module Cloud
@@ -37,7 +37,7 @@ module Google
       #
       #   firestore.project_id #=> "my-project"
       #
-      class Credentials < Google::Cloud::Firestore::V1beta1::Credentials
+      class Credentials < Google::Cloud::Firestore::V1::Credentials
       end
     end
   end

data/lib/google/cloud/firestore/document_reference.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1beta1"
+require "google/cloud/firestore/v1"
 require "google/cloud/firestore/document_snapshot"
 require "google/cloud/firestore/collection_reference"
 require "google/cloud/firestore/document_listener"
@@ -97,6 +97,7 @@ module Google
           collection_ids.each { |collection_id| yield col(collection_id) }
         end
         alias collections cols
+        alias list_collections cols
 
         ##
         # Retrieves a collection nested under the document snapshot.

data/lib/google/cloud/firestore/document_snapshot.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1beta1"
+require "google/cloud/firestore/v1"
 require "google/cloud/firestore/document_reference"
 require "google/cloud/firestore/collection_reference"
 require "google/cloud/firestore/convert"
@@ -62,7 +62,7 @@ module Google
       #
       class DocumentSnapshot
         ##
-        # @private The Google::Firestore::V1beta1::Document object.
+        # @private The Google::Firestore::V1::Document object.
         attr_accessor :grpc
 
         ##
@@ -345,7 +345,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1beta1::RunQueryResponse object.
+        # Google::Firestore::V1::RunQueryResponse object.
         def self.from_query_result result, client
           ref = DocumentReference.from_path result.document.name, client
           read_at = Convert.timestamp_to_time result.read_time
@@ -359,7 +359,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1beta1::DocumentChange object.
+        # Google::Firestore::V1::DocumentChange object.
         def self.from_document document, client, read_at: nil
           ref = DocumentReference.from_path document.name, client
 
@@ -372,7 +372,7 @@ module Google
 
         ##
         # @private New DocumentSnapshot from a
-        # Google::Firestore::V1beta1::BatchGetDocumentsResponse object.
+        # Google::Firestore::V1::BatchGetDocumentsResponse object.
         def self.from_batch_result result, client
           ref = nil
           grpc = nil

data/lib/google/cloud/firestore/field_path.rb

@@ -208,8 +208,8 @@ module Google
 
         protected
 
-        START_FIELD_PATH_CHARS = /\A[a-zA-Z_]/
-        INVALID_FIELD_PATH_CHARS = %r{[\~\*\/\[\]]}
+        START_FIELD_PATH_CHARS = /\A[a-zA-Z_]/.freeze
+        INVALID_FIELD_PATH_CHARS = %r{[\~\*\/\[\]]}.freeze
 
         def escape_field_for_path field
           field = String field

data/lib/google/cloud/firestore/field_value.rb

@@ -35,9 +35,9 @@ module Google
         ##
         # @private Creates a field value object representing changes made to
         # fields in document data.
-        def initialize type, values = nil
+        def initialize type, value = nil
           @type = type
-          @values = values
+          @value = value
         end
 
         ##
@@ -65,10 +65,10 @@ module Google
 
         ##
         # @private
-        # The values to change to an individual field in document data,
-        # depending on the type of change.
+        # The value to change to an individual field in document data, depending
+        # on the type of change.
         #
-        # @return [Array<Object>] The values.
+        # @return [Object] The value.
         #
         # @example
         #   require "google/cloud/firestore"
@@ -82,13 +82,13 @@ module Google
         #     1, 2, 3
         #   )
         #   array_union.type #=> :array_union
-        #   array_union.values #=> [1, 2, 3]
+        #   array_union.value #=> [1, 2, 3]
         #
         #   nyc_ref.update({ name: "New York City",
         #                    lucky_numbers: array_union })
         #
-        def values
-          @values
+        def value
+          @value
         end
 
         ##
@@ -138,7 +138,7 @@ module Google
         end
 
         ##
-        # Creates a sentinel value to indicate the union of the given values
+        # Creates a sentinel value to indicate the union of the given value
         # with an array.
         #
         # @param [Object] values The values to add to the array. Required.
@@ -202,6 +202,136 @@ module Google
 
           new :array_delete, values
         end
+
+        ##
+        # Creates a sentinel value to indicate the addition the given value to
+        # the field's current value.
+        #
+        # If the field's current value is not an integer or a double value
+        # (Numeric), or if the field does not yet exist, the transformation will
+        # set the field to the given value. If either of the given value or the
+        # current field value are doubles, both values will be interpreted as
+        # doubles. Double arithmetic and representation of double values follow
+        # IEEE 754 semantics. If there is positive/negative integer overflow,
+        # the field is resolved to the largest magnitude positive/negative
+        # integer.
+        #
+        # @param [Numeric] value The value to add to the given value. Required.
+        #
+        # @return [FieldValue] The increment field value object.
+        #
+        # @raise [ArgumentError] if the value is not an Integer or Numeric.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a document reference
+        #   nyc_ref = firestore.doc "cities/NYC"
+        #
+        #   # Set the population to increment by 1.
+        #   increment_value = Google::Cloud::Firestore::FieldValue.increment 1
+        #
+        #   nyc_ref.update({ name: "New York City",
+        #                    population: increment_value })
+        #
+        def self.increment value
+          # verify the values are the correct types
+          unless value.is_a? Numeric
+            raise ArgumentError, "value must be a Numeric"
+          end
+
+          new :increment, value
+        end
+
+        ##
+        # Creates a sentinel value to indicate the setting the field to the
+        # maximum of its current value and the given value.
+        #
+        # If the field is not an integer or double (Numeric), or if the field
+        # does not yet exist, the transformation will set the field to the given
+        # value. If a maximum operation is applied where the field and the input
+        # value are of mixed types (that is - one is an integer and one is a
+        # double) the field takes on the type of the larger operand. If the
+        # operands are equivalent (e.g. 3 and 3.0), the field does not change.
+        # 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and
+        # zero input value is always the stored value. The maximum of any
+        # numeric value x and NaN is NaN.
+        #
+        # @param [Numeric] value The value to compare against the given value to
+        #   calculate the maximum value to set. Required.
+        #
+        # @return [FieldValue] The maximum field value object.
+        #
+        # @raise [ArgumentError] if the value is not an Integer or Numeric.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a document reference
+        #   nyc_ref = firestore.doc "cities/NYC"
+        #
+        #   # Set the population to be at maximum 4,000,000.
+        #   maximum_value = Google::Cloud::Firestore::FieldValue.maximum 4000000
+        #
+        #   nyc_ref.update({ name: "New York City",
+        #                    population: maximum_value })
+        #
+        def self.maximum value
+          # verify the values are the correct types
+          unless value.is_a? Numeric
+            raise ArgumentError, "value must be a Numeric"
+          end
+
+          new :maximum, value
+        end
+
+        ##
+        # Creates a sentinel value to indicate the setting the field to the
+        # minimum of its current value and the given value.
+        #
+        # If the field is not an integer or double (Numeric), or if the field
+        # does not yet exist, the transformation will set the field to the input
+        # value. If a minimum operation is applied where the field and the input
+        # value are of mixed types (that is - one is an integer and one is a
+        # double) the field takes on the type of the smaller operand. If the
+        # operands are equivalent (e.g. 3 and 3.0), the field does not change.
+        # 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and
+        # zero input value is always the stored value. The minimum of any
+        # numeric value x and NaN is NaN.
+        #
+        # @param [Numeric] value The value to compare against the given value to
+        #   calculate the minimum value to set. Required.
+        #
+        # @return [FieldValue] The minimum field value object.
+        #
+        # @raise [ArgumentError] if the value is not an Integer or Numeric.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Get a document reference
+        #   nyc_ref = firestore.doc "cities/NYC"
+        #
+        #   # Set the population to be at minimum 1,000,000.
+        #   minimum_value = Google::Cloud::Firestore::FieldValue.minimum 1000000
+        #
+        #   nyc_ref.update({ name: "New York City",
+        #                    population: minimum_value })
+        #
+        def self.minimum value
+          # verify the values are the correct types
+          unless value.is_a? Numeric
+            raise ArgumentError, "value must be a Numeric"
+          end
+
+          new :minimum, value
+        end
       end
     end
   end

data/lib/google/cloud/firestore/query.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1beta1"
+require "google/cloud/firestore/v1"
 require "google/cloud/firestore/document_snapshot"
 require "google/cloud/firestore/query_listener"
 require "google/cloud/firestore/convert"
@@ -63,7 +63,7 @@ module Google
         attr_accessor :parent_path
 
         ##
-        # @private The Google::Firestore::V1beta1::Query object.
+        # @private The Google::Firestore::V1::Query object.
         attr_accessor :query
 
         ##
@@ -309,7 +309,7 @@ module Google
           field = FieldPath.parse field unless field.is_a? FieldPath
 
           new_query.order_by << StructuredQuery::Order.new(
-            field: StructuredQuery::FieldReference.new(
+            field:     StructuredQuery::FieldReference.new(
               field_path: field.formatted_string
             ),
             direction: order_direction(direction)
@@ -883,7 +883,7 @@ module Google
 
         ##
         # @private
-        StructuredQuery = Google::Firestore::V1beta1::StructuredQuery
+        StructuredQuery = Google::Firestore::V1::StructuredQuery
 
         ##
         # @private
@@ -949,19 +949,25 @@ module Google
 
             operator = value_nan?(value) ? :IS_NAN : :IS_NULL
 
-            return StructuredQuery::Filter.new(unary_filter:
-              StructuredQuery::UnaryFilter.new(field: field, op: operator))
+            return StructuredQuery::Filter.new(
+              unary_filter: StructuredQuery::UnaryFilter.new(
+                field: field, op: operator
+              )
+            )
           end
 
           value = Convert.raw_to_value value
-          StructuredQuery::Filter.new(field_filter:
-              StructuredQuery::FieldFilter.new(field: field, op: operator,
-                                               value: value))
+          StructuredQuery::Filter.new(
+            field_filter: StructuredQuery::FieldFilter.new(
+              field: field, op: operator, value: value
+            )
+          )
         end
 
         def composite_filter
-          StructuredQuery::Filter.new(composite_filter:
-              StructuredQuery::CompositeFilter.new(op: :AND))
+          StructuredQuery::Filter.new(
+            composite_filter: StructuredQuery::CompositeFilter.new(op: :AND)
+          )
         end
 
         def add_filters_to_query query, filter
@@ -1005,7 +1011,7 @@ module Google
             Convert.raw_to_value value
           end
 
-          Google::Firestore::V1beta1::Cursor.new values: values
+          Google::Firestore::V1::Cursor.new values: values
         end
 
         def snapshot_to_cursor snapshot, query
@@ -1035,11 +1041,11 @@ module Google
           inequality_paths = inequality_filter_field_paths query
           orig_order = order_by_field_paths query
 
-          inequality_paths.reverse.each do |field_path|
+          inequality_paths.reverse_each do |field_path|
             next if orig_order.include? field_path
 
             query.order_by.unshift StructuredQuery::Order.new(
-              field: StructuredQuery::FieldReference.new(
+              field:     StructuredQuery::FieldReference.new(
                 field_path: field_path
               ),
               direction: :ASCENDING
@@ -1051,7 +1057,7 @@ module Google
           return if order_by_field_paths(query).include? doc_id_path
 
           query.order_by.push StructuredQuery::Order.new(
-            field: StructuredQuery::FieldReference.new(
+            field:     StructuredQuery::FieldReference.new(
               field_path: doc_id_path
             ),
             direction: last_order_direction(query)

data/lib/google/cloud/firestore/query_snapshot.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "google/cloud/firestore/v1beta1"
+require "google/cloud/firestore/v1"
 require "google/cloud/firestore/document_reference"
 require "google/cloud/firestore/collection_reference"
 require "google/cloud/firestore/convert"

data/lib/google/cloud/firestore/service.rb

@@ -17,7 +17,7 @@ require "google/cloud/env"
 require "google/cloud/errors"
 require "google/cloud/firestore/credentials"
 require "google/cloud/firestore/version"
-require "google/cloud/firestore/v1beta1"
+require "google/cloud/firestore/v1"
 
 module Google
   module Cloud
@@ -26,28 +26,46 @@ module Google
       # @private Represents the gRPC Firestore service, including all the API
       # methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :client_config
+        attr_accessor :project, :credentials, :timeout, :client_config, :host
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, timeout: nil, client_config: nil
+        def initialize project, credentials, host: nil, timeout: nil,
+                       client_config: nil
           @project = project
           @credentials = credentials
+          @host = host || V1::FirestoreClient::SERVICE_ADDRESS
           @timeout = timeout
           @client_config = client_config || {}
         end
 
+        def channel
+          require "grpc"
+          GRPC::Core::Channel.new host, nil, chan_creds
+        end
+
+        def chan_creds
+          return credentials if insecure?
+          require "grpc"
+          GRPC::Core::ChannelCredentials.new.compose \
+            GRPC::Core::CallCredentials.new credentials.client.updater_proc
+        end
+
         def firestore
           @firestore ||= \
-            V1beta1::FirestoreClient.new(
-              credentials: credentials,
-              timeout: timeout,
+            V1::FirestoreClient.new(
+              credentials:   channel,
+              timeout:       timeout,
               client_config: client_config,
-              lib_name: "gccl",
-              lib_version: Google::Cloud::Firestore::VERSION
+              lib_name:      "gccl",
+              lib_version:   Google::Cloud::Firestore::VERSION
             )
         end
 
+        def insecure?
+          credentials == :this_channel_is_insecure
+        end
+
         def get_documents document_paths, mask: nil, transaction: nil
           batch_get_args = { mask: document_mask(mask) }
           if transaction.is_a? String
@@ -105,7 +123,7 @@ module Google
           execute do
             firestore.begin_transaction database_path,
                                         options_: transaction_opt,
-                                        options: options
+                                        options:  options
           end
         end
 
@@ -128,11 +146,11 @@ module Google
         end
 
         def database_path project_id: project, database_id: "(default)"
-          V1beta1::FirestoreClient.database_root_path project_id, database_id
+          V1::FirestoreClient.database_root_path project_id, database_id
         end
 
         def documents_path project_id: project, database_id: "(default)"
-          V1beta1::FirestoreClient.document_root_path project_id, database_id
+          V1::FirestoreClient.document_root_path project_id, database_id
         end
 
         def inspect
@@ -148,7 +166,7 @@ module Google
 
         def call_options parent: nil, token: nil
           Google::Gax::CallOptions.new({
-            kwargs: default_headers(parent),
+            metadata:   default_headers(parent),
             page_token: token
           }.delete_if { |_, v| v.nil? })
         end
@@ -159,7 +177,7 @@ module Google
           mask = Array(mask).map(&:to_s).reject(&:nil?).reject(&:empty?)
           return nil if mask.empty?
 
-          Google::Firestore::V1beta1::DocumentMask.new field_paths: mask
+          Google::Firestore::V1::DocumentMask.new field_paths: mask
         end
 
         def execute