gcloud 0.6.3 → 0.7.0

data/lib/gcloud/pubsub/topic/batch.rb

@@ -0,0 +1,66 @@
+# Copyright 2015 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.
+
+
+module Gcloud
+  module Pubsub
+    class Topic
+      ##
+      # Batch object used to publish multiple messages at once.
+      class Batch
+        ##
+        # @private The messages to publish
+        attr_reader :messages
+
+        ##
+        # @private Create a new instance of the object.
+        def initialize data = nil, attributes = {}
+          @messages = []
+          @mode = :batch
+          return if data.nil?
+          @mode = :single
+          publish data, attributes
+        end
+
+        ##
+        # Add multiple messages to the topic.
+        # All messages added will be published at once.
+        # See {Gcloud::Pubsub::Topic#publish}
+        def publish data, attributes = {}
+          # Convert attributes to strings to match the protobuf definition
+          attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
+          @messages << [data, attributes]
+        end
+
+        ##
+        # @private Create Message objects with message ids.
+        def to_gcloud_messages message_ids
+          msgs = @messages.zip(Array(message_ids)).map do |arr, id|
+            Message.from_grpc(Google::Pubsub::V1::PubsubMessage.new(
+                                data: [arr[0]].pack("m").encode("ASCII-8BIT"),
+                                attributes: arr[1],
+                                message_id: id))
+          end
+          # Return just one Message if a single publish,
+          # otherwise return the array of Messages.
+          if @mode == :single && msgs.count <= 1
+            msgs.first
+          else
+            msgs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gcloud/pubsub/topic/list.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "delegate"
 
 module Gcloud
@@ -24,7 +24,7 @@ module Gcloud
         ##
         # If not empty, indicates that there are more topics
         # that match the request and this value should be passed to
-        # the next Gcloud::PubSub::Project#topics to continue.
+        # the next {Gcloud::Pubsub::Project#topics} to continue.
         attr_accessor :token
 
         ##
@@ -32,15 +32,17 @@ module Gcloud
         def initialize arr = [], token = nil
           super arr
           @token = token
+          @token = nil if @token == ""
         end
 
         ##
-        # New Topic::List from a response object.
-        def self.from_response resp, conn #:nodoc:
-          topics = Array(resp.data["topics"]).map do |gapi_object|
-            Topic.from_gapi gapi_object, conn
+        # @private New Topic::List from a Google::Pubsub::V1::ListTopicsResponse
+        # object.
+        def self.from_grpc grpc_list, service
+          topics = Array(grpc_list.topics).map do |grpc|
+            Topic.from_grpc grpc, service
           end
-          new topics, resp.data["nextPageToken"]
+          new topics, grpc_list.next_page_token
         end
       end
     end

data/lib/gcloud/resource_manager.rb

@@ -12,37 +12,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "gcloud"
 require "gcloud/resource_manager/manager"
 
-#--
-# Google Cloud Resource Manager
 module Gcloud
   ##
-  # Creates a new +Project+ instance connected to the Resource Manager service.
+  # Creates a new `Project` instance connected to the Resource Manager service.
   # Each call creates a new connection.
   #
-  # === Parameters
+  # For more information on connecting to Google Cloud see the [Authentication
+  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
   #
-  # +keyfile+::
-  #   Keyfile downloaded from Google Cloud. If file path the file must be
-  #   readable. (+String+ or +Hash+)
-  # +scope+::
-  #   The OAuth 2.0 scopes controlling the set of resources and operations that
-  #   the connection can access. See {Using OAuth 2.0 to Access Google
-  #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
-  #   or +Array+)
+  # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If file
+  #   path the file must be readable.
+  # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
+  #   set of resources and operations that the connection can access. See [Using
+  #   OAuth 2.0 to Access Google
+  #   APIs](https://developers.google.com/identity/protocols/OAuth2).
   #
   #   The default scope is:
   #
-  #   * +https://www.googleapis.com/auth/cloud-platform+
-  #
-  # === Returns
-  #
-  # Gcloud::ResourceManager::Manager
+  #   * `https://www.googleapis.com/auth/cloud-platform`
   #
-  # === Example
+  # @return [Gcloud::ResourceManager::Manager]
   #
+  # @example
   #   require "gcloud/resource_manager"
   #
   #   resource_manager = Gcloud.resource_manager
@@ -60,16 +55,13 @@ module Gcloud
     Gcloud::ResourceManager::Manager.new credentials
   end
 
-  # rubocop:disable Metrics/LineLength
-  # Disabled because there are links in the docs that are long.
-
   ##
