pheme 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ead3f77e54732d0ec25696ec63984cca421f38a96f398c36c886f575ef05270
-  data.tar.gz: 62af0c6807a8fcec1f00f8a1e2217b056bd3307d99a5a191f35512acac352afa
+  metadata.gz: 290bb6b78fadf5e1dbd173c9c8bc1a6cd2cbd31f5d9058714ce4f2f77085cec7
+  data.tar.gz: f176ebff0f18a9cf36fade1cf6c169ad2c606116719d9cf206089c4d86a0553a
 SHA512:
-  metadata.gz: 2570dcdd9712acc03aa8ae0b25d6744e6aa2c2594aa2566cae59fb9e9b35c3143cf879a83fa4968026b1e47ee4d6a245f1122c673b354167e1421b928168a0d7
-  data.tar.gz: 828eca04402d568ed88fe5deb4b89320feea9961089a6218f8efc8d0ac989bf82ab30b89cea2fb711919cf1ace55d9fe91b67aee43eabc3f9eab3272991b3413
+  metadata.gz: 9ae6f12316cf6a777935078f322829b163603a2423672d8ef6b18ce4c0c64575cd66b22e218fc442547b34c25a8d6f9e9e6bc1b36fa6d97e45b48f5c29a78d4a
+  data.tar.gz: 8e35c281558aa4e72a9cfaf96cfe35f7d33929ccb61cf98ee48c21befd27587c2c7d31416e65a92c900f3bac4221511d5f039fe53e1c5cfafccbf27d85967a16

data/.rubocop.yml

@@ -7,40 +7,3 @@ inherit_gem:
 AllCops:
   # Specify your target Ruby version here (only major/minor versions):
   TargetRubyVersion: 2.4
-  Exclude:
-    - 'bin/**/*'
-    - 'examples/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-02-14 09:34:30 -0500 using RuboCop version 0.64.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: 1
-Metrics/AbcSize:
-  Max: 22
-
-# Offense count: 8
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 147
-
-# Offense count: 4
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 22
-
-RSpec/FilePath:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/pheme/queue_poller.rb'

data/.rubocop_todo.yml

@@ -1,20 +1,39 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-05-29 15:19:13 -0400 using RuboCop version 0.70.0.
+# on 2019-07-09 13:48:32 -0400 using RuboCop version 0.72.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: 12
-# Configuration parameters: Prefixes.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/configuration_spec.rb'
-    - 'spec/message_handler_spec.rb'
-    - 'spec/queue_poller_spec.rb'
-    - 'spec/topic_publisher_spec.rb'
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 164
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 17
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 147
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 28
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 11
 
 # Offense count: 5
 # Configuration parameters: CustomTransform, IgnoreMethods.
@@ -26,10 +45,10 @@ RSpec/FilePath:
     - 'spec/message_type/aws_event_spec.rb'
     - 'spec/message_type/sns_message_spec.rb'
     - 'spec/queue_poller_spec.rb'
-    - 'spec/rollbar_spec.rb'
     - 'spec/topic_publisher_spec.rb'
+    - 'spec/rollbar_spec.rb'
     - 'spec/version_spec.rb'
-    
+
 # Offense count: 14
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: have_received, receive
@@ -40,14 +59,14 @@ RSpec/MessageSpies:
     - 'spec/rollbar_spec.rb'
     - 'spec/topic_publisher_spec.rb'
 
-# Offense count: 39
-# Configuration parameters: IgnoreSharedExamples.
-RSpec/NamedSubject:
+# Offense count: 2
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
-    - 'spec/configuration_spec.rb'
-    - 'spec/logger_spec.rb'
-    - 'spec/message_handler_spec.rb'
-    - 'spec/message_type/sns_message_spec.rb'
     - 'spec/queue_poller_spec.rb'
-    - 'spec/rollbar_spec.rb'
-    - 'spec/topic_publisher_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/pheme/queue_poller.rb'

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 3.3.0 - 2019-07-09
+### Added
+- Add more friendly options for initializing queue pollers by either:
+    - passing the message handler class; or
+    - providing a handler block
+
 ## 3.2.0 - 2019-05-29
 ### Added
 - Support for Pheme::TopicPublisher to publish to an explicit SNS client.

data/lib/pheme/queue_poller.rb

@@ -6,7 +6,15 @@ module Pheme
 
     attr_accessor :queue_url, :queue_poller, :connection_pool_block, :format, :max_messages, :poller_configuration
 
