google-cloud-bigquery 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95ecbf392c1c918219849034d540067effe661d635f7d435c1f73c0bbdcbefb3
-  data.tar.gz: 6452936f3e68a2fb9249fbdd23e54374ce67a86945b936adc6d06571b0266d5d
+  metadata.gz: 35c396da998783ed10060a16abd258256f2b14fd9f1a2bae8842a01db2edcd61
+  data.tar.gz: c942df4f34c23a7403344d532b62ad740c0073604d184f2851f4278310558250
 SHA512:
-  metadata.gz: 3c28948fc38d7fccd1b3775f209926eacbe671ddd36432660f336457d0630d8ce921b1600170cb7d56b093c2f805dd39d84230ddc04668f9e3a3d1238d0038dc
-  data.tar.gz: 7adba9ab644ef05f683a5a1b5f647e9106b77d997796c0d867d569caeac10d778d2948823f383f3eb7cfe1b5946b5c22a46d1403352f8358c7df1500ffdf291c
+  metadata.gz: d8b5a6f8dbec478cbb582f756ce27297e9e284a3146f644bc60a585ac952d7558235603d7a7a53a026cc9f2237bc6bf19890357b39b9559dcf1e4da671e19b7f
+  data.tar.gz: 86cbd63bffb1956b4d5685c79662befc444a6e15337f3da58118cc3cac6f3d7609b06f7be5ee836667f501dc7887b0acd5790fa9ec4f7f954606ab7780aa358a

data/AUTHENTICATION.md

@@ -2,7 +2,9 @@
 
 In general, the google-cloud-bigquery library uses [Service
 Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running on Compute Engine
+credentials to connect to Google Cloud services. When running on Google Cloud
+Platform (GCP), including Google Compute Engine (GCE), Google Kubernetes Engine
+(GKE), Google App Engine (GAE), Google Cloud Functions (GCF) and Cloud Run,
 the credentials will be discovered automatically. When running on other
 environments, the Service Account credentials can be specified by providing the
 path to the [JSON
@@ -35,32 +37,10 @@ providing **Project ID** and **Service Account Credentials** directly in code.
 
 ### Google Cloud Platform environments
 
-While running on Google Cloud Platform environments such as Google Compute
-Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
-The **Project ID** and **Credentials** and are discovered automatically. Code
-should be written as if already authenticated. Just be sure when you [set up the
-GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
-access. For example:
-
-  * **All APIs**
-    * `https://www.googleapis.com/auth/cloud-platform`
-    * `https://www.googleapis.com/auth/cloud-platform.read-only`
-  * **BigQuery**
-    * `https://www.googleapis.com/auth/bigquery`
-    * `https://www.googleapis.com/auth/bigquery.insertdata`
-  * **Compute Engine**
-    * `https://www.googleapis.com/auth/compute`
-  * **Datastore**
-    * `https://www.googleapis.com/auth/datastore`
-    * `https://www.googleapis.com/auth/userinfo.email`
-  * **DNS**
-    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
-  * **Pub/Sub**
-    * `https://www.googleapis.com/auth/pubsub`
-  * **Storage**
-    * `https://www.googleapis.com/auth/devstorage.full_control`
-    * `https://www.googleapis.com/auth/devstorage.read_only`
-    * `https://www.googleapis.com/auth/devstorage.read_write`
+When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
+Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
+(GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
+automatically. Code should be written as if already authenticated.
 
 ### Environment Variables
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 1.17.0 / 2019-10-29
+
+This release requires Ruby 2.4 or later.
+
+#### Documentation
+
+* Clarify which Google Cloud Platform environments support automatic authentication
+
 ### 1.16.0 / 2019-10-03
 
 #### Features

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-bigquery console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-bigquery requires Ruby 2.3+. You may choose to
+1. Install Ruby. google-cloud-bigquery requires Ruby 2.4+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).

data/OVERVIEW.md

@@ -6,11 +6,11 @@ is BigQuery?](https://cloud.google.com/bigquery/what-is-bigquery).
 
 The goal of google-cloud is to provide an API that is comfortable to Rubyists.
 Your authentication credentials are detected automatically in Google Cloud
-Platform environments such as Google Compute Engine, Google App Engine and
-Google Kubernetes Engine. In other environments you can configure authentication
-easily, either directly in your code or via environment variables. Read more
-about the options for connecting in the {file:AUTHENTICATION.md Authentication
-Guide}.
+Platform (GCP), including Google Compute Engine (GCE), Google Kubernetes Engine
+(GKE), Google App Engine (GAE), Google Cloud Functions (GCF) and Cloud Run. In
+other environments you can configure authentication easily, either directly in
+your code or via environment variables. Read more about the options for
+connecting in the {file:AUTHENTICATION.md Authentication Guide}.
 
 To help you get started quickly, the first few examples below use a public
 dataset provided by Google. As soon as you have [signed

data/lib/google-cloud-bigquery.rb

@@ -103,13 +103,10 @@ module Google
     #   dataset = bigquery.dataset "my_dataset"
     #   table = dataset.table "my_table"
     #
-    def self.bigquery project_id = nil, credentials = nil, scope: nil,
-                      retries: nil, timeout: nil
+    def self.bigquery project_id = nil, credentials = nil, scope: nil, retries: nil, timeout: nil
       require "google/cloud/bigquery"
-      Google::Cloud::Bigquery.new project_id: project_id,
-                                  credentials: credentials,
-                                  scope: scope, retries: retries,
-                                  timeout: timeout
+      Google::Cloud::Bigquery.new project_id: project_id, credentials: credentials,
+                                  scope: scope, retries: retries, timeout: timeout
     end
   end
 end
@@ -121,16 +118,13 @@ Google::Cloud.configure.add_config! :bigquery do |config|
   end
   default_creds = Google::Cloud::Config.deferred do
     Google::Cloud::Config.credentials_from_env(
-      "BIGQUERY_CREDENTIALS", "BIGQUERY_CREDENTIALS_JSON",
-      "BIGQUERY_KEYFILE", "BIGQUERY_KEYFILE_JSON"
+      "BIGQUERY_CREDENTIALS", "BIGQUERY_CREDENTIALS_JSON", "BIGQUERY_KEYFILE", "BIGQUERY_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_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! :retries, nil, match: Integer

data/lib/google/cloud/bigquery.rb

@@ -66,8 +66,8 @@ module Google
       #   dataset = bigquery.dataset "my_dataset"
       #   table = dataset.table "my_table"
       #
-      def self.new project_id: nil, credentials: nil, scope: nil, retries: nil,
-                   timeout: nil, endpoint: nil, project: nil, keyfile: nil
+      def self.new project_id: nil, credentials: nil, scope: nil, retries: nil, timeout: nil, endpoint: nil,
+                   project: nil, keyfile: nil
         scope       ||= configure.scope
         retries     ||= configure.retries
         timeout     ||= configure.timeout
@@ -121,9 +121,7 @@ module Google
       # @private Resolve project.
       def self.resolve_project_id given_project, credentials
         project_id = given_project || default_project_id
-        if credentials.respond_to? :project_id
-          project_id ||= credentials.project_id
-        end
+        project_id ||= credentials.project_id if credentials.respond_to? :project_id
         project_id.to_s # Always cast to a string
       end
 

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

@@ -118,83 +118,62 @@ module Google
         def self.to_query_param value
           if TrueClass === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "BOOL"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: true)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "BOOL"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: true)
             )
           elsif FalseClass === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "BOOL"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: false)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "BOOL"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: false)
             )
           elsif Integer === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "INT64"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "INT64"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value)
             )
           elsif Float === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "FLOAT64"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "FLOAT64"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value)
             )
           elsif BigDecimal === value
             # Round to precision of 9
             value_str = value.finite? ? value.round(9).to_s("F") : value.to_s
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "NUMERIC"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value_str)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "NUMERIC"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value_str)
             )
           elsif String === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "STRING"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "STRING"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value)
             )
           elsif DateTime === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "DATETIME"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value.strftime("%Y-%m-%d %H:%M:%S.%6N"))
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "DATETIME"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value.strftime("%Y-%m-%d %H:%M:%S.%6N"))
             )
           elsif Date === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "DATE"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value.to_s)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "DATE"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value.to_s)
             )
           elsif ::Time === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "TIMESTAMP"),
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "TIMESTAMP"),
               parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
                 value: value.strftime("%Y-%m-%d %H:%M:%S.%6N%:z"))
             )
           elsif Bigquery::Time === value
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-              type: "TIME"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: value.value)
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "TIME"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: value.value)
             )
           elsif value.respond_to?(:read) && value.respond_to?(:rewind)
             value.rewind
             return Google::Apis::BigqueryV2::QueryParameter.new(
-              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(
-                type: "BYTES"),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                value: Base64.strict_encode64(
+              parameter_type:  Google::Apis::BigqueryV2::QueryParameterType.new(type: "BYTES"),
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(value: Base64.strict_encode64(
                   value.read.force_encoding("ASCII-8BIT")))
             )
           elsif Array === value
@@ -225,9 +204,7 @@ module Google
                 type: "STRUCT",
                 struct_types: struct_pairs.map(&:first)
               ),
