google-cloud-firestore 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59722ad7ca97829be2d1b4fef41f04feb57b59829748e2ae4dc0c997a2f38c9c
-  data.tar.gz: eae83c0c46385c40ebed685020696b21a70213b2c2365f73583f4b80f7fb018f
+  metadata.gz: 51be2bb301f8eb7d271a28efa81767e4cf296b6111665df4f0857ed495f4bc4e
+  data.tar.gz: b859f290260bdc0448f7407c4f0c7f481bfdc98ef808750c56633817b46417c0
 SHA512:
-  metadata.gz: 2bc4ab3e852b45dff885a3fa491b8048649abb07d26cba035b09894738956b571c185645f404a08632cd8122caf4db86fc3dd926854e0bfe1511303697431595
-  data.tar.gz: 040ff8cb71f195695825ab50be5dc09203c129fa76f7804651341849f63bf90af63d0bb74bc668127659543ee03a54c31b20599f001566b820a79793fc209b1a
+  metadata.gz: 72a920965f28b179256c47f474668cf1c7d35b202356184a2a3c934768dab747aaddce43d3bb821c82785da73560b03baf130bb534886315fcbdedb1b1032b56
+  data.tar.gz: 46bde522096b25cd0cd0951a92d598378c6d8536e4a505215110272b2dca08ea585ded8591c79e461ac3dd31f8539450f7a29c07ae68f60beccf77b739c7e217

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History
 
+### 1.1.0 / 2019-08-23
+
+#### Features
+
+* Support overriding of service endpoint
+* Add low-level client for the admin API
+
+#### Documentation
+
+* Update documentation
+
 ### 1.0.0 / 2019-07-15
 
 * Bump release level to GA.

data/LOGGING.md

