cloudenvoy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 788d59dcdb276ba209ea7502f1d03765ab0beac646089ac5891ea67967a96a25
-  data.tar.gz: 819add5f2b7d7b3b37fc6f1f32d008af05fddd1409d585e0a88c7249f0427f57
+  metadata.gz: 504b503a71e3417dc060ca78ab1653e670b77a87a094394d231e1c8d6bace2f9
+  data.tar.gz: fc905028b47de294dc1a42c7c6ea6edbf3148db8c2e9f94c3b656f2f480fd317
 SHA512:
-  metadata.gz: 3df6bb839c332feea426ec26ac09f46c951f8997159a53d32ce5ac3a11549648842f747ae1b2a0e962f399d8d12a11e6a64501d72134c0347485d39ec07d0ca8
-  data.tar.gz: cd320825e2b8c842e2746c5b7acbfbb82751f743c9bae38a4e997f411a3aa44b6d1e658bf8c8a7afba108ecc7fcc3a5cca4bd2c4b9711a9bfeadd1d88e512c31
+  metadata.gz: 7f91e316422710774f1298c9e8f675c89c79e2e6b1043903b8beacf5c7929696b7d3131f25aeda9f3cd54f0b1f81c65291b9ec92dfa4acb66ef03c837e5c6d89
+  data.tar.gz: 7d6cfe241d6477428c40c40fd28975c8e27752a4d485ba2a40a865d8d60f426770118f88e376ee6bc8750277cebff8f3e5dc14f59463c44ccfcfd4918c763109

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
 
