RubyGems - isimud - Versions diffs - 0.5.2 - Mend

isimud 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

checksums.yaml +7 -0
data/.gitignore +18 -0
data/.rspec +2 -0
data/.ruby-version +1 -0
data/.yardoc/checksums +15 -0
data/.yardoc/object_types +0 -0
data/.yardoc/objects/root.dat +0 -0
data/.yardoc/proxy_types +0 -0
data/Gemfile +23 -0
data/Gemfile.lock +123 -0
data/README.md +218 -0
data/Rakefile +2 -0
data/config.ru +7 -0
data/config/tddium.yml +11 -0
data/doc/Isimud.html +1696 -0
data/doc/Isimud/BunnyClient.html +1004 -0
data/doc/Isimud/Client.html +812 -0
data/doc/Isimud/Event.html +1500 -0
data/doc/Isimud/EventListener.html +1217 -0
data/doc/Isimud/EventObserver.html +367 -0
data/doc/Isimud/EventObserver/ClassMethods.html +292 -0
data/doc/Isimud/Generators.html +117 -0
data/doc/Isimud/Generators/ConfigGenerator.html +192 -0
data/doc/Isimud/Generators/InitializerGenerator.html +192 -0
data/doc/Isimud/Logging.html +230 -0
data/doc/Isimud/ModelWatcher.html +312 -0
data/doc/Isimud/ModelWatcher/ClassMethods.html +511 -0
data/doc/Isimud/Railtie.html +123 -0
data/doc/Isimud/TestClient.html +1003 -0
data/doc/Isimud/TestClient/Queue.html +556 -0
data/doc/_index.html +290 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +338 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +338 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +711 -0
data/doc/top-level-namespace.html +112 -0
data/isimud.gemspec +25 -0
data/lib/isimud.rb +91 -0
data/lib/isimud/bunny_client.rb +95 -0
data/lib/isimud/client.rb +48 -0
data/lib/isimud/event.rb +112 -0
data/lib/isimud/event_listener.rb +200 -0
data/lib/isimud/event_observer.rb +81 -0
data/lib/isimud/logging.rb +11 -0
data/lib/isimud/model_watcher.rb +144 -0
data/lib/isimud/railtie.rb +9 -0
data/lib/isimud/tasks.rb +20 -0
data/lib/isimud/test_client.rb +89 -0
data/lib/isimud/version.rb +3 -0
data/lib/rails/generators/isimud/config_generator.rb +12 -0
data/lib/rails/generators/isimud/initializer_generator.rb +12 -0
data/lib/rails/generators/isimud/templates/initializer.rb +17 -0
data/lib/rails/generators/isimud/templates/isimud.yml +20 -0
data/spec/internal/app/models/admin.rb +2 -0
data/spec/internal/app/models/company.rb +34 -0
data/spec/internal/app/models/user.rb +27 -0
data/spec/internal/config/database.yml +3 -0
data/spec/internal/config/routes.rb +3 -0
data/spec/internal/db/schema.rb +22 -0
data/spec/internal/log/.gitignore +1 -0
data/spec/internal/public/favicon.ico +0 -0
data/spec/isimud/bunny_client_spec.rb +125 -0
data/spec/isimud/event_listener_spec.rb +86 -0
data/spec/isimud/event_observer_spec.rb +32 -0
data/spec/isimud/event_spec.rb +74 -0
data/spec/isimud/model_watcher_spec.rb +189 -0
data/spec/isimud/test_client_spec.rb +28 -0
data/spec/isimud_spec.rb +49 -0
data/spec/spec_helper.rb +55 -0
metadata +195 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Isimud.html" title="Isimud (module)">Isimud</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Fri Apr  3 09:28:08 2015 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.1).
+</div>
+  </body>
+</html>

data/isimud.gemspec ADDED

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'isimud/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'isimud'
+  spec.version       = Isimud::VERSION
+  spec.authors       = ['George Feil', 'Brian Jenkins']
+  spec.email         = %w{george.feil@keas.com bonkydog@bonkydog.com}
+  spec.summary       = %q{AMQP Messaging for Events and ActiveRecord changes}
+  spec.description   = %q{}
+  spec.homepage      = ''
+  spec.license       = "Copyright (C) 2014 Keas -- All rights reserved"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activerecord', '>= 3.2.17'
+  spec.add_dependency 'activesupport', '>= 3.2.17'
+  spec.add_dependency 'bunny', '>= 1.6.0'
+  spec.add_dependency 'chronic_duration', '>= 0.10.6'
+end

data/lib/isimud.rb ADDED

@@ -0,0 +1,91 @@
+require 'active_support'
+require 'active_support/core_ext/module/attribute_accessors'
+module Isimud
+  include ::ActiveSupport::Configurable
+  # @!attribute [r] client_type
+  #   @return [Enumerable<'bunny', 'test'>] Type of client to use
+  # @!attribute [r] client_options
+  #   @return [Hash] client specific options
+  # @!attribute [r] default_client
+  #   @return [Isimud::Client] default client
+  # @!attribute [r] events_exchange
+  #   @return [String] AMQP exchange used for publishing Event instances
+  # @!attribute [r] enable_model_watcher
+  #   @return [Boolean] when set, send Isimud::ModelWatcher messages
+  # @!attribute [r] listener_error_limit
+  #   @return [Integer] maximum number of exceptions allowed per hour before listener shuts down (100)
+  # @!attribute [r] logger
+  #   @return [Logger] logger for tracing messages (Rails.logger)
+  # @!attribute [r] log_level
+  #   @return [Symbol] log level (:debug)
+  # @!attribute [r] model_watcher_exchange
+  #   @return [String] AMQP exchange used for publishing ModelWatcher messages
+  # @!attribute [r] model_watcher_schema
+  #   @return [String] schema name (Rails.configuration.database_configuration[Rails.env]['database'])
+  # @!attribute [r] prefetch_count
+  #   @return [Integer] number of messages to fetch -- only applies to BunnyClient
+  # @!attribute [r] retry_failures
+  #   @return [Boolean] when set, if an exception occurs during message processing, requeue it
+  # @!attribute [r] server
+  #   @return [<String, Hash>] server connection attributes
+  config_accessor :client_type do
+    :bunny
+  end
+  config_accessor :client_options, :default_client, :enable_model_watcher, :model_watcher_schema, :retry_failures
+  config_accessor :listener_error_limit do
+    100
+  end
+  config_accessor :logger do
+    Rails.logger
+  end
+  config_accessor :log_level do
+    :debug
+  end
+  config_accessor :events_exchange do
+    'events'
+  end
+  config_accessor :model_watcher_exchange do
+    'models'
+  end
+  config_accessor :prefetch_count do
+    100
+  end
+  config_accessor :server do
+    ENV['AMQP_URL']
+  end
+  def self.client_class
+    type = "#{client_type}_client".classify
+    "Isimud::#{type}".constantize
+  end
+  # Fetch or initialize the messaging client for this process.
+  # @return [Isimud::Client] messaging client
+  def self.client
+    self.default_client ||= client_class.new(server, client_options || {})
+  end
+  # Connect to the messaging server
+  def self.connect
+    client.connect
+  end
+  # Return status of model watching mode
+  def self.model_watcher_enabled?
+    enable_model_watcher.nil? || enable_model_watcher
+  end
+  # Reconnect the messaging client
+  def self.reconnect
+    client.reconnect
+  end
+end
+require 'isimud/logging'
+require 'isimud/client'
+require 'isimud/event'
+require 'isimud/event_listener'
+require 'isimud/event_observer'
+require 'isimud/model_watcher'
+require 'isimud/version'

data/lib/isimud/bunny_client.rb ADDED

