google-cloud-bigtable 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75dda3fa2c76316a47a331878fc5b634c5bd5f471ec3c89ece5db2e8ce60c388
-  data.tar.gz: dfceb7dabcb83f54c3f2bf1e30d85e3ddf13e6f490260e1dd966e52c2675b05b
+  metadata.gz: 9eddd8059079440d6581a1e6342310ad31127c8f27f9f34a3e18d975a6a5d699
+  data.tar.gz: 637a977333b83097dc2a37bf70bf08b014305ed6409c258aeae3dba74ccb5602
 SHA512:
-  metadata.gz: 88626715dc50760d929db8819cdf6333a7faffe67153222a81dcd2d941ced9cc471912f33ed74fa04a0c629f4d351386f9ae6ca098f4d083eb24100b5120b82d
-  data.tar.gz: 3c5c577ae655453c155fab31735312933c834984b2d2091a7950fddbec9532f71b8d395d41a3c768d4ed6bec016f07f5384c11ac547075e1cfb67ed0abaf7b51
+  metadata.gz: 0551601ee5fda48a466492e92a8c4c714f6fe06dde7a8cbe14c3ea6f25c8847df7afac42389cef51e414f239034dce1e93cf724087e0500ed25fb7663b0105a9
+  data.tar.gz: 85614a616934df1c135d279e5ed0136d2a382ce538535db1519e712e5d30942e3c75c5d69ac67918aab9568d183e74393b46652995f85568f4c602067d543c5d

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Release History
 
+### 0.6.0 / 2019-08-23
+
+#### Features
+
+* Support overriding of the service endpoint
+
+#### Documentation
+
+* Update documentation
+
 ### 0.5.0 / 2019-08-05
 
 * Accept nil gc_rule arguments for column_family create/update

data/lib/google-cloud-bigtable.rb

@@ -170,4 +170,5 @@ Google::Cloud.configure.add_config! :bigtable 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/bigtable.rb

@@ -46,6 +46,8 @@ module Google
       #   should already be composed with a `GRPC::Core::CallCredentials` object.
       #   `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 [String] endpoint Override of the endpoint host name. Optional.
+      #   If the param is nil, uses the default endpoint.
       # @param [String] emulator_host Bigtable emulator host. Optional.
       #   If the parameter is nil, uses the value of the `emulator_host` config.
       # @param scope [Array<String>]
@@ -67,49 +69,34 @@ module Google
       #   require "google/cloud/bigtable"
       #
       #   client = Google::Cloud::Bigtable.new
-
+      #
       def self.new \
           project_id: nil,
           credentials: nil,
           emulator_host: nil,
           scope: nil,
           client_config: nil,
+          endpoint: nil,
           timeout: nil
         project_id    ||= default_project_id
         scope         ||= configure.scope
         timeout       ||= configure.timeout
         client_config ||= configure.client_config
         emulator_host ||= configure.emulator_host
+        endpoint      ||= configure.endpoint
 
         if emulator_host
-          project_id = project_id.to_s # Always cast to a string
-          raise ArgumentError, "project_id is missing" if project_id.empty?
-
-          return Bigtable::Project.new(
-            Bigtable::Service.new(
-              project_id, :this_channel_is_insecure,
-              host: emulator_host, timeout: timeout,
-              client_config: client_config
-            )
-          )
-        end
-
-        credentials ||= default_credentials(scope: scope)
-        unless credentials.is_a? Google::Auth::Credentials
-          credentials = Bigtable::Credentials.new credentials, scope: scope
+          return new_with_emulator project_id, emulator_host, timeout,
+                                   client_config
         end
 
-        if credentials.respond_to? :project_id
-          project_id ||= credentials.project_id
-        end
-        project_id = project_id.to_s # Always cast to a string
+        credentials = resolve_credentials credentials, scope
+        project_id = resolve_project_id project_id, credentials
         raise ArgumentError, "project_id is missing" if project_id.empty?
 
         service = Bigtable::Service.new(
-          project_id,
-          credentials,
-          timeout: timeout,
-          client_config: client_config
+          project_id, credentials,
+          host: endpoint, timeout: timeout, client_config: client_config
         )
         Bigtable::Project.new(service)
       end