+## [v0.2.0](https://github.com/keypup-io/cloudenvoy/tree/v0.2.0) (2020-09-22)
+
+[Full Changelog](https://github.com/keypup-io/cloudenvoy/compare/v0.1.0...v0.2.0)
+
+**Improvements:**
+- Subscriptions: support creation options such as `retained_acked` and `deadline`
+
 ## [v0.1.0](https://github.com/keypup-io/cloudenvoy/tree/v0.1.0) (2020-09-16)
 Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloudenvoy (0.1.0)
+    cloudenvoy (0.2.0)
       activesupport
       google-cloud-pubsub (~> 2.0)
       jwt

data/README.md

@@ -357,7 +357,19 @@ class UserSubscriber
   include Cloudenvoy::Subscriber
 
   # Subscribers can subscribe to multiple topics
-  cloudenvoy_options topics: ['system-users']
+  #
+  # You can subscribe to multiple topics:
+  # > cloudenvoy_options topics: ['system-users', 'events']
+  #
+  # You can specify subscription options for each topic
+  # by passing a hash (target: v0.2.0)
+  #
+  # > cloudenvoy_options topics: ['system-users', { name: 'events', retain_acked: true }]
+  #
+  # See the Pub/Sub documentation of the list of available subscription options: 
+  # https://googleapis.dev/ruby/google-cloud-pubsub/latest/Google/Cloud/PubSub/Topic.html#subscribe-instance_method
+  #
+  cloudenvoy_options topic: 'system-users'
 
   # Create the user locally if it does not exist already
   #

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cloudenvoy (0.1.0)
+    cloudenvoy (0.2.0)
       activesupport
       google-cloud-pubsub (~> 2.0)
       jwt

data/gemfiles/rails_6.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cloudenvoy (0.1.0)
+    cloudenvoy (0.2.0)
       activesupport
       google-cloud-pubsub (~> 2.0)
       jwt

data/lib/cloudenvoy/backend/google_pub_sub.rb

@@ -68,21 +68,42 @@ module Cloudenvoy
       #
       # @param [String] topic The name of the topic
       # @param [String] name The name of the subscription
+      # @param [Hash] opts The subscription configuration options
+      # @option opts [Integer] :deadline The maximum number of seconds after a subscriber receives a message
+      #   before the subscriber should acknowledge the message.
+      # @option opts [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 window. Default is false.
+      # @option opts [<Type>] :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 Subscription#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).
+      # @option opts [String] :filter An expression written in the Cloud Pub/Sub filter language.
+      #   If non-empty, then only Message instances whose attributes field matches the filter are delivered
+      #   on this subscription. If empty, then no messages are filtered out. Optional.
       #
       # @return [Cloudenvoy::Subscription] The upserted subscription.
       #
-      def upsert_subscription(topic, name)
-        ps_sub = begin
-          # Retrieve the topic
-          ps_topic = backend.topic(topic, skip_lookup: true)
+      def upsert_subscription(topic, name, opts = {})
+        sub_config = opts.to_h.merge(endpoint: webhook_url)
 
-          # Attempt to create the subscription
-          ps_topic.subscribe(name, endpoint: webhook_url)
-                 rescue Google::Cloud::AlreadyExistsError
-                   # Update endpoint on subscription
-                   # Topic is not updated as it is name-dependent
-                   backend.subscription(name).tap { |e| e.endpoint = webhook_url }
-        end
+        ps_sub =
+          begin
+            # Retrieve the topic
+            ps_topic = backend.topic(topic, skip_lookup: true)
+
+            # Attempt to create the subscription
+            ps_topic.subscribe(name, sub_config)
+          rescue Google::Cloud::AlreadyExistsError
+            # Update endpoint on subscription
+            # Topic is not updated as it is name-dependent
+            backend.subscription(name).tap do |e|
+              sub_config.each do |k, v|
+                e.send("#{k}=", v)
+              end
+            end
+          end
 
         # Return formatted subscription
         Subscription.new(name: ps_sub.name, original: ps_sub)

data/lib/cloudenvoy/backend/memory_pub_sub.rb

@@ -66,10 +66,11 @@ module Cloudenvoy
       #
       # @param [String] topic The name of the topic
       # @param [String] name The name of the subscription
+      # @param [Hash] opts The subscription configuration options
       #
       # @return [Cloudenvoy::Subscription] The upserted subscription.
       #
-      def upsert_subscription(_topic, name)
+      def upsert_subscription(_topic, name, _opts)
         Subscription.new(name: name)
       end
 

data/lib/cloudenvoy/pub_sub_client.rb

@@ -41,11 +41,25 @@ module Cloudenvoy
     #
     # @param [String] topic The name of the topic
     # @param [String] name The name of the subscription
+    # @param [Hash] opts The subscription configuration options
+    # @option opts [Integer] :deadline The maximum number of seconds after a subscriber receives a message
+    #   before the subscriber should acknowledge the message.
+    # @option opts [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 window. Default is false.
+    # @option opts [<Type>] :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 Subscription#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).
+    # @option opts [String] :filter An expression written in the Cloud Pub/Sub filter language.
+    #   If non-empty, then only Message instances whose attributes field matches the filter are delivered
+    #   on this subscription. If empty, then no messages are filtered out. Optional.
     #
     # @return [Cloudenvoy::Subscription] The upserted subscription.
     #
-    def self.upsert_subscription(topic, name)
-      backend.upsert_subscription(topic, name)
+    def self.upsert_subscription(topic, name, opts = {})
+      backend.upsert_subscription(topic, name, opts)
     end
 
     #

data/lib/cloudenvoy/subscriber.rb

@@ -98,10 +98,12 @@ module Cloudenvoy
       # Return the list of topics this subscriber listens
       # to.
       #
-      # @return [Array<String>] The list of subscribed topics.
+      # @return [Array<Hash>] The list of subscribed topics.
       #
       def topics
-        cloudenvoy_options_hash[:topics] || []
+        @topics ||= (Array(cloudenvoy_options_hash[:topic]) + Array(cloudenvoy_options_hash[:topics])).map do |t|
+          t.is_a?(String) ? { name: t } : t
+        end
       end
 
       #
@@ -125,7 +127,9 @@ module Cloudenvoy
       #
       def setup
         topics.map do |t|
-          PubSubClient.upsert_subscription(t, subscription_name(t))
+          relative_name = t[:name] || t['name']
+          sub_opts = t.reject { |k, _| k.to_sym == :name }
+          PubSubClient.upsert_subscription(t, subscription_name(relative_name), sub_opts)
         end
       end
     end

data/lib/cloudenvoy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudenvoy
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudenvoy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Arnaud Lachaume
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport