cloudenvoy 0.1.0.dev → 0.1.0

data/lib/cloudenvoy/subscriber_logger.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cloudenvoy
+  # Logger configuration for subscribers
+  class SubscriberLogger < LoggerWrapper
+    #
+    # The subscriber default context processor.
+    #
+    # @return [Proc] The context processor proc.
+    #
+    def self.default_context_processor
+      @default_context_processor ||= ->(loggable) { loggable.message.to_h.slice(:id, :metadata, :topic) }
+    end
+
+    #
+    # Format main log message.
+    #
+    # @param [String] msg The message to log.
+    #
+    # @return [String] The formatted log message
+    #
+    def formatted_message(msg)
+      "[Cloudenvoy][#{loggable.class}][#{loggable.message.id}] #{msg}"
+    end
+  end
+end

data/lib/cloudenvoy/subscription.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cloudenvoy
+  # A wrapper class for pub/sub subscriptions. Used to wrap
+  # responses.
+  class Subscription
+    attr_accessor :name, :original
+
+    #
+    # Constructor
+    #
+    # @param [Hash] **kwargs Arguments
+    #
+    def initialize(**kwargs)
+      @name = kwargs&.dig(:name)
+      @original = kwargs&.dig(:original)
+    end
+  end
+end

data/lib/cloudenvoy/testing.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'cloudenvoy/backend/memory_pub_sub'
+
+module Cloudenvoy
+  # Enable/Disable test mode for Cloudenvoy
+  module Testing
+    module_function
+
+    #
+    # Set the test mode, either permanently or
+    # temporarily (via block).
+    #
+    # @param [Symbol] mode The test mode.
+    #
+    # @return [Symbol] The test mode.
+    #
+    def switch_test_mode(mode)
+      if block_given?
+        current_mode = @test_mode
+        begin
+          @test_mode = mode
+          yield
+        ensure
+          @test_mode = current_mode
+        end
+      else
+        @test_mode = mode
+      end
+    end
+
+    #
+    # Set cloudenvoy to real mode temporarily
+    #
+    # @param [Proc] &block The block to run in real mode
+    #
+    def enable!(&block)
+      switch_test_mode(:enabled, &block)
+    end
+
+    #
+    # Set cloudenvoy to fake mode temporarily
+    #
+    # @param [Proc] &block The block to run in fake mode
+    #
+    def fake!(&block)
+      switch_test_mode(:fake, &block)
+    end
+
+    #
+    # Return true if Cloudenvoy is enabled.
+    #
+    def enabled?
+      !@test_mode || @test_mode == :enabled
+    end
+
+    #
+    # Return true if Cloudenvoy is in fake mode.
+    #
+    # @return [Boolean] True if messages should be stored in memory.
+    #
+    def fake?
+      @test_mode == :fake
+    end
+
+    #
+    # Return true if tasks should be managed in memory.
+    #
+    # @return [Boolean] True if jobs are managed in memory.
+    #
+    def in_memory?
+      !enabled?
+    end
+
+    #
+    # Clear all messages across all topics.
+    #
+    # @param [String] name The topic to clear.
+    #
+    def clear_all
+      Cloudenvoy::Backend::MemoryPubSub.clear_all
+    end
+
+    #
+    # Clear all messages in a specific topic.
+    #
+    # @param [String] name The topic to clear.
+    #
+    # @return [Array] The cleared array.
+    #
+    def clear(topic)
+      Cloudenvoy::Backend::MemoryPubSub.clear(topic)
+    end
+
+    #
+    # Return the message queue for a specific topic.
+    #
+    # @param [String] name The topic to retrieve.
+    #
+    # @return [Array] The list of messages for the provided topic
+    #
+    def queue(topic)
+      Cloudenvoy::Backend::MemoryPubSub.queue(topic)
+    end
+  end
+end

data/lib/cloudenvoy/topic.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cloudenvoy
+  # A wrapper class for pub/sub topics. Used to wrap
+  # responses.
+  class Topic
+    attr_accessor :name, :original
+
+    #
+    # Constructor
+    #
+    # @param [Hash] **kwargs Arguments
+    #
+    def initialize(**kwargs)
+      @name = kwargs&.dig(:name)
+      @original = kwargs&.dig(:original)
+    end
+  end
+end

data/lib/cloudenvoy/version.rb

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

data/lib/tasks/cloudenvoy.rake

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'cloudenvoy'
+
+ENV['GOOGLE_AUTH_SUPPRESS_CREDENTIALS_WARNINGS'] ||= 'true'
+
+namespace :cloudenvoy do
+  desc 'Setup publishers and subscribers.'
+  task setup: :environment do
+    Rake::Task['cloudenvoy:setup_publishers'].invoke
+    Rake::Task['cloudenvoy:setup_subscribers'].invoke
+  end
+
+  desc 'Create required subscriptions for all subcribers.'
+  task setup_subscribers: :environment do
+    # Force registration of subscribers
+    Rails.application.eager_load!
+
+    # Setup subscriptions
+    list = Cloudenvoy.setup_subscribers.sort_by(&:name)
+
+    puts "\n"
+
+    # Notify user when no suscribers
+    if list.empty?
+      puts 'There are no subscribers defined in your application'
+      return
+    end
+
+    puts 'The following subscribers are configured:'
+    list.each do |e|
+      puts "- #{e.name}"
+    end
+
+    puts "\n"
+  end
+
+  desc 'Create required topics for all publishers.'
+  task setup_publishers: :environment do
+    # Force registration of publishers
+    Rails.application.eager_load!
+
+    # Setup topics
+    list = Cloudenvoy.setup_publishers.sort_by(&:name)
+
+    puts "\n"
+
+    # Notify user when no topics
+    if list.empty?
+      puts 'There are no publishers defined in your application'
+      return
+    end
+
+    puts 'The following topics are configured:'
+    list.each do |e|
+      puts "- #{e.name}"
+    end
+
+    puts "\n"
+  end
+end

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: cloudenvoy
 version: !ruby/object:Gem::Version
