google-cloud-pubsub 0.20.0

data/lib/google/cloud/pubsub/topic/list.rb

@@ -0,0 +1,176 @@
+# 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.
+
+
+require "delegate"
+
+module Google
+  module Cloud
+    module Pubsub
+      class Topic
+        ##
+        # Topic::List is a special case Array with additional values.
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more topics
+          # that match the request and this value should be passed to
+          # the next {Google::Cloud::Pubsub::Project#topics} to continue.
+          attr_accessor :token
+
+          ##
+          # @private Create a new Topic::List with an array of values.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there a next page of topics.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   pubsub = gcloud.pubsub
+          #
+          #   topics = pubsub.topics
+          #   if topics.next?
+          #     next_topics = topics.next
+          #   end
+          #
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of topics.
+          #
+          # @return [Topic::List]
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   pubsub = gcloud.pubsub
+          #
+          #   topics = pubsub.topics
+          #   if topics.next?
+          #     next_topics = topics.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            options = { token: token, max: @max }
+            grpc = @service.list_topics options
+            self.class.from_grpc grpc, @service, @max
+          end
+
+          ##
+          # Retrieves all topics by repeatedly loading {#next} until {#next?}
+          # returns `false`. Calls the given block once for each topic, which is
+          # passed as the parameter.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method may make several API calls until all topics 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 topics. Default is no limit.
+          # @yield [topic] The block for accessing each topic.
+          # @yieldparam [Topic] topic The topic object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each topic by passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   pubsub = gcloud.pubsub
+          #
+          #   topics = pubsub.topics
+          #   topics.all do |topic|
+          #     puts topic.name
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   pubsub = gcloud.pubsub
+          #
+          #   topics = pubsub.topics
+          #   all_names = topics.all.map do |topic|
+          #     topic.name
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   pubsub = gcloud.pubsub
+          #
+          #   topics = pubsub.topics
+          #   topics.all(request_limit: 10) do |topic|
+          #     puts topic.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 Topic::List from a
+          # Google::Pubsub::V1::ListTopicsResponse object.
+          def self.from_grpc grpc_list, service, max = nil
+            topics = new(Array(grpc_list.topics).map do |grpc|
+              Topic.from_grpc grpc, service
+            end)
+            token = grpc_list.next_page_token
+            token = nil if token == ""
+            topics.instance_variable_set "@token",   token
+            topics.instance_variable_set "@service", service
+            topics.instance_variable_set "@max",     max
+            topics
+          end
+
+          protected
+
+          ##
+          # @private Raise an error unless an active connection to the service
+          # is available.
+          def ensure_service!
+            fail "Must have active connection to service" unless @service
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/pubsub/topic/publisher.rb

@@ -0,0 +1,87 @@
+# 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 Google
+  module Cloud
+    module Pubsub
+      class Topic
+        ##
+        # Topic Publisher object used to publish multiple messages at once.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.new
+        #   pubsub = gcloud.pubsub
+        #
+        #   topic = pubsub.topic "my-topic"
+        #   msgs = topic.publish do |t|
+        #     t.publish "new-message-1", foo: :bar
+        #     t.publish "new-message-2", foo: :baz
+        #     t.publish "new-message-3", foo: :bif
+        #   end
+        class Publisher
+          ##
+          # @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 {Google::Cloud::Pubsub::Topic#publish}
+          def publish data, attributes = {}
+            # Convert IO-ish objects to strings
+            if data.respond_to?(:read) && data.respond_to?(:rewind)
+              data.rewind
+              data = data.read
+            end
+            # Convert data to encoded byte array to match the protobuf defn
+            data = String(data).force_encoding("ASCII-8BIT")
+            # 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], 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
+end

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

@@ -0,0 +1,22 @@
+# 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.
+
+
+module Google
+  module Cloud
+    module Pubsub
+      VERSION = "0.20.0"
+    end
+  end
+end

data/lib/google/iam/v1/iam_policy.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/iam/v1/iam_policy.proto
+
+require 'google/protobuf'
+
+require 'google/iam/v1/policy'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.iam.v1.SetIamPolicyRequest" do
+    optional :resource, :string, 1
+    optional :policy, :message, 2, "google.iam.v1.Policy"
+  end
+  add_message "google.iam.v1.GetIamPolicyRequest" do
+    optional :resource, :string, 1
+  end
+  add_message "google.iam.v1.TestIamPermissionsRequest" do
+    optional :resource, :string, 1
+    repeated :permissions, :string, 2
+  end
+  add_message "google.iam.v1.TestIamPermissionsResponse" do
+    repeated :permissions, :string, 1
+  end
+end
+
+module Google
+  module Iam
+    module V1
+      SetIamPolicyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.SetIamPolicyRequest").msgclass
+      GetIamPolicyRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.GetIamPolicyRequest").msgclass
+      TestIamPermissionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.TestIamPermissionsRequest").msgclass
+      TestIamPermissionsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.TestIamPermissionsResponse").msgclass
+    end
+  end
+end

data/lib/google/iam/v1/iam_policy_services.rb

@@ -0,0 +1,30 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/iam/v1/iam_policy.proto for package 'google.iam.v1'
+
+require 'grpc'
+require 'google/iam/v1/iam_policy'
+
+module Google
+  module Iam
+    module V1
+      module IAMPolicy
+
+        # TODO: add proto service documentation here
+        class Service
+
+          include GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'google.iam.v1.IAMPolicy'
+
+          rpc :SetIamPolicy, SetIamPolicyRequest, Policy
+          rpc :GetIamPolicy, GetIamPolicyRequest, Policy
+          rpc :TestIamPermissions, TestIamPermissionsRequest, TestIamPermissionsResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/lib/google/iam/v1/policy.rb

