google-cloud-bigquery 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74839ee1c88e2e24abdd6d512f8a452e1d1a082625d24e01edc47181ffd13f04
-  data.tar.gz: 9f9953c3b0b6eacfa267fbba3965119e7dcb10452a5c5ea5a7af221a9a50621a
+  metadata.gz: cb7f8896ef2f04b07d335a2d619a60557246633ef343255c7fd6f2c31c1afbcf
+  data.tar.gz: 8445e2df96afbd0be615ee17d891d3b192a2a6a32f21f010113809c020e6aa76
 SHA512:
-  metadata.gz: 1690839d5bf4ae37c36aa0e70f57ff57e7a724916732ecb486d55b78a7b1cc81d2c5efcf8ce9db4af13049aede00a5a005bcf5391e99ca59fbef353eb011b757
-  data.tar.gz: 190dd0298a146cfc1a7f58687c771a7603a374084af4614627aeb02539cbf4cd1dde2b82ad09b591dfb3f36653b1673fa771aea7fac2c57e940bdd030cbf7c9c
+  metadata.gz: ead4df8de6a2db97edf826bfdf82c49b48e7eebd999d3ee1448616a5b1d53d219bcc66dfe13fbe6e005282d7a59582ff4ead46adbe10a25cb365b19ebb0a5ba2
+  data.tar.gz: f1de83104a82b84673b071395aa1527bc4ed3d992c2ed0b7b04b9cbb13f3f303277da04ee93e944411ae0cab10cdea573783da6ef9ece20782f429c34da76ac2

data/lib/google-cloud-bigquery.rb

@@ -20,6 +20,8 @@
 
 gem "google-cloud-core"
 require "google/cloud"
+require "google/cloud/config"
+require "googleauth"
 
 module Google
   module Cloud
@@ -111,3 +113,26 @@ module Google
     end
   end
 end
+
+# Set the default bigquery configuration
+Google::Cloud.configure.add_config! :bigquery do |config|
+  default_project = Google::Cloud::Config.deferred do
+    ENV["BIGQUERY_PROJECT"]
+  end
+  default_creds = Google::Cloud::Config.deferred do
+    Google::Cloud::Config.credentials_from_env(
+      "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_alias! :keyfile, :credentials
+  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :retries, nil, match: Integer
+  config.add_field! :timeout, nil, match: Integer
+end

data/lib/google/cloud/bigquery.rb

@@ -15,6 +15,8 @@
 
 require "google-cloud-bigquery"
 require "google/cloud/bigquery/project"
+require "google/cloud/config"
+require "google/cloud/env"
 
 module Google
   module Cloud
@@ -46,13 +48,13 @@ module Google
     #
     # A BigQuery project contains datasets, which in turn contain tables.
     # Assuming that you have not yet created datasets or tables in your own
-    # project, let's connect to Google's `publicdata` project, and see what we
-    # find.
+    # project, let's connect to Google's `bigquery-public-data` project, and see
+    # what we find.
     #
     # ```ruby
     # require "google/cloud/bigquery"
     #
-    # bigquery = Google::Cloud::Bigquery.new project: "publicdata"
+    # bigquery = Google::Cloud::Bigquery.new project: "bigquery-public-data"
     #
     # bigquery.datasets.count #=> 1
     # bigquery.datasets.first.dataset_id #=> "samples"
@@ -72,7 +74,7 @@ module Google
     # ```ruby
     # require "google/cloud/bigquery"
     #
-    # bigquery = Google::Cloud::Bigquery.new project: "publicdata"
+    # bigquery = Google::Cloud::Bigquery.new project: "bigquery-public-data"
     #
     # dataset = bigquery.dataset "samples"
     # table = dataset.table "shakespeare"
@@ -145,7 +147,7 @@ module Google
     # bigquery = Google::Cloud::Bigquery.new
     #
     # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " \
-    #       "FROM [publicdata:samples.shakespeare]"
+    #       "FROM [bigquery-public-data:samples.shakespeare]"
     # data = bigquery.query sql, legacy_sql: true
     # ```
     #
@@ -210,7 +212,7 @@ module Google
     #
     # sql = "SELECT APPROX_TOP_COUNT(corpus, 10) as title, " \
     #       "COUNT(*) as unique_words " \
-    #       "FROM publicdata.samples.shakespeare"
+    #       "FROM `bigquery-public-data.samples.shakespeare`"
     # data = bigquery.query sql
     #
     # data.next? #=> false
@@ -237,7 +239,7 @@ module Google
     #
     # sql = "SELECT APPROX_TOP_COUNT(corpus, 10) as title, " \
     #       "COUNT(*) as unique_words " \
-    #       "FROM publicdata.samples.shakespeare"
+    #       "FROM `bigquery-public-data.samples.shakespeare`"
     # job = bigquery.query_job sql
     #
     # job.wait_until_done!
@@ -521,18 +523,66 @@ module Google
       #
       def self.new project_id: nil, credentials: nil, scope: nil, retries: nil,
                    timeout: nil, project: nil, keyfile: nil
-        project_id ||= (project || Bigquery::Project.default_project_id)
+        project_id ||= (project || default_project_id)
         project_id = project_id.to_s # Always cast to a string
-        fail ArgumentError, "project_id is missing" if project_id.empty?
+        raise ArgumentError, "project_id is missing" if project_id.empty?
 
-        credentials ||= (keyfile || Bigquery::Credentials.default(scope: scope))
+        scope ||= configure.scope
+        retries ||= configure.retries
+        timeout ||= configure.timeout
+
+        credentials ||= (keyfile || default_credentials(scope: scope))
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Bigquery::Credentials.new credentials, scope: scope
         end
 
         Bigquery::Project.new(
           Bigquery::Service.new(
-            project_id, credentials, retries: retries, timeout: timeout))
+            project_id, credentials, retries: retries, timeout: timeout
+          )
+        )
+      end
+
+      ##
+      # Configure the Google Cloud BigQuery library.
+      #
+      # The following BigQuery configuration parameters are supported:
+      #
+      # * `project_id` - (String) Identifier for a BigQuery project. (The
+      #   parameter `project` is considered deprecated, but may also be used.)
+      # * `credentials` - (String, Hash, Google::Auth::Credentials) The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Bigquery::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.
+      # * `retries` - (Integer) Number of times to retry requests on server
+      #   error.
+      # * `timeout` - (Integer) Default timeout to use in requests.
+      #
+      # @return [Google::Cloud::Config] The configuration object the
+      #   Google::Cloud::Bigquery library uses.
+      #
+      def self.configure
+        yield Google::Cloud.configure.bigquery if block_given?
+
+        Google::Cloud.configure.bigquery
+      end
+
+      ##
+      # @private Default project.
+      def self.default_project_id
+        Google::Cloud.configure.bigquery.project_id ||
+          Google::Cloud.configure.project_id ||
+          Google::Cloud.env.project_id
+      end
+
+      ##
+      # @private Default credentials.
+      def self.default_credentials scope: nil
+        Google::Cloud.configure.bigquery.credentials ||
+          Google::Cloud.configure.credentials ||
+          Bigquery::Credentials.default(scope: scope)
       end
     end
   end

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

@@ -208,7 +208,7 @@ module Google
               )
             )
           else
-            fail "A query parameter of type #{value.class} is not supported."
+            raise "A query parameter of type #{value.class} is not supported."
           end
         end
 

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

@@ -38,19 +38,19 @@ module Google
       #   bigquery.project_id #=> "my-project"
       #
       class Credentials < Google::Auth::Credentials
-        SCOPE = ["https://www.googleapis.com/auth/bigquery"]
-        PATH_ENV_VARS = %w(BIGQUERY_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)
-        JSON_ENV_VARS = %w(BIGQUERY_CREDENTIALS_JSON
+                           GCLOUD_KEYFILE].freeze
+        JSON_ENV_VARS = %w[BIGQUERY_CREDENTIALS_JSON
                            GOOGLE_CLOUD_CREDENTIALS_JSON
                            BIGQUERY_KEYFILE_JSON
                            GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON)
+                           GCLOUD_KEYFILE_JSON].freeze
         DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"]
+          ["~/.config/gcloud/application_default_credentials.json"].freeze
       end
     end
   end

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

@@ -33,7 +33,7 @@ module Google
       #
       #   bigquery = Google::Cloud::Bigquery.new
       #
-      #   sql = "SELECT word FROM publicdata.samples.shakespeare"
+      #   sql = "SELECT word FROM `bigquery-public-data.samples.shakespeare`"
       #   job = bigquery.query_job sql
       #
       #   job.wait_until_done!
@@ -105,7 +105,7 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   sql = "SELECT word FROM publicdata.samples.shakespeare"
+        #   sql = "SELECT word FROM `bigquery-public-data.samples.shakespeare`"
         #   job = bigquery.query_job sql
         #
         #   job.wait_until_done!
@@ -120,7 +120,7 @@ module Google
         #
         def total
           Integer @gapi_json[:totalRows]
-        rescue
+        rescue StandardError
           nil
         end
 
@@ -205,7 +205,7 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   sql = "SELECT word FROM publicdata.samples.shakespeare"
+        #   sql = "SELECT word FROM `bigquery-public-data.samples.shakespeare`"
         #   job = bigquery.query_job sql
         #
         #   job.wait_until_done!
@@ -232,7 +232,7 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #
-        #   sql = "SELECT word FROM publicdata.samples.shakespeare"
+        #   sql = "SELECT word FROM `bigquery-public-data.samples.shakespeare`"
         #   job = bigquery.query_job sql
         #
         #   job.wait_until_done!
@@ -343,7 +343,7 @@ module Google
         ##
         # Raise an error unless an active service is available.
         def ensure_service!
-          fail "Must have active connection" unless service
+          raise "Must have active connection" unless service
         end
       end
     end

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

@@ -202,7 +202,7 @@ module Google
           ensure_full_data!
           begin
             Integer @gapi.default_table_expiration_ms
-          rescue
+          rescue StandardError
             nil
           end
         end
@@ -239,7 +239,7 @@ module Google
           ensure_full_data!
           begin
             ::Time.at(Integer(@gapi.creation_time) / 1000.0)
-          rescue
+          rescue StandardError
             nil
           end
         end
@@ -257,7 +257,7 @@ module Google
           ensure_full_data!
           begin
             ::Time.at(Integer(@gapi.last_modified_time) / 1000.0)
-          rescue
+          rescue StandardError
             nil
           end
         end
@@ -494,7 +494,9 @@ module Google
           new_tb = Google::Apis::BigqueryV2::Table.new(
             table_reference: Google::Apis::BigqueryV2::TableReference.new(
               project_id: project_id, dataset_id: dataset_id,
-              table_id: table_id))
+              table_id: table_id
+            )
+          )
           updater = Table::Updater.new(new_tb).tap do |tb|
             tb.name = name unless name.nil?
             tb.description = description unless description.nil?
@@ -1070,8 +1072,8 @@ module Google
           if job.failed?
             begin
               # raise to activate ruby exception cause handling
-              fail job.gapi_error
-            rescue => e
+              raise job.gapi_error
+            rescue StandardError => e
               # wrap Google::Apis::Error with Google::Cloud::Error
               raise Google::Cloud::Error.from_error(e)
             end
@@ -1363,7 +1365,7 @@ module Google
                       null_marker: null_marker }
           return load_storage(table_id, file, options) if storage_url? file
           return load_local(table_id, file, options) if local_file? file
-          fail Google::Cloud::Error, "Don't know how to load #{file}"
+          raise Google::Cloud::Error, "Don't know how to load #{file}"
         end
 
         ##
@@ -1570,8 +1572,8 @@ module Google
           if job.failed?
             begin
               # raise to activate ruby exception cause handling
-              fail job.gapi_error
-            rescue => e
+              raise job.gapi_error
+            rescue StandardError => e
               # wrap Google::Apis::Error with Google::Cloud::Error
               raise Google::Cloud::Error.from_error(e)
             end
@@ -1601,7 +1603,7 @@ module Google
           @gapi = reloaded_gapi
           self
         end
-        alias_method :refresh!, :reload!
+        alias refresh! reload!
 
         ##
         # Determines whether the dataset exists in the BigQuery service. The
@@ -1867,8 +1869,7 @@ module Google
         #
         #   bigquery = Google::Cloud::Bigquery.new
         #   dataset = bigquery.dataset "my_dataset"
-        #   table = dataset.table "my_table"
-        #   inserter = table.insert_async do |result|
+        #   inserter = dataset.insert_async "my_table" do |result|
         #     if result.error?
         #       log_error result.error
         #     else
@@ -1904,7 +1905,7 @@ module Google
 
         def insert_data table_id, rows, skip_invalid: nil, ignore_unknown: nil
           rows = [rows] if rows.is_a? Hash
-          fail ArgumentError, "No rows provided" if rows.empty?
+          raise ArgumentError, "No rows provided" if rows.empty?
           ensure_service!
           options = { skip_invalid: skip_invalid,
                       ignore_unknown: ignore_unknown }