-  version: 0.1.0.dev
+  version: 0.1.0
 platform: ruby
 authors:
 - Arnaud Lachaume
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,27 +136,192 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.37.0
-description: Cross-application messaging using GCP Pub/Sub (in development)
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: webmock
+  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: rails
+  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: rspec-rails
+  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: sqlite3
+  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'
+description: Cross-application messaging using GCP Pub/Sub (alpha)
 email:
 - arnaud.lachaume@keypup.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Appraisals
+- 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
 - cloudenvoy.gemspec
+- config/routes.rb
+- examples/rails/.ruby-version
+- examples/rails/Gemfile
+- examples/rails/Gemfile.lock
+- examples/rails/Procfile
+- examples/rails/README.md
+- examples/rails/Rakefile
+- examples/rails/app/assets/config/manifest.js
+- examples/rails/app/assets/images/.keep
+- examples/rails/app/assets/stylesheets/application.css
+- examples/rails/app/channels/application_cable/channel.rb
+- examples/rails/app/channels/application_cable/connection.rb
+- examples/rails/app/controllers/application_controller.rb
+- examples/rails/app/controllers/concerns/.keep
+- examples/rails/app/helpers/application_helper.rb
+- examples/rails/app/javascript/packs/application.js
+- examples/rails/app/jobs/application_job.rb
+- examples/rails/app/mailers/application_mailer.rb
+- examples/rails/app/models/application_record.rb
+- examples/rails/app/models/concerns/.keep
+- examples/rails/app/publishers/hello_publisher.rb
+- examples/rails/app/subscribers/hello_subscriber.rb
+- examples/rails/app/views/layouts/application.html.erb
+- examples/rails/app/views/layouts/mailer.html.erb
+- examples/rails/app/views/layouts/mailer.text.erb
+- examples/rails/bin/rails
+- examples/rails/bin/rake
+- examples/rails/bin/setup
+- examples/rails/config.ru
+- examples/rails/config/application.rb
+- examples/rails/config/boot.rb
+- examples/rails/config/cable.yml
+- examples/rails/config/credentials.yml.enc
+- examples/rails/config/database.yml
+- examples/rails/config/environment.rb
+- examples/rails/config/environments/development.rb
+- examples/rails/config/environments/production.rb
+- examples/rails/config/environments/test.rb
+- examples/rails/config/initializers/application_controller_renderer.rb
+- examples/rails/config/initializers/assets.rb
+- examples/rails/config/initializers/backtrace_silencers.rb
+- examples/rails/config/initializers/cloudenvoy.rb
+- examples/rails/config/initializers/content_security_policy.rb
+- examples/rails/config/initializers/cookies_serializer.rb
+- examples/rails/config/initializers/filter_parameter_logging.rb
+- examples/rails/config/initializers/inflections.rb
+- examples/rails/config/initializers/mime_types.rb
+- examples/rails/config/initializers/wrap_parameters.rb
+- examples/rails/config/locales/en.yml
+- examples/rails/config/master.key
+- examples/rails/config/puma.rb
+- examples/rails/config/routes.rb
+- examples/rails/config/spring.rb
+- examples/rails/config/storage.yml
+- examples/rails/db/development.sqlite3
+- examples/rails/db/test.sqlite3
+- examples/rails/lib/assets/.keep
+- examples/rails/log/.keep
+- examples/rails/public/404.html
+- examples/rails/public/422.html
+- examples/rails/public/500.html
+- examples/rails/public/apple-touch-icon-precomposed.png
+- examples/rails/public/apple-touch-icon.png
+- examples/rails/public/favicon.ico
+- examples/rails/storage/.keep
+- examples/rails/tmp/.keep
+- examples/rails/tmp/development_secret.txt
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.0.gemfile.lock
 - lib/cloudenvoy.rb
+- lib/cloudenvoy/authentication_error.rb
+- lib/cloudenvoy/authenticator.rb
+- lib/cloudenvoy/backend/google_pub_sub.rb
+- lib/cloudenvoy/backend/memory_pub_sub.rb
+- lib/cloudenvoy/config.rb
+- lib/cloudenvoy/engine.rb
+- lib/cloudenvoy/invalid_subscriber_error.rb
+- lib/cloudenvoy/logger_wrapper.rb
+- lib/cloudenvoy/message.rb
+- lib/cloudenvoy/middleware/chain.rb
+- lib/cloudenvoy/pub_sub_client.rb
+- lib/cloudenvoy/publisher.rb
+- lib/cloudenvoy/publisher_logger.rb
+- lib/cloudenvoy/subscriber.rb
+- lib/cloudenvoy/subscriber_logger.rb
+- lib/cloudenvoy/subscription.rb
+- lib/cloudenvoy/testing.rb
+- lib/cloudenvoy/topic.rb
 - lib/cloudenvoy/version.rb
+- lib/tasks/cloudenvoy.rake
 homepage: https://github.com/keypup-io/cloudenvoy
 licenses:
 - MIT
@@ -105,12 +340,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
-summary: Cross-application messaging using GCP Pub/Sub (in development)
+summary: Cross-application messaging using GCP Pub/Sub (alpha)
 test_files: []