philotic 0.8.1 → 1.0.1

data/spec/philotic/logging/logger_spec.rb

@@ -9,7 +9,7 @@ module Philotic
 
       end
       let(:logger) { Philotic::Logging::Logger.new(device) }
-      let(:message) { 'Hey!' }
+      let(:expected_message) { 'Hey!' }
       let(:error_message) { "These are not the droids you're looking for" }
 
       before do
@@ -17,45 +17,45 @@ module Philotic
       end
       specify do
 
-        expect(logger.connection).to receive(:publish) do |event|
-          expect(event.message).to eq message
-          expect(event.severity).to eq Logger::INFO
+        expect(logger.connection).to receive(:publish) do |message|
+          expect(message.message).to eq expected_message
+          expect(message.severity).to eq Logger::INFO
 
         end
 
         expect(device).to receive(:write) do |log_message|
-          expect(log_message).to match /#{message}/
+          expect(log_message).to match /#{expected_message}/
         end
-        logger.info message
+        logger.info expected_message
 
       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
+        expect(logger.connection).to receive(:publish) do |message|
+          expect(message.message).to eq expected_message
+          expect(message.severity).to eq Logger::INFO
 
         end
 
         expect(device).to receive(:write) do |log_message|
-          expect(log_message).to match /#{message}/
+          expect(log_message).to match /#{expected_message}/
         end
-        logger.info { message }
+        logger.info { expected_message }
       end
 
       it "should not die if it can't log to RabbitMQ" do
-        expect(logger.connection).to receive(:publish) do |event|
+        expect(logger.connection).to receive(:publish) do |message|
           raise error_message
         end
 
         expect(device).to receive(:write) do |log_message|
-          expect(log_message).to match /#{message}/
+          expect(log_message).to match /#{expected_message}/
         end
 
         expect(device).to receive(:write) do |log_message|
           expect(log_message).to match /#{error_message}/
         end
-        logger.info message
+        logger.info expected_message
       end
 
       it 'should behave not log if the severity is too low' do
@@ -64,7 +64,7 @@ module Philotic
 
         expect(device).not_to receive(:write)
         logger.level = Logger::WARN
-        logger.info message
+        logger.info expected_message
       end
     end
   end

data/spec/philotic/message_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+require 'philotic/message'
+
+# create 'deep' inheritance to test self.inherited
+class TestEventParent < Philotic::Message
+end
+class TestEvent < TestEventParent
+  attr_routable :routable_attr
+  attr_payload :payload_attr
+end
+
+describe Philotic::Message do
+  let(:message) { TestEvent.new }
+  subject { message }
+
+  %w[
+      attr_routable_accessors
+      attr_routable
+      attr_payload_accessors
+      attr_payload
+  ].each do |method_name|
+    specify { expect(subject.class.methods).to include method_name.to_sym }
+  end
+
+  it 'should have proper headers' do
+    expect(subject.headers).to include({routable_attr: nil})
+  end
+
+  it 'should have proper payload' do
+    expect(subject.payload).to eq({payload_attr: nil})
+  end
+
+  it 'should have proper attributes' do
+    expect(subject.attributes).to include({routable_attr: nil, payload_attr: nil})
+  end
+
+  it 'should have empty metadata, other than timestamp' do
+    expect(subject.metadata.keys).to eq([:timestamp])
+  end
+
+  context 'overriding a value with metadata=' do
+    before do
+      subject.metadata = {mandatory: false}
+    end
+    it 'should work' do
+      expect(subject.metadata).to include({mandatory: false})
+    end
+  end
+
+  Philotic::Message.methods.sort.each do |method_name|
+    specify { expect(subject.class.methods).to include method_name.to_sym }
+  end
+
+  Philotic::MESSAGE_OPTIONS.each do |method_name|
+    specify { expect(subject.methods).to include method_name.to_sym }
+    specify { expect(subject.methods).to include "#{method_name}=".to_sym }
+  end
+
+  Philotic::PHILOTIC_HEADERS.each do |method_name|
+    specify { expect(subject.methods).to include method_name.to_sym }
+    specify { expect(subject.methods).to include "#{method_name}=".to_sym }
+  end
+
+  describe 'metadata' do
+    it 'should have a timestamp' do
+      Timecop.freeze
+      expect(subject.metadata).to eq(timestamp: Time.now.to_i)
+    end
+
+    it 'should reflect changes in the message properties' do
+      expect(subject.metadata[:app_id]).to eq nil
+      subject.app_id = 'ANSIBLE'
+      expect(subject.metadata[:app_id]).to eq 'ANSIBLE'
+    end
+  end
+  describe 'headers' do
+    it 'should include :philotic_product' do
+      expect(subject.headers.keys).to include :philotic_product
+    end
+  end
+
+  context 'generic message' do
+    let(:headers) do
+      {
+        header1: 'h1',
+        header2: 'h2',
+        header3: 'h3',
+      }
+    end
+
+    let(:payloads) do
+      {
+        payload1: 'h1',
+        payload2: 'h2',
+        payload3: 'h3',
+      }
+    end
+    it 'builds an message with dynamic headers and payloads' do
+      message = Philotic::Message.new(headers, payloads)
+
+      expect(message.headers).to include(headers)
+      expect(message.payload).to eq payloads
+
+    end
+  end
+
+  describe '#publish' do
+    subject { Philotic::Message.new }
+    specify do
+      expect(subject.connection).to receive(:publish).with(subject)
+
+      subject.publish
+    end
+
+  end
+
+  describe '.publish' do
+    let (:connection) { double }
+    let(:headers) do
+      {
+        header1: 'h1',
+        header2: 'h2',
+        header3: 'h3',
+      }
+    end
+
+    let(:payloads) do
+      {
+        payload1: 'h1',
+        payload2: 'h2',
+        payload3: 'h3',
+      }
+    end
+    subject { Philotic::Message }
+    specify do
+      expect_any_instance_of(Philotic::Message).to receive(:connection).and_return(connection)
+      expect(connection).to receive(:publish) do |message|
+        expect(message.headers).to include(headers)
+        expect(message.payload).to eq payloads
+      end
+
+      subject.publish(headers, payloads)
+    end
+
+  end
+end