@@ -130,59 +117,74 @@ 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.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Bigtable library uses.
-
+      #
       def self.configure
         yield Google::Cloud.configure.bigtable if block_given?
 
         Google::Cloud.configure.bigtable
       end
 
-      # Configure the Google Cloud Bigtable library.
-      #
-      # The following Bigtable configuration parameters are supported:
-      #
-      # * `project_id` - (String) Identifier for a Bigtable project. (The
-      #   parameter `project` is considered deprecated, but may also be used.)
-      # * `credentials` - (String, Hash, Google::Auth::Credentials,
-      #    GRPC::Core::Channel, GRPC::Core::ChannelCredentials) The path to
-      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
-      #   Google::Auth::Credentials object. (See {Bigtable::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.
+      # @private
+      # New client given an emulator host.
       #
-      # @return [Google::Cloud::Config] The configuration object the
-      #   Google::Cloud::Bigtable library uses.
-
-      def self.configure
-        yield Google::Cloud.configure.bigtable if block_given?
+      def self.new_with_emulator project_id, emulator_host, timeout,
+                                 client_config
+        project_id = project_id.to_s # Always cast to a string
+        raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        Google::Cloud.configure.bigtable
+        Bigtable::Project.new(
+          Bigtable::Service.new(
+            project_id, :this_channel_is_insecure,
+            host: emulator_host, timeout: timeout,
+            client_config: client_config
+          )
+        )
       end
 
-     # @private
-     # Default project.
+      # @private
+      # Resolve credentials
+      #
+      def self.resolve_credentials given_credentials, scope
+        credentials = given_credentials || default_credentials(scope: scope)
+        unless credentials.is_a? Google::Auth::Credentials
+          credentials = Bigtable::Credentials.new credentials, scope: scope
+        end
+        credentials
+      end
 
-     def self.default_project_id
-       Google::Cloud.configure.bigtable.project_id ||
-         Google::Cloud.configure.project_id ||
-         Google::Cloud.env.project_id
-     end
+      # @private
+      # Resolve project.
+      #
+      def self.resolve_project_id given_project_id, credentials
+        project_id = given_project_id || default_project_id
+        if credentials.respond_to? :project_id
+          project_id ||= credentials.project_id
+        end
+        project_id.to_s # Always cast to a string
+      end
 
-     # @private
-     # Default credentials.
+      # @private
+      # Default project.
+      #
+      def self.default_project_id
+        Google::Cloud.configure.bigtable.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
 
-     def self.default_credentials scope: nil
-       Google::Cloud.configure.bigtable.credentials ||
-         Google::Cloud.configure.credentials ||
-         Bigtable::Credentials.default(scope: scope)
-     end
+      # @private
+      # Default credentials.
+      #
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.bigtable.credentials ||
+          Google::Cloud.configure.credentials ||
+          Bigtable::Credentials.default(scope: scope)
+      end
     end
   end
 end

data/lib/google/cloud/bigtable/admin/v2/doc/google/iam/v1/policy.rb

@@ -79,7 +79,7 @@ module Google
       #     ensure that their change will be applied to the same version of the policy.
       #
       #     If no `etag` is provided in the call to `setIamPolicy`, then the existing
-      #     policy is overwritten blindly.
+      #     policy is overwritten.
       class Policy; end
 
       # Associates `members` with a `role`.
@@ -99,7 +99,7 @@ module Google
       #       who is authenticated with a Google account or a service account.
       #
       #     * `user:{emailid}`: An email address that represents a specific Google
-      #       account. For example, `alice@gmail.com` .
+      #       account. For example, `alice@example.com` .
       #
       #
       #     * `serviceAccount:{emailid}`: An email address that represents a service

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigtable
-      VERSION = "0.5.0".freeze
+      VERSION = "0.6.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigtable
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax