google-cloud-firestore 0.20.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b003b01ba72dbe743a7874f6978b886d395bea33a1cca2c13995b2e1054c5dc
+  data.tar.gz: bdb2c649d040de24cb63a80bb6de03ce427288b0de2cf4311c19702a751a40ab
+SHA512:
+  metadata.gz: edb498706f4a6ca151c28bbe7d45c5e62b2e86566879cfd394b2b7443b3d29db33f1bdeb53ab10c183a083a0a583e7069176b68ac136ec1ee700e200f1875b63
+  data.tar.gz: 9cd66ddae9bc997f0d87616cef791a48e6a89e87304c29d79eb4b97997dae1294ff820dd1a57011e4a34ac5b782a77db44f1bcc6dd2ef733acb7fafcafb61813

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--title=Google Cloud Firestore API
+--exclude lib/google/firestore/v1beta1
+--markup markdown
+
+./lib/**/*.rb
+-
+README.md

data/LICENSE

@@ -0,0 +1,201 @@
+                            Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       https://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.

data/README.md

@@ -0,0 +1,30 @@
+# Ruby Client for Google Cloud Firestore API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+
+[Google Cloud Firestore API][Product Documentation]:
+
+- [Client Library Documentation][]
+- [Product Documentation][]
+
+## Quick Start
+In order to use this library, you first need to go through the following
+steps:
+
+1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+2. [Enable the Google Cloud Firestore API.](https://console.cloud.google.com/apis/api/firestore)
+3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+
+### Installation
+```
+$ gem install google-cloud-firestore
+```
+
+### Next Steps
+- Read the [Client Library Documentation][] for Google Cloud Firestore API
+  to see other available methods on the client.
+- Read the [Google Cloud Firestore API Product documentation][Product Documentation]
+  to learn more about the product and see How-to Guides.
+- View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+  to see the full list of Cloud APIs that we cover.
+
+[Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-firestore/latest/google/firestore/v1beta1
+[Product Documentation]: https://cloud.google.com/firestore

data/lib/google-cloud-firestore.rb

@@ -0,0 +1,106 @@
+# Copyright 2017 Google LLC
+#
+# 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
+#
+#     https://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.
+
+##
+# This file is here to be autorequired by bundler, so that the .firestore and
+# #firestore methods can be available, but the library and all dependencies
+# won't be loaded until required and used.
+
+
+gem "google-cloud-core"
+require "google/cloud"
+
+module Google
+  module Cloud
+    ##
+    # Creates a new object for connecting to the Firestore service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @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
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #
+    #   The default scope is:
+    #
+    #   * `https://www.googleapis.com/auth/datastore`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Hash] client_config A hash of values to override the default
+    #   behavior of the API client. Optional.
+    #
+    # @return [Google::Cloud::Firestore::Client]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   gcloud = Google::Cloud.new
+    #   firestore = gcloud.firestore
+    #
+    # @example The default scope can be overridden with the `scope` option:
+    #   require "google/cloud"
+    #
+    #   gcloud  = Google::Cloud.new
+    #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
+    #   firestore = gcloud.firestore scope: platform_scope
+    #
+    def firestore scope: nil, timeout: nil, client_config: nil
+      Google::Cloud.firestore @project, @keyfile,
+                              scope: scope, timeout: (timeout || @timeout),
+                              client_config: client_config
+    end
+
+    ##
+    # Creates a new object for connecting to the Firestore service.
+    # Each call creates a new connection.
+    #
+    # For more information on connecting to Google Cloud see the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # @param [String] project_id Identifier for a Firestore project. If not
+    #   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})
+    # @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
+    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+    #
+    #   The default scope is:
+    #
+    #   * `https://www.googleapis.com/auth/datastore`
+    # @param [Integer] timeout Default timeout to use in requests. Optional.
+    # @param [Hash] client_config A hash of values to override the default
+    #   behavior of the API client. Optional.
+    #
+    # @return [Google::Cloud::Firestore::Client]
+    #
+    # @example
+    #   require "google/cloud"
+    #
+    #   firestore = Google::Cloud.firestore
+    #
+    def self.firestore project_id = nil, credentials = nil, scope: nil,
+                       timeout: nil, client_config: nil
+      require "google/cloud/firestore"
+      Google::Cloud::Firestore.new project_id: project_id,
+                                   credentials: credentials,
+                                   scope: scope, timeout: timeout,
+                                   client_config: client_config
+    end
+  end
+end

data/lib/google/cloud/firestore.rb

@@ -0,0 +1,514 @@
+# Copyright 2017 Google LLC
+#
+# 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
+#
+#     https://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-firestore"
+require "google/cloud/firestore/client"
+
+module Google
+  module Cloud
+    ##
+    # # Cloud Firestore
+    #
+    # Cloud Firestore is a NoSQL document database built for automatic scaling,
+    # high performance, and ease of application development. While the Cloud
+    # Firestore interface has many of the same features as traditional
+    # databases, as a NoSQL database it differs from them in the way it
+    # describes relationships between data objects.
+    #
+    # For more information about Cloud Firestore, read the [Cloud
+    # Firestore Documentation](https://cloud.google.com/firestore/docs/).
+    #
+    # The goal of google-cloud is to provide an API that is comfortable to
+    # Rubyists. Authentication is handled by {Google::Cloud#firestore}. You can
+    # provide the project and credential information to connect to the Cloud
+    # Firestore service, or if you are running on Google Compute Engine this
+    # configuration is taken care of for you. You can read more about the
+    # options for connecting in the [Authentication
+    # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+    #
+    # ## Adding data
+    #
+    # Cloud Firestore stores data in Documents, which are stored in Collections.
+    # Cloud Firestore creates collections and documents implicitly the first
+    # time you add data to the document. (For more information, see [Adding Data
+    # to Cloud Firestore](https://cloud.google.com/firestore/docs/manage-data/add-data).
+    #
+    # To create or overwrite a single document, use {Firestore::Client#doc} to
+    # obtain a document reference. (This does not create a document in Cloud
+    # Firestore.) Then, call {Firestore::DocumentReference#set} to create the
+    # document or overwrite an existing document:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.set({ name: "New York City" }) # Document created
+    # ```
+    #
+    # When you use this combination of `doc` and `set` to create a new document,
+    # you must specify an ID for the document. (In the example above, the ID is
+    # "NYC".) However, if you do not have a meaningful ID for the document, you
+    # may omit the ID from a call to {Firestore::CollectionReference#doc}, and
+    # Cloud Firestore will auto-generate an ID for you.
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Get a document reference with data
+    # random_ref = cities_col.doc
+    # random_ref.set({ name: "New York City" })
+    #
+    # # The document ID is randomly generated
+    # random_ref.document_id #=> "RANDOMID123XYZ"
+    # ```
+    #
+    # You can perform both of the operations shown above, auto-generating
+    # an ID and creating the document, in a single call to
+    # {Firestore::CollectionReference#add}.
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Get a document reference with data
+    # random_ref = cities_col.add({ name: "New York City" })
+    #
+    # # The document ID is randomly generated
+    # random_ref.document_id #=> "RANDOMID123XYZ"
+    # ```
+    #
+    # You can also use `add` to create an empty document:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Create a document without data
+    # random_ref = cities_col.add
+    #
+    # # The document ID is randomly generated
+    # random_ref.document_id #=> "RANDOMID123XYZ"
+    # ```
+    #
+    # ## Retrieving collection references
+    #
+    # Collections are simply named containers for documents. A collection
+    # contains documents and nothing else. It can't directly contain raw fields
+    # with values, and it can't contain other collections. You do not need to
+    # "create" or "delete" collections. After you create the first document in a
+    # collection, the collection exists. If you delete all of the documents in a
+    # collection, it no longer exists. (For more information, see [Cloud
+    # Firestore Data Model](https://cloud.google.com/firestore/docs/data-model).
+    #
+    # Use {Firestore::Client#cols} to list the root-level collections:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get the root collections
+    # firestore.cols.each do |col|
+    #   puts col.collection_id
+    # end
+    # ```
+    #
+    # Retrieving a reference to a single root-level collection is similar:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get the cities collection
+    # cities_col = firestore.col "cities"
+    # ```
+    #
+    # To list the collections in a document, first get the document reference,
+    # then use {Firestore::DocumentReference#cols}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.cols.each do |col|
+    #   puts col.collection_id
+    # end
+    # ```
+    #
+    # Again, retrieving a reference to a single collection is similar::
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # # Get precincts sub-collection
+    # precincts_col = nyc_ref.col "precincts"
+    # ```
+    #
+    # ## Reading data
+    #
+    # You can retrieve a snapshot of the data in a single document with
+    # {Firestore::DocumentReference#get}, which returns an instance of
+    # {Firestore::DocumentSnapshot}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_snap = nyc_ref.get
+    # nyc_snap[:population] #=> 1000000
+    # ```
+    # In the example above, {Firestore::DocumentSnapshot#[]} is used to access a
+    # top-level field. To access nested fields, use {Firestore::FieldPath}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # user_snap = firestore.doc("users/frank").get
+    #
+    # nested_field_path = Google::Cloud::Firestore::FieldPath.new(
+    #   :favorites, :food
+    # )
+    # user_snap.get(nested_field_path) #=> "Pizza"
+    # ```
+    #
+    # Or, use {Firestore::Client#get_all} to retrieve a list of document
+    # snapshots (data):
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get and print city documents
+    # cities = ["cities/NYC", "cities/SF", "cities/LA"]
+    # firestore.get_all(cities).each do |city|
+    #   puts "#{city.document_id} has #{city[:population]} residents."
+    # end
+    # ```
+    #
+    # To retrieve all of the document snapshots in a collection, use
+    # {Firestore::CollectionReference#get}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Get and print all city documents
+    # cities_col.get do |city|
+    #   puts "#{city.document_id} has #{city[:population]} residents."
+    # end
+    # ```
+    #
+    # The example above is actually a simple query without filters. Let's look
+    # at some other queries for Cloud Firestore.
+    #
+    # ## Querying data
+    #
+    # Use {Firestore::Query#where} to filter queries on a field:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Create a query
+    # query = cities_col.where(:population, :>=, 1000000)
+    #
+    # query.get do |city|
+    #   puts "#{city.document_id} has #{city[:population]} residents."
+    # end
+    # ```
+    #
+    # You can order the query results with {Firestore::Query#order}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Create a query
+    # query = cities_col.order(:name, :desc)
+    #
+    # query.get do |city|
+    #   puts "#{city.document_id} has #{city[:population]} residents."
+    # end
+    # ```
+    #
+    # Query methods may be chained, as in this example using
+    # {Firestore::Query#limit} and  {Firestore::Query#offset} to perform
+    # pagination:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a collection reference
+    # cities_col = firestore.col "cities"
+    #
+    # # Create a query
+    # query = cities_col.limit(5).offset(10)
+    #
+    # query.get do |city|
+    #   puts "#{city.document_id} has #{city[:population]} residents."
+    # end
+    # ```
+    #
+    # See [Managing Indexes in Cloud
+    # Firestore](https://cloud.google.com/firestore/docs/query-data/indexing) to
+    # ensure the best performance for your queries.
+    #
+    # ## Updating data
+    #
+    # You can use {Firestore::DocumentReference#set} to completely overwrite an
+    # existing document:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.set({ name: "New York City" })
+    # ```
+    #
+    # Or, to selectively update only the fields appearing in your `data`
+    # argument, set the `merge` option to `true`:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.set({ name: "New York City" }, merge: true)
+    # ```
+    #
+    # Use {Firestore::DocumentReference#update} to directly update a
+    # deeply-nested field with a {Firestore::FieldPath}:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # user_ref = firestore.doc "users/frank"
+    #
+    # nested_field_path = Google::Cloud::Firestore::FieldPath.new(
+    #   :favorites, :food
+    # )
+    # user_ref.update({ nested_field_path: "Pasta" })
+    # ```
+    #
+    # ## Using transactions and batched writes
+    #
+    # Cloud Firestore supports atomic operations for reading and writing data.
+    # In a set of atomic operations, either all of the operations succeed, or
+    # none of them are applied. There are two types of atomic operations in
+    # Cloud Firestore: A transaction is a set of read and write operations on
+    # one or more documents, while a batched write is a set of only write
+    # operations on one or more documents. (For more information, see
+    # [Transactions and Batched Writes](https://cloud.google.com/firestore/docs/manage-data/transactions).
+    #
+    # ### Transactions
+    #
+    # A transaction consists of any number of read operations followed by any
+    # number of write operations. (Read operations must always come before write
+    # operations.) In the case of a concurrent update by another client, Cloud
+    # Firestore runs the entire transaction again. Therefore, transaction blocks
+    # should be idempotent and should not not directly modify application state.
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # city = firestore.col("cities").doc("SF")
+    # city.set({ name: "San Francisco",
+    #            state: "CA",
+    #            country: "USA",
+    #            capital: false,
+    #            population: 860000 })
+    #
+    # firestore.transaction do |tx|
+    #   new_population = tx.get(city).data[:population] + 1
+    #   tx.update(city, { population: new_population })
+    # end
+    # ```
+    #
+    # ### Batched writes
+    #
+    # If you do not need to read any documents in your operation set, you can
+    # execute multiple write operations as a single batch. A batch of writes
+    # completes atomically and can write to multiple documents. Batched writes
+    # are also useful for migrating large data sets to Cloud Firestore.
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # firestore.batch do |b|
+    #   # Set the data for NYC
+    #   b.set("cities/NYC", { name: "New York City" })
+    #
+    #   # Update the population for SF
+    #   b.update("cities/SF", { population: 1000000 })
+    #
+    #   # Delete LA
+    #   b.delete("cities/LA")
+    # end
+    # ```
+    #
+    # ## Deleting data
+    #
+    # Use {Firestore::DocumentReference#delete} to delete a document from Cloud
+    # Firestore:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.delete
+    # ```
+    #
+    # To delete specific fields from a document, use the
+    # {Firestore::Client.field_delete} method when you update a document:
+    #
+    # ```ruby
+    # require "google/cloud/firestore"
+    #
+    # firestore = Google::Cloud::Firestore.new
+    #
+    # # Get a document reference
+    # nyc_ref = firestore.doc "cities/NYC"
+    #
+    # nyc_ref.update({ name: "New York City",
+    #                  trash: firestore.field_delete })
+    # ```
+    #
+    # To delete an entire collection or sub-collection in Cloud Firestore,
+    # retrieve all the documents within the collection or sub-collection and
+    # delete them. If you have larger collections, you may want to delete the
+    # documents in smaller batches to avoid out-of-memory errors. Repeat the
+    # process until you've deleted the entire collection or sub-collection.
+    #
+    module Firestore
+      ##
+      # Creates a new object for connecting to the Firestore service.
+      # Each call creates a new connection.
+      #
+      # For more information on connecting to Google Cloud see the
+      # [Authentication
+      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/authentication).
+      #
+      # @param [String] project_id Identifier for a Firestore project. If not
+      #   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})
+      # @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
+      #   APIs](https://developers.google.com/identity/protocols/OAuth2).
+      #
+      #   The default scope is:
+      #
+      #   * `https://www.googleapis.com/auth/datastore`
+      # @param [Integer] timeout Default timeout to use in requests. Optional.
+      # @param [Hash] client_config A hash of values to override the default
+      #   behavior of the API client. Optional.
+      # @param [String] project Alias for the `project_id` argument. Deprecated.
+      # @param [String] keyfile Alias for the `credentials` argument.
+      #   Deprecated.
+      #
+      # @return [Google::Cloud::Firestore::Client]
+      #
+      # @example
+      #   require "google/cloud/firestore"
+      #
+      #   firestore = Google::Cloud::Firestore.new
+      #
+      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_id.to_s # Always cast to a string
+        fail ArgumentError, "project_id is missing" if project_id.empty?
+
+        credentials ||= keyfile
+        credentials ||= Firestore::Credentials.default(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
+      end
+    end
+  end
+end