google-cloud-firestore 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b003b01ba72dbe743a7874f6978b886d395bea33a1cca2c13995b2e1054c5dc
-  data.tar.gz: bdb2c649d040de24cb63a80bb6de03ce427288b0de2cf4311c19702a751a40ab
+  metadata.gz: c376cdc37ee4df6dda7cd41213f01a8662279cef89bd9a0bac780c68d470ccf1
+  data.tar.gz: 45b1405ee2ea98bd26a2220fbfc0c5018e95d4b5e9bd828474c65ccfaa74a7db
 SHA512:
-  metadata.gz: edb498706f4a6ca151c28bbe7d45c5e62b2e86566879cfd394b2b7443b3d29db33f1bdeb53ab10c183a083a0a583e7069176b68ac136ec1ee700e200f1875b63
-  data.tar.gz: 9cd66ddae9bc997f0d87616cef791a48e6a89e87304c29d79eb4b97997dae1294ff820dd1a57011e4a34ac5b782a77db44f1bcc6dd2ef733acb7fafcafb61813
+  metadata.gz: 894292d1be7d5175b880fd986a4ac5d7ff06a541b3f80fef4994242707d71680d7776b7be1f18892c9978ad3a89ba66a85cbda43a52f90ba032278722b8c981e
+  data.tar.gz: a45b97170718f6e751c2593f5e00cdcaab7bd19ae1d12bb371e0030ff33eaf5d4e590bda05bc9431e5273f9f62320db44a8fd7dd954bad31c4d467c146aa3be6

data/lib/google-cloud-firestore.rb

@@ -20,6 +20,8 @@
 
 gem "google-cloud-core"
 require "google/cloud"
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -104,3 +106,26 @@ module Google
     end
   end
 end
+
+# Set the default firestore configuration
+Google::Cloud.configure.add_config! :firestore do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["FIRESTORE_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "FIRESTORE_CREDENTIALS", "FIRESTORE_CREDENTIALS_JSON",
+      "FIRESTORE_KEYFILE", "FIRESTORE_KEYFILE_JSON"
+    )
+  end
+
+  config.add_field! :project_id, default_project, match: String, allow_nil: true
+  config.add_alias! :project, :project_id
+  config.add_field! :credentials, default_creds,
+                    match: [String, Hash, Google::Auth::Credentials],
+                    allow_nil: true
+  config.add_alias! :keyfile, :credentials
+  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :timeout, nil, match: Integer
+  config.add_field! :client_config, nil, match: Hash
+end

data/lib/google/cloud/firestore.rb

@@ -15,6 +15,8 @@
 
 require "google-cloud-firestore"
 require "google/cloud/firestore/client"
+require "google/cloud/config"
+require "google/cloud/env"
 
 module Google
   module Cloud
@@ -469,7 +471,7 @@ module Google
       #   present, the default project for the credentials is used.
       # @param [String, Hash, Google::Auth::Credentials] credentials The path to
       #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Datastore::Credentials})
+      #   Google::Auth::Credentials object. (See {Firestore::Credentials})
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google
@@ -494,20 +496,67 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
                    client_config: nil, project: nil, keyfile: nil
-        project_id ||= (project || Firestore::Service.default_project_id)
+        project_id ||= (project || default_project_id)
         project_id = project_id.to_s # Always cast to a string
-        fail ArgumentError, "project_id is missing" if project_id.empty?
+        raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        credentials ||= keyfile
-        credentials ||= Firestore::Credentials.default(scope: scope)
+        scope ||= configure.scope
+        timeout ||= configure.timeout
+        client_config ||= configure.client_config
+
+        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Firestore::Credentials.new credentials, scope: scope
         end
 
