pheme 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43b82532ae9c2d1e266860d9553d1b9e6c47fba937de781431f50f87921fa8b6
-  data.tar.gz: 14cd293a8fdbabab40154bf10a6e1cee36d4c609749a7ca4f0ee44d4df1780ee
+  metadata.gz: 5ead3f77e54732d0ec25696ec63984cca421f38a96f398c36c886f575ef05270
+  data.tar.gz: 62af0c6807a8fcec1f00f8a1e2217b056bd3307d99a5a191f35512acac352afa
 SHA512:
-  metadata.gz: 1b1da30552e2ba5fb12a898c1af86a0f48654a6c3a3bca615ae00d7a762bd4a7db6f660bcfd99149d00ec0ebeaccdd4b115c06ce5233b382706045aa5d470d9e
-  data.tar.gz: d86bfe1b06f0d5040e4461a24bfc5cfe2e264c8014563b26c8e0e49912834f3db03286f49dd042f65b6f13a38547c8866406ff04a8f82814bfb644ef5b24c288
+  metadata.gz: 2570dcdd9712acc03aa8ae0b25d6744e6aa2c2594aa2566cae59fb9e9b35c3143cf879a83fa4968026b1e47ee4d6a245f1122c673b354167e1421b928168a0d7
+  data.tar.gz: 828eca04402d568ed88fe5deb4b89320feea9961089a6218f8efc8d0ac989bf82ab30b89cea2fb711919cf1ace55d9fe91b67aee43eabc3f9eab3272991b3413

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   ws-style:
     - default.yml
@@ -34,6 +36,9 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 22
 
+RSpec/FilePath:
+  Enabled: false
+
 # Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:

data/.rubocop_todo.yml

@@ -0,0 +1,53 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-05-29 15:19:13 -0400 using RuboCop version 0.70.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: 5
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/configuration_spec.rb'
+    - 'spec/logger_spec.rb'
+    - 'spec/message_handler_spec.rb'
+    - '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/version_spec.rb'
+    
+# Offense count: 14
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  Exclude:
+    - 'spec/message_handler_spec.rb'
+    - 'spec/queue_poller_spec.rb'
+    - 'spec/rollbar_spec.rb'
+    - 'spec/topic_publisher_spec.rb'
+
+# Offense count: 39
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  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'

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.2.0 - 2019-05-29
+### Added
+- Support for Pheme::TopicPublisher to publish to an explicit SNS client.
+
 ## 3.1.3 - 2019-02-14
 ### Fixed
 - Increase code coverage to 100%.

data/README.md

@@ -1,4 +1,4 @@
-# pheme [![CircleCI](https://circleci.com/gh/wealthsimple/pheme.svg?style=svg&circle-token=76942be0b1712ac066627be264886ee18039ad11)](https://circleci.com/gh/wealthsimple/pheme) [![Coverage Status](https://coveralls.io/repos/github/wealthsimple/pheme/badge.svg)](https://coveralls.io/github/wealthsimple/pheme?branch=3.1.0-rc)
+# pheme [![CircleCI](https://circleci.com/gh/wealthsimple/pheme.svg?style=svg&circle-token=76942be0b1712ac066627be264886ee18039ad11)](https://circleci.com/gh/wealthsimple/pheme) [![Coverage Status](https://coveralls.io/repos/github/wealthsimple/pheme/badge.svg)](https://coveralls.io/github/wealthsimple/pheme)
 
 Ruby SNS publisher + SQS poller & message handler
 

data/lib/pheme/topic_publisher.rb

@@ -34,7 +34,7 @@ module Pheme
       raise NotImplementedError
     end
 
-    def publish(message)
+    def publish(message, sns_client: Pheme.configuration.sns_client)
       payload = {
         message: "#{self.class} publishing message to #{topic_arn}",
         body: message,
@@ -42,7 +42,7 @@ module Pheme
         topic_arn: topic_arn,
       }
       Pheme.logger.info(payload.to_json)
-      Pheme.configuration.sns_client.publish(topic_arn: topic_arn, message: serialize(message))
+      sns_client.publish(topic_arn: topic_arn, message: serialize(message))
     end
 
     def serialize(message)

