cony 1.0.0

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+cony

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    cony (1.0.0)
+      activesupport (>= 3)
+      bunny (~> 1.1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    amq-protocol (1.9.2)
+    bunny (1.1.9)
+      amq-protocol (>= 1.9.2)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (5.3.3)
+    rake (10.3.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    thread_safe (0.3.3)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cony!
+  rake (~> 10.0)
+  rspec (~> 2.12)

data/README.md

@@ -0,0 +1,96 @@
+# :rabbit: Cony [![Build Status](https://travis-ci.org/ninech/cony.svg)](https://travis-ci.org/ninech/cony)
+
+Cony sends notifications about the lifecycle of your models via AMQP.
+
+
+## Setup
+
+### Rails 3 & 4
+
+In Rails 3 and 4, add this to your Gemfile and run the bundle command.
+
+```ruby
+gem 'cony'
+```
+
+To configure the AMQP-Settings, use an initializer (e.g.
+`config/initializers/cony.rb`) with the following content.
+
+```ruby
+Cony.configure do |config|
+  config.amqp = {
+    host: 'localhost',
+    exchange: 'organization.application'
+  }
+  # config.durable = false
+end
+```
+
+
+## Getting Started
+
+To enable the notifications for a model, you just need to include the
+corresponding class. For `ActiveRecord` use the following snippet.
+
+```ruby
+class ExampleModel < ActiveRecord::Base
+  include Cony::ActiveRecord
+end
+```
+
+## Message Format
+
+The routing key for the messages have a format of
+`model_name_with_underscore.mutation.action`.
+
+It will append the id of the model and the detected changes to the payload of the message.
+
+### Create
+
+A create for a `Example::Model` model will have a routing key of
+`example/model.mutation.create`.
+
+The sent JSON structure will look like this:
+
+```json
+{
+  "id": 1337,
+  "changes": [
+    { "name": { "old": null, "new": "value" } },
+    { "description": { "old": null, "new": "value" } }
+  ]
+}
+```
+
+
+### Update
+
+An update for a `Example::Model` model will have a routing key of
+`example/model.mutation.update`.
+
+The sent JSON structure will look like this:
+
+```json
+{
+  "id": 1337,
+  "changes": [
+    { "name": { "old": "old-value", "new": "new-value" } }
+  ]
+}
+```
+
+
+### Destroy
+
+A destroy event for a `Example::Model` model will have a routing key of
+`example/model.mutation.destroy`.
+
+The sent JSON structure will look like this:
+
+```json
+{
+  "id": 1337,
+  "changes": []
+}
+```
+

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/cony-receive

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'amqp'
+
+EventMachine.run do
+  AMQP.connect do |connection|
+    channel  = AMQP::Channel.new(connection)
+    # topic exchange name can be any string
+    exchange = channel.topic("cony-test", durable: true)
+
+    # Subscribers.
+    channel.queue("", :exclusive => true) do |queue|
+      queue.bind(exchange, :routing_key => "#").subscribe do |headers, payload|
+        puts payload.inspect
+      end
+    end
+  end
+end

data/cony.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+#
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'cony'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['Raffael Schmid']
+  s.email       = ['info@nine.ch']
+  s.homepage    = 'http://github.com/ninech/'
+  s.license     = 'MIT'
+  s.summary     = 'Automatically sends notifications via AMQP when a model has been changed.'
+  s.description     = 'Automatically sends notifications via AMQP when a model has been changed.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 2.12'
+
+  s.add_runtime_dependency 'activesupport', '>= 3'
+  s.add_runtime_dependency 'bunny', '~> 1.1.7'
+end

data/lib/cony/active_record.rb

@@ -0,0 +1,48 @@
+require 'active_support/core_ext/string/inflections'
+
+require 'cony'
+require 'cony/amqp_connection_handler'
+
+module Cony
+  module ActiveRecord
+
+    extend ActiveSupport::Concern
+
+    included do
+      after_create :cony_send_create_notify
+      after_update :cony_send_update_notify
+      after_destroy :cony_send_destroy_notify
+    end
+
+    def cony_send_create_notify
+      publish(:create)
+    end
+
+    def cony_send_update_notify
+      publish(:update)
+    end
+
+    def cony_send_destroy_notify
+      publish(:destroy)
+    end
+
+
+    private
+    def publish(type)
+      amqp_connection.publish(
+        {id: self.id, changes: cony_changes},
+        "#{self.class.name.underscore}.mutation.#{type}")
+    end
+
+    def amqp_connection
+      @amqp_connection ||= Cony::AMQPConnectionHandler.new(Cony.config.amqp)
+    end
+
+    def cony_changes
+      changes.map do |name, change|
+        {name => {old: change.first, new: change.last}}
+      end
+    end
+
+  end
+end

data/lib/cony/amqp_connection_handler.rb

@@ -0,0 +1,24 @@
+require 'bunny'
+require 'json'
+
+module Cony
+  class AMQPConnectionHandler
+
+    def initialize(config)
+      @config = config
+    end
+
+    def publish(message, routing_key)
+      Bunny.run(@config) do |connection|
+        exchange = connection.exchange(@config[:exchange], type: :topic, durable: Cony.config.durable)
+        exchange.publish(message.to_json,
+                         key: routing_key,
+                         mandatory: false,
+                         immediate: false,
+                         persistent: Cony.config.durable,
+                         content_type: 'application/json')
+      end
+    end
+
+  end
+end

data/lib/cony.rb

@@ -0,0 +1,15 @@
+require 'active_support/core_ext/object/deep_dup'
+require 'active_support/configurable'
+
+require 'cony/active_record'
+
+module Cony
+  include ActiveSupport::Configurable
+
+  defaults = {
+    durable: false
+  }
+
+  self.config.merge! defaults.deep_dup
+
+end

data/spec/cony/active_record_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+require 'cony/active_record'
+
+describe Cony::ActiveRecord do
+
+  let(:amqp_connection) { double('Cony::AMQPConnectionHandler') }
+  let(:id) { 1337 }
+  let(:active_record_changes) { {name: ['old', 'new']} }
+  let(:cony_changes) { [{name: {old: 'old', new: 'new'}}] }
+
+  let(:model) do
+    eval <<-EOF
+      Class.new do
+        def self.after_create(callback); end
+        def self.after_update(callback); end
+        def self.after_destroy(callback); end
+        def self.name; "Anonymaus::Klass"; end
+        def id; #{id}; end
+        def changes; #{active_record_changes}; end
+
+        include Cony::ActiveRecord
+      end
+    EOF
+  end
+
+  before do
+    Cony::AMQPConnectionHandler.stub(:new).and_return(amqp_connection)
+  end
+
+  subject { model.new }
+
+  describe '#cony_send_create_notify' do
+    it 'uses the amqp connection to send the notify' do
+      amqp_connection.should_receive(:publish).with({id: id, changes: cony_changes}, 'anonymaus/klass.mutation.create')
+      subject.cony_send_create_notify
+    end
+  end
+
+  describe '#cony_send_update_notify' do
+    it 'uses the amqp connection to send the notify' do
+      amqp_connection.should_receive(:publish).with({id: id, changes: cony_changes}, 'anonymaus/klass.mutation.update')
+      subject.cony_send_update_notify
+    end
+  end
+
+  describe '#cony_send_destroy_notify' do
+    it 'uses the amqp connection to send the notify' do
+      amqp_connection.should_receive(:publish).with({id: id, changes: cony_changes}, 'anonymaus/klass.mutation.destroy')
+      subject.cony_send_destroy_notify
+    end
+  end
+end

data/spec/cony/amqp_connection_handler_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+require 'cony/amqp_connection_handler'
+
+describe Cony::AMQPConnectionHandler do
+
+  let(:config) { {exchange: 'bunny-tests'} }
+  let(:handler) { Cony::AMQPConnectionHandler.new(config) }
+  let(:message) { 'Bunnies are connies' }
+  let(:routing_key) { 'bunny.info' }
+  let(:exchange_double) do
+    double('Exchange double').tap do |exc|
+      exc.stub(:publish)
+    end
+  end
+  let(:connection_double) do
+    double('Connection double').tap do |conn|
+      conn.stub(:exchange).and_return(exchange_double)
+    end
+  end
+
+  subject { handler }
+
+  before do
+    Bunny.stub(:run).and_yield(connection_double)
+  end
+
+  it 'uses bunny to publish a message' do
+    Bunny.should_receive(:run)
+    subject.publish(message, routing_key)
+  end
+
+  it 'configures the exchange correctly' do
+    connection_double.should_receive(:exchange).with('bunny-tests', type: :topic, durable: false)
+    subject.publish(message, routing_key)
+  end
+
+  it 'publishes the message' do
+    publish_options = {
+      key: routing_key,
+      mandatory: false,
+      immediate: false,
+      persistent: false,
+      content_type: 'application/json',
+    }
+    exchange_double.should_receive(:publish)
+      .with('"Bunnies are connies"', publish_options)
+    subject.publish(message, routing_key)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: cony
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Raffael Schmid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+description: Automatically sends notifications via AMQP when a model has been changed.
+email:
+- info@nine.ch
+executables:
+- cony-receive
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bin/cony-receive
+- cony.gemspec
+- lib/cony.rb
+- lib/cony/active_record.rb
+- lib/cony/amqp_connection_handler.rb
+- spec/cony/active_record_spec.rb
+- spec/cony/amqp_connection_handler_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ninech/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Automatically sends notifications via AMQP when a model has been changed.
+test_files:
+- spec/cony/active_record_spec.rb
+- spec/cony/amqp_connection_handler_spec.rb
+- spec/spec_helper.rb