philotic 0.0.1 → 0.1.0

data/spec/philotic/logging/logger_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Philotic
+  module Logging
+    describe Logger do
+      let (:device) { double }
+      let(:logger) { Philotic::Logging::Logger.new(device) }
+      let (:message) { 'Hey!' }
+      specify do
+
+        expect(Philotic::Publisher).to receive(:publish) do |event|
+          expect(event.message).to eq message
+          expect(event.severity).to eq Logger::INFO
+
+        end
+        expect(device).to receive(:respond_to?).with(:write).and_return(true)
+        expect(device).to receive(:respond_to?).with(:close).and_return(true)
+        expect(device).to receive(:write) do |log_message|
+          expect(log_message).to match /#{message}/
+        end
+        logger.info message
+
+      end
+    end
+  end
+end

data/spec/philotic/publisher_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'philotic/dummy_event'
+
+describe Philotic::Publisher do
+  before(:each) do
+    @event           = Philotic::DummyEvent.new
+    @event.subject   = 'Hello'
+    @event.message   = 'How are you?'
+    @event.gender    = :M
+    @event.available = true
+  end
+  let(:publisher) { Philotic::Publisher }
+  subject { publisher }
+
+  describe 'config' do
+    it 'should return the Philotic::Config singleton' do
+      expect(subject.config).to eq Philotic::Config
+    end
+  end
+
+
+  describe 'publish' do
+    it 'should call _publish with the right values' do
+      expect(subject).to receive(:_publish).with(
+                             {
+                                 subject: 'Hello',
+                                 message: 'How are you?'
+                             },
+                             {
+                                 headers:   {
+                                     philotic_firehose:   true,
+                                     philotic_product:    nil,
+                                     philotic_component:  nil,
+                                     philotic_event_type: nil,
+                                     gender:              :M,
+                                     available:           true
+                                 },
+                                 timestamp: Time.now.to_i
+                             }
+                         )
+      subject.publish(@event)
+    end
+
+  end
+
+  describe 'raw_publish' do
+
+    it 'should call exchange.publish with the right values' do
+      exchange = double
+      expect(Philotic::Connection).to receive(:exchange).and_return(exchange)
+
+      expect(Philotic).to receive(:connect!)
+      expect(Philotic::Connection).to receive(:connected?).and_return(true)
+
+      expect(exchange).to receive(:publish).with(
+                              {
+                                  subject: 'Hello',
+                                  message: 'How are you?'
+                              }.to_json,
+                              {
+                                  routing_key:      nil,
+                                  persistent:       true,
+                                  mandatory:        true,
+                                  content_type:     nil,
+                                  content_encoding: nil,
+                                  priority:         nil,
+                                  message_id:       nil,
+                                  correlation_id:   nil,
+                                  reply_to:         nil,
+                                  type:             nil,
+                                  user_id:          nil,
+                                  app_id:           nil,
+                                  expiration:       nil,
+                                  headers:          {
+                                      philotic_firehose:   true,
+                                      philotic_product:    nil,
+                                      philotic_component:  nil,
+                                      philotic_event_type: nil,
+                                      gender:              :M,
+                                      available:           true
+                                  },
+                                  timestamp:        Time.now.to_i
+                              }
+                          )
+      subject.publish(@event)
+    end
+
+    it 'should log an error when there is no connection' do
+
+
+      expect(Philotic).to receive(:connect!)
+      expect(Philotic::Connection).to receive(:connected?).once.and_return(false)
+
+      expect(Philotic.logger).to receive(:error)
+      subject.publish(@event)
+    end
+
+  end
+end

data/spec/{routable_spec.rb → philotic/routable_spec.rb}

@@ -2,14 +2,14 @@ require 'spec_helper'
 
 describe Philotic::Routable do
   context "including the module on class" do
-    let(:routable_event_class){
+    let(:routable_event_class) {
       Class.new do
         include Philotic::Routable
         attr_routable :routable_attr
         attr_payload :payload_attr
       end
     }
-    subject { routable_event_class}
+    subject { routable_event_class }
 
     %w{ attr_payload_reader attr_payload_readers 
         attr_payload_writer attr_payload_writers 
@@ -18,40 +18,41 @@ describe Philotic::Routable do
         attr_routable_reader attr_routable_readers 
         attr_routable_writers attr_routable_writer 
         attr_routable }.each do |method_name|
-      specify { subject.methods.should include method_name.to_sym }
+      specify { expect(subject.methods).to include method_name.to_sym }
     end
 
     context " and then instantiating it" do
-      let(:routable_event_instance){ routable_event_class.new }
+      let(:routable_event_instance) { routable_event_class.new }
       subject { routable_event_instance }
 
       it 'should have proper headers' do
-        subject.headers.should == { routable_attr: nil }
+        expect(subject.headers).to eq({routable_attr: nil})
       end
 
       it 'should have proper payload' do
-        subject.payload.should == { payload_attr: nil }
+        expect(subject.payload).to eq({payload_attr: nil})
       end
 
       it 'should have proper attributes' do
-        subject.attributes.should == { routable_attr: nil,
-                                       payload_attr: nil }
+        expect(subject.attributes).to eq({routable_attr: nil, payload_attr:  nil})
       end
 
       it 'should call Philotic::Publisher.publish with subject' do
-        Philotic::Publisher.should_receive(:publish).with(subject)
+        expect(Philotic::Publisher).to receive(:publish).with(subject)
         subject.publish
-      end 
+      end
 
       it 'should have empty message_metadata' do
-        subject.message_metadata.should == {}
+        expect(subject.message_metadata).to eq({})
       end
 
-      context " overriding a value with message_metadata=" do
+      context "overriding a value with message_metadata=" do
         before do
-          routable_event_instance.message_metadata = { mandatory: false }
+          routable_event_instance.message_metadata = {mandatory: false}
+        end
+        it 'should work' do
+          expect(subject.message_metadata).to eq(mandatory: false)
         end
-        its(:message_metadata) { should eq( mandatory: false ) }
       end
     end
   end

data/spec/philotic/subscriber_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'philotic/dummy_event'
+require 'philotic/constants'
+
+describe Philotic::Subscriber do
+
+
+  describe '.subscribe' do
+    let(:subscription) { 'some_queue' }
+    context 'when options is a string' do
+      it 'binds to a queue defined by the options' do
+
+        exchange = double
+        channel  = double
+        queue    = double
+
+        metadata = double
+        message  = double
+
+        callback = lambda { |metadata, message|}
+
+        expect(Philotic).to receive(:connect!)
+
+        expect(Philotic::Connection).to receive(:exchange).and_return(exchange)
+        expect(Philotic::Connection).to receive(:channel).and_return(channel)
+        expect(channel).to receive(:queue).and_return(queue)
+
+        expect(queue).not_to receive(:bind)
+        expect(queue).to receive(:subscribe).with({})
+        expect(Philotic::Subscriber).to receive(:subscription_callback).and_yield(metadata, message)
+        expect(callback).to receive(:call).with(metadata, message)
+
+        Philotic::Subscriber.subscribe(subscription, &callback)
+      end
+    end
+
+    context 'when options is not a string' do
+      let(:subscription) do
+        {
+            firehose: true
+        }
+      end
+      it 'binds to a queue defined by the options' do
+
+        exchange = double
+        channel  = double
+        queue    = double
+
+        metadata = double
+        message  = double
+
+        callback = lambda { |metadata, payload|}
+
+        expect(Philotic).to receive(:connect!)
+
+        expect(Philotic::Connection).to receive(:exchange).and_return(exchange)
+        expect(Philotic::Connection).to receive(:channel).and_return(channel)
+        expect(channel).to receive(:queue).and_return(queue)
+
+        expect(queue).to receive(:bind).with(exchange, hash_including(arguments: subscription))
+        expect(queue).to receive(:subscribe).with({})
+        expect(Philotic::Subscriber).to receive(:subscription_callback).and_yield(metadata, message)
+        expect(callback).to receive(:call).with(metadata, message)
+
+        Philotic::Subscriber.subscribe(subscription, &callback)
+      end
+    end
+  end
+
+  describe '.subscribe_to_any' do
+    let(:headers) do
+      {
+          header1: 'h1',
+          header2: 'h2',
+          header3: 'h3',
+      }
+    end
+    specify do
+      expect(Philotic::Subscriber).to receive(:subscribe).with(headers.merge(:'x-match' => :any))
+      Philotic::Subscriber.subscribe_to_any(headers) {}
+    end
+  end
+
+  describe '.acknowledge' do
+    let(:channel) { double }
+    let(:delivery_tag) { double }
+    let(:delivery_info) { double }
+    let(:message) { {delivery_info: delivery_info} }
+
+    specify do
+      expect(Philotic::Connection).to receive(:channel).and_return(channel)
+      expect(delivery_info).to receive(:delivery_tag).and_return(delivery_tag)
+      expect(channel).to receive(:acknowledge).with(delivery_tag, false)
+      Philotic::Subscriber.acknowledge(message)
+    end
+  end
+
+  describe '.reject' do
+    let(:channel) { double }
+    let(:delivery_tag) { double }
+    let(:delivery_info) { double }
+    let(:message) { {delivery_info: delivery_info} }
+
+    specify do
+      expect(Philotic::Connection).to receive(:channel).and_return(channel)
+      expect(delivery_info).to receive(:delivery_tag).and_return(delivery_tag)
+      expect(channel).to receive(:reject).with(delivery_tag, true)
+      Philotic::Subscriber.reject(message)
+    end
+  end
+end

data/spec/philotic_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Philotic do
+
+  describe '.initialize_named_queue!' do
+
+    let(:test_queues) do
+      {
+          app_live_feed: {
+              exchange: 'philotic.headers.test_app.feed.live',
+              options:  {
+                  arguments: {
+                      :'x-dead-letter-exchange' => 'philotic.headers.test_app.feed.delayed',
+                      :'x-message-ttl'          => 600000 # ms
+                  }},
+              bindings:
+                        [
+                            {
+                                philotic_product:   'test_app',
+                                philotic_component: 'app_component',
+                                :'x-match:'         => 'all'
+                            },
+                        ],
+          }
+      }
+    end
+    it "should throw an error when ENV['INITIALIZE_NAMED_QUEUE'] is not set to 'true'" do
+      ENV['INITIALIZE_NAMED_QUEUE'] = nil
+      queue_name                    = test_queues.keys.first
+      config                        = test_queues[queue_name]
+      expect(Philotic).to receive(:connect!)
+      expect { Philotic.initialize_named_queue! queue_name, config }.to raise_error("ENV['INITIALIZE_NAMED_QUEUE'] must equal 'true' to run Philotic.initialize_named_queue!")
+
+    end
+
+    it 'should set up the queue with the right parameters' do
+      ENV['INITIALIZE_NAMED_QUEUE'] = 'true'
+
+      test_queues.each_pair do |queue_name, config|
+
+        queue_options = Philotic::DEFAULT_NAMED_QUEUE_OPTIONS.dup
+        queue_options.merge!(config[:options] || {})
+
+        channel    = double
+        queue      = double
+        exchange   = double
+        connection = double
+
+        expect(Philotic).to receive(:connect!)
+        expect(Philotic::Connection).to receive(:connection).and_return(connection)
+        expect(connection).to receive(:queue_exists?)
+        expect(Philotic::Connection).to receive(:channel).and_return(channel).exactly(2).times
+        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})
+          Philotic.initialize_named_queue! queue_name, config
+        end
+
+
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,10 +3,18 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'config'))
 
-
-require 'rubygems'
+require 'simplecov'
+require 'codeclimate-test-reporter'
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+                SimpleCov::Formatter::HTMLFormatter,
+                CodeClimate::TestReporter::Formatter
+            ]
+end
 require 'bundler/setup'
+require 'rspec/its'
 require 'philotic'
+require 'timecop'
 
 Bundler.require(:default, :test)
 
@@ -18,6 +26,6 @@ RSpec.configure do |config|
   config.after do
     Timecop.return
   end
-  
+
 end
-#Philotic.logger = Logger.new("/dev/null")
+Philotic.logger = Logger.new("/dev/null")

data/tasks/bump.rake

@@ -4,10 +4,10 @@ task bump: 'bump:patch'
 namespace :bump do
   desc 'Bump x.y.Z'
   task :patch
-  
+
   desc 'Bump x.Y.z'
   task :minor
-  
+
   desc 'Bump X.y.z'
   task :major
 end
@@ -15,16 +15,16 @@ end
 # extracted and modified from https://github.com/grosser/project_template
 rule /^bump:.*/ do |t|
   sh "git status | grep 'nothing to commit'" # ensure we are not dirty
-  index = ['major', 'minor','patch'].index(t.name.split(':').last)
-  file = 'lib/philotic/version.rb'
+  index = ['major', 'minor', 'patch'].index(t.name.split(':').last)
+  file  = 'lib/philotic/version.rb'
 
-  version_file = File.read(file)
+  version_file                = File.read(file)
   old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
-  version_parts[index] = version_parts[index].to_i + 1
-  version_parts[2] = 0 if index < 2
-  version_parts[1] = 0 if index < 1
-  new_version = version_parts * '.'
-  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+  version_parts[index]        = version_parts[index].to_i + 1
+  version_parts[2]            = 0 if index < 2
+  version_parts[1]            = 0 if index < 1
+  new_version                 = version_parts * '.'
+  File.open(file, 'w') { |f| f.write(version_file.sub(old_version, new_version)) }
 
   sh "bundle && git add #{file} && git commit -m 'bump version to #{new_version}'"
 end

metadata

@@ -1,83 +1,209 @@
 --- !ruby/object:Gem::Specification
 name: philotic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Keyes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-11 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: evented-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: amqp
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   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
@@ -87,9 +213,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -99,14 +225,19 @@ files:
 - examples/creating_named_queues/philotic_named_queues.yml
 - examples/creating_named_queues/with_rake.rb
 - examples/publishing/publish.rb
+- examples/subscribing/acks.rb
 - examples/subscribing/anonymous_queue.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/logging.rb
+- lib/philotic/logging/event.rb
+- lib/philotic/logging/logger.rb
 - lib/philotic/publisher.rb
 - lib/philotic/routable.rb
 - lib/philotic/subscriber.rb
@@ -116,12 +247,15 @@ files:
 - philotic.gemspec
 - philotic.yml.example
 - philotic_queues.yml.example
-- spec/connection_spec.rb
-- spec/event_spec.rb
-- spec/publisher_spec.rb
-- spec/routable_spec.rb
+- spec/philotic/config_spec.rb
+- spec/philotic/connection_spec.rb
+- spec/philotic/event_spec.rb
+- spec/philotic/logging/logger_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
-- spec/subscriber_spec.rb
 - tasks/bump.rake
 homepage: https://github.com/nkeyes/philotic
 licenses:
@@ -133,25 +267,28 @@ require_paths:
 - lib
 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.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Lightweight, opinionated wrapper for using RabbitMQ headers exchanges
 test_files:
-- spec/connection_spec.rb
-- spec/event_spec.rb
-- spec/publisher_spec.rb
-- spec/routable_spec.rb
+- spec/philotic/config_spec.rb
+- spec/philotic/connection_spec.rb
+- spec/philotic/event_spec.rb
+- spec/philotic/logging/logger_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
-- spec/subscriber_spec.rb
 has_rdoc: