google-cloud-pubsub 0.24.0 → 0.25.0

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

@@ -100,6 +100,17 @@ module Google
         # @param [Integer] deadline The maximum number of seconds after a
         #   subscriber receives a message before the subscriber should
         #   acknowledge the message.
+        # @param [Boolean] retain_acked Indicates whether to retain acknowledged
+        #   messages. If `true`, then messages are not expunged from the
+        #   subscription's backlog, even if they are acknowledged, until they
+        #   fall out of the `retention_duration` window. Default is `false`.
+        # @param [Numeric] retention How long to retain unacknowledged messages
+        #   in the subscription's backlog, from the moment a message is
+        #   published. If `retain_acked` is `true`, then this also configures
+        #   the retention of acknowledged messages, and thus configures how far
+        #   back in time a {#seek} can be done. Cannot be more than 604,800
+        #   seconds (7 days) or less than 600 seconds (10 minutes). Default is
+        #   604,800 seconds (7 days).
         # @param [String] endpoint A URL locating the endpoint to which messages
         #   should be pushed.
         #
@@ -112,7 +123,7 @@ module Google
         #
         #   topic = pubsub.topic "my-topic"
         #   sub = topic.subscribe "my-topic-sub"
-        #   puts sub.name # => "my-topic-sub"
+        #   sub.name # => "my-topic-sub"
         #
         # @example Wait 2 minutes for acknowledgement and push all to endpoint:
         #   require "google/cloud/pubsub"
@@ -124,9 +135,11 @@ module Google
         #                         deadline: 120,
         #                         endpoint: "https://example.com/push"
         #
-        def subscribe subscription_name, deadline: nil, endpoint: nil
+        def subscribe subscription_name, deadline: nil, retain_acked: false,
+                      retention: nil, endpoint: nil
           ensure_service!
-          options = { deadline: deadline, endpoint: endpoint }
+          options = { deadline: deadline, retain_acked: retain_acked,
+                      retention: retention, endpoint: endpoint }
           grpc = service.create_subscription name, subscription_name, options
           Subscription.from_grpc grpc, service
         end
@@ -151,17 +164,20 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   subscription = topic.subscription "my-topic-subscription"
-        #   puts subscription.name
+        #
+        #   sub = topic.subscription "my-topic-sub"
+        #   sub.name #=> "projects/my-project/subscriptions/my-topic-sub"
         #
         # @example Skip the lookup against the service with `skip_lookup`:
         #   require "google/cloud/pubsub"
         #
         #   pubsub = Google::Cloud::Pubsub.new
         #
+        #   topic = pubsub.topic "my-topic"
+        #
         #   # No API call is made to retrieve the subscription information.
-        #   subscription = pubsub.subscription "my-sub", skip_lookup: true
-        #   puts subscription.name
+        #   sub = topic.subscription "my-topic-sub", skip_lookup: true
+        #   sub.name #=> "projects/my-project/subscriptions/my-topic-sub"
         #
         def subscription subscription_name, skip_lookup: nil
           ensure_service!
@@ -190,7 +206,7 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   subscription = topic.subscriptions
+        #   subscriptions = topic.subscriptions
         #   subscriptions.each do |subscription|
         #     puts subscription.name
         #   end
@@ -201,7 +217,7 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   subscription = topic.subscriptions
+        #   subscriptions = topic.subscriptions
         #   subscriptions.all do |subscription|
         #     puts subscription.name
         #   end
@@ -234,7 +250,7 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   msg = topic.publish "new-message"
+        #   msg = topic.publish "task completed"
         #
         # @example A message can be published using a File object:
         #   require "google/cloud/pubsub"
@@ -250,7 +266,7 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #
         #   topic = pubsub.topic "my-topic"
-        #   msg = topic.publish "new-message",
+        #   msg = topic.publish "task completed",
         #                       foo: :bar,
         #                       this: :that
         #
@@ -261,9 +277,9 @@ module Google
         #
         #   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
+        #     t.publish "task 1 completed", foo: :bar
+        #     t.publish "task 2 completed", foo: :baz
+        #     t.publish "task 3 completed", foo: :bif
         #   end
         #
         def publish data = nil, attributes = {}
