untied 0.0.1 → 0.0.4

data/README.md

@@ -58,7 +58,35 @@ class MyDoorkeeper
 end
 ```
 
-The watcher defined above will propagate Users instances when they are created or updated.
+The watcher defined above will propagate Users instances when they are created or updated. The ``to_json`` will be called whenever the model is propagated.
+
+#### Models representers
+
+You can use gems such as [ROAR](https://github.com/apotonick/roar) or [representable](https://github.com/apotonick/representable) to define how your models will be mapped into JSONs:
+
+```ruby
+require 'roar/representer/json'
+
+module UserRepresenter
+  include Roar::Representer::JSON
+
+  property :complete_name
+
+  def complete_name
+    "#{self.frist_name} #{self.last_name}"
+  end
+end
+
+class DoorkeeperWithRepresenter
+  include Untied::Doorkeeper
+
+  def initialize
+    watch User, :after_create, :represent_with => UserRepresenter
+  end
+end
+```
+
+Untied will extend the user instance with ``UserRepresenter`` just before sending it into the wire.
 
 ### Consumer
 
@@ -85,9 +113,14 @@ Activating observers:
 ```ruby
 Untied::Consumer.configure do |config|
   config.observers = [UserObserver]
+  config.abort_on_exception = false # default: false
 end
 ```
 
+You should start the consumer running the ``untied:consumer:worker`` Raketask.
+
+The ``abort_on_exception`` configuration tells if the worker should ignore Exception thrown. If set to true the exception and the stacktrace will be logged but the worker will not stop. This is recomended for production environments.
+
 ## Internals
 
 TODO
@@ -95,10 +128,7 @@ TODO
 ## What need to be done?
 
 - Make it ActiveRecord independent.
-- Add instructions about how to initialize the worker.
 - Failsafeness
-- Do not rely on Pub class name
-
 
 ## Contributing
 

data/examples/consumer-daemon/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.5 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/examples/consumer-daemon/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'untied-consumer', :git => 'git://github.com/redu/untied-consumer.git'
+gem 'daemons'

data/examples/consumer-daemon/README.mkd

@@ -0,0 +1,31 @@
+# Untied consumer as a deamon proccess
+
+Here is an example of how to run untied consumer in background. This is useful for deployment automation. We also keep the process ID on a file so you can monitor the process using Monit or God.
+
+## How to
+
+Add the following line to your Gemfile:
+
+```
+gem 'daemons'
+```
+
+Or simple install the [daemons](http://daemons.rubyforge.org/) gem using ``gem install daemons``.
+
+That is it, you should call the method ``daemonize`` from the worker class and provide the log and pid directories absolute paths.
+
+```ruby
+worker = Untied::Consumer::Worker.new
+worker.daemonize(:pids_dir => pids_dir, :log_dir => log_dir)
+```
+
+Now you have access to the following commands:
+
+```sh
+$ ruby consumerd.rb start
+$ ruby consumerd.rb status
+untiedc: running [pid 52324]
+$ ruby consumerd.rb stop
+untiedc: trying to stop process with pid 52324...
+untiedc: process with pid 52324 successfully stopped.
+```

data/examples/consumer-daemon/consumerd.rb

@@ -0,0 +1,20 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require "bundler/setup"
+require "amqp"
+require "untied-consumer"
+require "untied-consumer/worker"
+require "daemons"
+
+require "observer"
+
+# Enabling the observer defined in observer.rb
+Untied::Consumer.configure do |c|
+  c.observers = [Observer]
+end
+
+log_dir = File.expand_path File.join(File.dirname(__FILE__), 'log')
+pids_dir = File.expand_path File.join(File.dirname(__FILE__), 'tmp', 'pids')
+
+worker = Untied::Consumer::Worker.new
+worker.daemonize(:pids_dir => pids_dir, :log_dir => log_dir)

data/examples/consumer-daemon/observer.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+# Here you should define the method which are going to be called when the
+# publisher sends some event.
+class Observer < Untied::Consumer::Observer
+  observe :user, :from => :core
+
+  def after_create(model)
+    puts "An user was created on Goliath server, yay!"
+    puts model.inspect
+  end
+
+  def after_update(model)
+    puts "An user was created on Goliath server, yay!"
+    puts model.inspect
+  end
+end

data/lib/untied/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Untied
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/lib/untied.rb

@@ -1,20 +1,5 @@
 # -*- encoding : utf-8 -*-
 require 'untied/version'
 
-require 'rubygems'
-require 'bundler/setup'
-require 'amqp/utilities/event_loop_helper'
-
 module Untied
-  def self.start
-    Thread.abort_on_exception = false
-
-    AMQP::Utilities::EventLoopHelper.run do
-      AMQP.start
-    end
-
-    EventMachine.next_tick do
-      AMQP.channel ||= AMQP::Channel.new(AMQP.connection)
-    end
-  end
 end

data/untied.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency "rake"
-  gem.add_runtime_dependency "amqp"
 
-  gem.add_runtime_dependency "untied-consumer"
-  gem.add_runtime_dependency "untied-publisher"
+  gem.add_runtime_dependency "untied-consumer", "~> 0.0.4"
+  gem.add_runtime_dependency "untied-publisher", "~> 0.0.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: untied
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Guilherme Cavalcanti
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-22 00:00:00 Z
+date: 2012-11-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -35,44 +35,34 @@ dependencies:
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
         - 0
-        version: "0"
+        - 0
+        - 4
+        version: 0.0.4
   prerelease: false
   type: :runtime
-  name: amqp
+  name: untied-consumer
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
         - 0
-        version: "0"
-  prerelease: false
-  type: :runtime
-  name: untied-consumer
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
         - 0
-        version: "0"
+        - 4
+        version: 0.0.4
   prerelease: false
   type: :runtime
   name: untied-publisher
-  requirement: *id004
+  requirement: *id003
 description: Cross application ActiveRecord::Observer
 email: 
 - guiocavalcanti@gmail.com
@@ -91,6 +81,11 @@ files:
 - README.md
 - Rakefile
 - bin/untied_worker
+- examples/consumer-daemon/.rvmrc
+- examples/consumer-daemon/Gemfile
+- examples/consumer-daemon/README.mkd
+- examples/consumer-daemon/consumerd.rb
+- examples/consumer-daemon/observer.rb
 - examples/goliath/.rvmrc
 - examples/goliath/Gemfile
 - examples/goliath/README.mkd