-        Firestore::Client.new \
-          Firestore::Service.new \
-            project_id, credentials,
-            timeout: timeout, client_config: client_config
+        Firestore::Client.new(
+          Firestore::Service.new(
+            project_id, credentials, timeout: timeout,
+                                     client_config: client_config
+          )
+        )
+      end
+
+      ##
+      # Configure the Google Cloud Firestore library.
+      #
+      # The following Firestore configuration parameters are supported:
+      #
+      # * `project_id` - (String) Identifier for a Firestore project. (The
+      #   parameter `project` is considered deprecated, but may also be used.)
+      # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Firestore::Credentials}) (The
+      #   parameter `keyfile` is considered deprecated, but may also be used.)
+      # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
+      #   the set of resources and operations that the connection can access.
+      # * `timeout` - (Integer) Default timeout to use in requests.
+      # * `client_config` - (Hash) A hash of values to override the default
+      #   behavior of the API client.
+      #
+      # @return [Google::Cloud::Config] The configuration object the
+      #   Google::Cloud::Firestore library uses.
+      #
+      def self.configure
+        yield Google::Cloud.configure.firestore if block_given?
+
+        Google::Cloud.configure.firestore
+      end
+
+      ##
+      # @private Default project.
+      def self.default_project_id
+        Google::Cloud.configure.firestore.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
+      ##
+      # @private Default credentials.
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.firestore.credentials ||
+          Google::Cloud.configure.credentials ||
+          Firestore::Credentials.default(scope: scope)
       end
     end
   end

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

@@ -67,7 +67,7 @@ module Google
         def firestore
           @client
         end
-        alias_method :client, :firestore
+        alias client firestore
 
         # @!group Modifications
 
@@ -388,7 +388,8 @@ module Google
           doc_path = coalesce_doc_path_argument doc
 
           @writes << Convert.write_for_delete(
-            doc_path, exists: exists, update_time: update_time)
+            doc_path, exists: exists, update_time: update_time
+          )
 
           nil
         end
@@ -441,20 +442,20 @@ module Google
         ##
         # @private
         def ensure_not_closed!
-          fail "batch is closed" if closed?
+          raise "batch is closed" if closed?
         end
 
         ##
         # @private Raise an error unless an database available.
         def ensure_client!
-          fail "Must have active connection to service" unless firestore
+          raise "Must have active connection to service" unless firestore
         end
 
         ##
         # @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
       end
     end

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

@@ -107,7 +107,7 @@ module Google
           collection_ids = service.list_collections "#{path}/documents"
           collection_ids.each { |collection_id| yield col(collection_id) }
         end
-        alias_method :collections, :cols
+        alias collections cols
 
         ##
         # Retrieves a collection.
@@ -130,13 +130,13 @@ module Google
         #
         def col collection_path
           if collection_path.to_s.split("/").count.even?
-            fail ArgumentError, "collection_path must refer to a collection."
+            raise ArgumentError, "collection_path must refer to a collection."
           end
 
           CollectionReference.from_path \
             "#{path}/documents/#{collection_path}", self
         end
-        alias_method :collection, :col
+        alias collection col
 
         ##
         # Retrieves a document reference.
@@ -158,14 +158,14 @@ module Google
         #
         def doc document_path
           if document_path.to_s.split("/").count.odd?
-            fail ArgumentError, "document_path must refer to a document."
+            raise ArgumentError, "document_path must refer to a document."
           end
 
           doc_path = "#{path}/documents/#{document_path}"
 
           DocumentReference.from_path doc_path, self
         end
-        alias_method :document, :doc
+        alias document doc
 
         ##
         # Retrieves a list of document snapshots.
@@ -205,9 +205,9 @@ module Google
             yield DocumentSnapshot.from_batch_result(result, self)
           end
         end
-        alias_method :get_docs, :get_all
-        alias_method :get_documents, :get_all
-        alias_method :find, :get_all
+        alias get_docs get_all
+        alias get_documents get_all
+        alias find get_all
 
         ##
         # Creates a field path object representing the sentinel ID of a
@@ -401,7 +401,7 @@ module Google
             return nil if retries > 0
             # Re-raise error.
             raise err
-          rescue => err
+          rescue StandardError => err
             # Rollback transaction when handling unexpected error
             transaction.rollback rescue nil
             # Re-raise error.
@@ -416,17 +416,13 @@ module Google
         ##
         # @private
         def coalesce_get_argument obj
-          if obj.is_a?(String) || obj.is_a?(Symbol)
-            if obj.to_s.split("/").count.even?
-              return doc obj # Convert a DocumentReference
-            else
-              return col obj # Convert to Query
-            end
-          end
-
           return obj.ref if obj.is_a? DocumentSnapshot
 