@@ -5,7 +5,7 @@ To enable logging for this library, set the logger for the underlying
 that you set may be a Ruby stdlib
 [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
-[`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+[`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver
 Logging](https://cloud.google.com/logging/). See
 [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)

data/lib/google-cloud-firestore.rb

@@ -134,4 +134,5 @@ Google::Cloud.configure.add_config! :firestore do |config|
   config.add_field! :client_config, nil, match: Hash
   config.add_field! :emulator_host, default_emulator,
                     match: String, allow_nil: true
+  config.add_field! :endpoint, nil, match: String
 end

data/lib/google/cloud/firestore.rb

@@ -58,6 +58,8 @@ module Google
       # @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] endpoint Override of the endpoint host name. Optional.
+      #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Firestore emulator host. Optional.
       #   If the param is nil, uses the value of the `emulator_host` config.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
@@ -72,12 +74,13 @@ module Google
       #   firestore = Google::Cloud::Firestore.new
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, emulator_host: nil, project: nil,
-                   keyfile: nil
+                   client_config: nil, endpoint: nil, emulator_host: nil,
+                   project: nil, keyfile: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
         client_config ||= configure.client_config
+        endpoint      ||= configure.endpoint
         emulator_host ||= configure.emulator_host
 
         if emulator_host
@@ -106,8 +109,8 @@ module Google
 
         Firestore::Client.new(
           Firestore::Service.new(
-            project_id, credentials, timeout:       timeout,
-                                     client_config: client_config
+            project_id, credentials,
+            host: endpoint, timeout: timeout, client_config: client_config
           )
         )
       end
@@ -131,6 +134,8 @@ module Google
       # * `timeout` - (Integer) Default timeout to use in requests.
       # * `client_config` - (Hash) A hash of values to override the default
       #   behavior of the API client.
+      # * `endpoint` - (String) Override of the endpoint host name, or `nil`
+      #   to use the default endpoint.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to
       #   `ENV["FIRESTORE_EMULATOR_HOST"]`
       #

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

@@ -0,0 +1,144 @@
+# Copyright 2019 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/gax"
+require "pathname"
+
+module Google
+  module Cloud
+    module Firestore
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for Google Cloud Firestore Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+      #
+      # [Google Cloud Firestore Admin API][Product Documentation]:
+      # Accesses the NoSQL document database built for automatic scaling, high
+      # performance, and ease of application development.
+      # - [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 billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the Google Cloud Firestore Admin API.](https://console.cloud.google.com/apis/library/firestore-admin.googleapis.com)
+      # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-firestore/latest/file.AUTHENTICATION.html)
+      #
+      # ### Installation
+      # ```
+      # $ gem install google-cloud-firestore-admin
+      # ```
+      #
+      # ### Next Steps
+      # - Read the [Google Cloud Firestore Admin 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/googleapis/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/firestore-admin
+      #
+      # ## Enabling Logging
+      #
+      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+      #
+      # Configuring a Ruby stdlib logger:
+      #
+      # ```ruby
+      # require "logger"
+      #
+      # module MyLogger
+      #   LOGGER = Logger.new $stderr, level: Logger::WARN
+      #   def logger
+      #     LOGGER
+      #   end
+      # end
+      #
+      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+      # module GRPC
+      #   extend MyLogger
+      # end
+      # ```
+      #
+      module Admin
+        # rubocop:enable LineLength
+
+        FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("admin"))
+
+        AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
+          .select { |file| File.directory?(file) }
+          .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
+          .select { |dir| File.exist?(dir + ".rb") }
+          .map { |dir| File.basename(dir) }
+
+        ##
+        # Operations are created by service `FirestoreAdmin`, but are accessed via
+        # service `google.longrunning.Operations`.
+        #
+        # @param version [Symbol, String]
+        #   The major version of the service to be used. By default :v1
+        #   is used.
+        # @overload new(version:, credentials:, scopes:, client_config:, timeout:)
+        #   @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #     Provides the means for authenticating requests made by the client. This parameter can
+        #     be many types.
+        #     A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #     authenticating requests made by this client.
+        #     A `String` will be treated as the path to the keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #     credentials for this client.
+        #     A `GRPC::Core::Channel` will be used to make calls through.
+        #     A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #     should already be composed with a `GRPC::Core::CallCredentials` object.
+        #     A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #     metadata for requests, generally, to give OAuth credentials.
+        #   @param scopes [Array<String>]
+        #     The OAuth scopes for this service. This parameter is ignored if
+        #     an updater_proc is supplied.
+        #   @param client_config [Hash]
+        #     A Hash for call options for each method. See
+        #     Google::Gax#construct_settings for the structure of
+        #     this data. Falls back to the default config if not specified
+        #     or the specified config is missing data points.
+        #   @param timeout [Numeric]
+        #     The default timeout, in seconds, for calls made through this client.
+        #   @param metadata [Hash]
+        #     Default metadata to be sent with each request. This can be overridden on a per call basis.
+        #   @param exception_transformer [Proc]
+        #     An optional proc that intercepts any exceptions raised during an API call to inject
+        #     custom error handling.
+        def self.new(*args, version: :v1, **kwargs)
+          unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
+            raise "The version: #{version} is not available. The available versions " \
+              "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
+          end
+
+          require "#{FILE_DIR}/#{version.to_s.downcase}"
+          version_module = Google::Cloud::Firestore::Admin
+            .constants
+            .select {|sym| sym.to_s.downcase == version.to_s.downcase}
+            .first
+          Google::Cloud::Firestore::Admin.const_get(version_module).new(*args, **kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/firestore/admin/v1.rb

@@ -0,0 +1,151 @@
+# Copyright 2019 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/admin/v1/firestore_admin_client"
+require "google/firestore/admin/v1/operation_pb"
+require "google/firestore/admin/v1/location_pb"
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        # rubocop:disable LineLength
+
+        ##
+        # # Ruby Client for Google Cloud Firestore Admin API ([Alpha](https://github.com/googleapis/google-cloud-ruby#versioning))
+        #
+        # [Google Cloud Firestore Admin API][Product Documentation]:
+        # Accesses the NoSQL document database built for automatic scaling, high
+        # performance, and ease of application development.
+        # - [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 billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+        # 3. [Enable the Google Cloud Firestore Admin API.](https://console.cloud.google.com/apis/library/firestore-admin.googleapis.com)
+        # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-firestore/latest/file.AUTHENTICATION.html)
+        #
+        # ### Installation
+        # ```
+        # $ gem install google-cloud-firestore-admin
+        # ```
+        #
+        # ### Next Steps
+        # - Read the [Google Cloud Firestore Admin 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/googleapis/google-cloud-ruby/blob/master/README.md)
+        #   to see the full list of Cloud APIs that we cover.
+        #
+        # [Product Documentation]: https://cloud.google.com/firestore-admin
+        #
+        # ## Enabling Logging
+        #
+        # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+        # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+        # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+        # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+        # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+        #
+        # Configuring a Ruby stdlib logger:
+        #
+        # ```ruby
+        # require "logger"
+        #
+        # module MyLogger
+        #   LOGGER = Logger.new $stderr, level: Logger::WARN
+        #   def logger
+        #     LOGGER
+        #   end
+        # end
+        #
+        # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+        # module GRPC
+        #   extend MyLogger
+        # end
+        # ```
+        #
+        module V1
+          # rubocop:enable LineLength
+
+          ##
+          # Operations are created by service `FirestoreAdmin`, but are accessed via
+          # service `google.longrunning.Operations`.
+          #
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          # @param metadata [Hash]
+          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+          # @param service_address [String]
+          #   Override for the service hostname, or `nil` to leave as the default.
+          # @param service_port [Integer]
+          #   Override for the service port, or `nil` to leave as the default.
+          # @param exception_transformer [Proc]
+          #   An optional proc that intercepts any exceptions raised during an API call to inject
+          #   custom error handling.
+          def self.new \
+              credentials: nil,
+              scopes: nil,
+              client_config: nil,
+              timeout: nil,
+              metadata: nil,
+              service_address: nil,
+              service_port: nil,
+              exception_transformer: nil,
+              lib_name: nil,
+              lib_version: nil
+            kwargs = {
+              credentials: credentials,
+              scopes: scopes,
+              client_config: client_config,
+              timeout: timeout,
+              metadata: metadata,
+              exception_transformer: exception_transformer,
+              lib_name: lib_name,
+              service_address: service_address,
+              service_port: service_port,
+              lib_version: lib_version
+            }.select { |_, v| v != nil }
+            Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.new(**kwargs)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# Copyright 2019 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 "googleauth"
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          class Credentials < Google::Auth::Credentials
+            SCOPE = [
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/datastore"
+            ].freeze
+            PATH_ENV_VARS = %w(FIRESTORE_ADMIN_CREDENTIALS
+                               FIRESTORE_ADMIN_KEYFILE
+                               GOOGLE_CLOUD_CREDENTIALS
+                               GOOGLE_CLOUD_KEYFILE
+                               GCLOUD_KEYFILE)
+            JSON_ENV_VARS = %w(FIRESTORE_ADMIN_CREDENTIALS_JSON
+                               FIRESTORE_ADMIN_KEYFILE_JSON
+                               GOOGLE_CLOUD_CREDENTIALS_JSON
+                               GOOGLE_CLOUD_KEYFILE_JSON
+                               GCLOUD_KEYFILE_JSON)
+            DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/field.rb

@@ -0,0 +1,88 @@
+# Copyright 2019 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.
+
+
+module Google
+  module Firestore
+    module Admin
+      module V1
+        # Represents a single field in the database.
+        #
+        # Fields are grouped by their "Collection Group", which represent all
+        # collections in the database with the same id.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     A field name of the form
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
+        #
+        #     A field path may be a simple field name, e.g. `address` or a path to fields
+        #     within map_value , e.g. `address.city`,
+        #     or a special field path. The only valid special field is `*`, which
+        #     represents any field.
+        #
+        #     Field paths may be quoted using ` (backtick). The only character that needs
+        #     to be escaped within a quoted field path is the backtick character itself,
+        #     escaped using a backslash. Special characters in field paths that
+        #     must be quoted include: `*`, `.`,
+        #     ``` (backtick), `[`, `]`, as well as any ascii symbolic characters.
+        #
+        #     Examples:
+        #     (Note: Comments here are written in markdown syntax, so there is an
+        #      additional layer of backticks to represent a code block)
+        #     `\`address.city\`` represents a field named `address.city`, not the map key
+        #     `city` in the field `address`.
+        #     `\`*\`` represents a field named `*`, not any field.
+        #
+        #     A special `Field` contains the default indexing settings for all fields.
+        #     This field's resource name is:
+        #     `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
+        #     Indexes defined on this `Field` will be applied to all fields which do not
+        #     have their own `Field` index configuration.
+        # @!attribute [rw] index_config
+        #   @return [Google::Firestore::Admin::V1::Field::IndexConfig]
+        #     The index configuration for this field. If unset, field indexing will
+        #     revert to the configuration defined by the `ancestor_field`. To
+        #     explicitly remove all indexes for this field, specify an index config
+        #     with an empty list of indexes.
+        class Field
+          # The index configuration for this field.
+          # @!attribute [rw] indexes
+          #   @return [Array<Google::Firestore::Admin::V1::Index>]
+          #     The indexes supported for this field.
+          # @!attribute [rw] uses_ancestor_config
+          #   @return [true, false]
+          #     Output only.
+          #     When true, the `Field`'s index configuration is set from the
+          #     configuration specified by the `ancestor_field`.
+          #     When false, the `Field`'s index configuration is defined explicitly.
+          # @!attribute [rw] ancestor_field
+          #   @return [String]
+          #     Output only.
+          #     Specifies the resource name of the `Field` from which this field's
+          #     index configuration is set (when `uses_ancestor_config` is true),
+          #     or from which it *would* be set if this field had no index configuration
+          #     (when `uses_ancestor_config` is false).
+          # @!attribute [rw] reverting
+          #   @return [true, false]
+          #     Output only
+          #     When true, the `Field`'s index configuration is in the process of being
+          #     reverted. Once complete, the index config will transition to the same
+          #     state as the field specified by `ancestor_field`, at which point
+          #     `uses_ancestor_config` will be `true` and `reverting` will be `false`.
+          class IndexConfig; end
+        end
+      end
+    end
+  end
+end