data/lib/pheme/version.rb

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

data/spec/configuration_spec.rb

@@ -3,6 +3,7 @@ describe Pheme do
     let(:sns_client) { double }
     let(:sqs_client) { double }
     let(:custom_logger) { double }
+
     it "sets global configuration" do
       expect(described_class.configuration.sns_client).to be_nil
       expect(described_class.configuration.sqs_client).to be_nil

data/spec/logger_spec.rb

@@ -1,10 +1,10 @@
 RSpec.describe Pheme do
   describe '.log' do
+    subject { described_class.log(method, text) }
+
     let(:method) { 'info' }
     let(:text) { 'Some informational message' }
 
-    subject { Pheme.log(method, text) }
-
     it { subject }
   end
 end

data/spec/message_handler_spec.rb

@@ -1,8 +1,10 @@
 describe Pheme::MessageHandler do
-  before(:each) { use_default_configuration! }
+  subject { ExampleMessageHandler.new(message: message, metadata: { timestamp: timestamp }) }
+
+  before { use_default_configuration! }
+
   let(:message) { RecursiveOpenStruct.new(status: status) }
   let(:timestamp) { '2018-04-17T21:45:05.915Z' }
-  subject { ExampleMessageHandler.new(message: message, metadata: { timestamp: timestamp }) }
 
   describe "#handle" do
     context 'complete message' do

data/spec/message_type/aws_event_spec.rb

@@ -15,6 +15,7 @@ describe Pheme::MessageType::AwsEvent do
 
     context "with JSON message" do
       let!(:records) { [{ 'eventVersion' => '2.0' }] }
+
       its('first.eventVersion') { is_expected.to eq('2.0') }
     end
   end

data/spec/message_type/sns_message_spec.rb

@@ -15,7 +15,7 @@ describe Pheme::MessageType::SnsMessage do
     poller
   end
 
-  before(:each) do
+  before do
     use_default_configuration!
     allow(Aws::SQS::QueuePoller).to receive(:new) { poller }
   end
@@ -24,7 +24,7 @@ describe Pheme::MessageType::SnsMessage do
     context "with JSON message" do
       let!(:message) { OpenStruct.new({ body: '{"Message":"{\"test\":\"test\"}"}' }) }
 
-      it 'should parse the message correctly' do
+      it 'parses the message correctly' do
         expect(subject.parse_body(message).test).to eq("test")
       end
     end

data/spec/queue_poller_spec.rb

@@ -2,6 +2,16 @@ describe Pheme::QueuePoller do
   let(:queue_url) { "https://sqs.us-east-1.amazonaws.com/whatever" }
   let(:timestamp) { '2018-04-17T21:45:05.915Z' }
 
+  let!(:queue_message) do
+    OpenStruct.new(
+      body: { Message: message }.to_json,
+      message_id: message_id,
+    )
+  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) }
 
@@ -24,7 +34,7 @@ describe Pheme::QueuePoller do
     end
 
     context "when initialized with max_messages" do
-      it "should set max_messages" do
+      it "sets max_messages" do
         expect(ExampleQueuePoller.new(queue_url: "queue_url", max_messages: 5).max_messages).to eq(5)
       end
     end
@@ -32,13 +42,15 @@ describe Pheme::QueuePoller do
     context "when initialized with sqs_client" do
       let(:sqs_client) { Object.new }
 
-      it "should set custom sqs_client" do
+      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)
       end
     end
 
     context 'received too many messages' do
+      subject { described_class.new(queue_url: 'http://sqs.aws.com', max_messages: max_messages) }
+
       let(:aws_poller) { instance_double('Aws::SQS::QueuePoller') }
       let(:max_messages) { 50 }
 
@@ -47,30 +59,19 @@ describe Pheme::QueuePoller do
         allow(aws_poller).to receive(:before_request).and_yield(OpenStruct.new(received_message_count: max_messages))
       end
 
-      subject { described_class.new(queue_url: 'http://sqs.aws.com', max_messages: max_messages) }
-
       it 'throws error' do
         expect { subject }.to raise_error(UncaughtThrowError, /stop_polling/)
       end
     end
   end
 