-          obj
+          return obj unless obj.is_a?(String) || obj.is_a?(Symbol)
+
+          return doc obj if obj.to_s.split("/").count.even?
+
+          col obj # Convert to CollectionReference
         end
 
         ##
@@ -441,7 +437,7 @@ 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
       end
     end

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

@@ -124,7 +124,7 @@ module Google
           ensure_client!
           client.doc "#{collection_path}/#{document_path}"
         end
-        alias_method :document, :doc
+        alias document doc
 
         ##
         # The document reference or database the collection reference belongs
@@ -241,7 +241,7 @@ module Google
         ##
         # @private Raise an error unless an database available.
         def ensure_client!
-          fail "Must have active connection to service" unless client
+          raise "Must have active connection to service" unless client
         end
       end
     end

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

@@ -118,7 +118,7 @@ module Google
               encoded_content = Base64.strict_encode64 content
               Google::Firestore::V1beta1::Value.new bytes_value: encoded_content
             else
-              fail ArgumentError,
+              raise ArgumentError,
                    "A value of type #{obj.class} is not supported."
             end
           end
@@ -127,9 +127,9 @@ module Google
             writes = []
 
             if is_field_value_nested data, :delete
-              fail ArgumentError, "DELETE not allowed on create"
+              raise ArgumentError, "DELETE not allowed on create"
             end
-            fail ArgumentError, "data is required" unless data.is_a? Hash
+            raise ArgumentError, "data is required" unless data.is_a? Hash
 
             data, server_time_paths = remove_field_value_from data, :server_time
 
@@ -159,7 +159,7 @@ module Google
           end
 
           def writes_for_set doc_path, data, merge: nil
-            fail ArgumentError, "data is required" unless data.is_a? Hash
+            raise ArgumentError, "data is required" unless data.is_a? Hash
 
             if merge
               if merge == true
@@ -178,7 +178,7 @@ module Google
 
             data, delete_paths = remove_field_value_from data, :delete
             if delete_paths.any?
-              fail ArgumentError, "DELETE not allowed on set"
+              raise ArgumentError, "DELETE not allowed on set"
             end
 
             data, server_time_paths = remove_field_value_from data, :server_time
@@ -197,7 +197,7 @@ module Google
           end
 
           def writes_for_set_merge doc_path, data, field_paths
-            fail ArgumentError, "data is required" unless data.is_a? Hash
+            raise ArgumentError, "data is required" unless data.is_a? Hash
 
             writes = []
 
@@ -214,7 +214,7 @@ module Google
               end
             end
             all_valid_check = all_valid_check.include? false
-            fail ArgumentError, "all fields must be in data" if all_valid_check
+            raise ArgumentError, "all fields must be in data" if all_valid_check
 
             data, delete_paths = remove_field_value_from data, :delete
             data, server_time_paths = remove_field_value_from data, :server_time
@@ -230,7 +230,7 @@ module Google
               end
             end
             delete_valid_check = delete_valid_check.include? false
-            fail ArgumentError, "deleted field not included in merge" if delete_valid_check
+            raise ArgumentError, "deleted field not included in merge" if delete_valid_check
 
             # Choose only the data there are field paths for
             field_paths -= delete_paths
@@ -239,7 +239,7 @@ module Google
 
             if data.empty?
               if server_time_paths.empty?
-                fail ArgumentError, "data required for set with merge"
+                raise ArgumentError, "data required for set with merge"
               end
             else
               writes << Google::Firestore::V1beta1::Write.new(
@@ -261,7 +261,7 @@ module Google
           def writes_for_update doc_path, data, update_time: nil
             writes = []
 
-            fail ArgumentError, "data is required" unless data.is_a? Hash
+            raise ArgumentError, "data is required" unless data.is_a? Hash
 
             # Convert data to use FieldPath
             new_data_pairs = data.map do |key, value|
@@ -272,14 +272,14 @@ module Google
             # Duplicate field paths check
             dup_keys = new_data_pairs.map(&:first).map(&:formatted_string)
             if dup_keys.size != dup_keys.uniq.size
-              fail ArgumentError, "duplicate field paths"
+              raise ArgumentError, "duplicate field paths"
             end
             dup_keys.each do |field_path|
               prefix_check = dup_keys.select do |this_path|
                 this_path.start_with? "#{field_path}."
               end
               if prefix_check.any?
-                fail ArgumentError, "one field cannot be a prefix of another"
+                raise ArgumentError, "one field cannot be a prefix of another"
               end
             end
 
@@ -298,7 +298,7 @@ module Google
             root_server_time_paths.map!(&:first)
 
             data, nested_deletes = remove_field_value_from data, :delete
-            fail ArgumentError, "DELETE cannot be nested" if nested_deletes.any?
+            raise ArgumentError, "DELETE cannot be nested" if nested_deletes.any?
 
             data, nested_server_time_paths = remove_field_value_from data, :server_time
 
@@ -307,11 +307,11 @@ module Google
 
             field_paths = (field_paths - (field_paths - identify_all_file_paths(data)) + delete_paths).uniq
             field_paths.each do |field_path|
-              fail ArgumentError, "empty paths not allowed" if field_path.fields.empty?
+              raise ArgumentError, "empty paths not allowed" if field_path.fields.empty?
             end
 
             if data.empty? && delete_paths.empty? && server_time_paths.empty?
-              fail ArgumentError, "data is required"
+              raise ArgumentError, "data is required"
             end
 
             if data.any? || delete_paths.any?
@@ -346,7 +346,7 @@ module Google
 
           def write_for_delete doc_path, exists: nil, update_time: nil
             if !exists.nil? && !update_time.nil?
-              fail ArgumentError, "cannot specify both exists and update_time"
+              raise ArgumentError, "cannot specify both exists and update_time"
             end
 
             write = Google::Firestore::V1beta1::Write.new(
@@ -402,7 +402,7 @@ module Google
                 else
                   if value.is_a? Array
                     if is_field_value_nested value, field_value_type
-                      fail ArgumentError, "cannot nest #{field_value_type} under arrays"
+                      raise ArgumentError, "cannot nest #{field_value_type} under arrays"
                     end
                   end
 
@@ -515,7 +515,7 @@ module Google
               tmp_dup = dup_hash
               last_field = nil
               field_path.fields.map(&:to_sym).each do |field|
-                fail ArgumentError, "empty paths not allowed" if field.empty?
+                raise ArgumentError, "empty paths not allowed" if field.empty?
                 tmp_dup = tmp_dup[last_field] unless last_field.nil?
                 last_field = field
                 tmp_dup[field] ||= {}

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

@@ -19,16 +19,35 @@ module Google
   module Cloud
     module Firestore
       ##
-      # @private Represents the OAuth 2.0 signing logic for Firestore.
+      # # Credentials
+      #
+      # Represents the authentication and authorization used to connect to the
+      # Firestore service.
+      #
+      # @example
+      #   require "google/cloud/firestore"
+      #
+      #   keyfile = "/path/to/keyfile.json"
+      #   creds = Google::Cloud::Firestore::Credentials.new keyfile
+      #
+      #   firestore = Google::Cloud::Firestore.new(
+      #     project_id: "my-project",
+      #     credentials: creds
+      #   )
+      #
+      #   firestore.project_id #=> "my-project"
+      #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/datastore"]
-        PATH_ENV_VARS = %w(FIRESTORE_CREDENTIALS FIRESTORE_KEYFILE
+        SCOPE = ["https://www.googleapis.com/auth/datastore"].freeze
+        PATH_ENV_VARS = %w[FIRESTORE_CREDENTIALS FIRESTORE_KEYFILE
                            GOOGLE_CLOUD_CREDENTIALS GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(FIRESTORE_CREDENTIALS_JSON FIRESTORE_KEYFILE_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[FIRESTORE_CREDENTIALS_JSON FIRESTORE_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"].freeze
       end
     end
   end

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

@@ -95,7 +95,7 @@ module Google
           collection_ids = service.list_collections path
           collection_ids.each { |collection_id| yield col(collection_id) }
         end
-        alias_method :collections, :cols
+        alias collections cols
 
         ##
         # Retrieves a collection nested under the document snapshot.
@@ -118,12 +118,12 @@ module Google
         #
         def col collection_path
           if collection_path.to_s.split("/").count.even?
-            fail ArgumentError, "collection_path must refer to a collection."
+            raise ArgumentError, "collection_path must refer to a collection."
           end
 
           CollectionReference.from_path "#{path}/#{collection_path}", client
         end
-        alias_method :collection, :col
+        alias collection col
 
         ##
         # Retrieve the document data.
@@ -453,14 +453,14 @@ module Google
         ##
         # @private Raise an error unless an database available.
         def ensure_client!
-          fail "Must have active connection to service" unless client
+          raise "Must have active connection to service" unless client
         end
 
         ##
         # @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
       end
     end

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

@@ -91,7 +91,7 @@ module Google
         def ref
           @ref
         end
-        alias_method :reference, :ref
+        alias reference ref
 
         ##
         # The collection the document snapshot belongs to.
@@ -136,7 +136,7 @@ module Google
           return nil if missing?
           Convert.fields_to_hash grpc.fields, ref.client
         end
-        alias_method :fields, :data
+        alias fields data
 
         ##
         # Retrieves the document data.
@@ -196,14 +196,15 @@ module Google
 
           nodes.each do |node|
             unless selected_data.is_a? Hash
-              fail ArgumentError,
-                   "#{field_path.formatted_string} is not contained in the data"
+              err_msg = "#{field_path.formatted_string} is not " \
+                        "contained in the data"
+              raise ArgumentError, err_msg
             end
             selected_data = selected_data[node]
           end
           selected_data
         end
-        alias_method :[], :get
+        alias [] get
 
         # @!endgroup
 
@@ -218,7 +219,7 @@ module Google
           return nil if missing?
           Convert.timestamp_to_time grpc.create_time
         end
-        alias_method :create_time, :created_at
+        alias create_time created_at
 
         ##
         # The time at which the document was last changed.
@@ -232,7 +233,7 @@ module Google
           return nil if missing?
           Convert.timestamp_to_time grpc.update_time
         end
-        alias_method :update_time, :updated_at
+        alias update_time updated_at
 
         ##
         # The time at which the document was read.
@@ -244,7 +245,7 @@ module Google
         def read_at
           @read_at
         end
-        alias_method :read_time, :read_at
+        alias read_time read_at
 
         ##
         # Determines whether the document exists.

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

@@ -59,7 +59,7 @@ module Google
         def initialize *fields
           @fields = fields.flatten.map(&:to_s)
           @fields.each do |field|
-            fail ArgumentError, "empty paths not allowed" if field.empty?
+            raise ArgumentError, "empty paths not allowed" if field.empty?
           end
         end
 
@@ -167,7 +167,7 @@ module Google
           fields = String(dotted_string).split(".")
           fields.each do |field|
             if INVALID_FIELD_PATH_CHARS.match field
-              fail ArgumentError, "invalid character, use FieldPath instead"
+              raise ArgumentError, "invalid character, use FieldPath instead"
             end
           end
           new fields

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

@@ -21,11 +21,11 @@ module Google
       ##
       # @private Helper module for generating random values
       module Generate
-        CHARS = [*"a".."z", *"A".."Z", *"0".."9"]
+        CHARS = [*"a".."z", *"A".."Z", *"0".."9"].freeze
 
         def self.unique_id length: 20, chars: CHARS
           size = chars.size
-          length.times.map do
+          Array.new(length) do
             chars[SecureRandom.random_number(size)]
           end.join
         end

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

@@ -130,7 +130,7 @@ module Google
           new_query ||= StructuredQuery.new
 
           if new_query.from.empty?
-            fail "missing collection_id to specify descendants."
+            raise "missing collection_id to specify descendants."
           end
 
           new_query.from.last.all_descendants = true
@@ -166,7 +166,7 @@ module Google
           new_query ||= StructuredQuery.new
 
           if new_query.from.empty?
-            fail "missing collection_id to specify descendants."
+            raise "missing collection_id to specify descendants."
           end
 
           new_query.from.last.all_descendants = false
@@ -283,11 +283,12 @@ module Google
             field: StructuredQuery::FieldReference.new(
               field_path: field.formatted_string
             ),
-            direction: order_direction(direction))
+            direction: order_direction(direction)
+          )
 
           Query.start new_query, parent_path, client
         end
-        alias_method :order_by, :order
+        alias order_by order
 
         ##
         # Skips to an offset in a query. If the current query already has
@@ -389,12 +390,12 @@ module Google
 
           values = values.flatten.map { |value| Convert.raw_to_value value }
           new_query.start_at = Google::Firestore::V1beta1::Cursor.new(
-            values: values, before: true)
+            values: values, before: true
+          )
 
           Query.start new_query, parent_path, client
         end
 
-
         ##
         # Starts query results after a set of field values. The result set will
         # not include the document specified by `values`.
@@ -431,7 +432,8 @@ module Google
 
           values = values.flatten.map { |value| Convert.raw_to_value value }
           new_query.start_at = Google::Firestore::V1beta1::Cursor.new(
-            values: values, before: false)
+            values: values, before: false
+          )
 
           Query.start new_query, parent_path, client
         end
@@ -472,7 +474,8 @@ module Google
 
           values = values.flatten.map { |value| Convert.raw_to_value value }
           new_query.end_at = Google::Firestore::V1beta1::Cursor.new(
-            values: values, before: true)
+            values: values, before: true
+          )
 
           Query.start new_query, parent_path, client
         end
@@ -513,7 +516,8 @@ module Google
 
           values = values.flatten.map { |value| Convert.raw_to_value value }
           new_query.end_at = Google::Firestore::V1beta1::Cursor.new(
-            values: values, before: false)
+            values: values, before: false
+          )
 
           Query.start new_query, parent_path, client
         end
@@ -552,7 +556,7 @@ module Google
             yield DocumentSnapshot.from_query_result(result, self)
           end
         end
-        alias_method :run, :get
+        alias run get
 
         ##
         # @private Start a new Query.
@@ -567,25 +571,36 @@ module Google
 
         protected
 
+        ##
+        # @private
         StructuredQuery = Google::Firestore::V1beta1::StructuredQuery
 
+        ##
+        # @private
         FILTER_OPS = {
-          "<"            => :LESS_THAN,
-          "lt"           => :LESS_THAN,
-          "<="           => :LESS_THAN_OR_EQUAL,
-          "lte"          => :LESS_THAN_OR_EQUAL,
-          ">"            => :GREATER_THAN,
-          "gt"           => :GREATER_THAN,
-          ">="           => :GREATER_THAN_OR_EQUAL,
-          "gte"          => :GREATER_THAN_OR_EQUAL,
-          "="            => :EQUAL,
-          "=="           => :EQUAL,
-          "eq"           => :EQUAL,
-          "eql"          => :EQUAL,
-          "is"           => :EQUAL }
-        UNARY_NIL_VALUES = [nil, :null, :nil]
-        UNARY_NAN_VALUES = [:nan, Float::NAN]
-        UNARY_VALUES = UNARY_NIL_VALUES + UNARY_NAN_VALUES
+          "<"   => :LESS_THAN,
+          "lt"  => :LESS_THAN,
+          "<="  => :LESS_THAN_OR_EQUAL,
+          "lte" => :LESS_THAN_OR_EQUAL,
+          ">"   => :GREATER_THAN,
+          "gt"  => :GREATER_THAN,
+          ">="  => :GREATER_THAN_OR_EQUAL,
+          "gte" => :GREATER_THAN_OR_EQUAL,
+          "="   => :EQUAL,
+          "=="  => :EQUAL,
+          "eq"  => :EQUAL,
+          "eql" => :EQUAL,
+          "is"  => :EQUAL
+        }.freeze
+        ##
+        # @private
+        UNARY_NIL_VALUES = [nil, :null, :nil].freeze
+        ##
+        # @private
+        UNARY_NAN_VALUES = [:nan, Float::NAN].freeze
+        ##
+        # @private
+        UNARY_VALUES = (UNARY_NIL_VALUES + UNARY_NAN_VALUES).freeze
 
         def filter name, op, value
           field = StructuredQuery::FieldReference.new field_path: name.to_s
