cloudenvoy 0.3.1 → 0.5.rc1

data/gemfiles/semantic_logger_4.7.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    cloudenvoy (0.3.1)
+    cloudenvoy (0.4.2)
       activesupport
       google-cloud-pubsub (~> 2.0)
       jwt
@@ -10,200 +10,115 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      mail (>= 2.7.1)
-    actionmailer (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      actionview (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.3)
-      actionview (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      rack (~> 2.0, >= 2.0.8)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      nokogiri (>= 1.8.5)
-    actionview (6.0.3.3)
-      activesupport (= 6.0.3.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.3)
-      activesupport (= 6.0.3.3)
-      globalid (>= 0.3.6)
-    activemodel (6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activerecord (6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activestorage (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.3.0)
+    appraisal (2.4.1)
       bundler
       rake
       thor (>= 0.14.0)
-    ast (2.4.1)
-    builder (3.2.4)
-    concurrent-ruby (1.1.7)
-    crack (0.4.4)
-    crass (1.0.6)
-    diff-lcs (1.4.4)
-    erubi (1.9.0)
-    faraday (1.0.1)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    gapic-common (0.3.4)
-      google-protobuf (~> 3.12, >= 3.12.2)
-      googleapis-common-protos (>= 1.3.9, < 2.0)
-      googleapis-common-protos-types (>= 1.0.4, < 2.0)
-      googleauth (~> 0.9)
-      grpc (~> 1.25)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    google-cloud-core (1.5.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    gapic-common (0.7.0)
+      faraday (~> 1.3)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.a)
+      googleapis-common-protos-types (>= 1.0.6, < 2.a)
+      googleauth (>= 0.17.0, < 2.a)
+      grpc (~> 1.36)
+    google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
-    google-cloud-env (1.3.3)
+    google-cloud-env (1.5.0)
       faraday (>= 0.17.3, < 2.0)
-    google-cloud-errors (1.0.1)
-    google-cloud-pubsub (2.0.0)
+    google-cloud-errors (1.2.0)
+    google-cloud-pubsub (2.9.0)
       concurrent-ruby (~> 1.1)
       google-cloud-core (~> 1.5)
       google-cloud-pubsub-v1 (~> 0.0)
-    google-cloud-pubsub-v1 (0.1.2)
-      gapic-common (~> 0.3)
+    google-cloud-pubsub-v1 (0.6.1)
+      gapic-common (>= 0.7, < 2.a)
       google-cloud-errors (~> 1.0)
-      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
-    google-protobuf (3.13.0-universal-darwin)
-    googleapis-common-protos (1.3.10)
-      google-protobuf (~> 3.11)
-      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+      grpc-google-iam-v1 (>= 0.6.10, < 2.a)
+    google-protobuf (3.19.1)
+    googleapis-common-protos (1.3.12)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (~> 1.2)
       grpc (~> 1.27)
-    googleapis-common-protos-types (1.0.5)
-      google-protobuf (~> 3.11)
-    googleauth (0.13.1)
+    googleapis-common-protos-types (1.3.0)
+      google-protobuf (~> 3.14)
+    googleauth (1.1.0)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
-      signet (~> 0.14)
-    grpc (1.32.0-universal-darwin)
-      google-protobuf (~> 3.13)
+      signet (>= 0.16, < 2.a)
+    grpc (1.42.0)
+      google-protobuf (~> 3.18)
       googleapis-common-protos-types (~> 1.0)
-    grpc-google-iam-v1 (0.6.10)
-      google-protobuf (~> 3.11)
-      googleapis-common-protos (>= 1.3.10, < 2.0)
+    grpc-google-iam-v1 (1.0.0)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.12, < 2.0)
       grpc (~> 1.27)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    jwt (2.2.2)
-    loofah (2.7.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    jwt (2.3.0)
     memoist (0.16.2)
-    method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    minitest (5.15.0)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    os (1.1.1)
-    parallel (1.19.2)
-    parser (2.7.1.5)
+    os (1.1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.0.3.3)
-      actioncable (= 6.0.3.3)
-      actionmailbox (= 6.0.3.3)
-      actionmailer (= 6.0.3.3)
-      actionpack (= 6.0.3.3)
-      actiontext (= 6.0.3.3)
-      actionview (= 6.0.3.3)
-      activejob (= 6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activerecord (= 6.0.3.3)
-      activestorage (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.3)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.0.3.3)
-      actionpack (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.6)
     retriable (3.1.2)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (4.0.1)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.9)
-      rspec-expectations (~> 3.9)
-      rspec-mocks (~> 3.9)
-      rspec-support (~> 3.9)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -213,53 +128,40 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-rspec (1.37.0)
       rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     semantic_logger (4.7.2)
       concurrent-ruby (~> 1.0)
-    signet (0.14.0)
-      addressable (~> 2.3)
+    signet (0.16.0)
+      addressable (~> 2.8)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
-    sprockets (4.0.2)
+    thor (1.1.0)
+    timecop (0.9.4)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    timecop (0.9.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
     unicode-display_width (1.6.1)
-    webmock (3.9.1)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    websocket-driver (0.7.3)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.4.0)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (= 6.1)
   appraisal
   cloudenvoy!
-  rails
   rake (>= 12.3.3)
   rspec (~> 3.0)
-  rspec-rails
   rubocop (= 0.76.0)
   rubocop-rspec (= 1.37.0)
   semantic_logger (= 4.7.2)
-  sqlite3
   timecop
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.3.4

data/lib/cloudenvoy/backend/google_pub_sub.rb

@@ -17,15 +17,24 @@ module Cloudenvoy
         Cloudenvoy.config
       end
 
+      #
+      # Return true if the current config mode is development.
+      #
+      # @return [Boolean] True if Cloudenvoy is run in development mode.
+      #
+      def development?
+        config.mode == :development
+      end
+
       #
       # Return the backend to use for sending messages.
       #
       # @return [Google::Cloud::Pub] The low level client instance.
       #
       def backend
-        @backend ||= Google::Cloud::PubSub.new({
+        @backend ||= Google::Cloud::PubSub.new(**{
           project_id: config.gcp_project_id,
-          emulator_host: config.mode == :development ? Cloudenvoy::Config::EMULATOR_HOST : nil
+          emulator_host: development? ? Cloudenvoy::Config::EMULATOR_HOST : nil
         }.compact)
       end
 
@@ -88,13 +97,19 @@ module Cloudenvoy
       def upsert_subscription(topic, name, opts = {})
         sub_config = opts.to_h.merge(endpoint: webhook_url)
 
+        # Auto-create topic in development. In non-development environments
+        # the create subscription action raises an error if the topic does
+        # not exist
+        upsert_topic(topic) if development?
+
+        # Create subscription
         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)
+            ps_topic.subscribe(name, **sub_config)
           rescue Google::Cloud::AlreadyExistsError
             # Update endpoint on subscription
             # Topic is not updated as it is name-dependent

data/lib/cloudenvoy/message.rb

@@ -75,8 +75,8 @@ module Cloudenvoy
     def to_h
       {
         id: id,
-        payload: payload,
-        metadata: metadata,
+        payload: payload&.dup,
+        metadata: metadata&.dup,
         topic: topic,
         sub_uri: sub_uri
       }.compact

data/lib/cloudenvoy/publisher.rb

@@ -200,6 +200,7 @@ module Cloudenvoy
         begin
           publish_message
         rescue StandardError => e
+          logger.error([e, e.backtrace.join("\n")].join("\n"))
           try(:on_error, e)
           return raise(e)
         end

data/lib/cloudenvoy/subscriber.rb

@@ -53,7 +53,7 @@ module Cloudenvoy
     # @return [Array<String,String>] A tuple [subscriber_name, topic ]
     #
     def self.parse_sub_uri(sub_uri)
-      sub_uri.split('/').last.split('.').last(2)
+      sub_uri.split('/').last.split('.', 2).last.split('.', 2)
     end
 
     #
@@ -211,8 +211,9 @@ module Cloudenvoy
         begin
           process(message)
         rescue StandardError => e
+          logger.error([e, e.backtrace.join("\n")].join("\n"))
           try(:on_error, e)
-          return raise(e)
+          raise(e)
         end
       end
     ensure

data/lib/cloudenvoy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudenvoy
-  VERSION = '0.3.1'
+  VERSION = '0.5.rc1'
 end

data/lib/cloudenvoy.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/try'
 
 require 'cloudenvoy/version'
 require 'cloudenvoy/config'

data/lib/generators/cloudenvoy/publisher_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Cloudenvoy
+  module Generators # :nodoc:
+    class PublisherGenerator < ::Rails::Generators::NamedBase # :nodoc:
+      desc 'This generator creates a CloudEnvoy in app/publishers and a corresponding test'
+
+      check_class_collision suffix: 'Publisher'
+
+      def self.default_generator_root
+        File.dirname(__FILE__)
+      end
+
+      def create_publisher_file
+        template 'publisher.rb.erb', File.join('app/publishers', class_path, "#{file_name}_publisher.rb")
+      end
+
+      def create_test_file
+        return unless test_framework
+
+        create_publisher_spec if test_framework == :rspec
+      end
+
+      private
+
+      def create_publisher_spec
+        template_file = File.join(
+          'spec/publishers',
+          class_path,
+          "#{file_name}_publisher_spec.rb"
+        )
+        template 'publisher_spec.rb.erb', template_file
+      end
+
+      def file_name
+        @file_name ||= super.sub(/_?publisher\z/i, '')
+      end
+
+      def test_framework
+        ::Rails.application.config.generators.options[:rails][:test_framework]
+      end
+    end
+  end
+end

data/lib/generators/cloudenvoy/subscriber_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Cloudenvoy
+  module Generators # :nodoc:
+    class SubscriberGenerator < ::Rails::Generators::NamedBase # :nodoc:
+      desc 'This generator creates a CloudEnvoy in app/subscribers and a corresponding test'
+
+      check_class_collision suffix: 'Subscriber'
+
+      def self.default_generator_root
+        File.dirname(__FILE__)
+      end
+
+      def create_subscriber_file
+        template 'subscriber.rb.erb', File.join('app/subscribers', class_path, "#{file_name}_subscriber.rb")
+      end
+
+      def create_test_file
+        return unless test_framework
+
+        create_subscriber_spec if test_framework == :rspec
+      end
+
+      private
+
+      def create_subscriber_spec
+        template_file = File.join(
+          'spec/subscribers',
+          class_path,
+          "#{file_name}_subscriber_spec.rb"
+        )
+        template 'subscriber_spec.rb.erb', template_file
+      end
+
+      def file_name
+        @file_name ||= super.sub(/_?subscriber\z/i, '')
+      end
+
+      def test_framework
+        ::Rails.application.config.generators.options[:rails][:test_framework]
+      end
+    end
+  end
+end

data/lib/generators/cloudenvoy/templates/publisher.rb.erb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Publisher
+  include Cloudenvoy::Publisher
+
+  cloudenvoy_options topic: 'test-msgs'
+
+  def payload(msg)
+    # Format the message payload. The payload can be a hash or a string.
+  end
+end
+<% end -%>

data/lib/generators/cloudenvoy/templates/publisher_spec.rb.erb

@@ -0,0 +1,6 @@
+require 'rails_helper'
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Publisher, type: :publisher do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/cloudenvoy/templates/subscriber.rb.erb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Subscriber
+  include Cloudenvoy::Subscriber
+
+  cloudenvoy_options topic: 'test-msgs'
+
+  def process(msg)
+    # Do something
+  end
+end
+<% end -%>

data/lib/generators/cloudenvoy/templates/subscriber_spec.rb.erb

@@ -0,0 +1,6 @@
+require 'rails_helper'
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Subscriber, type: :subscriber do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/tasks/cloudenvoy.rake

@@ -23,8 +23,8 @@ namespace :cloudenvoy do
 
     # Notify user when no suscribers
     if list.empty?
-      puts 'There are no subscribers defined in your application'
-      return
+      puts 'Skipping subscribers (none defined)'
+      next
     end
 
     puts 'The following subscribers are configured:'
@@ -47,8 +47,8 @@ namespace :cloudenvoy do
 
     # Notify user when no topics
     if list.empty?
-      puts 'There are no publishers defined in your application'
-      return
+      puts 'Skipping publishers (none defined)'
+      next
     end
 
     puts 'The following topics are configured:'