caerbannog 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd7777dd47aea5fb2c75fe83337676f39bdcfe4a
-  data.tar.gz: 2d43c2b1f4d9e262483e45bbf7e0fff161ddda34
+  metadata.gz: 023d6338359111413e0f62e40ec72aa34442e002
+  data.tar.gz: 6a54db3d5aac7ab4deced6c17e2100473a513ea4
 SHA512:
-  metadata.gz: 87f4705b972e70f7ba5ebcbab7236f609050b3c8c370722e5ef3e1a8d4ec388d137643c1ba65c5e38c275f34287e9e9902dc5f175673c849859d7c75b508d49e
-  data.tar.gz: 9be692dc762855119244d7a912ed19c36de91aa5fc31f8ab9e0cad5cfffd984f04bb59db01add5f992d63869d9f93529f598e6c8f495457b60ba01110caca3ec
+  metadata.gz: 7181df709957bb02a3ef3f3959ca1641382b2847c811c7a36b4266d2c609e18b33a3c1a90570a4a94e4a3c73a45ab4adb9123cf5f53877dfb52363af47286bb5
+  data.tar.gz: 693e29df25da07ec0902af3892dde90ff7bd8621bdf5caee0c636de9f0ae3805c34e3112f37d9da88e7dadc3a5c83a4b5003785b7677bf0b43b61b41c2bbb451

data/README.md

@@ -1,8 +1,9 @@
 # Caerbannog