@@ -594,7 +609,8 @@ module Google
           is_value_nan = value.respond_to?(:nan?) && value.nan?
           if UNARY_VALUES.include?(value) || is_value_nan
             if op != :EQUAL
-              fail ArgumentError, "can only check equality for #{value} values."
+              raise ArgumentError,
+                    "can only check equality for #{value} values."
             end
 
             op = :IS_NULL
@@ -628,7 +644,7 @@ module Google
         ##
         # @private Raise an error unless an database available.
         def ensure_client!
-          fail "Must have active connection to service" unless client
+          raise "Must have active connection to service" unless client
         end
 
         ##
@@ -643,7 +659,7 @@ 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
       end
     end

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

@@ -28,15 +28,6 @@ module Google
       class Service
         attr_accessor :project, :credentials, :timeout, :client_config
 
-        ##
-        # @private Default project.
-        def self.default_project_id
-          ENV["FIRESTORE_PROJECT"] ||
-            ENV["GOOGLE_CLOUD_PROJECT"] ||
-            ENV["GCLOUD_PROJECT"] ||
-            Google::Cloud.env.project_id
-        end
-
         ##
         # Creates a new Service instance.
         def initialize project, credentials, timeout: nil, client_config: nil
@@ -53,7 +44,8 @@ module Google
               timeout: timeout,
               client_config: client_config,
               lib_name: "gccl",