@@ -0,0 +1,25 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/iam/v1/policy.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.iam.v1.Policy" do
+    optional :version, :int32, 1
+    repeated :bindings, :message, 4, "google.iam.v1.Binding"
+    optional :etag, :bytes, 3
+  end
+  add_message "google.iam.v1.Binding" do
+    optional :role, :string, 1
+    repeated :members, :string, 2
+  end
+end
+
+module Google
+  module Iam
+    module V1
+      Policy = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.Policy").msgclass
+      Binding = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.iam.v1.Binding").msgclass
+    end
+  end
+end

data/lib/google/pubsub/v1/pubsub_pb.rb

@@ -0,0 +1,129 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/pubsub/v1/pubsub.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.pubsub.v1.Topic" do
+    optional :name, :string, 1
+  end
+  add_message "google.pubsub.v1.PubsubMessage" do
+    optional :data, :bytes, 1
+    map :attributes, :string, :string, 2
+    optional :message_id, :string, 3
+    optional :publish_time, :message, 4, "google.protobuf.Timestamp"
+  end
+  add_message "google.pubsub.v1.GetTopicRequest" do
+    optional :topic, :string, 1
+  end
+  add_message "google.pubsub.v1.PublishRequest" do
+    optional :topic, :string, 1
+    repeated :messages, :message, 2, "google.pubsub.v1.PubsubMessage"
+  end
+  add_message "google.pubsub.v1.PublishResponse" do
+    repeated :message_ids, :string, 1
+  end
+  add_message "google.pubsub.v1.ListTopicsRequest" do
+    optional :project, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.pubsub.v1.ListTopicsResponse" do
+    repeated :topics, :message, 1, "google.pubsub.v1.Topic"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.pubsub.v1.ListTopicSubscriptionsRequest" do
+    optional :topic, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.pubsub.v1.ListTopicSubscriptionsResponse" do
+    repeated :subscriptions, :string, 1
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.pubsub.v1.DeleteTopicRequest" do
+    optional :topic, :string, 1
+  end
+  add_message "google.pubsub.v1.Subscription" do
+    optional :name, :string, 1
+    optional :topic, :string, 2
+    optional :push_config, :message, 4, "google.pubsub.v1.PushConfig"
+    optional :ack_deadline_seconds, :int32, 5
+  end
+  add_message "google.pubsub.v1.PushConfig" do
+    optional :push_endpoint, :string, 1
+    map :attributes, :string, :string, 2
+  end
+  add_message "google.pubsub.v1.ReceivedMessage" do
+    optional :ack_id, :string, 1
+    optional :message, :message, 2, "google.pubsub.v1.PubsubMessage"
+  end
+  add_message "google.pubsub.v1.GetSubscriptionRequest" do
+    optional :subscription, :string, 1
+  end
+  add_message "google.pubsub.v1.ListSubscriptionsRequest" do
+    optional :project, :string, 1
+    optional :page_size, :int32, 2
+    optional :page_token, :string, 3
+  end
+  add_message "google.pubsub.v1.ListSubscriptionsResponse" do
+    repeated :subscriptions, :message, 1, "google.pubsub.v1.Subscription"
+    optional :next_page_token, :string, 2
+  end
+  add_message "google.pubsub.v1.DeleteSubscriptionRequest" do
+    optional :subscription, :string, 1
+  end
+  add_message "google.pubsub.v1.ModifyPushConfigRequest" do
+    optional :subscription, :string, 1
+    optional :push_config, :message, 2, "google.pubsub.v1.PushConfig"
+  end
+  add_message "google.pubsub.v1.PullRequest" do
+    optional :subscription, :string, 1
+    optional :return_immediately, :bool, 2
+    optional :max_messages, :int32, 3
+  end
+  add_message "google.pubsub.v1.PullResponse" do
+    repeated :received_messages, :message, 1, "google.pubsub.v1.ReceivedMessage"
+  end
+  add_message "google.pubsub.v1.ModifyAckDeadlineRequest" do
+    optional :subscription, :string, 1
+    repeated :ack_ids, :string, 4
+    optional :ack_deadline_seconds, :int32, 3
+  end
+  add_message "google.pubsub.v1.AcknowledgeRequest" do
+    optional :subscription, :string, 1
+    repeated :ack_ids, :string, 2
+  end
+end
+
+module Google
+  module Pubsub
+    module V1
+      Topic = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.Topic").msgclass
+      PubsubMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PubsubMessage").msgclass
+      GetTopicRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.GetTopicRequest").msgclass
+      PublishRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PublishRequest").msgclass
+      PublishResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PublishResponse").msgclass
+      ListTopicsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicsRequest").msgclass
+      ListTopicsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicsResponse").msgclass
+      ListTopicSubscriptionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicSubscriptionsRequest").msgclass
+      ListTopicSubscriptionsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListTopicSubscriptionsResponse").msgclass
+      DeleteTopicRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeleteTopicRequest").msgclass
+      Subscription = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.Subscription").msgclass
+      PushConfig = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PushConfig").msgclass
+      ReceivedMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ReceivedMessage").msgclass
+      GetSubscriptionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.GetSubscriptionRequest").msgclass
+      ListSubscriptionsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListSubscriptionsRequest").msgclass
+      ListSubscriptionsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ListSubscriptionsResponse").msgclass
+      DeleteSubscriptionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.DeleteSubscriptionRequest").msgclass
+      ModifyPushConfigRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ModifyPushConfigRequest").msgclass
+      PullRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PullRequest").msgclass
+      PullResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.PullResponse").msgclass
+      ModifyAckDeadlineRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.ModifyAckDeadlineRequest").msgclass
+      AcknowledgeRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.pubsub.v1.AcknowledgeRequest").msgclass
+    end
+  end
+end