+[![Circle CI](https://circleci.com/gh/magplus/caerbannog.png?style=shield)](https://circleci.com/gh/magplus/caerbannog)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/caerbannog`. To experiment with that code, run `bin/console` for an interactive prompt.
+Implements a database buffer and workers for sending and receiving events
+to/from RabbitMQ.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,13 +23,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem is meant to be used by a sender application and one or more receiver
+applications.
+
+### On the sender side
+
+Caerbannog needs to be configured with a message storage class that is an
+ActiveRecord model or works like an ActiveRecord model with regards to the
+methods `.all`, `.create!` and `#destroy`, and has two attributes `name` and
+`payload`. It also needs a RabbitMQ read and a write URL.
+
+```ruby
+Caerbannog.configure do |config|
+  config.message_class = MessageQueueMessage
+  config.rabbit_read_url = ENV['RABBIT_URL']
+  config.rabbit_write_url = ENV['RABBIT_URL']
+end
+```
+
+If you are using the gem from within a Rails application, you can run the
+following to generate this model and the configuration:
+
+    $ rails generate caerbannog
+
+This generates a migration file, an ActiveRecord message class
+`MessageQueueMessage`, and an initializer file.
+
+This class will be used to store messages when you call
+`Caerbannog::Queue.push`, before they are sent to RabbitMQ,
+
+Call the `Caerbannog::Queue.push` method with two parameters: the message name,
+that will be used as the routing key in RabbitMQ, and the message payload,
+which should be a hash or an array.
+
+```ruby
+Caerbannog::Queue.push('message name', { one_field: 'one', two_field: 'two' })
+```
+
+We then need a background publisher that uses the `all` method of the message
+class to fetch all pushed messages and send them to RabbitMQ, and then
+`destroy`s them.
+
+If you have initialized the `Caerbannog::Queue#message_class=`, you can use
+something like this to start the publisher process:
+
+    $ bundle exec rails runner 'Caerbannog::Queue.publish'
+
+### On the receiving side
+
+To receive messages you need to run a subscriber process that calls the
+`Caerbannog::Queue.subscribe` method.  An example subscriber class with some
+error handling might look like this:
+
+```ruby
+class MessageQueueWorker
+  def perform
+    Caerbannog::Queue.subscribe('my-apps-queue-name', 'message-name1', 'message-name2') do |delivery_info, properties, payload|
+      parsed_message = JSON.parse(payload)
+      # Do something with the parsed message
+    end
+  rescue Bunny::TCPConnectionFailedForAllHosts => e
+    puts 'Oh no' # Handle the error somehow
+    sleep 10 # Wait for RabbitMQ to come back up
+    retry # Try to reconnect
+  end
+end
+```
+
+and you might run this process like
+
+    $ bundle exec rails runner 'MessageQueueWorker'
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "caerbannog"
+require 'bundler/setup'
+require 'caerbannog'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/caerbannog.gemspec

@@ -4,40 +4,39 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'caerbannog/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "caerbannog"
+  spec.name          = 'caerbannog'
   spec.version       = Caerbannog::VERSION
   spec.authors = [
-    "Dennis Rogenius",
-    "Karl Eklund",
-    "Kristoffer Roupé",
-    "Lennart Fridén",
-    "Martin Svalin",
-    "Mikael Amborn",
-    "Victoria Wagman"
+    'Dennis Rogenius',
+    'Karl Eklund',
+    'Kristoffer Roupé',
+    'Lennart Fridén',
+    'Martin Svalin',
+    'Mikael Amborn',
+    'Victoria Wagman'
   ]
   spec.email = [
-    "dennis@magplus.com",
-    "karl@magplus.com",
-    "kristoffer@maglus.com",
-    "lennart@magplus.com",
-    "martin@magplus.com",
-    "mikael.amborn@magplus.com",
-    "victoria@magplus.com"
+    'dennis@magplus.com',
+    'karl@magplus.com',
+    'kristoffer@maglus.com',
+    'lennart@magplus.com',
+    'martin@magplus.com',
+    'mikael.amborn@magplus.com',
+    'victoria@magplus.com'
   ]
 
   spec.summary       = %q{Library for handling messages}
   spec.description   = %q{Implements a database buffer and workers for sending events to RabbitMQ}
-  spec.homepage      = "https://github.com/magplus/caerbannog"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/magplus/caerbannog'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rspec"
-
-  spec.add_dependency "bunny"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'bunny'
 end

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.0.0

data/lib/caerbannog/queue.rb

@@ -1,15 +1,15 @@
 module Caerbannog
   class Queue
-    def self.message_class=(message_class)
-      @message_class = message_class
-    end
-
     def self.push(name, payload)
-      @message_class.create!(:name => name, :payload => JSON.generate(payload))
+      raise ConfigurationError.new("Must configure #{self.name} with message_class") unless Caerbannog.message_class
+
+      Caerbannog.message_class.create!(:name => name, :payload => JSON.generate(payload))
     end
 
-    def self.rabbitmq
-      Bunny.run ENV['RABBIT_URL'] do |conn|
+    def self.rabbitmq(rabbit_url)
+      raise ConfigurationError.new("Must configure #{self.name} with rabbit_read_url and/or rabbit_write_url") unless rabbit_url
+
+      Bunny.run rabbit_url do |conn|
         ch = conn.create_channel
         exchange = ch.direct('events', :durable => true)
         yield exchange, ch
@@ -17,7 +17,7 @@ module Caerbannog
     end
 
     def self.subscribe(queue_name, *routing_keys, &block)
-      rabbitmq do |exchange, channel|
+      rabbitmq Caerbannog.rabbit_read_url do |exchange, channel|
         queue = channel.queue(queue_name)
         routing_keys.each { |routing_key| queue.bind(exchange, :routing_key => routing_key) }
         queue.subscribe(:block => true, &block)
@@ -25,7 +25,7 @@ module Caerbannog
     end
 
     def self.publish(messages = MessagePoller.new(@message_class))
-      rabbitmq do |exchange|
+      rabbitmq Caerbannog.rabbit_write_url do |exchange|
         messages.each do |message|
           exchange.publish(message.payload, :routing_key => message.name, :persistent => true)
           message.destroy

data/lib/caerbannog/version.rb

@@ -1,3 +1,3 @@
 module Caerbannog
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/caerbannog.rb

@@ -1,7 +1,19 @@
-require "bundler/setup"
-require "bunny"
+require 'bundler/setup'
+require 'bunny'
 require 'json'
 
-require "caerbannog/version"
-require "caerbannog/message_poller"
-require "caerbannog/queue"
+require 'caerbannog/version'
+require 'caerbannog/message_poller'
+require 'caerbannog/queue'
+
+module Caerbannog
+  class ConfigurationError < StandardError; end
+
+  class << self
+    attr_accessor :message_class, :rabbit_read_url, :rabbit_write_url
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/generators/caerbannog_generator.rb

@@ -1,21 +1,21 @@
 class CaerbannogGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
   source_root File.expand_path('../templates', __FILE__)
-  
+
   def self.next_migration_number(path)
-    Time.now.utc.strftime("%Y%m%d%H%M%S")
+    Time.now.utc.strftime('%Y%m%d%H%M%S')
   end
 
   def copy_migration
-    migration_template "add_caerbannog_messages.rb", "db/migrate/add_caerbannog_messages.rb"
+    migration_template 'add_caerbannog_messages.rb', 'db/migrate/add_caerbannog_messages.rb'
   end
 
   def create_message_model
-    copy_file "caerbannog_message.rb", "app/models/caerbannog_message.rb"
+    copy_file 'caerbannog_message.rb', 'app/models/caerbannog_message.rb'
   end
 
   def create_caerbannog_initializer
-    copy_file "caerbannog_initializer.rb", "config/initializers/caerbannog_initializer.rb"
+    copy_file 'caerbannog_initializer.rb', 'config/initializers/caerbannog_initializer.rb'
   end
 end
-  
+

data/lib/generators/templates/caerbannog_initializer.rb

@@ -1 +1,5 @@
-Caerbannog::Queue.message_class = CaerbannogMessage
+Caerbannog::Queue.configure do |config|
+  config.message_class = CaerbannogMessage
+  config.rabbit_read_url = ENV['RABBIT_URL']
+  config.rabbit_write_url = ENV['RABBIT_URL']
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caerbannog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis Rogenius
@@ -14,22 +14,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +96,7 @@ files:
 - bin/console
 - bin/setup
 - caerbannog.gemspec
+- circle.yml
 - lib/caerbannog.rb
 - lib/caerbannog/message_poller.rb
 - lib/caerbannog/queue.rb
@@ -130,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="