philotic 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 3ed9395d1fe81863b4c38f92ab7caa95186d7731
-  data.tar.gz: d550b106f564a798635798e121dcd80d192d9e10
+  metadata.gz: 0f73c756665ad98e8a1387acdda9141a8e84e95c
+  data.tar.gz: cc3615e57182313cbc80acc792be53cc7bfbdefb
 SHA512: 
-  metadata.gz: 160ebead89967ffdcd676867166573334df6d8b7a01fe08fa061043a0cb7b23b31a8ac23d2ad9c6cff2876871b0b039ed10f4ab00dab48e8451ce4756a1a0d94
-  data.tar.gz: 8e40399b956a627bc93ccd1e7bca8e0408efe25e9cba930ba2833139c8a299d6e5fe95ec206bbbd2ca3f8867f125c19688aeeba06399ad8b5bd4887be6d29b81
+  metadata.gz: 2e1d40caf53520703dcb80ea912f1fb5c2ebbc1e70496aa2c938273e566fb9dece69a0c00cf0729c483140014fb70b848d56df6e2d98dd142478dbeea7c48853
+  data.tar.gz: 8b2ef1f4b04f2d4b6cbce4b8f14c4877504c19574af33da3ab006f9a0e8df7c041af78271efd235cf97c18da9095ad4c8ff433b9144c32c8ee7200132d14b01c

data/README.md

@@ -16,7 +16,7 @@ require 'awesome_print'
 
 # override the message return handler
 Philotic.config.message_return_handler = lambda do |basic_return, metadata, message|
-  Philotic.logger.warn "Message returned. reply_text: #{basic_return.reply_text}"
+  Philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
 Philotic.subscribe(header_key: 'header_1') do |metadata, message|
@@ -45,7 +45,7 @@ philotic = Philotic::Connection.new
 
 # override the message return handler
 philotic.config.message_return_handler = lambda do |basic_return, metadata, message|
-  philotic.logger.warn "Message returned. reply_text: #{basic_return.reply_text}"
+  philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
 philotic.subscribe(header_key: 'header_1') do |metadata, message|

data/examples/simple_instance.rb

@@ -9,7 +9,7 @@ philotic = Philotic::Connection.new
 
 # override the message return handler
 philotic.config.message_return_handler = lambda do |basic_return, metadata, message|
-  philotic.logger.warn "Message returned. reply_text: #{basic_return.reply_text}"
+  philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
 philotic.subscribe(header_key: 'header_1') do |metadata, message|

data/examples/simple_singleton.rb

@@ -7,7 +7,7 @@ require 'awesome_print'
 
 # override the message return handler
 Philotic.config.message_return_handler = lambda do |basic_return, metadata, message|
-  Philotic.logger.warn "Message returned. reply_text: #{basic_return.reply_text}"
+  Philotic.logger.warn { "Message returned. reply_text: #{basic_return.reply_text}" }
 end
 
 Philotic.subscribe(header_key: 'header_1') do |metadata, message|

data/lib/philotic/config.rb

@@ -39,7 +39,7 @@ module Philotic
     DEFAULT_APP_ID                  = nil
     DEFAULT_TIMESTAMP               = nil
     DEFAULT_EXPIRATION              = nil
-    DEFAULT_CONNECTION_RETRIES      = 2
+    DEFAULT_CONNECTION_ATTEMPTS     = 3
 
     attr_accessor :connection
 
@@ -79,27 +79,28 @@ module Philotic
       @log_level ||= defaults[:log_level].to_i
     end
 
-    def connection_retries
-      @connection_retries ||= defaults[:connection_retries].to_i
+    def connection_attempts
+      @connection_retries ||= defaults[:connection_attempts].to_i
     end
 
     attr_writer :connection_failed_handler, :connection_loss_handler, :message_return_handler
 
     def connection_failed_handler
       @connection_failed_handler ||= lambda do |settings|
-        logger.error "RabbitMQ connection failure; host:#{rabbit_host}"
+        logger.error { "RabbitMQ connection failure; host:#{rabbit_host}" }
       end
     end
 
     def connection_loss_handler
       @connection_loss_handler ||= lambda do |conn, settings|
-        logger.warn "RabbitMQ connection loss; host:#{rabbit_host}"; conn.reconnect(false, 2)
+        logger.warn { "RabbitMQ connection loss; host:#{rabbit_host}" }
+        conn.reconnect(false, 2)
       end
     end
 
     def message_return_handler
       @message_return_handler ||= lambda do |basic_return, metadata, payload|
-        logger.warn "Philotic message #{JSON.parse payload} was returned! reply_code = #{basic_return.reply_code}, reply_text = #{basic_return.reply_text} headers = #{metadata[:headers]}"
+        logger.warn { "Philotic message #{JSON.parse payload} was returned! reply_code = #{basic_return.reply_code}, reply_text = #{basic_return.reply_text} headers = #{metadata[:headers]}" }
       end
     end
 
@@ -124,6 +125,11 @@ module Philotic
       "#{rabbit_scheme}://#{rabbit_user}:#{rabbit_password}@#{rabbit_host}:#{rabbit_port}/#{CGI.escape rabbit_vhost}"
     end
 
+    def sanitized_rabbit_url
+      parse_rabbit_uri
+      rabbit_url.gsub("#{rabbit_user}:#{rabbit_password}", '[USER_REDACTED]:[PASSWORD_REDACTED]')
+    end
+
     def load_config(config)
       config.each do |k, v|
         mutator = "#{k}="

data/lib/philotic/connection.rb

@@ -10,7 +10,13 @@ require 'philotic/subscriber'
 module Philotic
   class Connection
 
-    class TCPConnectionFailed < Bunny::TCPConnectionFailed; end
+    class TCPConnectionFailed < StandardError
+      attr_reader :url
+
+      def initialize(message, url)
+        super("Could not establish TCP connection to #{url}: #{message}")
+      end
+    end
 
     extend Forwardable
 
@@ -41,11 +47,11 @@ module Philotic
       start_connection!
 
       if connected?
-        logger.info "connected to RabbitMQ: #{config.rabbit_host}:#{config.rabbit_port}"
+        logger.info { "Connected to RabbitMQ: #{config.sanitized_rabbit_url}" }
         set_exchange_return_handler!
         true
       else
-        logger.error "failed connected to RabbitMQ; host:#{config.rabbit_host}"
+        logger.error { "Failed to connect to RabbitMQ: #{config.sanitized_rabbit_url}" }
         false
       end
     end
@@ -54,18 +60,23 @@ module Philotic
       begin
         attempt_connection
       rescue ::Bunny::TCPConnectionFailed => e
-        if connection_attempts <= config.connection_retries
+        if connection_attempts < config.connection_attempts
           retry
         else
-          raise TCPConnectionFailed.new "Failed to connect after #{connection_attempts} attempts", config.rabbit_host, config.rabbit_port
+          attempts             = connection_attempts
+          @connection_attempts = 0
+          raise TCPConnectionFailed.new "Failed to connect to RabbitMQ server after #{attempts} attempts", config.sanitized_rabbit_url
         end
       end
     end
 
     def attempt_connection
       @connection_attempts += 1
-      @connection          = Bunny.new(config.rabbit_url, connection_settings)
+      logger.warn { "Connecting to RabbitMQ: #{config.sanitized_rabbit_url}. Attempt #{connection_attempts} of #{config.connection_attempts}" } if connection_attempts > 1
+
+      @connection = Bunny.new(config.rabbit_url, connection_settings)
       @connection.start
+      @connection_attempts = 0
     end
 
     def connection_settings
@@ -77,7 +88,7 @@ module Philotic
     end
 
     def close
-      logger.info "closing connection to RabbitMQ; host:#{config.rabbit_host}"
+      logger.warn { "closing connection to RabbitMQ: #{config.sanitized_rabbit_url}" }
       connection.close if connected?
       @channel  = nil
       @exchange = nil
@@ -112,7 +123,7 @@ module Philotic
 
       if should_delete_queue
         channel.queue(queue_name, passive: true).delete
-        logger.info "deleted old queue. queue: #{queue_name}"
+        logger.info { "deleted old queue. queue: #{queue_name}" }
       end
 
       if should_create_queue
@@ -120,7 +131,7 @@ module Philotic
         queue  = queue_from_config(queue_name, config)
         bind_queue(queue, config)
       else
-        logger.warn "Queue #{queue_name} not created; it already exists. self.config.delete_existing_queues must be true to override."
+        logger.warn { "Queue #{queue_name} not created; it already exists. self.config.delete_existing_queues must be true to override." }
       end
     end
 
@@ -129,10 +140,10 @@ module Philotic
       bindings       = config[:bindings]
       bindings.each do |arguments|
         queue.bind(queue_exchange, {arguments: arguments})
-        logger.info "Added binding to queue. queue: #{queue.name} binding: #{arguments}"
+        logger.info { "Added binding to queue. queue: #{queue.name} binding: #{arguments}" }
       end
 
-      logger.info "Finished adding bindings to queue. queue: #{queue.name}"
+      logger.info { "Finished adding bindings to queue. queue: #{queue.name}" }
     end
 
     def exchange_from_config(config)
@@ -144,7 +155,7 @@ module Philotic
       queue_options.merge!(config[:options] || {})
 
       channel.queue(queue_name, queue_options).tap do
-        logger.info "Created queue. queue:#{queue_name}"
+        logger.info { "Created queue. queue:#{queue_name}" }
       end
     end
 

data/lib/philotic/publisher.rb

@@ -30,6 +30,16 @@ module Philotic
       event
     end
 
+    def normalize_payload_times(payload)
+      payload.each do |k, v|
+        if v.respond_to?(:utc)
+          payload[k] = v.utc
+        elsif v.respond_to?(:to_utc)
+          payload[k] = v.to_utc
+        end
+      end
+    end
+
     private
     def _publish(payload, message_metadata = {})
       if config.disable_publish