-              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(
-                struct_values: struct_values
-              )
+              parameter_value: Google::Apis::BigqueryV2::QueryParameterValue.new(struct_values: struct_values)
             )
           else
             raise "A query parameter of type #{value.class} is not supported."
@@ -390,7 +367,7 @@ module Google
         #   nil if the given argument is nil.
         def self.time_to_millis time_obj
           return nil unless time_obj
-          (time_obj.to_i * 1000) + (time_obj.nsec / 1000000)
+          (time_obj.to_i * 1000) + (time_obj.nsec / 1_000_000)
         end
       end
 

data/lib/google/cloud/bigquery/copy_job.rb

@@ -51,9 +51,7 @@ module Google
         def source
           table = @gapi.configuration.copy.source_table
           return nil unless table
-          retrieve_table table.project_id,
-                         table.dataset_id,
-                         table.table_id
+          retrieve_table table.project_id, table.dataset_id, table.table_id
         end
 
         ##
@@ -64,9 +62,7 @@ module Google
         def destination
           table = @gapi.configuration.copy.destination_table
           return nil unless table
-          retrieve_table table.project_id,
-                         table.dataset_id,
-                         table.table_id
+          retrieve_table table.project_id, table.dataset_id, table.table_id
         end
 
         ##
@@ -139,9 +135,7 @@ module Google
         #
         # @!group Attributes
         def encryption
-          EncryptionConfiguration.from_gapi(
-            @gapi.configuration.copy.destination_encryption_configuration
-          )
+          EncryptionConfiguration.from_gapi @gapi.configuration.copy.destination_encryption_configuration
         end
 
         ##
@@ -227,8 +221,7 @@ module Google
           #
           # @!group Attributes
           def create= new_create
-            @gapi.configuration.copy.update! \
-              create_disposition: Convert.create_disposition(new_create)
+            @gapi.configuration.copy.update! create_disposition: Convert.create_disposition(new_create)
           end
 
           ##
@@ -248,8 +241,7 @@ module Google
           #
           # @!group Attributes
           def write= new_write
-            @gapi.configuration.copy.update! \
-              write_disposition: Convert.write_disposition(new_write)
+            @gapi.configuration.copy.update! write_disposition: Convert.write_disposition(new_write)
           end
 
           ##
@@ -273,9 +265,7 @@ module Google
           #
           # @!group Attributes
           def encryption= val
-            @gapi.configuration.copy.update!(
-              destination_encryption_configuration: val.to_gapi
-            )
+            @gapi.configuration.copy.update! destination_encryption_configuration: val.to_gapi
           end
 
           ##

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

@@ -39,18 +39,11 @@ module Google
       #
       class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/bigquery"].freeze