-              lib_version: Google::Cloud::Firestore::VERSION)
+              lib_version: Google::Cloud::Firestore::VERSION
+            )
         end
 
         def get_documents document_paths, mask: nil, transaction: nil

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

@@ -74,7 +74,7 @@ module Google
         def firestore
           @client
         end
-        alias_method :client, :firestore
+        alias client firestore
 
         # @!group Access
 
@@ -120,9 +120,9 @@ module Google
             yield DocumentSnapshot.from_batch_result(result, self)
           end
         end
-        alias_method :get_docs, :get_all
-        alias_method :get_documents, :get_all
-        alias_method :find, :get_all
+        alias get_docs get_all
+        alias get_documents get_all
+        alias find get_all
 
         ##
         # Retrieves document snapshots for the given value. Valid values can be
@@ -233,7 +233,7 @@ module Google
             yield DocumentSnapshot.from_query_result(result, self)
           end
         end
-        alias_method :run, :get
+        alias run get
 
         # @!endgroup
 
@@ -562,7 +562,8 @@ module Google
           doc_path = coalesce_doc_path_argument doc
 
           @writes << Convert.write_for_delete(
-            doc_path, exists: exists, update_time: update_time)
+            doc_path, exists: exists, update_time: update_time
+          )
 
           nil
         end
@@ -637,17 +638,13 @@ module Google
         ##
         # @private
         def coalesce_get_argument obj
-          if obj.is_a?(String) || obj.is_a?(Symbol)
-            if obj.to_s.split("/").count.even?
-              return client.doc obj # Convert a DocumentReference
-            else
-              return client.col obj # Convert to CollectionReference
-            end
-          end
-
           return obj.ref if obj.is_a? DocumentSnapshot
 
-          obj
+          return obj unless obj.is_a?(String) || obj.is_a?(Symbol)
+
+          return client.doc obj if obj.to_s.split("/").count.even?
+
+          client.col obj # Convert to CollectionReference
         end
 
         ##
@@ -695,7 +692,7 @@ module Google
         ##
         # @private
         def ensure_not_closed!
-          fail "transaction is closed" if closed?
+          raise "transaction is closed" if closed?
         end
 
         ##
@@ -711,14 +708,14 @@ module Google
         ##
         # @private Raise an error unless an database available.
         def ensure_client!
-          fail "Must have active connection to service" unless firestore
+          raise "Must have active connection to service" unless firestore
         end
 
         ##
         # @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
       end
     end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Firestore
-      VERSION = "0.20.0"
+      VERSION = "0.21.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.35.1
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Firestore API