gcloud 0.12.2 → 0.20.0

data/lib/gcloud/pubsub/received_message.rb

@@ -1,160 +0,0 @@
-# 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 "gcloud/errors"
-require "gcloud/pubsub/message"
-
-module Gcloud
-  module Pubsub
-    ##
-    # # ReceivedMessage
-    #
-    # Represents a Pub/Sub {Message} that can be acknowledged or delayed.
-    #
-    # @example
-    #   require "gcloud"
-    #
-    #   gcloud = Gcloud.new
-    #   pubsub = gcloud.pubsub
-    #
-    #   sub = pubsub.subscription "my-topic-sub"
-    #   received_message = sub.pull.first
-    #   if received_message
-    #     puts received_message.message.data
-    #     received_message.acknowledge!
-    #   end
-    #
-    class ReceivedMessage
-      ##
-      # @private The {Subscription} object.
-      attr_accessor :subscription
-
-      ##
-      # @private The gRPC Google::Pubsub::V1::ReceivedMessage object.
-      attr_accessor :grpc
-
-      ##
-      # @private Create an empty {Subscription} object.
-      def initialize
-        @subscription = nil
-        @grpc = Google::Pubsub::V1::ReceivedMessage.new
-      end
-
-      ##
-      # The acknowledgment ID for the message.
-      def ack_id
-        @grpc.ack_id
-      end
-
-      ##
-      # The received message.
-      def message
-        Message.from_grpc @grpc.message
-      end
-      alias_method :msg, :message
-
-      ##
-      # The received message's data.
-      def data
-        message.data
-      end
-
-      ##
-      # The received message's attributes.
-      def attributes
-        message.attributes
-      end
-
-      ##
-      # The ID of the received message, assigned by the server at publication
-      # time. Guaranteed to be unique within the topic.
-      def message_id
-        message.message_id
-      end
-      alias_method :msg_id, :message_id
-
-      ##
-      # Acknowledges receipt of the message.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   pubsub = gcloud.pubsub
-      #
-      #   sub = pubsub.subscription "my-topic-sub"
-      #   received_message = sub.pull.first
-      #   if received_message
-      #     puts received_message.message.data
-      #     received_message.acknowledge!
-      #   end
-      #
-      def acknowledge!
-        ensure_subscription!
-        subscription.acknowledge ack_id
-      end
-      alias_method :ack!, :acknowledge!
-
-      ##
-      # Modifies the acknowledge deadline for the message.
-      #
-      # This indicates that more time is needed to process the message, or to
-      # make the message available for redelivery.
-      #
-      # @param [Integer] new_deadline The new ack deadline in seconds from the
-      #   time this request is sent to the Pub/Sub system. Must be >= 0. For
-      #   example, if the value is `10`, the new ack deadline will expire 10
-      #   seconds after the call is made. Specifying `0` may immediately make
-      #   the message available for another pull request.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   pubsub = gcloud.pubsub
-      #
-      #   sub = pubsub.subscription "my-topic-sub"
-      #   received_message = sub.pull.first
-      #   if received_message
-      #     puts received_message.message.data
-      #     # Delay for 2 minutes
-      #     received_message.delay! 120
-      #   end
-      #
-      def delay! new_deadline
-        ensure_subscription!
-        subscription.delay new_deadline, ack_id
-      end
-
-      ##
-      # @private New ReceivedMessage from a Google::Pubsub::V1::ReceivedMessage
-      # object.
-      def self.from_grpc grpc, subscription
-        new.tap do |rm|
-          rm.grpc         = grpc
-          rm.subscription = subscription
-        end
-      end
-
-      protected
-
-      ##
-      # Raise an error unless an active subscription is available.
-      def ensure_subscription!
-        fail "Must have active subscription" unless subscription
-      end
-    end
-  end
-end

data/lib/gcloud/pubsub/service.rb

