RubyGems - cloudenvoy - Versions diffs - 0.1.0.dev → 0.1.0 - Mend

cloudenvoy 0.1.0.dev → 0.1.0

Files changed (102) hide show

checksums.yaml +4 -4
data/.github/workflows/test.yml +37 -0
data/.gitignore +3 -0
data/.rubocop.yml +1 -0
data/Appraisals +9 -0
data/CHANGELOG.md +4 -0
data/Gemfile.lock +212 -1
data/README.md +569 -7
data/app/controllers/cloudenvoy/application_controller.rb +8 -0
data/app/controllers/cloudenvoy/subscriber_controller.rb +59 -0
data/cloudenvoy.gemspec +14 -2
data/config/routes.rb +5 -0
data/examples/rails/.ruby-version +1 -0
data/examples/rails/Gemfile +15 -0
data/examples/rails/Gemfile.lock +207 -0
data/examples/rails/Procfile +1 -0
data/examples/rails/README.md +31 -0
data/examples/rails/Rakefile +8 -0
data/examples/rails/app/assets/config/manifest.js +2 -0
data/examples/rails/app/assets/images/.keep +0 -0
data/examples/rails/app/assets/stylesheets/application.css +15 -0
data/examples/rails/app/channels/application_cable/channel.rb +6 -0
data/examples/rails/app/channels/application_cable/connection.rb +6 -0
data/examples/rails/app/controllers/application_controller.rb +4 -0
data/examples/rails/app/controllers/concerns/.keep +0 -0
data/examples/rails/app/helpers/application_helper.rb +4 -0
data/examples/rails/app/javascript/packs/application.js +15 -0
data/examples/rails/app/jobs/application_job.rb +9 -0
data/examples/rails/app/mailers/application_mailer.rb +6 -0
data/examples/rails/app/models/application_record.rb +5 -0
data/examples/rails/app/models/concerns/.keep +0 -0
data/examples/rails/app/publishers/hello_publisher.rb +34 -0
data/examples/rails/app/subscribers/hello_subscriber.rb +16 -0
data/examples/rails/app/views/layouts/application.html.erb +14 -0
data/examples/rails/app/views/layouts/mailer.html.erb +13 -0
data/examples/rails/app/views/layouts/mailer.text.erb +1 -0
data/examples/rails/bin/rails +6 -0
data/examples/rails/bin/rake +6 -0
data/examples/rails/bin/setup +35 -0
data/examples/rails/config.ru +7 -0
data/examples/rails/config/application.rb +19 -0
data/examples/rails/config/boot.rb +7 -0
data/examples/rails/config/cable.yml +10 -0
data/examples/rails/config/credentials.yml.enc +1 -0
data/examples/rails/config/database.yml +25 -0
data/examples/rails/config/environment.rb +7 -0
data/examples/rails/config/environments/development.rb +65 -0
data/examples/rails/config/environments/production.rb +114 -0
data/examples/rails/config/environments/test.rb +50 -0
data/examples/rails/config/initializers/application_controller_renderer.rb +9 -0
data/examples/rails/config/initializers/assets.rb +14 -0
data/examples/rails/config/initializers/backtrace_silencers.rb +8 -0
data/examples/rails/config/initializers/cloudenvoy.rb +22 -0
data/examples/rails/config/initializers/content_security_policy.rb +29 -0
data/examples/rails/config/initializers/cookies_serializer.rb +7 -0
data/examples/rails/config/initializers/filter_parameter_logging.rb +6 -0
data/examples/rails/config/initializers/inflections.rb +17 -0
data/examples/rails/config/initializers/mime_types.rb +5 -0
data/examples/rails/config/initializers/wrap_parameters.rb +16 -0
data/examples/rails/config/locales/en.yml +33 -0
data/examples/rails/config/master.key +1 -0
data/examples/rails/config/puma.rb +37 -0
data/examples/rails/config/routes.rb +4 -0
data/examples/rails/config/spring.rb +8 -0
data/examples/rails/config/storage.yml +34 -0
data/examples/rails/db/development.sqlite3 +0 -0
data/examples/rails/db/test.sqlite3 +0 -0
data/examples/rails/lib/assets/.keep +0 -0
data/examples/rails/log/.keep +0 -0
data/examples/rails/public/404.html +67 -0
data/examples/rails/public/422.html +67 -0
data/examples/rails/public/500.html +66 -0
data/examples/rails/public/apple-touch-icon-precomposed.png +0 -0
data/examples/rails/public/apple-touch-icon.png +0 -0
data/examples/rails/public/favicon.ico +0 -0
data/examples/rails/storage/.keep +0 -0
data/gemfiles/rails_5.2.gemfile +7 -0
data/gemfiles/rails_5.2.gemfile.lock +248 -0
data/gemfiles/rails_6.0.gemfile +7 -0
data/gemfiles/rails_6.0.gemfile.lock +264 -0
data/lib/cloudenvoy.rb +96 -2
data/lib/cloudenvoy/authentication_error.rb +6 -0
data/lib/cloudenvoy/authenticator.rb +57 -0
data/lib/cloudenvoy/backend/google_pub_sub.rb +110 -0
data/lib/cloudenvoy/backend/memory_pub_sub.rb +88 -0
data/lib/cloudenvoy/config.rb +165 -0
data/lib/cloudenvoy/engine.rb +20 -0
data/lib/cloudenvoy/invalid_subscriber_error.rb +6 -0
data/lib/cloudenvoy/logger_wrapper.rb +167 -0
data/lib/cloudenvoy/message.rb +96 -0
data/lib/cloudenvoy/middleware/chain.rb +250 -0
data/lib/cloudenvoy/pub_sub_client.rb +62 -0
data/lib/cloudenvoy/publisher.rb +211 -0
data/lib/cloudenvoy/publisher_logger.rb +32 -0
data/lib/cloudenvoy/subscriber.rb +218 -0
data/lib/cloudenvoy/subscriber_logger.rb +26 -0
data/lib/cloudenvoy/subscription.rb +19 -0
data/lib/cloudenvoy/testing.rb +106 -0
data/lib/cloudenvoy/topic.rb +19 -0
data/lib/cloudenvoy/version.rb +1 -1
data/lib/tasks/cloudenvoy.rake +61 -0
metadata +241 -6

