google-cloud-bigquery 0.20.1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6129a4396ad062d0e2650f3e535fedbca11ee0e
-  data.tar.gz: 0899727f3944a1880bf3ffb19c509200e15702c2
+  metadata.gz: f16696b5a90b556871480222793c4e66d27c9fe6
+  data.tar.gz: b6c55807e67d5888773bccf1dabee042b23a9abe
 SHA512:
-  metadata.gz: 058e23892c9ec64ac3823816e25a0c55a2d572f0885972db63b89d06d4510ee29e0aefc7d77cea756da90d291f244faa8aba8e7a8acb8084e1ea5ba64773199d
-  data.tar.gz: 6b98a5e9edd5daa77b03c525adc5c08602419e4c3bb88e2e5f0ee9180515c14b42925ac433dfed73d54286f15255f8de72f807f6d25ca7653e2877a2f337fd37
+  metadata.gz: f07cece664a25f4962b72aef938fc39ff560e2aefbe32eabb375f8e98303f016d032fddce70de0a8f8887b2d4e49f5aa3e0b1e358a09a675d650a082d8984d61
+  data.tar.gz: 7b3ebbc30c72952601caf1f293fb8913ce51e9be6b22e2b783baaf7d26b378648009a7bec603b94823d2558befbe9cadcd362de701c3b71905704f45bc0b6d0c

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

@@ -20,6 +20,7 @@ require "google/cloud/bigquery/credentials"
 require "google/cloud/bigquery/dataset"
 require "google/cloud/bigquery/job"
 require "google/cloud/bigquery/query_data"
+require "google/cloud/bigquery/project/list"
 
 module Google
   module Cloud
@@ -35,7 +36,12 @@ module Google
       # Google BigQuery. {Google::Cloud::Bigquery::Dataset} objects are created,
       # accessed, and deleted by Google::Cloud::Bigquery::Project.
       #
-      # See {Google::Cloud#bigquery}
+      # See {Google::Cloud#bigquery}.
+      #
+      # @attr_reader [String, nil] name The descriptive name of the project.
+      #   Can only be present if the project was retrieved with {#projects}.
+      # @attr_reader [Integer, nil] numeric_id The numeric ID of the project.
+      #   Can only be present if the project was retrieved with {#projects}.
       #
       # @example
       #   require "google/cloud"
@@ -50,6 +56,8 @@ module Google
         # @private The Service object.
         attr_accessor :service
 
+        attr_reader :name, :numeric_id
+
         ##
         # Creates a new Service instance.
         #
@@ -468,6 +476,75 @@ module Google
           Job::List.from_gapi gapi, service, all, max, filter
         end
 
+        ##
+        # Retrieves the list of all projects for which the currently authorized
+        # account has been granted any project role. The returned project
+        # instances share the same credentials as the project used to retrieve
+        # them, but lazily create a new API connection for interactions with the
+        # BigQuery service.
+        #
+        # @param [String] token A previously-returned page token representing
+        #   part of the larger set of results to view.
+        # @param [Integer] max Maximum number of projects to return.
+        #
+        # @return [Array<Google::Cloud::Bigquery::Project>] (See
+        #   {Google::Cloud::Bigquery::Project::List})
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   bigquery = gcloud.bigquery
+        #
+        #   projects = bigquery.projects
+        #   projects.each do |project|
+        #     puts project.name
+        #     project.datasets.all.each do |dataset|
+        #       puts dataset.name
+        #     end
+        #   end
+        #
+        # @example Retrieve all projects: (See {Project::List#all})
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   bigquery = gcloud.bigquery
+        #
+        #   projects = bigquery.projects
+        #
+        #   projects.all do |project|
+        #     puts project.name
+        #     project.datasets.all.each do |dataset|
+        #       puts dataset.name
+        #     end
+        #   end
+        #
+        def projects token: nil, max: nil
+          ensure_service!
+          options = { token: token, max: max }
+          gapi = service.list_projects options
+          Project::List.from_gapi gapi, service, max
+        end
+
+        ##
+        # @private New Project from a Google API Client object, using the
+        # same Credentials as this project.
+        def self.from_gapi gapi, service
+          project_service = Service.new gapi.project_reference.project_id,
+                                        service.credentials,
+                                        retries: service.retries,
+                                        timeout: service.timeout
+          new(project_service).tap do |p|
+            p.instance_variable_set :@name, gapi.friendly_name
+
+            # TODO: remove `Integer` and set normally after migrating to Gax or
+            # to google-api-client 0.10 (See google/google-api-ruby-client#439)
+            if gapi.numeric_id
+              p.instance_variable_set :@numeric_id, Integer(gapi.numeric_id)
+            end
+          end
+        end
+
         protected
 
         ##

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