@@ -1,334 +0,0 @@
-# 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 "gcloud/backoff"
-require "gcloud/errors"
-require "google/pubsub/v1/pubsub_services"
-require "google/iam/v1/iam_policy_services"
-require "gcloud/grpc_utils"
-require "json"
-
-module Gcloud
-  module Pubsub
-    ##
-    # @private Represents the gRPC Pub/Sub service, including all the API
-    # methods.
-    class Service
-      attr_accessor :project, :credentials, :host, :retries, :timeout
-
-      ##
-      # Creates a new Service instance.
-      def initialize project, credentials, host: nil, retries: nil, timeout: nil
-        @project = project
-        @credentials = credentials
-        @host = host || "pubsub.googleapis.com"
-        @retries = retries
-        @timeout = timeout
-      end
-
-      def creds
-        return credentials if insecure?
-        GRPC::Core::ChannelCredentials.new.compose \
-          GRPC::Core::CallCredentials.new credentials.client.updater_proc
-      end
-
-      def subscriber
-        return mocked_subscriber if mocked_subscriber
-        @subscriber ||= Google::Pubsub::V1::Subscriber::Stub.new(
-          host, creds, timeout: timeout)
-      end
-      attr_accessor :mocked_subscriber
-
-      def publisher
-        return mocked_publisher if mocked_publisher
-        @publisher ||= Google::Pubsub::V1::Publisher::Stub.new(
-          host, creds, timeout: timeout)
-      end
-      attr_accessor :mocked_publisher
-
-      def iam
-        return mocked_iam if mocked_iam
-        @iam ||= Google::Iam::V1::IAMPolicy::Stub.new(
-          host, creds, timeout: timeout)
-      end
-      attr_accessor :mocked_iam
-
-      def insecure?
-        credentials == :this_channel_is_insecure
-      end
-
-      ##
-      # Gets the configuration of a topic.
-      # Since the topic only has the name attribute,
-      # this method is only useful to check the existence of a topic.
-      # If other attributes are added in the future,
-      # they will be returned here.
-      def get_topic topic_name, options = {}
-        topic_req = Google::Pubsub::V1::GetTopicRequest.new.tap do |r|
-          r.topic = topic_path(topic_name, options)
-        end
-
-        execute { publisher.get_topic topic_req }
-      end
-
-      ##
-      # Lists matching topics.
-      def list_topics options = {}
-        topics_req = Google::Pubsub::V1::ListTopicsRequest.new.tap do |r|
-          r.project = project_path(options)
-          r.page_token = options[:token] if options[:token]
-          r.page_size = options[:max] if options[:max]
-        end
-
-        execute { publisher.list_topics topics_req }
-      end
-
-      ##
-      # Creates the given topic with the given name.
-      def create_topic topic_name, options = {}
-        topic_req = Google::Pubsub::V1::Topic.new.tap do |r|
-          r.name = topic_path(topic_name, options)
-        end
-
-        execute { publisher.create_topic topic_req }
-      end
-
-      ##
-      # Deletes the topic with the given name.
-      # All subscriptions to this topic are also deleted.
-      # Raises GRPC status code 5 if the topic does not exist.
-      # After a topic is deleted, a new topic may be created with the same name.
-      def delete_topic topic_name
-        topic_req = Google::Pubsub::V1::DeleteTopicRequest.new.tap do |r|
-          r.topic = topic_path(topic_name)
-        end
-
-        execute { publisher.delete_topic topic_req }
-      end
-
-      ##
-      # Adds one or more messages to the topic.
-      # Raises GRPC status code 5 if the topic does not exist.
-      # The messages parameter is an array of arrays.
-      # The first element is the data, second is attributes hash.
-      def publish topic, messages
-        publish_req = Google::Pubsub::V1::PublishRequest.new(
-          topic: topic_path(topic),
-          messages: messages.map do |data, attributes|
-            Google::Pubsub::V1::PubsubMessage.new(
-              data: data, attributes: attributes)
-          end
-        )
-
-        execute { publisher.publish publish_req }
-      end
-
-      ##
-      # Gets the details of a subscription.
-      def get_subscription subscription_name, options = {}
-        sub_req = Google::Pubsub::V1::GetSubscriptionRequest.new(
-          subscription: subscription_path(subscription_name, options)
-        )
-
-        execute { subscriber.get_subscription sub_req }
-      end
-
-      ##
-      # Lists matching subscriptions by project and topic.
-      def list_topics_subscriptions topic, options = {}
-        list_params = { topic:     topic_path(topic, options),
-                        page_token: options[:token],
-                        page_size:  options[:max] }.delete_if { |_, v| v.nil? }
-        list_req = Google::Pubsub::V1::ListTopicSubscriptionsRequest.new \
-          list_params
-
-        execute { publisher.list_topic_subscriptions list_req }
-      end
-
-      ##
-      # Lists matching subscriptions by project.
-      def list_subscriptions options = {}
-        list_params = { project:    project_path(options),
-                        page_token: options[:token],
-                        page_size:  options[:max] }.delete_if { |_, v| v.nil? }
-        list_req = Google::Pubsub::V1::ListSubscriptionsRequest.new list_params
-
-        execute { subscriber.list_subscriptions list_req }
-      end
-
-      ##
-      # Creates a subscription on a given topic for a given subscriber.
-      def create_subscription topic, subscription_name, options = {}
-        sub_params = { name: subscription_path(subscription_name, options),
-                       topic: topic_path(topic),
-                       ack_deadline_seconds: options[:deadline]
-                     }.delete_if { |_, v| v.nil? }
-        sub_req = Google::Pubsub::V1::Subscription.new sub_params
-        if options[:endpoint]
-          sub_req.push_config = Google::Pubsub::V1::PushConfig.new(
-            push_endpoint: options[:endpoint],
-            attributes: (options[:attributes] || {}).to_h)
-        end
-
-        execute { subscriber.create_subscription sub_req }
-      end
-
-      ##
-      # Deletes an existing subscription.
-      # All pending messages in the subscription are immediately dropped.
-      def delete_subscription subscription
-        del_req = Google::Pubsub::V1::DeleteSubscriptionRequest.new(
-          subscription: subscription_path(subscription)
-        )
-
-        execute { subscriber.delete_subscription del_req }
-      end
-
-      ##
-      # Pulls a single message from the server.
-      def pull subscription, options = {}
-        pull_req = Google::Pubsub::V1::PullRequest.new(
-          subscription: subscription_path(subscription, options),
-          return_immediately: !(!options.fetch(:immediate, true)),
-          max_messages: options.fetch(:max, 100).to_i
-        )
-
-        execute { subscriber.pull pull_req }
-      end
-
-      ##
-      # Acknowledges receipt of a message.
-      def acknowledge subscription, *ack_ids
-        ack_req = Google::Pubsub::V1::AcknowledgeRequest.new(
-          subscription: subscription_path(subscription),
-          ack_ids: ack_ids
-        )
-
-        execute { subscriber.acknowledge ack_req }
-      end
-
-      ##
-      # Modifies the PushConfig for a specified subscription.
-      def modify_push_config subscription, endpoint, attributes
-        # Convert attributes to strings to match the protobuf definition
-        attributes = Hash[attributes.map { |k, v| [String(k), String(v)] }]
-
-        mpc_req = Google::Pubsub::V1::ModifyPushConfigRequest.new(
-          subscription: subscription_path(subscription),
-          push_config: Google::Pubsub::V1::PushConfig.new(
-            push_endpoint: endpoint,
-            attributes: attributes
-          )
-        )
-
-        execute { subscriber.modify_push_config mpc_req }
-      end
-
-      ##
-      # Modifies the ack deadline for a specific message.
-      def modify_ack_deadline subscription, ids, deadline
-        mad_req = Google::Pubsub::V1::ModifyAckDeadlineRequest.new(
-          subscription: subscription_path(subscription),
-          ack_ids: Array(ids),
-          ack_deadline_seconds: deadline
-        )
-
-        execute { subscriber.modify_ack_deadline mad_req }
-      end
-
-      def get_topic_policy topic_name, options = {}
-        get_req = Google::Iam::V1::GetIamPolicyRequest.new(
-          resource: topic_path(topic_name, options)
-        )
-
-        execute { iam.get_iam_policy get_req }
-      end
-
-      def set_topic_policy topic_name, new_policy, options = {}
-        set_req = Google::Iam::V1::SetIamPolicyRequest.new(
-          resource: topic_path(topic_name, options),
-          policy: new_policy
-        )
-
-        execute { iam.set_iam_policy set_req }
-      end
-
-      def test_topic_permissions topic_name, permissions, options = {}
-        test_req = Google::Iam::V1::TestIamPermissionsRequest.new(
-          resource: topic_path(topic_name, options),
-          permissions: permissions
-        )
-
-        execute { iam.test_iam_permissions test_req }
-      end
-
-      def get_subscription_policy subscription_name, options = {}
-        get_req = Google::Iam::V1::GetIamPolicyRequest.new(
-          resource: subscription_path(subscription_name, options)
-        )
-
-        execute { iam.get_iam_policy get_req }
-      end
-
-      def set_subscription_policy subscription_name, new_policy, options = {}
-        set_req = Google::Iam::V1::SetIamPolicyRequest.new(
-          resource: subscription_path(subscription_name, options),
-          policy: new_policy
-        )
-
-        execute { iam.set_iam_policy set_req }
-      end
-
-      def test_subscription_permissions subscription_name,
-                                        permissions, options = {}
-        test_req = Google::Iam::V1::TestIamPermissionsRequest.new(
-          resource: subscription_path(subscription_name, options),
-          permissions: permissions
-        )
-
-        execute { iam.test_iam_permissions test_req }
-      end
-
-      def project_path options = {}
-        project_name = options[:project] || project
-        "projects/#{project_name}"
-      end
-
-      def topic_path topic_name, options = {}
-        return topic_name if topic_name.to_s.include? "/"
-        "#{project_path(options)}/topics/#{topic_name}"
-      end
-
-      def subscription_path subscription_name, options = {}
-        return subscription_name if subscription_name.to_s.include? "/"
-        "#{project_path(options)}/subscriptions/#{subscription_name}"
-      end
-
-      def inspect
-        "#{self.class}(#{@project})"
-      end
-
-      protected
-
-      def execute
-        Gcloud::Backoff.new(retries: retries).execute_grpc do
-          yield
-        end
-      rescue GRPC::BadStatus => e
-        raise Error.from_error(e)
-      end
-    end
-  end
-end