data/examples/rails/app/jobs/application_job.rb ADDED

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/examples/rails/app/mailers/application_mailer.rb ADDED

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/examples/rails/app/models/application_record.rb ADDED

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/examples/rails/app/models/concerns/.keep ADDED

File without changes

data/examples/rails/app/publishers/hello_publisher.rb ADDED

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+class HelloPublisher
+  include Cloudenvoy::Publisher
+  cloudenvoy_options topic: 'hello-msgs'
+  #
+  # Set message metadata (attributes)
+  #
+  # @param [String] msg The message to publish
+  #
+  # @return [Hash] The message metadata
+  #
+  def metadata(msg)
+    {
+      kind: msg.start_with?('Hello') ? 'hello' : 'regular'
+    }
+  end
+  #
+  # Format the payload.
+  #
+  # @param [String] msg The message to publish
+  #
+  # @return [Hash] The formatted message
+  #
+  def payload(msg)
+    {
+      type: 'message',
+      content: msg
+    }
+  end
+end

data/examples/rails/app/subscribers/hello_subscriber.rb ADDED

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+class HelloSubscriber
+  include Cloudenvoy::Subscriber
+  cloudenvoy_options topics: ['hello-msgs']
+  #
+  # Process a pub/sub message
+  #
+  # @param [Cloudenvoy::Message] message The message to process.
+  #
+  def process(message)
+    logger.info("Received message #{message.payload.dig('content')}")
+  end
+end

data/examples/rails/app/views/layouts/application.html.erb ADDED

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/examples/rails/app/views/layouts/mailer.html.erb ADDED

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/examples/rails/app/views/layouts/mailer.text.erb ADDED

	@@ -0,0 +1 @@
1	+ <%= yield %>