@@ -1915,7 +1916,7 @@ module Google
         ##
         # Raise an error unless an active service is available.
         def ensure_service!
-          fail "Must have active connection" unless service
+          raise "Must have active connection" unless service
         end
 
         ##
@@ -1972,7 +1973,7 @@ module Google
 
         def local_file? file
           ::File.file? file
-        rescue
+        rescue StandardError
           false
         end
 

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

@@ -40,36 +40,42 @@ module Google
         #
         class Access
           # @private
-          ROLES = { "reader" => "READER",
-                    "writer" => "WRITER",
-                    "owner"  => "OWNER" }
+          ROLES = {
+            "reader" => "READER",
+            "writer" => "WRITER",
+            "owner"  => "OWNER"
+          }.freeze
 
           # @private
-          SCOPES = { "user"           => :user_by_email,
-                     "user_by_email"  => :user_by_email,
-                     "userByEmail"    => :user_by_email,
-                     "group"          => :group_by_email,
-                     "group_by_email" => :group_by_email,
-                     "groupByEmail"   => :group_by_email,
-                     "domain"         => :domain,
-                     "special"        => :special_group,
-                     "special_group"  => :special_group,
-                     "specialGroup"   => :special_group,
-                     "view"           => :view }
+          SCOPES = {
+            "user"           => :user_by_email,
+            "user_by_email"  => :user_by_email,
+            "userByEmail"    => :user_by_email,
+            "group"          => :group_by_email,
+            "group_by_email" => :group_by_email,
+            "groupByEmail"   => :group_by_email,
+            "domain"         => :domain,
+            "special"        => :special_group,
+            "special_group"  => :special_group,
+            "specialGroup"   => :special_group,
+            "view"           => :view
+          }.freeze
 
           # @private
-          GROUPS = { "owners"                  => "projectOwners",
-                     "project_owners"          => "projectOwners",
-                     "projectOwners"           => "projectOwners",
-                     "readers"                 => "projectReaders",
-                     "project_readers"         => "projectReaders",
-                     "projectReaders"          => "projectReaders",
-                     "writers"                 => "projectWriters",
-                     "project_writers"         => "projectWriters",
-                     "projectWriters"          => "projectWriters",
-                     "all"                     => "allAuthenticatedUsers",
-                     "all_authenticated_users" => "allAuthenticatedUsers",
-                     "allAuthenticatedUsers"   => "allAuthenticatedUsers" }
+          GROUPS = {
+            "owners"                  => "projectOwners",
+            "project_owners"          => "projectOwners",
+            "projectOwners"           => "projectOwners",
+            "readers"                 => "projectReaders",
+            "project_readers"         => "projectReaders",
+            "projectReaders"          => "projectReaders",
+            "writers"                 => "projectWriters",
+            "project_writers"         => "projectWriters",
+            "projectWriters"          => "projectWriters",
+            "all"                     => "allAuthenticatedUsers",
+            "all_authenticated_users" => "allAuthenticatedUsers",
+            "allAuthenticatedUsers"   => "allAuthenticatedUsers"
+          }.freeze
 
           ##
           # @private
@@ -891,7 +897,7 @@ module Google
           def validate_role role
             good_role = ROLES[role.to_s]
             if good_role.nil?
-              fail ArgumentError "Unable to determine role for #{role}"
+              raise ArgumentError "Unable to determine role for #{role}"
             end
             good_role
           end
@@ -900,7 +906,7 @@ module Google
           def validate_scope scope
             good_scope = SCOPES[scope.to_s]
             if good_scope.nil?
-              fail ArgumentError "Unable to determine scope for #{scope}"
+              raise ArgumentError "Unable to determine scope for #{scope}"
             end
             good_scope
           end
@@ -953,7 +959,8 @@ module Google
             value = validate_special_group(value) if scope == :special_group
             # Remove any rules of this role, scope, and value
             @rules.reject!(
-              &find_by_role_and_scope_and_value(role, scope, value))
+              &find_by_role_and_scope_and_value(role, scope, value)
+            )
           end
 
           # @private
@@ -972,7 +979,8 @@ module Google
             value = validate_special_group(value) if scope == :special_group
             # Detect any rules of this role, scope, and value
             !(!@rules.detect(
-              &find_by_role_and_scope_and_value(role, scope, value)))
+              &find_by_role_and_scope_and_value(role, scope, value)
+            ))
           end
 
           # @private