@@ -0,0 +1,95 @@
+require 'bunny'
+require 'logger'
+module Isimud
+  class BunnyClient < Isimud::Client
+    DEFAULT_URL = 'amqp://guest:guest@localhost'
+    attr_reader :url
+    def initialize(_url = nil, _bunny_options = {})
+      log "Isimud::BunnyClient.initialize: options = #{_bunny_options.inspect}"
+      @url           = _url || DEFAULT_URL
+      @bunny_options = _bunny_options
+    end
+    def bind(queue_name, exchange_name, *routing_keys, &block)
+      create_queue(queue_name, exchange_name,
+                   queue_options:     {durable: true},
+                   routing_keys:      routing_keys,
+                   subscribe_options: {manual_ack: true}, &block)
+    end
+    def create_queue(queue_name, exchange_name, options = {}, &block)
+      queue_options     = options[:queue_options] || {}
+      routing_keys      = options[:routing_keys] || []
+      subscribe_options = options[:subscribe_options] || {}
+      log "Isimud: create_queue #{queue_name}: queue_options=#{queue_options.inspect} routing_keys=#{routing_keys.join(',')} subscribe_options=#{subscribe_options.inspect}"
+      current_channel = channel
+      queue           = current_channel.queue(queue_name, queue_options)
+      routing_keys.each { |key| queue.bind(exchange_name, routing_key: key, nowait: false) }
+      queue.subscribe(subscribe_options) do |delivery_info, properties, payload|
+        begin
+          log "Isimud: queue #{queue_name} received #{delivery_info.delivery_tag} routing_key: #{delivery_info.routing_key}"
+          Thread.current['isimud_queue_name']    = queue_name
+          Thread.current['isimud_delivery_info'] = delivery_info
+          Thread.current['isimud_properties']    = properties
+          block.call(payload)
+          log "Isimud: queue #{queue_name} finished with #{delivery_info.delivery_tag}, acknowledging"
+          current_channel.ack(delivery_info.delivery_tag)
+        rescue => e
+          log("Isimud: queue #{queue_name} error processing #{delivery_info.delivery_tag} payload #{payload.inspect}: #{e.class.name} #{e.message}\n  #{e.backtrace.join("\n  ")}", :warn)
+          current_channel.reject(delivery_info.delivery_tag, Isimud.retry_failures)
+          exception_handler.try(:call, e)
+        end
+      end
+      queue
+    end
+    def delete_queue(queue_name)
+      channel.queue(queue_name).delete
+    end
+    def connection
+      @connection ||= ::Bunny.new(url, @bunny_options).tap(&:start)
+    end
+    alias connect connection
+    CHANNEL_KEY = :'isimud.bunny_client.channel'
+    def channel
+      if (channel = Thread.current[CHANNEL_KEY]).try(:open?)
+        channel
+      else
+        new_channel = connection.channel
+        new_channel.confirm_select
+        new_channel.prefetch(Isimud.prefetch_count) if Isimud.prefetch_count
+        Thread.current[CHANNEL_KEY] = new_channel
+      end
+    end
+    def reset
+      connection.close_all_channels
+    end
+    def connected?
+      @connection && @connection.open?
+    end
+    def close
+      connection.close
+    ensure
+      @connection = nil
+    end
+    def publish(exchange, routing_key, payload)
+      channel.topic(exchange, durable: true).publish(payload, routing_key: routing_key, persistent: true)
+    end
+    def reconnect
+      close
+      connect
+    end
+  end
+end

data/lib/isimud/client.rb ADDED

@@ -0,0 +1,48 @@
+module Isimud
+  # @abstract Messaging queue service client
+  class Client
+    include Isimud::Logging
+    attr_reader :exception_handler
+    def initialize(server = nil, options = nil)
+    end
+    def bind(queue_name, exchange_name, *keys, &method)
+    end
+    def channel
+    end
+    def close
+    end
+    def connect
+    end
+    def connected?
+    end
+    def create_queue(queue_name, exchange_name, options = {}, &method)
+    end
+    def delete_queue(queue_name)
+    end
+    def on_exception(&block)
+      @exception_handler = block
+    end
+    def publish(exchange, routing_key, payload)
+    end
+    def reconnect
+    end
+    def reset
+    end
+  end
+end
+require 'isimud/bunny_client'
+require 'isimud/test_client'