data/examples/rails/bin/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/examples/rails/bin/rake ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/examples/rails/bin/setup ADDED

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'fileutils'
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/examples/rails/config.ru ADDED

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# This file is used by Rack-based servers to start the application.
+require_relative 'config/environment'
+run Rails.application

data/examples/rails/config/application.rb ADDED

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative 'boot'
+require 'rails/all'
+Bundler.require(*Rails.groups)
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end

data/examples/rails/config/boot.rb ADDED

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/examples/rails/config/cable.yml ADDED

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+test:
+  adapter: test
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/examples/rails/config/credentials.yml.enc ADDED

@@ -0,0 +1 @@

+ jBUFm9LaktoqjLw7egZ/rqypP+0j0BrZyENZx2s4oGW9zhkrjGCUQvOPP6mL1LZlE1NeQX7yYwd4tM0KV4gBbSXcoLGZUD/KtWXg8ZMJraxBz3Klgt1SSoEDnKXbziqSPXXy0e4w9SqBflD9HAdg4hYj4I7m7utnrWctLB446Xn8LhApr/EPwmtLImRXVcLkY5fCQPrQ367lIbFxqX3vgQhadtZZnF6jpnD8R0m+QvhAJompM2jK3xZPilEG0TFZ5E/yd1Um+5PV+OFaM949zTR9mrINR+N6EzqzQg2oLoRJtXizEGyS399Lj8fL2yWj6fXvpeyGLbZEJRMECdWkoIfuRt5d+SRFEe39jprTTs1KNaMv5ajT5pzTQqb64W7dlBjw2oYRswfarDDuOv0eAWS1U7fTlQX3zgl8--yinJxK0UdO3VWhEq--NZjJhOTLbYEO+LqaGs60qg==

data/examples/rails/config/database.yml ADDED

@@ -0,0 +1,25 @@
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+development:
+  <<: *default
+  database: db/development.sqlite3
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+production:
+  <<: *default
+  database: db/production.sqlite3

data/examples/rails/config/environment.rb ADDED

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Load the Rails application.
+require_relative 'application'
+# Initialize the Rails application.
+Rails.application.initialize!

data/examples/rails/config/environments/development.rb ADDED

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+Rails.application.configure do
+  $stdout.sync = true
+  # Settings specified here will take precedence over those in config/application.rb.
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+  # Do not eager load code on boot.
+  config.eager_load = false
+  # Show full error reports.
+  config.consider_all_requests_local = true
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+    config.cache_store = :null_store
+  end
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+  config.action_mailer.perform_caching = false
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/examples/rails/config/environments/production.rb ADDED

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+  # Compress CSS using a preprocessor.
+  # config.assets.css_compressor = :sass
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+  # Mount Action Cable outside main process or domain.
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_production"
+  config.action_mailer.perform_caching = false
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+  if ENV['RAILS_LOG_TO_STDOUT'].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+  # Inserts middleware to perform automatic connection switching.
+  # The `database_selector` hash is used to pass options to the DatabaseSelector
+  # middleware. The `delay` is used to determine how long to wait after a write
+  # to send a subsequent read to the primary.
+  #
+  # The `database_resolver` class is used by the middleware to determine which
+  # database is appropriate to use based on the time delay.
+  #
+  # The `database_resolver_context` class is used by the middleware to set
+  # timestamps for the last write to the primary. The resolver uses the context
+  # class timestamps to determine how long to wait before reading from the
+  # replica.
+  #
+  # By default Rails will store a last write timestamp in the session. The
+  # DatabaseSelector middleware is designed as such you can define your own
+  # strategy for connection switching and pass that into the middleware through
+  # these configuration options.
+  # config.active_record.database_selector = { delay: 2.seconds }
+  # config.active_record.database_resolver = ActiveRecord::Middleware::DatabaseSelector::Resolver
+  # config.active_record.database_resolver_context = ActiveRecord::Middleware::DatabaseSelector::Resolver::Session
+end

data/examples/rails/config/environments/test.rb ADDED

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+  config.cache_classes = false
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+  }
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+  # Store uploaded files on the local file system in a temporary directory.
+  config.active_storage.service = :test
+  config.action_mailer.perform_caching = false
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+end