philotic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d1256a8211bd2888c9d9d9652fe4a6fc89de284
+  data.tar.gz: 20e5c1a6ffca4a788bafbc283bc3bcfbd3a868bc
+SHA512:
+  metadata.gz: 7b7f720591f38592197ebca75e7d3cb5440d6659c87b43aa99ed04d5ce3f92c4983721f1c1ef8e91387665095a9b30f0771d6073d4b5f75d4a83d056bf032d22
+  data.tar.gz: ea4267f99564ad426015b55b62ccefe22365a02f1ab8a28f35f3372e28a0c53f3116a1a6f576efd38bb77eddbf07ad493d0329a16b89b9bbbc57edb7d6df270c

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.project
+philotic.yml
+philotic_queues.yml
+.idea/
+log/*.log
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - 2.0.0
+  - jruby-19mode
+  - ruby-head
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in philotic.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'rake'
+  gem 'rspec'
+  gem 'timecop'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathan Keyes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+# Philotic
+
+Lightweight, opinionated wrapper for using RabbitMQ headers exchanges
+
+[![Build Status](https://travis-ci.org/nkeyes/philotic.png?branch=master)](https://travis-ci.org/nkeyes/philotic)
+
+Check out the [examples](https://github.com/nkeyes/philotic/tree/master/examples).

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+require 'philotic/tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+Dir["tasks/**/*.rake"].each { |ext| load ext }
+
+task :spec
+task default: :spec
+

data/examples/README.md

@@ -0,0 +1,13 @@
+# Philotic Examples
+Read the code, yo!
+
+## (Re)Initializing Named Queues
+Any project that includes Philotic can include the `philotic:init_queues[path/to/named_queues.yml]` task.
+
+For example:
+```bash
+PHILOTIC_RABBIT_HOST=localhost bundle exec rake eb:init_queues[path/to/named_queues.yml]
+```
+
+
+

data/examples/creating_named_queues/manually.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path( '../../../lib', __FILE__ )
+$stdout.sync = true
+
+require 'philotic'
+
+EventMachine.run do
+# hit Control + C to stop
+  Signal.trap("INT")  { EventMachine.stop }
+  Signal.trap("TERM") { EventMachine.stop }
+  
+  queue_after_initialize_handler = Proc.new do |q|
+    Philotic.logger.info "Queue '#{q.name}' initialized: #{q.bindings}"
+  end
+  # consume ansible + subspace + new_message events
+  ansible_arguments = {
+    "x-match" => :all,
+    philotic_product: :ansible,
+    philotic_component: :subspace,
+    philotic_event_type: :new_message,
+  }
+  Philotic.initialize_named_queue!('ansible.new_messages', ansible_arguments, &queue_after_initialize_handler)
+
+  
+  EM.add_timer(5) { EM.stop }
+end

data/examples/creating_named_queues/philotic_named_queues.yml

@@ -0,0 +1,6 @@
+# consume ansible + subspace + new_message events
+ansible.new_messages:
+  - philotic_product: ansible
+    philotic_component: subspace
+    philotic_event_type: new_message
+    x-match: all

data/examples/creating_named_queues/with_rake.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path( '../../../lib', __FILE__ )
+$stdout.sync = true
+
+require 'philotic'
+require 'rake'
+
+require 'philotic/tasks'
+# equivelant of:
+# rake eb:init_queues[examples/creating_named_queues/philotic_named_queues.yml]
+Rake::Task["eb:init_queues"].invoke(File.join(File.dirname(__FILE__),".","philotic_named_queues.yml"))

data/examples/publishing/publish.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../../lib', __FILE__)
+$stdout.sync = true
+
+require 'pry'
+
+require 'philotic'
+require 'philotic/dummy_event'
+
+EventMachine.run do
+  # hit Control + C to stop
+  #Signal.trap("INT") { EventMachine.stop }
+  #Signal.trap("TERM") { EventMachine.stop }
+
+
+  Philotic::Config.load_file(File.join(File.dirname(__FILE__), "../../", "philotic.yml"))
+
+  #Philotic::Config.message_return_handler = Proc.new { |basic_return, metadata, payload|
+  #  p "overridden"
+  #  Philotic.logger.warn "#{JSON.parse payload} was returned! reply_code = #{basic_return.reply_code}, reply_text = #{basic_return.reply_text}"
+  #}
+
+
+  Philotic::Connection.connect! do
+    def send_message number
+      dummy_event = Philotic::DummyEvent.new
+
+      dummy_event.philotic_firehose = true
+      dummy_event.philotic_product = 'rabbit'
+      dummy_event.philotic_component = 'speed_test'
+      dummy_event.philotic_event_type = 'ping'
+
+      dummy_event.subject = "Hey"
+      dummy_event.available = true
+      dummy_event.gender = [:F, :M].sample
+
+
+      dummy_event.message_metadata = {mandatory: true}
+      dummy_event.message_metadata = {app_id: 'PHX'}
+      dummy_event.message = "Message #{number}: Hey #{dummy_event.gender == :M ? 'dude' : 'dudette'}"
+      dummy_event.publish
+
+      EM.add_timer rand/10 do
+        send_message number + 1
+      end
+    end
+
+    send_message 1
+
+  end
+end

data/examples/subscribing/anonymous_queue.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../../lib', __FILE__)
+$stdout.sync = true
+
+require 'philotic'
+
+EventMachine.run do
+# hit Control + C to stop
+#  Signal.trap("INT")  { EventMachine.stop }
+#  Signal.trap("TERM") { EventMachine.stop }
+
+  Philotic::Config.load_file(File.join(File.dirname(__FILE__), "../../", "philotic.yml"))
+
+
+  Philotic::Subscriber.subscribe(philotic_fire_hose: true) do |metadata, payload|
+    p metadata.attributes
+    p payload
+  end
+end

data/examples/subscribing/multiple_named_queues.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../../lib', __FILE__)
+$stdout.sync = true
+
+require 'pry'
+require 'philotic'
+
+EventMachine.run do
+# hit Control + C to stop
+  Signal.trap("INT") { EventMachine.stop }
+  Signal.trap("TERM") { EventMachine.stop }
+
+  Philotic::Config.load_file(File.join(File.dirname(__FILE__), "../../", "philotic.yml"))
+
+  # explicitly create named queues for this example
+  # ENV['INITIALIZE_NAMED_QUEUE'] must equal 'true' to run Philotic.initialize_named_queue!
+  ENV['INITIALIZE_NAMED_QUEUE'] = 'true'
+  Philotic.initialize_named_queue!('male_queue', :"x-match" => 'all', gender: :M, available: true) do
+      Philotic.initialize_named_queue!('female_queue', :"x-match" => 'all', gender: :F, available: true)
+  end
+
+  # give it time to actually create the queue, then subscribe
+  EM.add_timer(3) do
+    Philotic::Subscriber.subscribe('male_queue') do |metadata, payload|
+      p metadata.attributes
+      p payload
+    end
+    Philotic::Subscriber.subscribe('female_queue') do |metadata, payload|
+      p metadata.attributes
+      p payload
+    end
+  end
+end

data/examples/subscribing/named_queue.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path( '../../../lib', __FILE__ )
+$stdout.sync = true
+
+require 'pry'
+require 'philotic'
+
+EventMachine.run do
+# hit Control + C to stop
+  Signal.trap("INT")  { EventMachine.stop }
+  Signal.trap("TERM") { EventMachine.stop }
+  
+  #explicitly create a named queue for this example
+  Philotic.initialize_named_queue!('test_queue', :"x-match" => 'any', gender: :M, available: true)
+  
+  # give it time to actually create the queue, then subscribe
+  EM.add_timer(3) do
+    Philotic::Subscriber.subscribe('test_queue') do |metadata, payload|
+      p metadata.attributes
+      p payload
+    end
+  end
+end

data/lib/philotic.rb

@@ -0,0 +1,144 @@
+require 'awesome_print'
+require 'active_support/all'
+
+require 'pathname'
+
+require 'logger'
+
+
+module Philotic
+  mattr_accessor :logger
+  mattr_accessor :log_event_handler
+
+  CONNECTION_OPTIONS = [
+      :rabbit_host,
+      :connection_failed_handler,
+      :connection_loss_handler,
+      :timeout,
+  ]
+  EXCHANGE_OPTIONS = [
+      :exchange_name,
+      :message_return_handler,
+  ]
+  MESSAGE_OPTIONS = [
+      :routing_key,
+      :persistent,
+      # :immediate,
+      :mandatory,
+      :content_type,
+      :content_encoding,
+      :priority,
+      :message_id,
+      :correlation_id,
+      :reply_to,
+      :type,
+      :user_id,
+      :app_id,
+      :timestamp,
+      :expiration,
+  ]
+
+  PHILOTIC_HEADERS = [
+      :philotic_firehose,
+      :philotic_product,
+      :philotic_component,
+      :philotic_event_type,
+  ]
+
+  DEFAULT_NAMED_QUEUE_OPTIONS = {
+      auto_delete: false,
+      durable: true
+  }
+  DEFAULT_ANONYMOUS_QUEUE_OPTIONS = {
+      auto_delete: true,
+      durable: false
+  }
+
+  DEFAULT_SUBSCRIBE_OPTIONS = {}
+
+  def self.root
+    ::Pathname.new File.expand_path('../../', __FILE__)
+  end
+
+  def self.env
+    ENV['SERVICE_ENV'] || 'development'
+  end
+
+  def self.exchange
+    Philotic::Connection.exchange
+  end
+
+  def self.initialize_named_queue!(queue_name, config, &block)
+    config = config.deep_symbolize_keys
+
+
+    raise "ENV['INITIALIZE_NAMED_QUEUE'] must equal 'true' to run Philotic.initialize_named_queue!" unless ENV['INITIALIZE_NAMED_QUEUE'] == 'true'
+    connect! do
+      queue_options = DEFAULT_NAMED_QUEUE_OPTIONS.dup
+      queue_options.merge!(config[:options] || {})
+
+      AMQP.channel.queue(queue_name, queue_options) do |old_queue|
+        old_queue.delete do
+          Philotic::Connection.close do
+            connect! do
+              Philotic.logger.info "deleted old queue. queue:#{queue_name}"
+
+              bindings = Array(config[:bindings])
+
+              queue_exchange = config[:exchange] ? AMQP.channel.headers(config[:exchange], durable: true) : exchange
+
+              AMQP.channel.queue(queue_name, queue_options) do |q|
+                Philotic.logger.info "Created queue. queue:#{q.name}"
+                bindings.each_with_index do |arguments, arguments_index|
+                  q.bind(queue_exchange, { arguments: arguments }) do
+                    Philotic.logger.info "Added binding to queue. queue:#{q.name} binding:#{arguments}"
+                    if arguments_index >= bindings.size - 1
+                      Philotic.logger.info "Finished adding bindings to queue. queue:#{q.name}"
+                      block.call(q) if block
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.logger
+    @@logger ||= init_logger
+  end
+
+  def self.init_logger
+    Logger.new(STDOUT)
+  end
+
+  def self.on_publish_event(&block)
+    @@log_event_handler = block
+  end
+
+  def self.log_event_published(severity, metadata, payload, message)
+    if @@log_event_handler
+      @@log_event_handler.call(severity, metadata, payload, message)
+    else
+      logger.send(severity, "#{message}; message_metadata:#{metadata}, payload:#{payload.to_json}")
+    end
+  end
+
+  def self.connected?
+    Philotic::Connection.connected?
+  end
+
+  def self.connect! &block
+    Philotic::Connection.connect! &block
+  end
+end
+
+require 'philotic/version'
+require 'philotic/connection'
+require 'philotic/config'
+require 'philotic/routable'
+require 'philotic/event'
+require 'philotic/publisher'
+require 'philotic/subscriber'