stenotype 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da486b9bc096f52bf0b4f81526d5d4922e0fa10a05141e28f2f55154c41cf3b
-  data.tar.gz: 2ef09f562429fded9c425086714985ef61736e458c9b111aeeb124d9e276f6db
+  metadata.gz: 78f28a1322b09dc099de1351779e15e67247ad5010c907b0cf99efb05e9c3ca4
+  data.tar.gz: 949901992d1c976941ca306154f546292bbd7f0df0bcb21a27a4458daa0dcd59
 SHA512:
-  metadata.gz: 8db324c94a6d1fdbf2d692df8ae87dca43ede513a1df59e3ba0db91eaa0b2dd4e44ac7f5e7a4c52893049ca1181da61b9a32cca69312693115cc788eb2230125
-  data.tar.gz: 45292456af9acee8382436aa02452512bd29f7f40c1033f0a548a6b01fe12a6a8d78dd42a20193755a904a1837bf7ecd4831676a7f42aa4cae7b6bab4af7c1f4
+  metadata.gz: 18e3d0ea81fc68afbe99cf5da1569e2c87c1819c30430fcc1f23c23b6cb201767cf35885d7d2a643ac3bf284b8ee00d5e26644a08ab0ace902b863fff4f0527e
+  data.tar.gz: 63a868b627122e6c46f6b920b6b237f2fa7c88c1827ef7946e226868644a80e43a0c4c9a89e66dfec4909ca54bc53cc7b5c534bf8a9972621016521ffb1faeab

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
-*Release Date*: 2020/01/10
+*Release Date*: 2020/01/13
 
-### 0.1.3: 2020/01/10
+### 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.3)
       activesupport (>= 5.0.0)
       google-cloud-pubsub (~> 1.0.0)
       spicery (>= 0.19.0, < 1.0)
@@ -96,7 +96,7 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.11.1-universal-darwin)
+    google-protobuf (3.11.1)
     googleapis-common-protos (1.3.9)
       google-protobuf (~> 3.0)
       googleapis-common-protos-types (~> 1.0)
@@ -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.25.0)
       google-protobuf (~> 3.8)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.9)

data/lib/stenotype/adapters/base.rb

@@ -35,12 +35,25 @@ 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
+
+      #
+      # 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

@@ -56,6 +56,16 @@ 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
+
       private
 
       def publish_sync(event_data, **additional_attrs)

data/lib/stenotype/adapters/stdout_adapter.rb

@@ -40,6 +40,13 @@ module Stenotype
         end
       end
 
+      #
+      # Does nothing
+      #
+      def flush!
+        # noop
+      end
+
       private
 
       def client

data/lib/stenotype/at_exit.rb

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

data/lib/stenotype/event.rb

@@ -31,7 +31,7 @@ module Stenotype
         #
         Stenotype::Configuration.logger.error(error)
 
-        raise unless Stenotype.config.graceful_error_handling
+        raise Stenotype::Error unless Stenotype.config.graceful_error_handling
       end
     end
 
@@ -75,7 +75,7 @@ module Stenotype
         #
         Stenotype::Configuration.logger.error(error)
 
-        raise unless Stenotype.config.graceful_error_handling
+        raise Stenotype::Error unless Stenotype.config.graceful_error_handling
       end
     end
   end

data/lib/stenotype/version.rb

@@ -2,6 +2,6 @@
 
 module Stenotype
   # :nodoc:
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
   # :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.5
 platform: ruby
 authors:
 - Roman Kapitonov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-01-13 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