pheme 3.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04243d79c91d1f19e0e2e2e9d04290a3a9dafa5acd907eec7e2dc0d80c99e21c
-  data.tar.gz: 9229a8eb9e453971f4b780954b7be9e770e784ffc6a129fbf331c232e9471247
+  metadata.gz: '0711608ea3831e4718cb928b6e3db90bd049c302b5ae864c4e457f3797215add'
+  data.tar.gz: 1387f1048aef3104ff08aad3fb5cdc7d3a542bfbb9b2c71e49f02b78fe67b8c3
 SHA512:
-  metadata.gz: bf5242abbfcc3b4ae522cbc0479c597d59a69835c33a1de2afe5e0a0eb70ef2afec4d73765367bb28c9c765ed702137f1d35117c5837e4eb3858a036ce5d6b5f
-  data.tar.gz: 773072b1e6c9ab9ae6437ae5ff61effca1ac3a3a389c933df8970acc35dc7bae26af6af9e030d5ab371080f12c4d140ad5ce1e161d4bd98d6e71015449dc3781
+  metadata.gz: f6ef008cf929f3eb8e6f9d846ee316982e378039f9a40b7900eb52bedd073fbfb80221d6de1dfb72d74b660f7faf75e0bad5d9f20148368d9332446704267dda
+  data.tar.gz: be52cf4fe2479f239568488fd5c498642842bb92646496907598a211700a1ad994fd889fb9d99c8923f411c24c0d258224fddbb3eb88414207ee92aff7bf437e

data/.rubocop.yml

@@ -6,4 +6,4 @@ inherit_gem:
 
 AllCops:
   # Specify your target Ruby version here (only major/minor versions):
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.4

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).
 
+## 4.0.0 - 2020-03-18
+### Breaking Changes
+- Add the ability for SQS to receive message attributes
+- `handle` function of `QueuePoller` now takes a third parameter `message_attributes`
+- blocks or `MessageHandler`s passed to `QueuePoller` can use this `message_attributes`
+
 ## 3.4.0 - 2020-03-17
 ### Added
 - Add the ability to pass message attributes to SNS

data/lib/pheme/message_handler.rb

@@ -1,10 +1,11 @@
 module Pheme
   class MessageHandler
-    attr_reader :message, :metadata, :timestamp
+    attr_reader :message, :metadata, :message_attributes, :timestamp
 
-    def initialize(message:, metadata: {})
+    def initialize(message:, metadata: {}, message_attributes: {})
       @message = message
       @metadata = metadata
+      @message_attributes = message_attributes
     end
 
     def handle

data/lib/pheme/queue_poller.rb

@@ -1,6 +1,7 @@
 require_relative 'compression'
 
 module Pheme
+  # rubocop:disable Metrics/ClassLength
   class QueuePoller
     include Compression
 
@@ -51,6 +52,7 @@ module Pheme
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def poll
       time_start = log_polling_start
       queue_poller.poll(poller_configuration) do |queue_message|
@@ -59,7 +61,8 @@ module Pheme
           begin
             content = parse_body(queue_message)
             metadata = parse_metadata(queue_message)
-            with_optional_connection_pool_block { handle(content, metadata) }
+            message_attributes = parse_message_attributes(queue_message)
+            with_optional_connection_pool_block { handle(content, metadata, message_attributes) }
             queue_poller.delete_message(queue_message)
             log_delete(queue_message)
             @messages_processed += 1
@@ -73,6 +76,7 @@ module Pheme
       end
       log_polling_end(time_start)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # returns queue_message.body as hash,
     # stores and parses get_content to body[:content]
@@ -105,6 +109,15 @@ module Pheme
       { timestamp: message_body['Timestamp'], topic_arn: message_body['TopicArn'] }
     end
 
+    def parse_message_attributes(queue_message)
+      message_attributes = {}
+      queue_message.message_attributes&.each do |key, value|
+        message_attributes[key.to_sym] = coerce_message_attribute(value)
+      end
+
+      message_attributes
+    end
+
     def get_metadata(message_body)
       message_body.except('Message', 'Records')
     end
@@ -123,11 +136,11 @@ module Pheme
       RecursiveOpenStruct.new({ wrapper: parsed_body }, recurse_over_arrays: true).wrapper
     end
 
-    def handle(message, metadata)
+    def handle(message, metadata, message_attributes)
       if @message_handler
-        @message_handler.new(message: message, metadata: metadata).handle
+        @message_handler.new(message: message, metadata: metadata, message_attributes: message_attributes).handle
       elsif @block_message_handler
-        @block_message_handler.call(message, metadata)
+        @block_message_handler.call(message, metadata, message_attributes)
       else
         raise NotImplementedError
       end
@@ -135,6 +148,22 @@ module Pheme
 
     private
 
+    def coerce_message_attribute(value)
+      case value['data_type']
+      when 'String'
+        value['string_value']
+      when 'Number'
+        JSON.parse(value['string_value'])
+      when 'String.Array'
+        JSON.parse(value['string_value'])
+      when 'Binary'
+        value['binary_value']
+      else
+        Pheme.logger.info("Unsupported custom data type")
+        value["binary_value"] || value["string_value"]
+      end
+    end
+
     def with_optional_connection_pool_block
       if connection_pool_block
         ActiveRecord::Base.connection_pool.with_connection { yield }
@@ -192,4 +221,5 @@ module Pheme
       }.to_json)
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/pheme/version.rb

@@ -1,3 +1,3 @@
 module Pheme
-  VERSION = '3.4.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/pheme.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_dependency "smarter_csv", "~> 1"
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'coveralls', "~> 0.8"
   s.add_development_dependency 'git'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/queue_poller_spec.rb

@@ -14,7 +14,7 @@ describe Pheme::QueuePoller do
   let(:message_id) { SecureRandom.uuid }
 
   context 'base poller' do
-    subject { described_class.new(queue_url: queue_url).handle(nil, nil) }
+    subject { described_class.new(queue_url: queue_url).handle(nil, nil, nil) }
 
     it 'does not implement handle' do
       expect { subject }.to raise_error(NotImplementedError)
@@ -90,13 +90,13 @@ describe Pheme::QueuePoller do
     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)
+          expect { described_class.new(queue_url: queue_url).handle(nil, 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)
+          expect { described_class.new(queue_url: queue_url, message_handler: nil).handle(nil, nil, nil) }.to raise_error(NotImplementedError)
         end
 
         it 'uses default when given invalid message_handler' do
@@ -106,9 +106,11 @@ describe Pheme::QueuePoller do
         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)
+          allow(ExampleMessageHandler).to receive(:new).
+            with(message: 'message', metadata: 'metadata', message_attributes: 'message_attributes').
+            and_return(mock_handler)
 
-          described_class.new(queue_url: queue_url, message_handler: ExampleMessageHandler).handle('message', 'metadata')
+          described_class.new(queue_url: queue_url, message_handler: ExampleMessageHandler).handle('message', 'metadata', 'message_attributes')
           expect(mock_handler).to have_received(:handle).once
         end
       end
@@ -117,12 +119,12 @@ describe Pheme::QueuePoller 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)
+          poller = described_class.new(queue_url: queue_url) do |message, metadata, message_attributes|
+            mock_handler.process(message, metadata, message_attributes)
           end
-          poller.handle('message', 'metadata')
+          poller.handle('message', 'metadata', 'message_attributes')
 
-          expect(mock_handler).to have_received(:process).with('message', 'metadata').once
+          expect(mock_handler).to have_received(:process).with('message', 'metadata', 'message_attributes').once
         end
 
         it 'fails on invalid handler' do
@@ -134,6 +136,63 @@ describe Pheme::QueuePoller do
     end
   end
 
+  describe '#parse_message_attributes' do
+    subject { described_class.new(queue_url: queue_url).parse_message_attributes(queue_message) }
+
+    context 'when no message_attributes' do
+      it { is_expected.to eq({}) }
+    end
+
+    context 'when message attributes' do
+      let(:queue_message) do
+        OpenStruct.new(
+          body: { Message: message }.to_json,
+          message_id: message_id,
+          message_attributes: {
+            "key" => {
+              "data_type" => data_type,
+              "string_value" => string_value,
+            },
+          },
+        )
+      end
+
+      context 'when data_type is String' do
+        let(:data_type) { 'String' }
+        let(:string_value) { 'some-string-value' }
+        let(:expected_value) { 'some-string-value' }
+
+        its([:key]) { is_expected.to eq(expected_value) }
+      end
+
+      context 'when data_type is Number' do
+        let(:data_type) { 'Number' }
+
+        context 'and it is an int' do
+          let(:string_value) { '1' }
+          let(:expected_value) { 1 }
+
+          its([:key]) { is_expected.to eq(expected_value) }
+        end
+
+        context 'and it is a float' do
+          let(:string_value) { '1.5' }
+          let(:expected_value) { 1.5 }
+
+          its([:key]) { is_expected.to eq(expected_value) }
+        end
+      end
+
+      context 'when data_type is String.array' do
+        let(:data_type) { 'String.Array' }
+        let(:string_value) { '["sdfsdf",1,2,null,true,false]' }
+        let(:expected_value) { ["sdfsdf", 1, 2, nil, true, false] }
+
+        its([:key]) { is_expected.to eq(expected_value) }
+      end
+    end
+  end
+
   describe "#parse_body" do
     subject { poller.parse_body(queue_message) }
 
@@ -305,6 +364,7 @@ describe Pheme::QueuePoller do
         expect(ExampleMessageHandler).to receive(:new).with(
           message: RecursiveOpenStruct.new(message),
           metadata: { timestamp: timestamp, topic_arn: topic_arn },
+          message_attributes: {},
         )
         subject.poll
       end

data/spec/support/example_queue_poller.rb

@@ -3,10 +3,10 @@ class ExampleQueuePoller < Pheme::QueuePoller
     super(queue_url: queue_url, **kwargs)
   end
 
-  def handle(message, metadata)
+  def handle(message, metadata, message_attributes)
     case message.status
     when 'complete', 'rejected'
-      ExampleMessageHandler.new(message: message, metadata: metadata).handle
+      ExampleMessageHandler.new(message: message, metadata: metadata, message_attributes: message_attributes).handle
     else
       raise ArgumentError, "Unknown message status: #{message.status}"
     end

data/spec/support/example_queue_poller_with_inlined_handler.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheme
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,16 +98,16 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement