philotic 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 158377a2a7f0458ec444e07ab7aab54225911480
-  data.tar.gz: 510ad20cb672b6d3294fbde7d71f4afd42a19500
+  metadata.gz: b72b8c6dc5ab1be2da45998cf70ebe908ad3099d
+  data.tar.gz: 8b6473eb588bdbe69d4b401b4b149cdcecb416b9
 SHA512: 
-  metadata.gz: 8fe5d2caff540d1eacfb224c5de104ed7bdf8769a13a8bc99afe6748e70368ce0c13b57bbb92d90efa7e38d4455b867a0c51d834cf3b4c79625fa6b0bf9cdd14
-  data.tar.gz: 713a02825e3bdc0d8eb62f0a185508a8de8bd3df8a9c3b431ff4b5213e7177b8f4a1a40431c1e478c8edcb185801670c09cf33461c41ce57f0861054227c299d
+  metadata.gz: 5a95fc1ea9e1729aff8752d68b50168e41d8ed621271c2a00809ec3e714ef68813defcb137febb57b4978df085a22da3b1a39e67b38e878f2de99d41b72e52eb
+  data.tar.gz: 96fb09160928634ec14693512aadd19c99237993d7e608bcf850ced33006a75ca8216ed60da6e6571e2c29b2a6e3c9363b649979578f8584e082b4a2c1358596

data/README.md

@@ -8,8 +8,35 @@ Lightweight, opinionated wrapper for using RabbitMQ headers exchanges
 [![Test Coverage](https://codeclimate.com/github/nkeyes/philotic/badges/coverage.svg)](https://codeclimate.com/github/nkeyes/philotic)
 
 Check out the [examples](https://github.com/nkeyes/philotic/tree/master/examples).
+## Examples
+### Using `Philotic` as a singleton
+```Ruby
+require 'philotic'
+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}"
+end
+
+Philotic.subscriber.subscribe(header_key: 'header_1') do |metadata, message|
+  ap message[:attributes]
+end
+
+# normally we'd do:
+#
+# Philotic.subscriber.endure
+#
+# to keep the parent thread alive while the subscribers do their thing
+# but this infinite publish loop takes care of that
+loop do
+  Philotic::Event.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  # only send a message every two seconds so we can see whats going on
+  sleep 2
+end
+```
 
-## Simple Example
+### Using an instance of `Philotic::Connection`
 ```Ruby
 require 'philotic'
 require 'awesome_print'

data/examples/creating_named_queues/manually.rb

@@ -4,13 +4,11 @@ $stdout.sync = true
 
 require 'philotic'
 
-philotic = Philotic::Connection.new
-
 # explicitly create named queues for this example
-# philotic.config.initialize_named_queues must be truthy to run Philotic.initialize_named_queue!
-philotic.config.initialize_named_queues = true
+# Philotic.config.initialize_named_queues must be truthy to run Philotic.initialize_named_queue!
+Philotic.config.initialize_named_queues = true
 
-philotic.initialize_named_queue!('male_queue', bindings: [{:'x-match' => 'all', gender: :M, available: true}])
-philotic.initialize_named_queue!('female_queue', bindings: [{:'x-match' => 'all', gender: :F, available: true}])
-philotic.initialize_named_queue!('test_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])
-philotic.initialize_named_queue!('flaky_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])
+Philotic.initialize_named_queue!('male_queue', bindings: [{:'x-match' => 'all', gender: :M, available: true}])
+Philotic.initialize_named_queue!('female_queue', bindings: [{:'x-match' => 'all', gender: :F, available: true}])
+Philotic.initialize_named_queue!('test_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])
+Philotic.initialize_named_queue!('flaky_queue', bindings: [{ :'x-match' => 'any', gender: :M, available: true }])

data/examples/publishing/publish.rb

@@ -5,9 +5,8 @@ $stdout.sync = true
 require 'philotic'
 require 'philotic/dummy_event'
 
-@philotic = Philotic::Connection.new
 
-@philotic.publisher.logger.level = Logger::WARN
+Philotic.logger.level = Logger::WARN
 
 @event = Philotic::DummyEvent.new
 
@@ -26,7 +25,7 @@ def send_message number
   @event.gender  = [:F, :M].sample
   @event.message = "Message #{number}: Hey #{@event.gender == :M ? 'dude' : 'dudette'}"
 
-  @philotic.publish @event
+  Philotic.publish @event
 
 end
 

data/examples/simple_singleton.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+$stdout.sync = true
+
+require 'philotic'
+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}"
+end
+
+Philotic.subscriber.subscribe(header_key: 'header_1') do |metadata, message|
+  ap message[:attributes]
+end
+
+# normally we'd do:
+#
+# Philotic.subscriber.endure
+#
+# to keep the parent thread alive while the subscribers do their thing
+# but this infinite publish loop takes care of that
+loop do
+  Philotic::Event.publish({header_key: "header_#{[1, 2].sample}"}, {payload_key: 'payload_value'})
+  # only send a message every two seconds so we can see whats going on
+  sleep 2
+end

data/examples/subscribing/acks.rb

@@ -5,24 +5,21 @@ $stdout.sync = true
 require 'philotic'
 require 'awesome_print'
 
-philotic = Philotic::Connection.new
-
-
 # sometimes ack
-philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
+Philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
   ap message[:attributes]
-   [true, false].sample ? philotic.subscriber.acknowledge(message) : philotic.subscriber.reject(message)
+   [true, false].sample ? Philotic.subscriber.acknowledge(message) : Philotic.subscriber.reject(message)
 end
 
 # always ack
-philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
+Philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
   ap message[:attributes]
-  philotic.subscriber.acknowledge(message, true)
+  Philotic.subscriber.acknowledge(message, true)
 end
 
 # always reject
-philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
+Philotic.subscriber.subscribe('flaky_queue', ack: true) do |metadata, message|
   ap message[:attributes]
-  philotic.subscriber.reject message
+  Philotic.subscriber.reject message
 end
-philotic.subscriber.endure
+Philotic.subscriber.endure

data/examples/subscribing/anonymous_queue.rb

@@ -5,13 +5,10 @@ $stdout.sync = true
 require 'philotic'
 require 'awesome_print'
 
-philotic = Philotic::Connection.new
+Philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'Philotic.yml.example'))
 
-philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'philotic.yml.example'))
-
-
-philotic.subscriber.subscribe(philotic_firehose: true) do |metadata, message|
+Philotic.subscriber.subscribe(philotic_firehose: true) do |metadata, message|
   ap message[:attributes]
 end
 
-philotic.subscriber.endure
+Philotic.subscriber.endure

data/examples/subscribing/multiple_named_queues.rb

@@ -4,17 +4,15 @@ $stdout.sync = true
 
 require 'philotic'
 require 'awesome_print'
-philotic = Philotic::Connection.new
 
+Philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'Philotic.yml.example'))
 
-philotic.config.load_file(File.join(File.dirname(__FILE__), '../../', 'philotic.yml.example'))
-
-philotic.subscriber.subscribe('female_queue') do |metadata, message|
+Philotic.subscriber.subscribe('female_queue') do |metadata, message|
   ap message[:attributes]
 end
 
-philotic.subscriber.subscribe('male_queue') do |metadata, message|
+Philotic.subscriber.subscribe('male_queue') do |metadata, message|
   ap message[:attributes]
 end
 
-philotic.subscriber.endure
+Philotic.subscriber.endure

data/examples/subscribing/named_queue.rb

@@ -5,10 +5,8 @@ $stdout.sync = true
 require 'philotic'
 require 'awesome_print'
 
-philotic = Philotic::Connection.new
-
-philotic.subscriber.subscribe('test_queue') do |metadata, message|
+Philotic.subscriber.subscribe('test_queue') do |metadata, message|
   ap message[:attributes]
 end
 
-philotic.subscriber.endure
+Philotic.subscriber.endure

data/lib/philotic.rb

@@ -1,36 +1,19 @@
 require 'active_support/all'
 require 'pathname'
 
-require 'philotic/constants'
-require 'philotic/connection'
-
-
 module Philotic
   class << self
-    extend Forwardable
-
     def root
       ::Pathname.new File.expand_path('../../', __FILE__)
     end
-
-    def env
-      ENV['SERVICE_ENV'] || 'development'
-    end
-
-    def connection
-      @connection ||= Philotic::Connection.new
-    end
-
-    def method_missing(method, *args, &block)
-      connection.send(method, *args, &block)
-    end
-
-    def_delegators :connection, *(Philotic::Connection.public_instance_methods(false) - [:connection])
-
   end
 
 end
 
+require 'philotic/constants'
+require 'philotic/singleton'
+
+require 'philotic/connection'
 require 'philotic/version'
 require 'philotic/config'
 require 'philotic/routable'

data/lib/philotic/connection.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'bunny'
 require 'logger'
 
+require 'philotic/constants'
 require 'philotic/config'
 require 'philotic/publisher'
 require 'philotic/subscriber'
@@ -119,7 +120,7 @@ module Philotic
     end
 
     def queue_from_config(queue_name, config)
-      queue_options = DEFAULT_NAMED_QUEUE_OPTIONS.dup
+      queue_options = Philotic::DEFAULT_NAMED_QUEUE_OPTIONS.dup
       queue_options.merge!(config[:options] || {})
 
       channel.queue(queue_name, queue_options).tap do

data/lib/philotic/dummy_event.rb

@@ -1,5 +1,7 @@
+require 'philotic/event'
+
 module Philotic
-  class DummyEvent < Event
+  class DummyEvent < Philotic::Event
     attr_payload :subject
     attr_payload :message
     attr_routable :gender

data/lib/philotic/event.rb

@@ -1,7 +1,6 @@
-require 'philotic'
 require 'philotic/constants'
-require 'philotic/connection'
 require 'philotic/routable'
+require 'philotic/singleton'
 
 module Philotic
   class Event

data/lib/philotic/publisher.rb

@@ -1,4 +1,4 @@
-require 'philotic/connection'
+require 'philotic/constants'
 
 module Philotic
   class Publisher

data/lib/philotic/singleton.rb

@@ -0,0 +1,13 @@
+require 'philotic/connection'
+
+module Philotic
+  class << self
+    extend Forwardable
+
+    def connection
+      @connection ||= Philotic::Connection.new
+    end
+
+    def_delegators :connection, *(Philotic::Connection.public_instance_methods(false) - [:connection])
+  end
+end

data/lib/philotic/subscriber.rb

@@ -1,3 +1,5 @@
+require 'philotic/constants'
+
 module Philotic
   class Subscriber
     class Metadata

data/lib/philotic/tasks/init_queues.rb

@@ -5,17 +5,14 @@ namespace :philotic do
 
     require 'philotic'
 
-    philotic = Philotic::Connection.new
-
     # philotic.config.initialize_named_queues must be truthy to run Philotic.initialize_named_queue!
-    philotic.config.initialize_named_queues = true
+    Philotic.config.initialize_named_queues = true
 
 
     @filename = args[:filename]
     queues    = YAML.load_file(@filename)
-    philotic.connect!
     queues.each_pair do |queue_name, queue_options|
-      philotic.initialize_named_queue!(queue_name, queue_options)
+      Philotic.initialize_named_queue!(queue_name, queue_options)
     end
   end
 end

data/lib/philotic/version.rb

@@ -1,3 +1,3 @@
 module Philotic
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/spec_helper.rb

@@ -13,7 +13,6 @@ SimpleCov.start do
 end
 require 'bundler/setup'
 require 'rspec/its'
-require 'philotic'
 require 'timecop'
 
 Bundler.require(:default, :test)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: philotic
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Nathan Keyes
@@ -169,7 +169,8 @@ files:
 - examples/creating_named_queues/manually.rb
 - examples/creating_named_queues/with_rake.rb
 - examples/publishing/publish.rb
-- examples/simple_combined_example.rb
+- examples/simple_instance.rb
+- examples/simple_singleton.rb
 - examples/subscribing/acks.rb
 - examples/subscribing/anonymous_queue.rb
 - examples/subscribing/multiple_named_queues.rb
@@ -185,6 +186,7 @@ files:
 - lib/philotic/logging/logger.rb
 - lib/philotic/publisher.rb
 - lib/philotic/routable.rb
+- lib/philotic/singleton.rb
 - lib/philotic/subscriber.rb
 - lib/philotic/tasks.rb
 - lib/philotic/tasks/init_queues.rb