@@ -281,11 +297,6 @@ module Google
         # @see https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#iampolicy
         #   google.iam.v1.IAMPolicy
         #
-        # @param [Boolean] force Force the latest policy to be retrieved from
-        #   the Pub/Sub service when `true`. Otherwise the policy will be
-        #   memoized to reduce the number of API calls made to the Pub/Sub
-        #   service. The default is `false`.
-        #
         # @yield [policy] A block for updating the policy. The latest policy
         #   will be read from the Pub/Sub service and passed to the block. After
         #   the block completes, the modified policy will be written to the
@@ -295,23 +306,13 @@ module Google
         #
         # @return [Policy] the current Cloud IAM Policy for this topic
         #
-        # @example Policy values are memoized to reduce the number of API calls:
-        #   require "google/cloud/pubsub"
-        #
-        #   pubsub = Google::Cloud::Pubsub.new
-        #   topic = pubsub.topic "my-topic"
-        #
-        #   policy = topic.policy # API call
-        #   policy_2 = topic.policy # No API call
-        #
-        # @example Use `force` to retrieve the latest policy from the service:
+        # @example
         #   require "google/cloud/pubsub"
         #
         #   pubsub = Google::Cloud::Pubsub.new
         #   topic = pubsub.topic "my-topic"
         #
-        #   policy = topic.policy force: true # API call
-        #   policy_2 = topic.policy force: true # API call
+        #   policy = topic.policy
         #
         # @example Update the policy by passing a block:
         #   require "google/cloud/pubsub"
@@ -319,21 +320,17 @@ module Google
         #   pubsub = Google::Cloud::Pubsub.new
         #   topic = pubsub.topic "my-topic"
         #
-        #   policy = topic.policy do |p|
+        #   topic.policy do |p|
         #     p.add "roles/owner", "user:owner@example.com"
-        #   end # 2 API calls
-        #
-        def policy force: nil
-          @policy = nil if force || block_given?
-          @policy ||= begin
-            ensure_service!
-            grpc = service.get_topic_policy name
-            Policy.from_grpc grpc
-          end
-          return @policy unless block_given?
-          p = @policy.deep_dup
-          yield p
-          self.policy = p
+        #   end
+        #
+        def policy
+          ensure_service!
+          grpc = service.get_topic_policy name
+          policy = Policy.from_grpc grpc
+          return policy unless block_given?
+          yield policy
+          self.policy = policy
         end
 
         ##
@@ -351,6 +348,8 @@ module Google
         # @param [Policy] new_policy a new or modified Cloud IAM Policy for this
         #   topic
         #
+        # @return [Policy] the policy returned by the API update operation
+        #
         # @example
         #   require "google/cloud/pubsub"
         #

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

@@ -27,9 +27,9 @@ module Google
         #
         #   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
+        #     t.publish "task 1 completed", foo: :bar
+        #     t.publish "task 2 completed", foo: :baz
+        #     t.publish "task 3 completed", foo: :bif
         #   end
         class Publisher
           ##

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Pubsub
-      VERSION = "0.24.0"
+      VERSION = "0.25.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -198,6 +198,8 @@ files:
 - lib/google/cloud/pubsub/project.rb
 - lib/google/cloud/pubsub/received_message.rb
 - lib/google/cloud/pubsub/service.rb
+- lib/google/cloud/pubsub/snapshot.rb
+- lib/google/cloud/pubsub/snapshot/list.rb
 - lib/google/cloud/pubsub/subscription.rb
 - lib/google/cloud/pubsub/subscription/list.rb
 - lib/google/cloud/pubsub/topic.rb
@@ -215,7 +217,7 @@ files:
 - lib/google/cloud/pubsub/version.rb
 - lib/google/pubsub/v1/pubsub_pb.rb
 - lib/google/pubsub/v1/pubsub_services_pb.rb
-homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
+homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-pubsub
 licenses:
 - Apache-2.0
 metadata: {}
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Pub/Sub