@@ -50,16 +60,6 @@ module Philotic
       true
     end
 
-    def normalize_payload_times(payload)
-      payload.each do |k, v|
-        if v.respond_to?(:utc)
-          payload[k] = v.utc
-        elsif v.respond_to?(:to_utc)
-          payload[k] = v.to_utc
-        end
-      end
-    end
-
     def merge_metadata(message_metadata)
       publish_defaults = {}
       Philotic::MESSAGE_OPTIONS.each do |key|

data/lib/philotic/version.rb

@@ -1,3 +1,3 @@
 module Philotic
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/spec/philotic/connection_spec.rb

@@ -55,7 +55,7 @@ describe Philotic::Connection do
     it 'should retry connecting' do
       expect(Bunny).to receive(:new) do
         raise connection_error
-      end.exactly(subject.config.connection_retries + 1).times
+      end.exactly(subject.config.connection_attempts).times
 
       expect { subject.start_connection! }.to raise_error(Philotic::Connection::TCPConnectionFailed)
     end
@@ -147,7 +147,6 @@ describe Philotic::Connection do
         expect(queue).to receive(:delete)
         expect(channel).to receive(:queue).with(queue_name, queue_options).and_return(queue)
         expect(channel).to receive(:headers).with(config[:exchange], durable: true) { exchange }
-        expect(queue).to receive(:name).and_return(queue_name).exactly(2).times
 
         config[:bindings].each do |arguments|
           expect(queue).to receive(:bind).with(exchange, {arguments: arguments})

data/spec/philotic/logging/logger_spec.rb

@@ -30,6 +30,19 @@ module Philotic
 
       end
 
+      it 'should accept a block' do
+        expect(logger.connection).to receive(:publish) do |event|
+          expect(event.message).to eq message
+          expect(event.severity).to eq Logger::INFO
+
+        end
+
+        expect(device).to receive(:write) do |log_message|
+          expect(log_message).to match /#{message}/
+        end
+        logger.info { message }
+      end
+
       it "should not die if it can't log to RabbitMQ" do
         expect(logger.connection).to receive(:publish) do |event|
           raise error_message
@@ -43,7 +56,15 @@ module Philotic
           expect(log_message).to match /#{error_message}/
         end
         logger.info message
+      end
 
+      it 'should behave not log if the severity is too low' do
+
+        expect(logger.connection).not_to receive(:publish)
+
+        expect(device).not_to receive(:write)
+        logger.level = Logger::WARN
+        logger.info message
       end
     end
   end

data/spec/philotic/publisher_spec.rb

@@ -16,8 +16,8 @@ describe Philotic::Publisher do
   let(:publisher) { Philotic::Connection.new.publisher }
   subject { publisher }
 
-  describe 'publish' do
-    let(:publish_error) {StandardError.new 'publish error'}
+  describe '#publish' do
+    let(:publish_error) { StandardError.new 'publish error' }
     it 'should call _publish with the right values' do
       Timecop.freeze
       expect(subject).to receive(:_publish).with(
@@ -55,9 +55,23 @@ describe Philotic::Publisher do
 
     end
 
+    context 'when publishing is disabled' do
+      before do
+        subject.config.disable_publish = true
+      end
+      it 'should log a warning' do
+        expect(subject).to receive(:log_event_published)
+
+        expect(event).to_not be_published
+        subject.publish(event)
+        expect(event).to_not be_published
+      end
+
+    end
+
   end
 
-  describe 'raw_publish' do
+  describe '#raw_publish' do
 
     it 'should call exchange.publish with the right values' do
       Timecop.freeze
@@ -117,4 +131,28 @@ describe Philotic::Publisher do
     end
 
   end
+
+
+  describe '#normalize_payload_times' do
+    let(:responds_to_utc) { double }
+    let(:responds_to_to_utc) { double }
+    let (:payload) { {utc: responds_to_utc, to_utc: responds_to_to_utc} }
+    let(:normalized_utc) { 1 }
+    let(:normalized_to_utc) { 2 }
+    let (:normalized_payload) { {utc: normalized_utc, to_utc: normalized_to_utc} }
+    it 'should call .utc on values that respond to it' do
+      expect(responds_to_utc).to receive(:respond_to?).with(:utc).and_return(true)
+      expect(responds_to_utc).to receive(:utc).and_return(normalized_utc)
+
+      expect(responds_to_to_utc).to receive(:respond_to?).with(:utc).and_return(false)
+      expect(responds_to_to_utc).to receive(:respond_to?).with(:to_utc).and_return(true)
+      expect(responds_to_to_utc).to receive(:to_utc).and_return(normalized_to_utc)
+
+      subject.normalize_payload_times payload
+
+      expect(payload).to eq normalized_payload
+
+    end
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: philotic
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Nathan Keyes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-12-24 00:00:00 Z
+date: 2014-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: codeclimate-test-reporter