-  let(:poller) { ExampleQueuePoller.new(queue_url: queue_url, format: format) }
-  let(:message_id) { SecureRandom.uuid }
-  let(:message) { nil }
-  let!(:queue_message) do
-    OpenStruct.new(
-      body: { Message: message }.to_json,
-      message_id: message_id,
-    )
-  end
-
   describe "#parse_body" do
     subject { poller.parse_body(queue_message) }
 
     context "message is JSON string" do
       let(:format) { :json }
       let!(:message) { { test: 'test' }.to_json }
+
       its([:test]) { is_expected.to eq('test') }
     end
 
@@ -98,7 +99,7 @@ describe Pheme::QueuePoller do
       let(:format) { :invalid_format }
       let(:message) { 'unkonwn' }
 
-      it "should raise error" do
+      it "raises error" do
         expect { subject }.to raise_error(ArgumentError)
       end
     end
@@ -128,7 +129,7 @@ describe Pheme::QueuePoller do
   end
 
   describe "#poll" do
-    before(:each) do
+    before do
       module ActiveRecord
         class Base
           def self.connection_pool; end
@@ -137,8 +138,10 @@ describe Pheme::QueuePoller do
     end
 
     context "with connection pool block" do
-      let(:mock_connection_pool) { double }
       subject { ExampleQueuePoller.new(queue_url: queue_url, connection_pool_block: true) }
+
+      let(:mock_connection_pool) { double }
+
       let(:message) { { status: 'complete' } }
       let(:notification) { { 'MessageId' => SecureRandom.uuid, 'Message' => message.to_json, 'Type' => 'Notification', 'Timestamp' => timestamp } }
       let!(:queue_message) do
@@ -148,7 +151,7 @@ describe Pheme::QueuePoller do
         )
       end
 
-      before(:each) do
+      before do
         allow(ActiveRecord::Base).to receive(:connection_pool) { mock_connection_pool }
         allow(mock_connection_pool).to receive(:with_connection).and_yield
         allow(subject.queue_poller).to receive(:poll).and_yield(queue_message)
@@ -163,6 +166,7 @@ describe Pheme::QueuePoller do
 
     context "without connection pool block" do
       subject { ExampleQueuePoller.new(queue_url: queue_url) }
+
       let(:message) { { status: 'complete' } }
       let(:notification) { { 'MessageId' => SecureRandom.uuid, 'Message' => message.to_json, 'Type' => 'Notification', 'Timestamp' => timestamp } }
       let!(:queue_message) do
@@ -172,7 +176,7 @@ describe Pheme::QueuePoller do
         )
       end
 
-      before(:each) do
+      before do
         allow(subject.queue_poller).to receive(:poll).and_yield(queue_message)
         allow(subject.queue_poller).to receive(:delete_message).with(queue_message)
       end
@@ -185,6 +189,7 @@ describe Pheme::QueuePoller do
 
     context "when a valid message is yielded" do
       subject { ExampleQueuePoller.new(queue_url: queue_url) }
+
       let(:message) { { id: "id-123", status: "complete" } }
       let(:notification) do
         {
@@ -201,7 +206,7 @@ describe Pheme::QueuePoller do
         )
       end
 
-      before(:each) do
+      before do
         allow(subject.queue_poller).to receive(:poll).and_yield(queue_message)
         allow(subject.queue_poller).to receive(:delete_message).with(queue_message)
       end
@@ -219,6 +224,7 @@ describe Pheme::QueuePoller do
 
     context "when an invalid message is yielded" do
       subject { ExampleQueuePoller.new(queue_url: queue_url) }
+
       let(:message) { { id: "id-123", status: "unknown-abc" } }
       let(:notification) do
         {
@@ -235,7 +241,7 @@ describe Pheme::QueuePoller do
         )
       end
 
-      before(:each) do
+      before do
         allow(subject.queue_poller).to receive(:poll).and_yield(queue_message)
         allow(subject.queue_poller).to receive(:delete).with(queue_message)
         allow(Pheme.logger).to receive(:error)
@@ -257,11 +263,13 @@ describe Pheme::QueuePoller do
 
     context "AWS-event message" do
       subject { ExampleAwsEventQueuePoller.new(queue_url: queue_url) }
