hanami-events-cloud_pubsub 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c1e904f1c495c8ec63738657cffec7235f9ac37
-  data.tar.gz: cc8260aba559598abff5cedeec6cc59e4514cf07
+  metadata.gz: 1fee1baafca2abf28345214b24f558961ca25a66
+  data.tar.gz: b090b51decb794b529f12786f92de729614d9dfd
 SHA512:
-  metadata.gz: 90585ecfef0ea10e61674e7e3671633a5feaa1b5f1437b7952bf01b1a001314b30652d3df20cfb4eccafef5b8e6de26832b0114bfd47a7aafaad6b58bea777a7
-  data.tar.gz: 69a520f5ed0fd98029bd6de9496f326d384ca2fb2717ee82635aacaca2113b70a5a9a83244077afbbd7f4d563e7f0a6f93a0dcec6fe937d86099f828161078e9
+  metadata.gz: 9991d0479c5b2f6fdbd0ad5ea5c1d12ae3e7cb3be8a2014ef25c9e712f0768b48b72c609a160d266d624eb6a5d1e2852d77687373c78313535660c55f8a6bd3a
+  data.tar.gz: dfaf278402868f15c16027e3a3d82cc78fc28b9070148926524137c7c3003be216997849811cceb9438bb93298787109904cb2ed39f9b137db359e52ba0c1acd

data/.rubocop_todo.yml

@@ -1,20 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-05 14:43:37 -0400 using RuboCop version 0.56.0.
+# on 2018-06-11 14:37:44 -0400 using RuboCop version 0.54.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 3
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
     - 'examples/server.rb'
     - 'lib/hanami/events/cloud_pubsub/cli.rb'
 
-# Offense count: 14
+# Offense count: 22
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 96
+  Max: 93

data/Gemfile

@@ -10,6 +10,6 @@ gemspec
 group :test do
   gem 'hanami-events', github: 'ianks/events', branch: 'args-to-subscribe'
   gem 'pry'
-  gem 'rubocop'
+  gem 'rubocop', '~> 0.54.0'
   gem 'simplecov', require: false
 end

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    hanami-events-cloud_pubsub (0.2.2)
+    hanami-events-cloud_pubsub (0.2.3)
       dry-configurable (~> 0.7.0)
       google-cloud-pubsub (~> 0.30.2)
       hanami-cli (~> 0.2.0)
@@ -76,7 +76,6 @@ GEM
     hanami-utils (1.2.0)
       concurrent-ruby (~> 1.0)
       transproc (~> 1.0)
-    jaro_winkler (1.5.1)
     json (2.1.0)
     jwt (2.1.0)
     little-plugger (1.1.4)
@@ -91,7 +90,7 @@ GEM
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -113,8 +112,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.57.1)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)
@@ -145,7 +143,7 @@ DEPENDENCIES
   pry
   rake (~> 12.3)
   rspec (~> 3.0)
-  rubocop
+  rubocop (~> 0.54.0)
   simplecov
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,5 @@
-# Hanami::Events::CloudPubsub
-[![Build Status](https://travis-ci.org/adHawk/hanami-events-cloud_pubsub.svg?branch=master)](https://travis-ci.org/adHawk/hanami-events-cloud_pubsub) [![Maintainability](https://api.codeclimate.com/v1/badges/7341f70d4ed1d0bd7a5d/maintainability)](https://codeclimate.com/github/adHawk/hanami-events-cloud_pubsub/maintainability)
+# Hanami Events for Google Cloud Pub/sub
+[![Build Status](https://travis-ci.org/adHawk/hanami-events-cloud_pubsub.svg?branch=master)](https://travis-ci.org/adHawk/hanami-events-cloud_pubsub) [![Maintainability](https://api.codeclimate.com/v1/badges/7341f70d4ed1d0bd7a5d/maintainability)](https://codeclimate.com/github/adHawk/hanami-events-cloud_pubsub/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/7341f70d4ed1d0bd7a5d/test_coverage)](https://codeclimate.com/github/adHawk/hanami-events-cloud_pubsub/test_coverage)
 
 ## Installation
 
@@ -53,6 +53,14 @@ require 'config/environment'
 
 Hanami.boot
 
+class CustomMiddleware
+  def call(message)
+    puts 'Middleware started!'
+    yield
+    puts 'Middleware ended!'
+  end
+end
+
 Hanami::Events::CloudPubsub.configure do |config|
   # required
   config.subscriptions_loader = -> do
@@ -68,8 +76,9 @@ Hanami::Events::CloudPubsub.configure do |config|
   config.error_handlers << lambda do |err, message|
     Honeybadger.notify(err, context: message.attributes)
   end
-end
 
+  config.middleware << CustomMiddleware.new # must respond to #call
+end
 ```
 
 Then, run the worker process:

data/lib/hanami/events/cloud_pubsub.rb

@@ -2,6 +2,9 @@
 
 require 'hanami/events'
 require 'hanami/events/cloud_pubsub/version'
+require 'hanami/events/cloud_pubsub/middleware/stack'
+require 'hanami/events/cloud_pubsub/middleware/logging'
+require 'hanami/events/cloud_pubsub/middleware/auto_acknowledge'
 require 'hanami/events/cloud_pubsub/runner'
 require 'hanami/events/cloud_pubsub/mixin'
 require 'google/cloud/pubsub'
@@ -46,6 +49,11 @@ module Hanami
         end
       ], reader: true
 
+      setting :middleware, Middleware::Stack.new(
+        Middleware::Logging.new,
+        Middleware::AutoAcknowledge.new
+      )
+
       def self.setup
         Hanami::Events::Adapter.register(:cloud_pubsub) do
           require_relative 'adapter/cloud_pubsub'

data/lib/hanami/events/cloud_pubsub/listener.rb

@@ -15,15 +15,22 @@ module Hanami
                     :logger,
                     :handler,
                     :event_name,
-                    :subscriber_opts
-
-        def initialize(topic:, logger:, handler:, event_name:, subscriber_id:)
+                    :subscriber_opts,
+                    :middleware
+
+        def initialize(topic:,
+                       logger:,
+                       handler:,
+                       event_name:,
+                       subscriber_id:,
+                       middleware: CloudPubsub.config.middleware)
           @topic = topic
           @logger = logger
           @handler = handler
           @event_name = event_name
           @subscriber_id = subscriber_id
           @subscriber_opts = CloudPubsub.config.subscriber.to_h
+          @middleware = middleware
         end
 
         def register
@@ -72,29 +79,12 @@ module Hanami
           run_handler(msg)
         end
 
-        #:reek:TooManyStatements
-        #:reek:DuplicateMethodCall
-        # rubocop:disable Metrics/MethodLength
         def run_handler(message)
-          succeeded = false
-          failed = false
-          handler.call(message)
-          succeeded = true
-        rescue Exception => err # rubocop:disable all
-          failed = true
+          middleware.invoke(message) { handler.call(message) }
+        rescue StandardError => err
           run_error_handlers(err, message)
-          raise err
-        ensure
-          id = message.message_id
-          if succeeded || failed
-            message.acknowledge!
-            logger.debug "Message(#{id}) was acknowledged"
-          else
-            message.reject!
-            logger.warn "Message(#{id}) was terminated from outside, rescheduling"
-          end
+          raise
         end
-        # rubocop:enable Metrics/MethodLength
 
         def subscription_for(name)
           topic.create_subscription(name)

data/lib/hanami/events/cloud_pubsub/middleware/auto_acknowledge.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      # Middleware
+      module Middleware
+        # Middleware used for automatically acknowledging messages
+        class AutoAcknowledge
+          def initialize(logger: nil)
+            @logger = logger
+          end
+
+          def call(message, *_args)
+            succeeded = false
+            failed = false
+            yield
+            succeeded = true
+          rescue StandardError => err
+            failed = true
+            raise err
+          ensure
+            ack_or_reject(message, succeeded, failed)
+          end
+
+          private
+
+          def ack_or_reject(message, succeeded, failed)
+            id = message.message_id
+
+            if succeeded || failed
+              message.acknowledge!
+              logger.debug "Message(#{id}) was acknowledged"
+            else
+              message.reject!
+              logger.warn "Message(#{id}) was terminated from outside, rescheduling"
+            end
+          end
+
+          def logger
+            @logger || CloudPubsub.logger
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/middleware/logging.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Middleware
+        # Middleware used for logging useful information about an event
+        class Logging
+          def initialize(logger: nil)
+            @logger = logger
+          end
+
+          def call(msg, *_args)
+            started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            yield
+          ensure
+            ended_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+            seconds = ended_at - started_at
+            logger.info <<~MSG
+              Processed message(id: #{msg.id}) took #{seconds} seconds to process
+            MSG
+          end
+
+          private
+
+          def logger
+            @logger || CloudPubsub.logger
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/middleware/stack.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Middleware
+        # Middleware which is invoked when a message is received
+        class Stack
+          # Error raised when middleware is not callable
+          class InvalidMiddlewareError < ArgumentError
+            def initialize(middleware)
+              super <<~MSG
+                Attempted to add middleware which is not callable: #{middleware.inspect}
+                Make sure that your middleware responds to the #call method
+              MSG
+            end
+          end
+
+          attr_reader :entries
+
+          def initialize(*entries)
+            entries.each(&method(:ensure_callable))
+            @entries = entries
+            yield self if block_given?
+          end
+
+          def <<(middleware)
+            ensure_callable(middleware)
+            entries << middleware
+            self
+          end
+
+          def shift
+            @entries.shift
+          end
+
+          def invoke(*args)
+            stack = entries.dup
+
+            traverse_stack = lambda do
+              if stack.empty?
+                yield(*args)
+              else
+                stack.shift.call(*args, &traverse_stack)
+              end
+            end
+
+            traverse_stack.call
+          end
+
+          private
+
+          def ensure_callable(middleware)
+            raise InvalidMiddlewareError, middleware unless middleware.respond_to?(:call)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/version.rb

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '0.2.2'
+      VERSION = '0.2.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -154,6 +154,9 @@ files:
 - lib/hanami/events/cloud_pubsub/handler.rb
 - lib/hanami/events/cloud_pubsub/health_check_server.rb
 - lib/hanami/events/cloud_pubsub/listener.rb
+- lib/hanami/events/cloud_pubsub/middleware/auto_acknowledge.rb
+- lib/hanami/events/cloud_pubsub/middleware/logging.rb
+- lib/hanami/events/cloud_pubsub/middleware/stack.rb
 - lib/hanami/events/cloud_pubsub/mixin.rb
 - lib/hanami/events/cloud_pubsub/runner.rb
 - lib/hanami/events/cloud_pubsub/safe_error_handler.rb