stenotype 0.1.4 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da486b9bc096f52bf0b4f81526d5d4922e0fa10a05141e28f2f55154c41cf3b
-  data.tar.gz: 2ef09f562429fded9c425086714985ef61736e458c9b111aeeb124d9e276f6db
+  metadata.gz: 8b9a863cd51cf75e8d472879bc6a7053f734c2b9081912c332d78de384291c02
+  data.tar.gz: 10c8fca08c07945f3df22cc9a3087c01aa0d65f8e8e3f171b9af678033c7ccb4
 SHA512:
-  metadata.gz: 8db324c94a6d1fdbf2d692df8ae87dca43ede513a1df59e3ba0db91eaa0b2dd4e44ac7f5e7a4c52893049ca1181da61b9a32cca69312693115cc788eb2230125
-  data.tar.gz: 45292456af9acee8382436aa02452512bd29f7f40c1033f0a548a6b01fe12a6a8d78dd42a20193755a904a1837bf7ecd4831676a7f42aa4cae7b6bab4af7c1f4
+  metadata.gz: 66a572106095607f8ca784ec38d32d00d13e5930fad9cc27177dff13ef8c3f5489d77e6feea2ac10e8bb1f745a5f23e300d9e597454e87325c0fea7695144ea3
+  data.tar.gz: 743b0866dca96eea731df808875bdae9a601255bb146a7d9446b8740e902a3d0fa1065e3a08290dba34c38e95203960f09bad517fdbeaa903e1d7ef76b681244

data/CHANGELOG.md

@@ -1,9 +1,23 @@
 # Changelog
 
-*Release Date*: 2020/01/10
+*Release Date*: 2020/01/13
 
-### 0.1.3: 2020/01/10
+### 0.1.7 2020/01/20
+* Adds a config option to allow explicit adapter setup.
+* Adds an `after_initialize` rails hook to setup adapters.
+* Remove topic from the list of Google Cloud adapter arguments.
+
+### 0.1.6 2020/01/17
+* Allow topic to be explicitly set upon Google Cloud adapter initialization
+
+### 0.1.5 2020/01/13
+* In case `graceful_error_handling` is set to off raise a generic `Stenotype::Error` on any exception in order to intercept a single error type in the client code.
+* Adds an `at_exit` hook to flush the async message queue when using the library in async mode.
+
+### 0.1.4 2020/01/10
 * Adds a new configuration option `graceful_error_handling` to suppress errors raised from the gem's internals yet logging the error to specified `config.logger`
+
+### 0.1.3: 2020/01/10
 * Adds a new configuration option `logger` to use during error handling
 * Adds a new config option `Stenotype.config.enabled`. If the option is set to false then event is not going to be published. The option is `true` by default.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stenotype (0.1.4)
+    stenotype (0.1.9)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
       spicery (>= 0.19.0, < 1.0)
@@ -75,7 +75,7 @@ GEM
       tablesalt (= 0.19.2)
     faker (1.9.6)
       i18n (>= 0.7)
-    faraday (0.17.1)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
     github-markup (3.0.4)
     globalid (0.4.2)
@@ -110,7 +110,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.12)
-    grpc (1.25.0-universal-darwin)
+    grpc (1.26.0-universal-darwin)
       google-protobuf (~> 3.8)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)

data/README.md

@@ -31,10 +31,11 @@ Stenotype.configure do |config|
     Stenotype::Adapters::GoogleCloud.new
   ]
 
-  config.uuid_generator          = SecureRandom
-  config.dispatcher              = Stenotype::Dispatcher.new
-  config.logger                  = Logger.new(STDOUT)
-  config.graceful_error_handling = true
+  config.uuid_generator               = SecureRandom
+  config.dispatcher                   = Stenotype::Dispatcher.new
+  config.logger                       = Logger.new(STDOUT)
+  config.graceful_error_handling      = true
+  config.auto_adapter_initialization  = true
 
   config.google_cloud do |gc_config|
     gc_config.project_id  = "google_cloud_project_id"
@@ -98,6 +99,10 @@ Allows to enable/disable Rails ActionController extension
 
 Allows to enable/disable Rails ActiveJob extension
 
+#### config.rails.auto_adapter_initialization
+
+Controls whether the hook `auto_initialize!` is run for each adapter. If set to true `auto_initialize!` is invoked for every adapter. If false `auto_initialize!` is not run. For example for google cloud adapter this will instantiate `client` and `topic` objects before first publish. If set to false `client` and `topic` are lazy initialized.
+
 #### Configuring context handlers
 
 Each event is emitted in a context which might be an ActionController instance or an ActiveJob instance or potentially any other place. Context handlers are implemented as plain ruby classes, so before using them you must register them. By default a plain `Class` handler is registered when not used with any framework. In case Ruby on Rails is used, then there are two additional context handlers for `ActionController` and `ActiveJob` instances.
@@ -228,6 +233,14 @@ class CustomAdapter < Stenotype::Adapters::Base
   def publish(event_data, **additional_arguments)
     # custom publishing logic
   end
+
+  def flush!
+    # actions to be taken to flush the messages
+  end
+
+  def auto_initialize!
+    # actions to be taken to setup internal adapter state (client, endpoint, whatsoever)
+  end
 end
 ```
 

data/lib/stenotype/adapters/base.rb

@@ -35,12 +35,33 @@ module Stenotype
       #
       # This method is expected to be implemented by subclasses
       # @abstract
-      # @raise [NotImplementedError] unless implemented in a subclass
+      # @raise {NotImplementedError} unless implemented in a subclass
       #
       def publish(_event_data, **_additional_attrs)
         raise NotImplementedError,
               "#{self.class.name} must implement method #publish"
       end
+
+      #
+      # Allows custom setup of the adapter. Noop by default
+      # @abstract
+      #
+      def auto_initialize!
+        # noop by default
+      end
+
+      #
+      # This method is expected to be implemented by subclasses. In case async
+      # publisher is used the process might end before the async queue of
+      # messages is processed, so this method is going to be used in a
+      # `at_exit` hook to flush the queue.
+      # @abstract
+      # @raise {NotImplementedError} unless implemented in a subclass
+      #
+      def flush!
+        raise NotImplementedError,
+              "#{self.class.name} must implement method #flush"
+      end
     end
   end
 end

data/lib/stenotype/adapters/google_cloud.rb

@@ -35,7 +35,7 @@ module Stenotype
     #
     class GoogleCloud < Base
       #
-      # @param event_data {Hash} The data to be published to Google Cloud
+      # @param event_data {String} The data to be published to Google Cloud
       # @raise {Stenotype::MessageNotPublishedError} unless message is published
       #
       # @example With default client
@@ -56,6 +56,26 @@ module Stenotype
         end
       end
 
+      #
+      # Flushes the topic's async queue
+      #
+      def flush!
+        # a publisher might be uninitialized until the first event is published
+        return unless topic.async_publisher
+
+        topic.async_publisher.stop.wait!
+      end
+
+      #
+      # If not called both client and topic are lazy initialized on first call (if not
+      # passed to #initialize). #auto_initialize! is going to explicitly initialize
+      # both client and topic.
+      #
+      def auto_initialize!
+        client
+        topic
+      end
+
       private
 
       def publish_sync(event_data, **additional_attrs)

data/lib/stenotype/adapters/stdout_adapter.rb

@@ -21,7 +21,7 @@ module Stenotype
     #
     class StdoutAdapter < Base
       #
-      # @param event_data {Hash} The data to be published to STDOUT
+      # @param event_data {Sting} The data to be published to STDOUT
       #
       # @example Publishing to default client (STDOUT)
       #  adapter = Stenotype::Adapters::StdoutAdapter.new
@@ -33,13 +33,17 @@ module Stenotype
       #
       def publish(event_data, **additional_attrs)
         client.info("[Stenotype::Event] emitted with the following attributes") do
-          {
-            **event_data,
-            **additional_attrs,
-          }
+          "MESSAGE BODY: #{event_data}, MESSAGE ATTRIBUTES #{additional_attrs.to_json}"
         end
       end
 
+      #
+      # Does nothing
+      #
+      def flush!
+        # noop
+      end
+
       private
 
       def client

data/lib/stenotype/at_exit.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# :nocov:
+require "stenotype"
+
+at_exit do
+  targets = Stenotype.config.targets
+  targets.each(&:flush!)
+end
+# :nocov:

data/lib/stenotype/configuration.rb

@@ -35,6 +35,9 @@ module Stenotype
     # @!attribute enabled
     # @return {true, false} a flag indicating whether event emission is enabled
 
+    # @!attribute auto_adapter_initialization
+    # @return {true, false} enables/disables lazy initialization of adapters' clients
+
     # @!attribute targets
     # @return {Array<#publish>} a list of targets responding to method [#publish]
 
@@ -59,7 +62,6 @@ module Stenotype
     # @!attribute [rw] google_cloud.async
     # @return [true, false] GC publish mode, either async if true, sync if false
 
-
     # @!attribute [rw] rails
     # @return [NestedConfiguration] Rails configuration.
 
@@ -87,6 +89,7 @@ module Stenotype
       nested :rails do
         option :enable_action_controller_ext, default: true
         option :enable_active_job_ext, default: true
+        option :auto_adapter_initialization, default: false
       end
     end
 
@@ -110,6 +113,7 @@ module Stenotype
     #
     def logger
       return config.logger if config.logger
+
       config.logger || Logger.new(STDOUT)
     end
 

data/lib/stenotype/dispatcher.rb

@@ -21,7 +21,7 @@ module Stenotype
       event_data = serializer.new(event).serialize
 
       targets.each do |t|
-        t.publish(event_data)
+        t.publish(event_data.to_json)
       end
 
       self

data/lib/stenotype/event.rb

@@ -24,14 +24,14 @@ module Stenotype
         event = new(name, attributes, eval_context: eval_context, dispatcher: dispatcher)
         event.emit!
         event
-      rescue => error
+      rescue StandardError => exception
         #
         # @todo This is a temporary solution to enable conditional logger fetching
         #   needs a fix to use default Spicerack::Configuration functionality
         #
-        Stenotype::Configuration.logger.error(error)
+        Stenotype::Configuration.logger.error(exception)
 
-        raise unless Stenotype.config.graceful_error_handling
+        raise Stenotype::Error unless Stenotype.config.graceful_error_handling
       end
     end
 
@@ -68,14 +68,14 @@ module Stenotype
 
       begin
         dispatcher.publish(self)
-      rescue => error
+      rescue StandardError => exception
         #
         # @todo This is a temporary solution to enable conditional logger fetching
         #   needs a fix to use default Spicerack::Configuration functionality
         #
-        Stenotype::Configuration.logger.error(error)
+        Stenotype::Configuration.logger.error(exception)
 
-        raise unless Stenotype.config.graceful_error_handling
+        raise Stenotype::Error unless Stenotype.config.graceful_error_handling
       end
     end
   end

data/lib/stenotype/railtie.rb

@@ -18,6 +18,8 @@ module Stenotype
 
     config.stenotype = Stenotype.config
 
+    config.after_initialize { config.stenotype.targets.each(&:auto_initialize!) } if config.stenotype.rails.auto_adapter_initialization
+
     if config.stenotype.rails.enable_action_controller_ext
       ActiveSupport.on_load(:action_controller) do
         Stenotype::ContextHandlers.register Stenotype::ContextHandlers::Rails::Controller

data/lib/stenotype/version.rb

@@ -2,6 +2,6 @@
 
 module Stenotype
   # :nodoc:
-  VERSION = "0.1.4"
+  VERSION = "0.1.9"
   # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.9
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -267,6 +267,7 @@ files:
 - lib/stenotype/adapters/base.rb
 - lib/stenotype/adapters/google_cloud.rb
 - lib/stenotype/adapters/stdout_adapter.rb
+- lib/stenotype/at_exit.rb
 - lib/stenotype/configuration.rb
 - lib/stenotype/context_handlers.rb
 - lib/stenotype/context_handlers/base.rb