-        PATH_ENV_VARS = %w[BIGQUERY_CREDENTIALS
-                           GOOGLE_CLOUD_CREDENTIALS
-                           BIGQUERY_KEYFILE
-                           GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE].freeze
-        JSON_ENV_VARS = %w[BIGQUERY_CREDENTIALS_JSON
-                           GOOGLE_CLOUD_CREDENTIALS_JSON
-                           BIGQUERY_KEYFILE_JSON
-                           GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON].freeze
-        DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"].freeze
+        PATH_ENV_VARS = ["BIGQUERY_CREDENTIALS", "GOOGLE_CLOUD_CREDENTIALS", "BIGQUERY_KEYFILE", "GOOGLE_CLOUD_KEYFILE",
+                         "GCLOUD_KEYFILE"].freeze
+        JSON_ENV_VARS = ["BIGQUERY_CREDENTIALS_JSON", "GOOGLE_CLOUD_CREDENTIALS_JSON", "BIGQUERY_KEYFILE_JSON",
+                         "GOOGLE_CLOUD_KEYFILE_JSON", "GCLOUD_KEYFILE_JSON"].freeze
+        DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

data/lib/google/cloud/bigquery/data.rb

@@ -227,8 +227,7 @@ module Google
         # @return [String, nil] The type of query statement.
         #
         def statement_type
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.statement_type
+          job_gapi&.statistics&.query&.statement_type
         end
 
         ##
@@ -249,8 +248,8 @@ module Google
         #   data.ddl? #=> true
         #
         def ddl?
-          %w[CREATE_MODEL CREATE_TABLE CREATE_TABLE_AS_SELECT CREATE_VIEW \
-             DROP_MODEL DROP_TABLE DROP_VIEW].include? statement_type
+          ["CREATE_MODEL", "CREATE_TABLE", "CREATE_TABLE_AS_SELECT", "CREATE_VIEW", "\n", "DROP_MODEL", "DROP_TABLE",
+           "DROP_VIEW"].include? statement_type
         end
 
         ##
@@ -273,7 +272,7 @@ module Google
         #   data.dml? #=> true
         #
         def dml?
-          %w[INSERT UPDATE MERGE DELETE].include? statement_type
+          ["INSERT", "UPDATE", "MERGE", "DELETE"].include? statement_type
         end
 
         ##
@@ -292,8 +291,7 @@ module Google
         # @return [String, nil] The DDL operation performed.
         #
         def ddl_operation_performed
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.ddl_operation_performed
+          job_gapi&.statistics&.query&.ddl_operation_performed
         end
 
         ##
@@ -305,10 +303,9 @@ module Google
         #   reference state.
         #
         def ddl_target_table
-          return nil unless job_gapi && job_gapi.statistics.query
           ensure_service!
-          table = job_gapi.statistics.query.ddl_target_table
-          return nil unless table
+          table = job_gapi&.statistics&.query&.ddl_target_table
+          return nil if table.nil?
           Google::Cloud::Bigquery::Table.new_reference_from_gapi table, service
         end
 
@@ -320,8 +317,7 @@ module Google
         #   or `nil` if the query is not a DML statement.
         #
         def num_dml_affected_rows
-          return nil unless job_gapi && job_gapi.statistics.query
-          job_gapi.statistics.query.num_dml_affected_rows
+          job_gapi&.statistics&.query&.num_dml_affected_rows
         end
 
         ##
@@ -447,7 +443,7 @@ module Google
             results.each { |r| yield r }
             if request_limit
               request_limit -= 1
-              break if request_limit < 0
+              break if request_limit.negative?
             end
             break unless results.next?
             results = results.next
@@ -458,9 +454,7 @@ module Google
         # @private New Data from a response object.
         def self.from_gapi_json gapi_json, table_gapi, job_gapi, service
           rows = gapi_json[:rows] || []
-          unless rows.empty?
-            rows = Convert.format_rows rows, table_gapi.schema.fields
-          end
+          rows = Convert.format_rows rows, table_gapi.schema.fields unless rows.empty?
 
           data = new rows
           data.table_gapi = table_gapi