+
       let(:queue_message) { OpenStruct.new(body: { 'Records' => records }.to_json) }
       let(:records) do
         [{ 'eventVersion' => '2.0', 'eventSource': 'aws:s3' }]
       end
-      before(:each) do
+
+      before do
         allow(subject.queue_poller).to receive(:poll).and_yield(queue_message)
         allow(subject.queue_poller).to receive(:delete).with(queue_message)
       end
@@ -272,6 +280,8 @@ describe Pheme::QueuePoller do
     end
 
     context 'SignalException' do
+      subject { ExampleQueuePoller.new(queue_url: queue_url) }
+
       let(:message) { { status: 'complete' } }
       let(:notification) { { 'MessageId' => SecureRandom.uuid, 'Message' => message.to_json, 'Type' => 'Notification', 'Timestamp' => timestamp } }
       let!(:queue_message) do
@@ -286,8 +296,6 @@ describe Pheme::QueuePoller do
         allow(subject.queue_poller).to receive(:delete_message).and_raise(SignalException.new('KILL'))
       end
 
-      subject { ExampleQueuePoller.new(queue_url: queue_url) }
-
       it 'stops polling' do
         expect { subject.poll }.to raise_error(UncaughtThrowError, /stop_polling/)
       end

data/spec/rollbar_spec.rb

@@ -2,18 +2,18 @@ RSpec.describe Pheme do
   let(:rollbar) { double }
 
   describe '.rollbar' do
+    subject { described_class.rollbar(exception, message, data) }
+
     let(:exception) { StandardError }
     let(:message) { 'Unable to poll for messages' }
     let(:data) { { sqs_url: 'arn::foo::bar' } }
 
     before do
-      Pheme.configure do |config|
+      described_class.configure do |config|
         config.rollbar = rollbar
       end
     end
 
-    subject { Pheme.rollbar(exception, message, data) }
-
     it 'sends error message to rollbar' do
       expect(rollbar).to receive(:error).with(exception, message, data)
       subject

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ RSpec.configure do |config|
 
   ENV['AWS_REGION'] = 'us-east-1'
 
-  config.before(:each) do
+  config.before do
     Pheme.reset_configuration!
   end
 end

data/spec/topic_publisher_spec.rb

@@ -1,5 +1,5 @@
 describe Pheme::TopicPublisher do
-  before(:each) { use_default_configuration! }
+  before { use_default_configuration! }
 
   context 'base publisher' do
     subject { described_class.new(topic_arn: 'arn::foo::bar').publish_events }
@@ -45,11 +45,11 @@ describe Pheme::TopicPublisher do
     end
 
     context 'with string message' do
+      subject { described_class.new(topic_arn: topic_arn) }
+
       let(:topic_arn) { "arn:aws:sns:anything" }
       let(:message) { "don't touch my string" }
 
-      subject { Pheme::TopicPublisher.new(topic_arn: topic_arn) }
-
       it "publishes unchanged message" do
         expect(Pheme.configuration.sns_client).to receive(:publish).with({
           topic_arn: topic_arn,
@@ -57,14 +57,26 @@ describe Pheme::TopicPublisher do
         })
         subject.publish(message)
       end
+
+      context 'with an explicit sns client' do
+        let(:sns_client) { double }
+
+        it "publishes unchanged message" do
+          expect(sns_client).to receive(:publish).with({
+            topic_arn: topic_arn,
+            message: message,
+          })
+          subject.publish(message, sns_client: sns_client)
+        end
+      end
     end
 
     context 'with message too large' do
+      subject { described_class.new(topic_arn: topic_arn).publish(message) }
+
       let(:topic_arn) { "arn:aws:sns:anything" }
       let(:message) { 'x' * (described_class::MESSAGE_SIZE_LIMIT + 1) }
 
-      subject { Pheme::TopicPublisher.new(topic_arn: topic_arn).publish(message) }
-
       let(:compressed_message) do
         gz = Zlib::GzipWriter.new(StringIO.new)
         gz << message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheme
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -233,6 +233,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -285,7 +286,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby SNS publisher + SQS poller & message handler