data/spec/philotic/publisher_spec.rb

@@ -1,17 +1,18 @@
 require 'spec_helper'
-require 'philotic/dummy_event'
+
+require 'philotic/dummy_message'
 require 'philotic/connection'
 require 'philotic/publisher'
 
 describe Philotic::Publisher do
-  let(:event) do
-    event           = Philotic::DummyEvent.new
-    event.subject   = 'Hello'
-    event.message   = 'How are you?'
-    event.gender    = :M
-    event.available = true
-
-    event
+  let(:message) do
+    message           = Philotic::DummyMessage.new
+    message.subject   = 'Hello'
+    message.message   = 'How are you?'
+    message.hue       = :M
+    message.available = true
+
+    message
   end
   let(:publisher) { Philotic::Connection.new.publisher }
   subject { publisher }
@@ -27,19 +28,19 @@ describe Philotic::Publisher do
                              },
                              {
                                  headers:   {
-                                     philotic_firehose:   true,
-                                     philotic_product:    nil,
-                                     philotic_component:  nil,
-                                     philotic_event_type: nil,
-                                     gender:              :M,
-                                     available:           true
+                                     philotic_firehose:     true,
+                                     philotic_product:      nil,
+                                     philotic_component:    nil,
+                                     philotic_message_type: nil,
+                                     hue:                   :M,
+                                     available:             true,
                                  },
                                  timestamp: Time.now.to_i
                              }
                          )
-      expect(event).to_not be_published
-      subject.publish(event)
-      expect(event).to_not be_published # not connected
+      expect(message).to_not be_published
+      subject.publish(message)
+      expect(message).to_not be_published # not connected
     end
 
     it 'should fail gracefully' do
@@ -48,10 +49,10 @@ describe Philotic::Publisher do
       end
 
       expect(subject.logger).to receive(:error).with(publish_error.message)
-      expect(event).to_not be_published
-      subject.publish(event)
-      expect(event).to_not be_published
-      expect(event.publish_error).to eq publish_error
+      expect(message).to_not be_published
+      subject.publish(message)
+      expect(message).to_not be_published
+      expect(message.publish_error).to eq publish_error
 
     end
 
@@ -60,11 +61,11 @@ describe Philotic::Publisher do
         subject.config.disable_publish = true
       end
       it 'should log a warning' do
-        expect(subject).to receive(:log_event_published)
+        expect(subject).to receive(:log_message_published)
 
-        expect(event).to_not be_published
-        subject.publish(event)
-        expect(event).to_not be_published
+        expect(message).to_not be_published
+        subject.publish(message)
+        expect(message).to_not be_published
       end
     end
   end
@@ -94,12 +95,12 @@ describe Philotic::Publisher do
           app_id:           nil,
           expiration:       nil,
           headers:          {
-              philotic_firehose:   true,
-              philotic_product:    nil,
-              philotic_component:  nil,
-              philotic_event_type: nil,
-              gender:              :M,
-              available:           true
+              philotic_firehose:     true,
+              philotic_product:      nil,
+              philotic_component:    nil,
+              philotic_message_type: nil,
+              hue:                   :M,
+              available:             true,
           },
           timestamp:        Time.now.to_i
       }
@@ -112,9 +113,9 @@ describe Philotic::Publisher do
                               }.to_json,
                               metadata
                           )
-      expect(event).to_not be_published
-      subject.publish(event)
-      expect(event).to be_published
+      expect(message).to_not be_published
+      subject.publish(message)
+      expect(message).to be_published
     end
 
     it 'should log an error when there is no connection' do
@@ -123,9 +124,9 @@ describe Philotic::Publisher do
       expect(subject.connection).to receive(:connected?).once.and_return(false)
 
       expect(subject.logger).to receive(:error)
-      expect(event).to_not be_published
-      subject.publish(event)
-      expect(event).to_not be_published
+      expect(message).to_not be_published
+      subject.publish(message)
+      expect(message).to_not be_published
     end
 
   end

data/spec/philotic/subscriber_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
-require 'philotic/dummy_event'
+
+require 'philotic/dummy_message'
 require 'philotic/connection'
 require 'philotic/constants'
 require 'philotic/subscriber'
@@ -91,11 +92,12 @@ describe Philotic::Subscriber do
     let(:channel) { double }
     let(:delivery_tag) { double }
     let(:delivery_info) { double }
-    let(:message) { {delivery_info: delivery_info} }
+    let(:message) { Philotic::Message.new }
     subject { Philotic::Connection.new.subscriber }
 
     specify do
       expect(subject.connection).to receive(:channel).and_return(channel)
+      expect(message).to receive(:delivery_info).and_return(delivery_info)
       expect(delivery_info).to receive(:delivery_tag).and_return(delivery_tag)
       expect(channel).to receive(:acknowledge).with(delivery_tag, false)
       subject.acknowledge(message)
@@ -106,11 +108,12 @@ describe Philotic::Subscriber do
     let(:channel) { double }
     let(:delivery_tag) { double }
     let(:delivery_info) { double }
-    let(:message) { {delivery_info: delivery_info} }
+    let(:message) { Philotic::Message.new }
     subject { Philotic::Connection.new.subscriber }
 
     specify do
       expect(subject.connection).to receive(:channel).and_return(channel)
+      expect(message).to receive(:delivery_info).and_return(delivery_info)
       expect(delivery_info).to receive(:delivery_tag).and_return(delivery_tag)
       expect(channel).to receive(:reject).with(delivery_tag, true)
       subject.reject(message)

metadata

@@ -1,166 +1,193 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: philotic
-version: !ruby/object:Gem::Version 
-  version: 0.8.1
+version: !ruby/object:Gem::Version
+  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Nathan Keyes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-05-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id009 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - &id015 !ruby/object:Gem::Version 
-        version: "1.6"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: evented-spec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
   name: pry
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.10"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "10.3"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.3'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.1"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rspec-its
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.1"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: timecop
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.7"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id009
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - &id012 !ruby/object:Gem::Version 
-        version: "3.2"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - *id012
-  type: :runtime
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
   name: awesome_print
-  prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.2"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: bunny
   prerelease: false
-  requirement: &id016 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - *id015
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirements: *id016
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id017 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.8"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
   type: :runtime
-  version_requirements: *id017
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Lightweight, opinionated wrapper for using RabbitMQ headers exchanges
-email: 
+email:
 - nkeyes@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rspec
-- .travis.yml
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -172,19 +199,20 @@ files:
 - examples/simple_singleton.rb
 - examples/subscribing/acks.rb
 - examples/subscribing/anonymous_queue.rb
+- examples/subscribing/consumer.rb
 - examples/subscribing/multiple_named_queues.rb
 - examples/subscribing/named_queue.rb
 - lib/philotic.rb
 - lib/philotic/config.rb
 - lib/philotic/connection.rb
 - lib/philotic/constants.rb
-- lib/philotic/dummy_event.rb
-- lib/philotic/event.rb
+- lib/philotic/consumer.rb
+- lib/philotic/dummy_message.rb
 - lib/philotic/logging.rb
-- lib/philotic/logging/event.rb
 - lib/philotic/logging/logger.rb
+- lib/philotic/logging/message.rb
+- lib/philotic/message.rb
 - lib/philotic/publisher.rb
-- lib/philotic/routable.rb
 - lib/philotic/singleton.rb
 - lib/philotic/subscriber.rb
 - lib/philotic/tasks.rb
@@ -196,44 +224,45 @@ files:
 - repl
 - spec/philotic/config_spec.rb
 - spec/philotic/connection_spec.rb
-- spec/philotic/event_spec.rb
+- spec/philotic/consumer_spec.rb
 - spec/philotic/logging/logger_spec.rb
+- spec/philotic/message_spec.rb
 - spec/philotic/publisher_spec.rb
-- spec/philotic/routable_spec.rb
 - spec/philotic/subscriber_spec.rb
 - spec/philotic_spec.rb
 - spec/spec_helper.rb
 - tasks/bump.rake
 homepage: https://github.com/nkeyes/philotic
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id009
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id009
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Lightweight, opinionated wrapper for using RabbitMQ headers exchanges
-test_files: 
+test_files:
 - spec/philotic/config_spec.rb
 - spec/philotic/connection_spec.rb
-- spec/philotic/event_spec.rb
+- spec/philotic/consumer_spec.rb
 - spec/philotic/logging/logger_spec.rb
+- spec/philotic/message_spec.rb
 - spec/philotic/publisher_spec.rb
-- spec/philotic/routable_spec.rb
 - spec/philotic/subscriber_spec.rb
 - spec/philotic_spec.rb
 - spec/spec_helper.rb