-  # = Google Cloud Resource Manager
+  # # Google Cloud Resource Manager
   #
   # The Resource Manager API provides methods that you can use to
   # programmatically manage your projects in the Google Cloud Platform. You may
-  # be familiar with managing projects in the {Developers
-  # Console}[https://developers.google.com/console/help/new/]. With this API you
+  # be familiar with managing projects in the [Developers
+  # Console](https://developers.google.com/console/help/new/). With this API you
   # can do the following:
   #
   # * Get a list of all projects associated with an account
@@ -81,163 +73,191 @@ module Gcloud
   # The Resource Manager API is a Beta release and is not covered by any SLA or
   # deprecation policy and may be subject to backward-incompatible changes.
   #
-  # == Accessing the Service
+  # ## Accessing the Service
   #
   # Currently, the full functionality of the Resource Manager API is available
   # only to whitelisted users. (Contact your account manager or a member of the
   # Google Cloud sales team if you are interested in access.) Read-only methods
-  # such as ResourceManager::Manager#projects and
-  # ResourceManager::Manager#project are accessible to any user who enables the
-  # Resource Manager API in the {Developers
-  # Console}[https://console.developers.google.com].
+  # such as {ResourceManager::Manager#projects} and
+  # {ResourceManager::Manager#project} are accessible to any user who enables
+  # the Resource Manager API in the [Developers
+  # Console](https://console.developers.google.com).
   #
-  # == Authentication
+  # ## Authentication
   #
-  # The Resource Manager API currently requires authentication of a {User
-  # Account}[https://developers.google.com/identity/protocols/OAuth2], and
-  # cannot currently be accessed with a {Service
-  # Account}[https://developers.google.com/identity/protocols/OAuth2ServiceAccount].
-  # To use a User Account install the {Google Cloud
-  # SDK}[http://cloud.google.com/sdk] and authenticate with the following:
+  # The Resource Manager API currently requires authentication of a [User
+  # Account](https://developers.google.com/identity/protocols/OAuth2), and
+  # cannot currently be accessed with a [Service
+  # Account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount).
+  # To use a User Account install the [Google Cloud
+  # SDK](http://cloud.google.com/sdk) and authenticate with the following:
   #
-  #   $ gcloud auth login
+  # ```
+  # $ gcloud auth login
+  # ```
   #
-  # Also make sure all +GCLOUD+ environment variables are cleared of any service
+  # Also make sure all `GCLOUD` environment variables are cleared of any service
   # accounts. Then gcloud will be able to detect the user authentication and
   # connect with those credentials.
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # ```
   #
-  # == Listing Projects
+  # ## Listing Projects
   #
   # Project is a collection of settings, credentials, and metadata about the
   # application or applications you're working on. You can retrieve and inspect
-  # all projects that you have permissions to. (See Manager#projects)
+  # all projects that you have permissions to. (See
+  # {Gcloud::ResourceManager::Manager#projects})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   resource_manager.projects.each do |project|
-  #     puts projects.project_id
-  #   end
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # resource_manager.projects.each do |project|
+  #   puts projects.project_id
+  # end
+  # ```
   #
-  # == Managing Projects with Labels
+  # ## Managing Projects with Labels
   #
-  # Labels can be added to or removed from projects. (See Project#labels)
+  # Labels can be added to or removed from projects. (See
+  # {Gcloud::ResourceManager::Project#labels})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   project = resource_manager.project "tokyo-rain-123"
-  #   # Label the project as production
-  #   project.update do |p|
-  #     p.labels["env"] = "production"
-  #   end
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # project = resource_manager.project "tokyo-rain-123"
+  # # Label the project as production
+  # project.update do |p|
+  #   p.labels["env"] = "production"
+  # end
+  # ```
   #
-  # Projects can then be filtered by labels. (See Manager#projects)
+  # Projects can then be filtered by labels. (See
+  # {Gcloud::ResourceManager::Manager#projects})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   # Find only the productions projects
-  #   projects = resource_manager.projects filter: "labels.env:production"
-  #   projects.each do |project|
-  #     puts project.project_id
-  #   end
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # # Find only the productions projects
+  # projects = resource_manager.projects filter: "labels.env:production"
+  # projects.each do |project|
+  #   puts project.project_id
+  # end
+  # ```
   #
-  # == Creating a Project
+  # ## Creating a Project
   #
   # You can also use the API to create new projects. (See
-  # Manager#create_project)
+  # {Gcloud::ResourceManager::Manager#create_project})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   project = resource_manager.create_project "tokyo-rain-123",
-  #                                             name: "Todos Development",
-  #                                             labels: {env: :development}
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # project = resource_manager.create_project "tokyo-rain-123",
+  #                                           name: "Todos Development",
+  #                                           labels: {env: :development}
+  # ```
   #
-  # == Deleting a Project
+  # ## Deleting a Project
   #
   # You can delete projects when they are no longer needed. (See
-  # Manager#delete and Project#delete)
+  # {Gcloud::ResourceManager::Manager#delete} and
+  # {Gcloud::ResourceManager::Project#delete})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   resource_manager.delete "tokyo-rain-123"
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # resource_manager.delete "tokyo-rain-123"
+  # ```
   #
-  # == Undeleting a Project
+  # ## Undeleting a Project
   #
-  # You can also restore a deleted project within the waiting period that
-  # starts when the project was deleted. Restoring a project returns it to the
-  # state it was in prior to being deleted. (See Manager#undelete and
-  # Project#undelete)
+  # You can also restore a deleted project within the waiting period that starts
+  # when the project was deleted. Restoring a project returns it to the state it
+  # was in prior to being deleted. (See
+  # {Gcloud::ResourceManager::Manager#undelete} and
+  # {Gcloud::ResourceManager::Project#undelete})
   #
-  #   require "gcloud"
+  # ```ruby
+  # require "gcloud"
   #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   resource_manager.undelete "tokyo-rain-123"
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # resource_manager.undelete "tokyo-rain-123"
+  # ```
   #
-  # == Managing IAM Policies
+  # ## Managing IAM Policies
   #
-  # Google Cloud Identity and Access Management ({Cloud
-  # IAM}[https://cloud.google.com/iam/]) access control policies can be managed
+  # Google Cloud Identity and Access Management ([Cloud
+  # IAM](https://cloud.google.com/iam/)) access control policies can be managed
   # on projects. These policies allow project owners to manage _who_ (identity)
-  # has access to _what_ (role). See {Cloud IAM
-  # Overview}[https://cloud.google.com/iam/docs/overview] for more information.
-  #
-  # A project's access control policy can be retrieved. (See Project#policy)
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   project = resource_manager.project "tokyo-rain-123"
-  #   policy = project.policy
-  #
-  # A project's access control policy can also be set. (See Project#policy=)
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   project = resource_manager.project "tokyo-rain-123"
-  #
-  #   viewer_policy = {
-  #     "bindings" => [{
-  #       "role" => "roles/viewer",
-  #       "members" => ["serviceAccount:your-service-account"]
-  #     }]
-  #   }
-  #   project.policy = viewer_policy
-  #
-  # And permissions can be tested on a project. (See Project#test_permissions)
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   resource_manager = gcloud.resource_manager
-  #   project = resource_manager.project "tokyo-rain-123"
-  #   perms = project.test_permissions "resourcemanager.projects.get",
-  #                                    "resourcemanager.projects.delete"
-  #   perms.include? "resourcemanager.projects.get"    #=> true
-  #   perms.include? "resourcemanager.projects.delete" #=> false
-  #
-  # For more information about using access control policies see {Managing
-  # Policies}[https://cloud.google.com/iam/docs/managing-policies].
+  # has access to _what_ (role). See [Cloud IAM
+  # Overview](https://cloud.google.com/iam/docs/overview) for more information.
+  #
+  # A project's access control policy can be retrieved. (See
+  # {Gcloud::ResourceManager::Project#policy})
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # project = resource_manager.project "tokyo-rain-123"
+  # policy = project.policy
+  # ```
+  #
+  # A project's access control policy can also be set. (See
+  # {Gcloud::ResourceManager::Project#policy=})
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # project = resource_manager.project "tokyo-rain-123"
+  #
+  # viewer_policy = {
+  #   "bindings" => [{
+  #     "role" => "roles/viewer",
+  #     "members" => ["serviceAccount:your-service-account"]
+  #   }]
+  # }
+  # project.policy = viewer_policy
+  # ```
+  #
+  # And permissions can be tested on a project. (See
+  # {Gcloud::ResourceManager::Project#test_permissions})
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # resource_manager = gcloud.resource_manager
+  # project = resource_manager.project "tokyo-rain-123"
+  # perms = project.test_permissions "resourcemanager.projects.get",
+  #                                  "resourcemanager.projects.delete"
+  # perms.include? "resourcemanager.projects.get"    #=> true
+  # perms.include? "resourcemanager.projects.delete" #=> false
+  # ```
+  #
+  # For more information about using access control policies see [Managing
+  # Policies](https://cloud.google.com/iam/docs/managing-policies).
   #
   module ResourceManager
   end
-
-  # rubocop:enable Metrics/LineLength
 end