@@ -0,0 +1,171 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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 "delegate"
+
+module Google
+  module Cloud
+    module Bigquery
+      class Project
+        ##
+        # Project::List is a special case Array with additional values.
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more records that match
+          # the request and this value should be passed to continue.
+          attr_accessor :token
+
+          # A hash of this page of results.
+          attr_accessor :etag
+
+          ##
+          # @private Create a new Project::List with an array of
+          # Project instances.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of projects.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   bigquery = gcloud.bigquery
+          #
+          #   projects = bigquery.projects
+          #   if projects.next?
+          #     next_projects = projects.next
+          #   end
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of projects.
+          #
+          # @return [Project::List]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   bigquery = gcloud.bigquery
+          #
+          #   projects = bigquery.projects
+          #   if projects.next?
+          #     next_projects = projects.next
+          #   end
+          def next
+            return nil unless next?
+            ensure_service!
+            options = { all: @hidden, token: token, max: @max }
+            gapi = @service.list_projects options
+            self.class.from_gapi gapi, @service, @max
+          end
+
+          ##
+          # Retrieves all projects by repeatedly loading {#next} until {#next?}
+          # returns `false`. Calls the given block once for each project, which
+          # is passed as the parameter.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method may make several API calls until all projects are
+          # retrieved. Be sure to use as narrow a search criteria as possible.
+          # Please use with caution.
+          #
+          # @param [Integer] request_limit The upper limit of API requests to
+          #   make to load all projects. Default is no limit.
+          # @yield [project] The block for accessing each project.
+          # @yieldparam [Project] project The project object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each result by passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   bigquery = gcloud.bigquery
+          #
+          #   bigquery.projects.all do |project|
+          #     puts project.name
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   bigquery = gcloud.bigquery
+          #
+          #   all_project_ids = bigquery.projects.all.map do |project|
+          #     project.name
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   bigquery = gcloud.bigquery
+          #
+          #   bigquery.projects.all(request_limit: 10) do |project|
+          #     puts project.name
+          #   end
+          #
+          def all request_limit: nil
+            request_limit = request_limit.to_i if request_limit
+            unless block_given?
+              return enum_for(:all, request_limit: request_limit)
+            end
+            results = self
+            loop do
+              results.each { |r| yield r }
+              if request_limit
+                request_limit -= 1
+                break if request_limit < 0
+              end
+              break unless results.next?
+              results = results.next
+            end
+          end
+
+          ##
+          # @private New Project::List from a response object.
+          def self.from_gapi gapi_list, service, max = nil
+            projects = List.new(Array(gapi_list.projects).map do |gapi_object|
+              Project.from_gapi gapi_object, service
+            end)
+            projects.instance_variable_set :@token,   gapi_list.next_page_token
+            projects.instance_variable_set :@etag,    gapi_list.etag
+            projects.instance_variable_set :@service, service
+            projects.instance_variable_set :@max,     max
+            projects
+          end
+
+          protected
+
+          ##
+          # Raise an error unless an active service is available.
+          def ensure_service!
+            fail "Must have active connection" unless @service
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,25 +36,32 @@ module Google
         # @private
         attr_accessor :credentials
 
+        # @private
+        attr_reader :retries, :timeout
+
         ##
         # Creates a new Service instance.
         def initialize project, credentials, retries: nil, timeout: nil
           @project = project
           @credentials = credentials
           @credentials = credentials
-          @service = API::BigqueryService.new
-          @service.client_options.application_name    = "google-cloud-bigquery"
-          @service.client_options.application_version = \
-            Google::Cloud::Bigquery::VERSION
-          @service.request_options.retries = retries || 3
-          @service.request_options.timeout_sec      = timeout
-          @service.request_options.open_timeout_sec = timeout
-          @service.authorization = @credentials.client
+          @retries = retries
+          @timeout = timeout
         end
 
         def service
           return mocked_service if mocked_service
-          @service
+          @service ||= begin
+            service = API::BigqueryService.new
+            service.client_options.application_name    = "google-cloud-bigquery"
+            service.client_options.application_version = \
+              Google::Cloud::Bigquery::VERSION
+            service.request_options.retries = @retries || 3
+            service.request_options.timeout_sec      = @timeout
+            service.request_options.open_timeout_sec = @timeout
+            service.authorization = @credentials.client
+            service
+          end
         end
         attr_accessor :mocked_service
 
@@ -278,6 +285,15 @@ module Google
           Google::Apis::BigqueryV2::TableReference.new new_table_ref_hash
         end
 
+        ##
+        # Lists all projects to which you have been granted any project role.
+        def list_projects options = {}
+          execute do
+            service.list_projects max_results: options[:max],
+                                  page_token: options[:token]
+          end
+        end
+
         def inspect
           "#{self.class}(#{@project})"
         end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Bigquery
-      VERSION = "0.20.1"
+      VERSION = "0.20.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-bigquery
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -151,6 +151,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
 description: google-cloud-bigquery is the official library for Google BigQuery.
 email:
 - mike@blowmage.com
@@ -173,6 +187,7 @@ files:
 - lib/google/cloud/bigquery/job/list.rb
 - lib/google/cloud/bigquery/load_job.rb
 - lib/google/cloud/bigquery/project.rb
+- lib/google/cloud/bigquery/project/list.rb
 - lib/google/cloud/bigquery/query_data.rb
 - lib/google/cloud/bigquery/query_job.rb
 - lib/google/cloud/bigquery/schema.rb
@@ -201,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: API Client library for Google BigQuery