-    def initialize(queue_url:, connection_pool_block: false, max_messages: nil, format: :json, poller_configuration: {}, sqs_client: nil)
+    def initialize(queue_url:,
+                   connection_pool_block: false,
+                   max_messages: nil,
+                   format: :json,
+                   poller_configuration: {},
+                   sqs_client: nil,
+                   idle_timeout: nil,
+                   message_handler: nil,
+                   &block_message_handler)
       raise ArgumentError, "must specify non-nil queue_url" if queue_url.blank?
 
       @queue_url = queue_url
@@ -22,6 +30,20 @@ module Pheme
         skip_delete: true, # manually delete messages
       }.merge(poller_configuration || {})
 
+      @poller_configuration[:idle_timeout] = idle_timeout unless idle_timeout.nil?
+
+      if message_handler
+        if message_handler.ancestors.include?(Pheme::MessageHandler)
+          @message_handler = message_handler
+        else
+          raise ArgumentError, 'Invalid message handler, must inherit from Pheme::MessageHandler'
+        end
+      end
+
+      @block_message_handler = block_message_handler
+
+      raise ArgumentError, 'only provide a message_handler or a block, not both' if @message_handler && @block_message_handler
+
       if max_messages
         queue_poller.before_request do |stats|
           throw :stop_polling if stats.received_message_count >= max_messages
@@ -103,8 +125,14 @@ module Pheme
       RecursiveOpenStruct.new({ wrapper: parsed_body }, recurse_over_arrays: true).wrapper
     end
 
-    def handle(_message, _metadata)
-      raise NotImplementedError
+    def handle(message, metadata)
+      if @message_handler
+        @message_handler.new(message: message, metadata: metadata).handle
+      elsif @block_message_handler
+        @block_message_handler.call(message, metadata)
+      else
+        raise NotImplementedError
+      end
     end
 
     private

data/lib/pheme/version.rb

@@ -1,3 +1,3 @@
 module Pheme
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.3.0'.freeze
 end

data/spec/queue_poller_spec.rb

@@ -1,4 +1,5 @@
 describe Pheme::QueuePoller do
+  let(:valid_queue_poller) { ExampleQueuePoller.new(queue_url: queue_url) }
   let(:queue_url) { "https://sqs.us-east-1.amazonaws.com/whatever" }
   let(:timestamp) { '2018-04-17T21:45:05.915Z' }
 
@@ -10,10 +11,9 @@ describe Pheme::QueuePoller do
   end
   let(:message) { nil }
   let(:message_id) { SecureRandom.uuid }
-  let(:poller) { ExampleQueuePoller.new(queue_url: queue_url, format: format) }
 
   context 'base poller' do
-    subject { described_class.new(queue_url: 'https://sqs.aws.com').handle(nil, nil) }
+    subject { described_class.new(queue_url: queue_url).handle(nil, nil) }
 
     it 'does not implement handle' do
       expect { subject }.to raise_error(NotImplementedError)
@@ -23,7 +23,7 @@ describe Pheme::QueuePoller do
   describe ".new" do
     context "when initialized with valid params" do
       it "does not raise an error" do
-        expect { ExampleQueuePoller.new(queue_url: "queue_url") }.not_to raise_error
+        expect { valid_queue_poller }.not_to raise_error
       end
     end
 
@@ -35,7 +35,7 @@ describe Pheme::QueuePoller do
 
     context "when initialized with max_messages" do
       it "sets max_messages" do
-        expect(ExampleQueuePoller.new(queue_url: "queue_url", max_messages: 5).max_messages).to eq(5)
+        expect(ExampleQueuePoller.new(queue_url: queue_url, max_messages: 5).max_messages).to eq(5)
       end
     end
 
@@ -43,13 +43,13 @@ describe Pheme::QueuePoller do
       let(:sqs_client) { Object.new }
 
       it "sets custom sqs_client" do
-        expect(Aws::SQS::QueuePoller).to receive(:new).with("queue_url", client: sqs_client)
-        ExampleQueuePoller.new(queue_url: "queue_url", sqs_client: sqs_client)
+        expect(Aws::SQS::QueuePoller).to receive(:new).with(queue_url, client: sqs_client)
+        ExampleQueuePoller.new(queue_url: queue_url, sqs_client: sqs_client)
       end
     end
 
     context 'received too many messages' do
-      subject { described_class.new(queue_url: 'http://sqs.aws.com', max_messages: max_messages) }
+      subject { described_class.new(queue_url: queue_url, max_messages: max_messages) }
 
       let(:aws_poller) { instance_double('Aws::SQS::QueuePoller') }
       let(:max_messages) { 50 }
@@ -63,11 +63,82 @@ describe Pheme::QueuePoller do
         expect { subject }.to raise_error(UncaughtThrowError, /stop_polling/)
       end
     end