data/lib/isimud/event.rb ADDED

@@ -0,0 +1,112 @@
+require 'active_support'
+module Isimud
+  class Event
+    include Isimud::Logging
+    attr_accessor :type, :action, :user_id, :occurred_at, :eventful_type, :eventful_id, :attributes, :parameters
+    attr_writer :exchange
+    DEFAULT_TYPE = :model
+    # Initialize a new Event
+    # @overload new(user, eventful, attributes)
+    #   @param[#id] user user associated by the event
+    #   @param[ActiveRecord::Base] eventful object associated with event
+    #   @param[Hash] parameters optional additional attributes
+    # @overload new(attributes)
+    #   @param[Hash] attributes event attributes
+    #   @option attributes [Integer] :user_id ID of User associated with event
+    #   @option attributes [String] :eventful_type class of object associated with event
+    #   @option attributes [Integer] :eventful_id id of object associated with event
+    #   @option attributes [String] :exchange (Isimud.events_exchange) exchange for publishing event
+    #   @option attributes [ActiveRecord::Base] :eventful object associated with event. This sets :eventful_type and :eventful_id.
+    #   @option attributes [String, Symbol] :type (:model) event type
+    #   @option attributes [String] :action event action
+    #   @option attributes [Time] :occurred_at (Time.now) date and time event occurred
+    #   @option attributes [Hash] :attributes event attributes
+    #   @option attributes [Hash] :parameters additional parameters (deprecated)
+    def initialize(*args)
+      options = args.extract_options!.with_indifferent_access
+      self.type        = options.delete(:type).try(:to_sym) || DEFAULT_TYPE
+      self.exchange    = options.delete(:exchange)
+      self.action      = options.delete(:action).try(:to_sym)
+      self.user_id     = options.delete(:user_id)
+      self.occurred_at = if (occurred = options.delete(:occurred_at))
+                           occurred.kind_of?(String) ? Time.parse(occurred) : occurred
+                         else
+                           Time.now.utc
+                         end
+      eventful_object = options.delete(:eventful)
+      if args.length > 0
+        self.parameters = options
+        if (user = args.shift)
+          self.user_id = user.id
+        end
+        eventful_object ||= args.shift
+      end
+      if eventful_object
+        self.eventful_type = eventful_object.class.base_class.name
+        self.eventful_id   = eventful_object.id
+      else
+        self.eventful_type = options.delete(:eventful_type)
+        self.eventful_id   = options.delete(:eventful_id)
+      end
+      self.attributes = options.delete(:attributes)
+      self.parameters = options.delete(:parameters) || options
+    end
+    def exchange
+      @exchange || Isimud.events_exchange
+    end
+    def routing_key
+      [type.to_s, eventful_type, eventful_id, action].compact.join('.')
+    end
+    # Return hash of data to be serialized to JSON
+    # @option options [Boolean] :omit_parameters when set, do not include attributes or parameters in data
+    # @return [Hash] data to serialize
+    def as_json(options = {})
+      session_id = parameters.delete(:session_id) || Thread.current[:keas_session_id]
+      data = {type:          type,
+              action:        action,
+              user_id:       user_id,
+              occurred_at:   occurred_at,
+              eventful_type: eventful_type,
+              eventful_id:   eventful_id,
+              session_id:    session_id}
+      unless options[:omit_parameters]
+        data[:parameters] = parameters
+        data[:attributes] = attributes
+      end
+      data
+    end
+    def serialize
+      self.to_json
+    end
+    class << self
+      def parse(data)
+        Event.new(JSON.parse(data))
+      end
+      def publish(*args)
+        Event.new(*args).publish
+      end
+      alias_method :dispatch, :publish
+    end
+    def publish
+      data = self.serialize
+      log "Event#publish: #{self.inspect}"
+      Isimud.client.publish(exchange, routing_key, data)
+    end
+  end
+end