cloudenvoy 0.3.0 → 0.4.2

data/gemfiles/semantic_logger_4.7.2.gemfile.lock

@@ -0,0 +1,279 @@
+PATH
+  remote: ..
+  specs:
+    cloudenvoy (0.4.1)
+      activesupport
+      google-cloud-pubsub (~> 2.0)
+      jwt
+      retriable
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    appraisal (2.4.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    gapic-common (0.4.1)
+      faraday (~> 1.3)
+      google-protobuf (~> 3.15, >= 3.15.2)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      googleauth (~> 0.15, >= 0.15.1)
+      grpc (~> 1.36)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    google-cloud-core (1.6.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.5.0)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.1.0)
+    google-cloud-pubsub (2.5.0)
+      concurrent-ruby (~> 1.1)
+      google-cloud-core (~> 1.5)
+      google-cloud-pubsub-v1 (~> 0.0)
+    google-cloud-pubsub-v1 (0.4.0)
+      gapic-common (~> 0.3)
+      google-cloud-errors (~> 1.0)
+      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
+    google-protobuf (3.15.8)
+    googleapis-common-protos (1.3.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos-types (>= 1.0.6, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.6)
+      google-protobuf (~> 3.14)
+    googleauth (0.16.1)
+      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.37.0)
+      google-protobuf (~> 3.15)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (0.6.11)
+      google-protobuf (~> 3.14)
+      googleapis-common-protos (>= 1.3.11, < 2.0)
+      grpc (~> 1.27)
+    hashdiff (1.0.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.2)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    os (1.1.1)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      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.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    retriable (3.1.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.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    semantic_logger (4.7.2)
+      concurrent-ruby (~> 1.0)
+    signet (0.15.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    sprockets (4.0.2)
+      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.1.0)
+    timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.6.1)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      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.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  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.2.9

data/lib/cloudenvoy/backend/google_pub_sub.rb

@@ -17,6 +17,15 @@ 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.
       #
@@ -25,7 +34,7 @@ module Cloudenvoy
       def backend
         @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,6 +97,12 @@ 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

data/lib/cloudenvoy/logger_wrapper.rb

@@ -153,7 +153,7 @@ module Cloudenvoy
     #
     def log_message(level, msg, &block)
       # Merge log-specific context into object-specific context
-      payload_block = -> { log_block.call.merge(block&.call || {}) }
+      payload_block = ->(*_args) { log_block.call.merge(block&.call || {}) }
 
       # ActiveSupport::Logger does not support passing a payload through a block on top
       # of a message.

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.0'
+  VERSION = '0.4.2'
 end

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:'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudenvoy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Arnaud Lachaume
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.37.0
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -221,11 +235,9 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/cloudenvoy/application_controller.rb
 - app/controllers/cloudenvoy/subscriber_controller.rb
 - bin/console
 - bin/setup
@@ -297,10 +309,27 @@ files:
 - examples/rails/storage/.keep
 - examples/rails/tmp/.keep
 - examples/rails/tmp/development_secret.txt
+- examples/sinatra/Gemfile
+- examples/sinatra/Gemfile.lock
+- examples/sinatra/Procfile
+- examples/sinatra/README.md
+- examples/sinatra/app.rb
+- examples/sinatra/app/publishers/hello_publisher.rb
+- examples/sinatra/app/subscribers/hello_subscriber.rb
+- examples/sinatra/bin/console
+- examples/sinatra/config/initializers/cloudenvoy.rb
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_5.2.gemfile.lock
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.0.gemfile.lock
+- gemfiles/semantic_logger_3.4.gemfile
+- gemfiles/semantic_logger_3.4.gemfile.lock
+- gemfiles/semantic_logger_4.6.gemfile
+- gemfiles/semantic_logger_4.6.gemfile.lock
+- gemfiles/semantic_logger_4.7.0.gemfile
+- gemfiles/semantic_logger_4.7.0.gemfile.lock
+- gemfiles/semantic_logger_4.7.2.gemfile
+- gemfiles/semantic_logger_4.7.2.gemfile.lock
 - lib/cloudenvoy.rb
 - lib/cloudenvoy/authentication_error.rb
 - lib/cloudenvoy/authenticator.rb
@@ -321,6 +350,12 @@ files:
 - lib/cloudenvoy/testing.rb
 - lib/cloudenvoy/topic.rb
 - lib/cloudenvoy/version.rb
+- lib/generators/cloudenvoy/publisher_generator.rb
+- lib/generators/cloudenvoy/subscriber_generator.rb
+- lib/generators/cloudenvoy/templates/publisher.rb.erb
+- lib/generators/cloudenvoy/templates/publisher_spec.rb.erb
+- lib/generators/cloudenvoy/templates/subscriber.rb.erb
+- lib/generators/cloudenvoy/templates/subscriber_spec.rb.erb
 - lib/tasks/cloudenvoy.rake
 homepage: https://github.com/keypup-io/cloudenvoy
 licenses:
@@ -329,7 +364,7 @@ metadata:
   homepage_uri: https://github.com/keypup-io/cloudenvoy
   source_code_uri: https://github.com/keypup-io/cloudenvoy
   changelog_uri: https://github.com/keypup-io/cloudenvoy/master/tree/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -345,7 +380,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.0
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Cross-application messaging using GCP Pub/Sub (alpha)
 test_files: []