+
+    context 'when given an idle_timeout' do
+      subject { ExampleQueuePoller.new(queue_url: queue_url, idle_timeout: idle_timeout).poller_configuration[:idle_timeout] }
+
+      context 'when given a number' do
+        let(:idle_timeout) { 5 }
+
+        it { is_expected.to eq(5) }
+      end
+
+      context 'when given nil' do
+        let(:idle_timeout) { nil }
+
+        it { is_expected.to eq(20) }
+      end
+
+      context 'when given false' do
+        let(:idle_timeout) { false }
+
+        it { is_expected.to be(false) }
+      end
+    end
+
+    context 'when handling messages' do
+      context 'when doing it the old way, via the handle function' do
+        it 'uses the handle function by default' do
+          expect { described_class.new(queue_url: queue_url).handle(nil, nil) }.to raise_error(NotImplementedError)
+        end
+      end
+
+      context 'when given a message_handler as parameter' do
+        it 'uses default when given nil' do
+          expect { described_class.new(queue_url: queue_url, message_handler: nil).handle(nil, nil) }.to raise_error(NotImplementedError)
+        end
+
+        it 'uses default when given invalid message_handler' do
+          expect { described_class.new(queue_url: queue_url, message_handler: Hash) }.to raise_error(ArgumentError)
+        end
+
+        it 'uses handler when given one' do
+          mock_handler = double('MessageHandler')
+          allow(mock_handler).to receive(:handle)
+          allow(ExampleMessageHandler).to receive(:new).with(message: 'message', metadata: 'metadata').and_return(mock_handler)
+
+          described_class.new(queue_url: queue_url, message_handler: ExampleMessageHandler).handle('message', 'metadata')
+          expect(mock_handler).to have_received(:handle).once
+        end
+      end
+
+      context 'when given a message_handler as block' do
+        it 'uses handler when given one' do
+          mock_handler = spy('MessageHandler')
+
+          poller = described_class.new(queue_url: queue_url) do |message, metadata|
+            mock_handler.process(message, metadata)
+          end
+          poller.handle('message', 'metadata')
+
+          expect(mock_handler).to have_received(:process).with('message', 'metadata').once
+        end
+
+        it 'fails on invalid handler' do
+          expect do
+            described_class.new(queue_url: queue_url, message_handler: ExampleMessageHandler) { raise Error('should never happen') }
+          end.to raise_error(ArgumentError, 'only provide a message_handler or a block, not both')
+        end
+      end
+    end
   end
 
   describe "#parse_body" do
     subject { poller.parse_body(queue_message) }
 
+    let(:format) { nil }
+    let(:poller) { described_class.new(queue_url: queue_url, format: format) }
+
     context "message is JSON string" do
       let(:format) { :json }
       let!(:message) { { test: 'test' }.to_json }

data/spec/spec_helper.rb

@@ -16,8 +16,6 @@ require 'pp'
 
 require './lib/pheme'
 
-Dir["./spec/support/**/*.rb"].each { |f| require f }
-
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
@@ -36,3 +34,5 @@ def use_default_configuration!
     config.logger = Logger.new(nil)
   end
 end
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }

data/spec/support/example_queue_poller_with_inlined_handler.rb

@@ -0,0 +1,5 @@
+Pheme::QueuePoller.new(queue_url: 'http://mock_url.test') do |message, metadata|
+  # handle the message
+  pp message
+  pp metadata
+end

data/spec/support/example_queue_poller_with_message_handler.rb

@@ -0,0 +1,3 @@
+require_relative './example_message_handler'
+
+Pheme::QueuePoller.new(queue_url: 'http://mock_url.test', message_handler: ExampleMessageHandler)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheme
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -264,6 +264,8 @@ files:
 - spec/support/example_message_handler.rb
 - spec/support/example_publisher.rb
 - spec/support/example_queue_poller.rb
+- spec/support/example_queue_poller_with_inlined_handler.rb
+- spec/support/example_queue_poller_with_message_handler.rb
 - spec/support/example_with_arn_publisher.rb
 - spec/topic_publisher_spec.rb
 - spec/version_spec.rb
@@ -286,8 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby SNS publisher + SQS poller & message handler
@@ -304,6 +305,8 @@ test_files:
 - spec/support/example_message_handler.rb
 - spec/support/example_publisher.rb
 - spec/support/example_queue_poller.rb
+- spec/support/example_queue_poller_with_inlined_handler.rb
+- spec/support/example_queue_poller_with_message_handler.rb
 - spec/support/example_with_arn_publisher.rb
 - spec/topic_publisher_spec.rb
 - spec/version_spec.rb