communicator 0.2.2 → 0.2.3

data/lib/communicator.rb

@@ -10,6 +10,14 @@ module Communicator
   
   # Error to be raised when no credentials were given
   class MissingCredentials < StandardError; end;
+    
+  autoload :Server, 'communicator/server'
+  autoload :Client, 'communicator/client'
+  autoload :ExceptionHandler, 'communicator/exception_handler'
+  autoload :ActiveRecordIntegration, 'communicator/active_record_integration'
+  autoload :OutboundMessage, 'communicator/outbound_message'
+  autoload :InboundMessage, 'communicator/inbound_message'
+  autoload :Version, 'communicator/version'
   
   # Fake logger to be returned as Communicator.logger when Rails is unavailable
   class FakeLogger
@@ -61,14 +69,10 @@ module Communicator
   end
 end
 
-require 'communicator/server'
-require 'communicator/client'
-require 'communicator/active_record_integration'
-require 'communicator/outbound_message'
-require 'communicator/inbound_message'
-require 'communicator/version'
+# Include class methods into active record base
+ActiveRecord::Base.send :extend, Communicator::ActiveRecordIntegration::ClassMethods
 
-# Autoload config when present for rails
+# Autoload config from yaml when present for rails
 if defined?(Rails)
   config_path = File.join(Rails.root, 'config', 'communicator.yml')
   if File.exist?(config_path)
@@ -78,4 +82,4 @@ if defined?(Rails)
     Communicator::Server.password = Communicator::Client.password = config[:password]
     Communicator::Client.base_uri config[:base_uri]
   end
-end
+end

data/lib/communicator/active_record_integration.rb

@@ -51,14 +51,11 @@ module Communicator::ActiveRecordIntegration
       
     rescue => err
       Communicator.logger.warn "Failed to process message on #{self.class} ##{id}! Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
-      if respond_to?(:report_exception)
-        report_exception err, "Validation Errors" => "Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}", "JSON Input" => input.inspect
+      if err.respond_to?(:context)
+        err.context["Validation Errors"] = "Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
+        err.context["JSON Input"] = input.inspect
       end
       raise err
     end
   end
 end
-
-# Include class methods into active record base
-ActiveRecord::Base.send :extend, Communicator::ActiveRecordIntegration::ClassMethods
-

data/lib/communicator/exception_handler.rb

@@ -0,0 +1,42 @@
+module Communicator::ExceptionHandler
+  class << self
+    def publish_and_reraise(err, subsections)
+      # Notify using capita/exception_notification fork, but only
+      # when notifications are not locked
+      if respond_to?(:report_exception) and not locked?
+        report_exception err, subsections
+        lock!
+      end
+      
+      # Always re-raise!
+      raise err
+    end
+    
+    # Returns the path to the lockfile, either in rails/tmp if present,
+    # otherwise in system-wide tmp
+    def lockfile
+      if defined?(Rails)
+        Rails.root.join('tmp', 'communicator_exception.lock')
+      else
+        '/tmp/communicator_exception.lock'
+      end
+    end
+    
+    # Checks whether mailing exceptions is currently locked
+    def locked?
+      File.exist?(lockfile)
+    end
+    
+    # Creates the exception notifier lockfile
+    def lock!
+      File.open(lockfile, "w+") do |f|
+        f.puts "Locked at #{Time.now}"
+      end
+    end
+    
+    # Removes the exception notifier lockfile
+    def unlock!
+      File.unlink(lockfile) if locked?
+    end
+  end  
+end

data/lib/communicator/inbound_message.rb

@@ -20,10 +20,11 @@ class Communicator::InboundMessage < ActiveRecord::Base
     inbound_msg
     
   rescue => err
-    if respond_to?(:report_exception)
-      report_exception err, "Validation Errors" => "Errors: #{inbound_msg.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}", 
-        "Inbound Message Record" => inbound_msg.attributes.inspect, 
-        "JSON Message" => json_message.inspect
+    # Add context to exception when using capita/exception_notification fork
+    if err.respond_to?(:context)
+      err.context["Validation Errors"] = "Errors: #{inbound_msg.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
+      err.context["Inbound Message"] = inbound_msg.attributes.inspect
+      err.context["JSON Message"] = json_message.inspect
     end
     
     raise err
@@ -74,11 +75,12 @@ class Communicator::InboundMessage < ActiveRecord::Base
   rescue => err
     Communicator.logger.warn "Failed to store inbound message ##{id}! Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
 
-    if respond_to?(:report_exception)
-      report_exception err, "Validation Errors" => "Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}", 
-        "Inbound Message" => self.attributes.inspect, 
-        "JSON Content" => self.message_content.inspect
-    end    
+    # Add context to exception when using capita/exception_notification fork
+    if err.respond_to?(:context)
+      err.context["Validation Errors"] = "Errors: #{self.errors.map{|k,v| "#{k}: #{v}"}.join(", ")}"
+      err.context["Inbound Message"] = self.attributes.inspect
+      err.context["JSON Content"] = self.message_content.inspect
+    end
     
     raise err
   end

data/lib/communicator/server.rb

@@ -36,41 +36,55 @@ class Communicator::Server < Sinatra::Base
     protected!
     # Require from_id attribute
     return [409, "Specify from_id!"] unless params[:from_id]
-    
-    # from_id is irrelevant when no messages are present
-    params[:from_id] = nil if Communicator::OutboundMessage.count == 0
-    
-    # Fetch the messages and build the json
-    messages = Communicator::OutboundMessage.delivery_collection(params[:from_id])
-    json = messages.map(&:payload).to_json
-    # Flag the messages as delivered
-    messages.each {|m| m.delivered! }
-    # Collect the message payloads and render them as json
-    [200, json]
+
+    begin
+      # from_id is irrelevant when no messages are present
+      params[:from_id] = nil if Communicator::OutboundMessage.count == 0
+      
+      # Fetch the messages and build the json
+      messages = Communicator::OutboundMessage.delivery_collection(params[:from_id])
+      json = messages.map(&:payload).to_json
+      # Flag the messages as delivered
+      messages.each {|m| m.delivered! }
+      
+      # Collect the message payloads and render them as json
+      [200, json]
+      
+    rescue => err
+      Communicator::ExceptionHandler.publish_and_reraise err, "Status" => "Server failed to publish outbound messages!"
+    end
   end
   
   # PUSH
   post '/messages.json' do
     protected!
     
-    body = request.body.read.strip
-    # Make sure a message body is given!
-    return [409, "No data given"] if body.length < 2
-    # Parse json
-    json_messages = JSON.parse(body)
-    
-    # If no messages present, just return
-    return [202, "No data given"] unless json_messages.length > 0
-   
-    # Make sure the first id does directly follow the last one present locally - but only if we already have ANY messages
-    # On failure, render HTTPConflicht and expected from_id
-    return [409, (Communicator::InboundMessage.last_id + 1).to_s] unless Communicator::InboundMessage.valid_next_id?(json_messages.first["id"])
-    
-    # Everything's fine? Let's store messages!
-    Communicator::InboundMessage.create_from_json_collection!(json_messages)
-    
-    202 # ACCEPTED
+    begin
+      body = request.body.read.strip
+      # Make sure a message body is given!
+      return [409, "No data given"] if body.length < 2
+      # Parse json
+      json_messages = JSON.parse(body)
+      
+      # If no messages present, just return
+      return [202, "No data given"] unless json_messages.length > 0
+     
+      # Make sure the first id does directly follow the last one present locally - but only if we already have ANY messages
+      # On failure, render HTTPConflicht and expected from_id
+      return [409, (Communicator::InboundMessage.last_id + 1).to_s] unless Communicator::InboundMessage.valid_next_id?(json_messages.first["id"])
+      
+      # Everything's fine? Let's store messages!
+      Communicator::InboundMessage.create_from_json_collection!(json_messages)
+      
+      # Unlock from exceptions after successfull PUSH
+      Communicator::ExceptionHandler.unlock!
+      
+      202 # ACCEPTED
+      
+    rescue => err
+      Communicator::ExceptionHandler.publish_and_reraise err, "Status" => "Server failed to receive inbound messages!"
+    end
   end
 end
 
-require 'pp'
+require 'pp'

data/lib/communicator/tasks.rb

@@ -20,16 +20,18 @@ namespace :communicator do
     begin
       Communicator::Client.push
     rescue => err
-      report_exception err, "Status" => "Sync failed while trying to PUSH messages"
-      raise err
+      Communicator::ExceptionHandler.publish_and_reraise err, "Status" => "Sync failed while trying to PUSH messages"
     end
     
     begin
       Communicator::Client.pull
     rescue => err
-      report_exception err, "Status" => "Sync failed while trying to PULL messages"
-      raise err
+      Communicator::ExceptionHandler.publish_and_reraise err, "Status" => "Sync failed while trying to PULL messages"
     end
+    
+    # If everything's fine, make sure exception notifications are unlocked and get 
+    # delivered again on next occurence
+    Communicator::ExceptionHandler.unlock!
   end
   
   desc "Purges inbound and outbound messages - USE WITH CAUTION!!"
@@ -37,4 +39,4 @@ namespace :communicator do
     Communicator::InboundMessage.delete_all
     Communicator::OutboundMessage.delete_all
   end
-end
+end

data/lib/communicator/version.rb

@@ -1,3 +1,3 @@
 module Communicator
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: communicator
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +01:00
+date: 2011-02-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -198,6 +198,7 @@ files:
 - lib/communicator.rb
 - lib/communicator/active_record_integration.rb
 - lib/communicator/client.rb
+- lib/communicator/exception_handler.rb
 - lib/communicator/inbound_message.rb
 - lib/communicator/outbound_message.rb
 - lib/communicator/server.rb