harbinger 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8d9107e1f0f58e16654d251c1faa1c8959f86cc
-  data.tar.gz: e35f452a7355e1a065e962ad3a27f9aebf08d034
+  metadata.gz: 9286ebe3e606bd4307248feb1794d0c6a4e84a44
+  data.tar.gz: ebe9958929959fbc584187e2afe50cae6eb0a5de
 SHA512:
-  metadata.gz: 68d76e1139c5a602a2a15386f4d9cafa87a899ba95cf1b28432f0215b95d1e77b24119db3a118542b12b2da350d87d9f1c1260ce4534f7c26df5a99741ca85e1
-  data.tar.gz: ce7e2a07029cda8eb3270a42717614ca41a441ecec51fdaee7a1be7e05da32530a40e4c56807c9ef0d5ef31336fea59249d30c21c89356a88e71280cc0453216
+  metadata.gz: 8c61a8b758e5fd0e1ec0f1aa11da0048195166cc8c55e3dfedbe53fe574a1917b5a0d083bcf68a389a5105c4d9f6fd276fa022917562110748bed57fc59f41cd
+  data.tar.gz: 7982c7f1af6d2d912d54ed749030e6b171378bb34c106973c6967b94c9930c1b87dcd77317d2c8f1b1b5546ab41f6425e896e3c63a5d8cc0c42d5c7a612acc1f

data/README.md

@@ -8,3 +8,51 @@
 [![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
 A Rails engine for arbitrary message creation and delivery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blorg'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blorg
+
+## Usage
+
+```ruby
+class PagesController
+  def show
+    @page = Page.find(params[:id])
+  rescue ActiveRecord::RecordNotFound => exception
+    Harbinger.call(
+      channels: [:database, :logger],
+      reporters: [exception, current_user, request]
+    )
+  end
+end
+```
+
+Given the above Rails-like code
+When a user attempts to find a page that does not exist
+Then an exception is raised
+And the Harbinger.call code will:
+
+* Build a message based on the three reporters:
+  * The raised exception
+  * The current user
+  * The request
+* Deliver that message to the two channels:
+  * Database
+  * Logger
+
+For further details I recommend delving into the [end to end exception handling spec](./spec/features/end_to_end_exception_handling_spec.rb)
+
+### Extending Contexts and Channels
+
+Harbinger is built to allow for easy creation of new Contexts and Channels.

data/app/controllers/harbinger/messages_controller.rb

@@ -1,5 +1,5 @@
 module Harbinger
-  class MessagesController < ActionController::Base
+  class MessagesController < ApplicationController
 
     def index
       messages
@@ -12,7 +12,7 @@ module Harbinger
     protected
 
     def messages
-      @messages ||= DatabaseChannelMessage.search(q: params[:q])
+      @messages ||= DatabaseChannelMessage.page(params[:page]).search(q: params[:q])
     end
 
     def message

data/app/models/harbinger/database_channel_message.rb

@@ -6,17 +6,18 @@ module Harbinger
     self.table_name = 'harbinger_messages'
     has_many :elements, class_name: 'Harbinger::DatabaseChannelMessageElement', foreign_key: :message_id
 
-    def contexts=(values)
+    def reporters=(values)
       super(Array.wrap(values).join(','))
     end
 
-    def contexts
+    def reporters
       super.split(',')
     end
 
     def self.store_message(message, storage = new)
-      storage.contexts = message.contexts
+      storage.reporters = message.reporters
       storage.state = 'new'
+      storage.message_object_id = message.object_id
       message.attributes.each do |key, value|
         storage.elements.build(key: key, value: value)
       end
@@ -33,10 +34,13 @@ module Harbinger
     scope :search_text, lambda { |text|
       if text
         where(
-          arel_table[:contexts].matches("#{text}%").
+          arel_table[:reporters].matches("#{text}%").
           or(
-            arel_table[:id].
-            in(Arel::SqlLiteral.new(DatabaseChannelMessageElement.search_text(text).select(:message_id).to_sql))
+            arel_table[:message_object_id].eq(text).
+            or(
+              arel_table[:id].
+              in(Arel::SqlLiteral.new(DatabaseChannelMessageElement.search_text(text).select(:message_id).to_sql))
+            )
           )
         )
       else

data/app/views/harbinger/messages/index.html.erb

@@ -17,11 +17,14 @@
   </fieldset>
 <% end %>
 
+<%= paginate messages %>
+
 <table>
   <caption>Messages</caption>
   <thead>
     <tr>
       <th>Created At</th>
+      <th>Message Object ID</th>
       <th>Contexts</th>
       <th>State</th>
       <th>Actions</th>
@@ -31,9 +34,10 @@
     <% messages.each do |message| %>
     <tr class="message">
       <td class="detail message-created-at-detail"><a href="<%= harbinger.message_path(message.to_param)%>"><time><%= message.created_at %></time></a></td>
+      <td class="detail message-object-id-detail"><%= message.message_object_id %></td>
       <td>
-        <ul><% message.contexts.each do |context| %>
-          <li class="detail message-contexts-detail"><%= context %></li>
+        <ul><% message.reporters.each do |context| %>
+          <li class="detail message-reporters-detail"><%= context %></li>
         <% end %></ul>
       </td>
       <td class="detail message-state-detail"><%= message.state %></td>

data/app/views/harbinger/messages/show.html.erb

@@ -2,14 +2,16 @@
   <header class="message-header">
     <h2>Message</h2>
     <dl>
-      <dt class="term message-contexts-term">Contexts</dt>
-      <% message.contexts.each do |context| %>
-      <dd class="detail message-contexts-detail"><%= context %></dd>
+      <dt class="term message-created-at-term">Created at</dt>
+      <dd class="detail message-created-at-detail"><time><%= message.created_at %></time></dd>
+      <dt class="term message-object-id-term">Message Object ID</dt>
+      <dd class="detail message-object-id-detail"><%= message.message_object_id %></dd>
+      <dt class="term message-reporters-term">Contexts</dt>
+      <% message.reporters.each do |context| %>
+      <dd class="detail message-reporters-detail"><%= context %></dd>
       <% end %>
       <dt class="term message-state-term">State</dt>
       <dd class="detail message-state-detail"><%= message.state %></dd>
-      <dt class="term message-created-at-term">Created at</dt>
-      <dd class="detail message-created-at-detail"><time><%= message.created_at %></time></dd>
     </dl>
   </header>
   <section class="message-body">

data/config/routes.rb

@@ -1,5 +1,6 @@
 Harbinger::Engine.routes.draw do
   scope module: 'harbinger' do
     resources :messages, only: [:index, :show]
+    root 'messages#index'
   end
 end

data/db/migrate/20140310185338_create_harbinger_database_channel_message.rb

@@ -1,11 +1,13 @@
 class CreateHarbingerDatabaseChannelMessage < ActiveRecord::Migration
   def change
     create_table :harbinger_messages do |t|
-      t.string :contexts
+      t.string :reporters
       t.string :state, limit: 32
+      t.integer :message_object_id
       t.timestamps
     end
     add_index :harbinger_messages, :state
-    add_index :harbinger_messages, :contexts
+    add_index :harbinger_messages, :reporters
+    add_index :harbinger_messages, :message_object_id
   end
 end

data/db/migrate/20140310185339_create_harbinger_database_channel_message_elements.rb

@@ -9,6 +9,5 @@ class CreateHarbingerDatabaseChannelMessageElements < ActiveRecord::Migration
     add_index :harbinger_message_elements, :message_id
     add_index :harbinger_message_elements, :key
     add_index :harbinger_message_elements, [:message_id, :key]
-    add_index :harbinger_message_elements, [:message_id, :value]
   end
 end

data/harbinger.gemspec

@@ -24,13 +24,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "kaminari", "~> 0.16"
+  spec.add_dependency "rails", "~> 4.0"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", '~> 10.3'
   spec.add_development_dependency "rspec-given", '~> 3.5'
   spec.add_development_dependency 'rspec-rails', '~> 3.0'
   spec.add_development_dependency 'rspec-html-matchers', '~>0.6'
   spec.add_development_dependency "engine_cart", '~> 0.3'
-  spec.add_development_dependency "rails", "~> 4.0"
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
   spec.add_development_dependency 'capybara', '~> 2.4'

data/lib/harbinger.rb

@@ -6,21 +6,24 @@ require "harbinger/exceptions"
 require "harbinger/configuration"
 
 module Harbinger
-  module_function
   class << self
     attr_writer :configuration
 
+    # @see Configuration
     def configuration
       @configuration ||= Configuration.new
     end
   end
 
   module_function
+
+  # @see Configuration
+  # @see .configuration
   def configure
     yield(configuration)
   end
 
-  # Responsible for building a :message from the various :contexts and then
+  # Responsible for building a :message from the various :reporters and then
   # delivering the :message to the appropriate :channels.
   #
   # @see .build_message
@@ -29,7 +32,7 @@ module Harbinger
   # @param [Hash] options
   # @option options [Message] :message The message you want to amend.
   #   If none is provided, then one is created.
-  # @option options [Object, Array<Object>] :contexts One or more Objects that
+  # @option options [Object, Array<Object>] :reporters One or more Objects that
   #   Harbinger will visit and extract message elements from.
   # @option options [Symbol, Array<Symbol>] :channels One or more channels that
   #   Harbinger will deliver the :message to
@@ -38,20 +41,20 @@ module Harbinger
     deliver_message(message, options)
   end
 
-  # Responsible for building a :message from the various :contexts.
+  # Responsible for building a :message from the various :reporters.
   #
   # @see .call
   #
   # @param [Hash] options
   # @option options [Message] :message The message you want to amend.
   #   If none is provided, then one is created.
-  # @option options [Object, Array<Object>] :contexts One or more Objects that
+  # @option options [Object, Array<Object>] :reporters One or more Objects that
   #   Harbinger will visit and extract message elements from.
   def build_message(options = {})
-    contexts = Array(options.fetch(:contexts)).flatten.compact
+    reporters = Array(options.fetch(:reporters)).flatten.compact
     message = options.fetch(:message) { default_message }
 
-    contexts.each { |context| reporter_for(context).accept(message) }
+    reporters.each { |context| reporter_for(context).accept(message) }
     message
   end
 
@@ -89,14 +92,17 @@ module Harbinger
   end
   private_class_method :channel_for
 
+  # @api protected
   def default_channels
     configuration.default_channels
   end
 
+  # @api protected
   def logger
     configuration.logger
   end
 
+  # @api protected
   def database_storage
     configuration.database_storage
   end

data/lib/harbinger/engine.rb

@@ -1,3 +1,5 @@
+require "kaminari"
+
 module Harbinger
   class Engine < ::Rails::Engine
     engine_name 'harbinger'

data/lib/harbinger/message.rb

@@ -12,7 +12,7 @@ module Harbinger
       @attributes[composite_key] << value
     end
 
-    def contexts
+    def reporters
       attributes.keys.collect { |key| key.split('.')[0] }.uniq
     end
 

data/lib/harbinger/reporters.rb

@@ -21,7 +21,7 @@ module Harbinger
       if context.is_a?(Exception)
         "ExceptionReporter"
       else
-        context.class.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase } + "Reporter"
+        context.class.to_s.split('::').last.gsub(/(?:^|_)([a-z])/) { $1.upcase } + "Reporter"
       end
     end
     private_class_method :reporter_name_for_instance

data/lib/harbinger/version.rb

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

data/spec/features/end_to_end_exception_handling_spec.rb

@@ -4,19 +4,15 @@ require 'harbinger'
 module Harbinger
   describe 'handling a message', type: :feature do
     let(:message) do
-      begin
-        {}.fetch(:missing_key)
-      rescue KeyError => exception
-        Harbinger.build_message(contexts: [exception])
-      end
     end
 
     it 'sends the exception message to the database channel' do
       expect(Harbinger.logger).to receive(:add).at_least(:once).and_call_original
-
-      expect { Harbinger.deliver_message(message, channels: [:database, :logger]) }.
-        to change { DatabaseChannelMessage.count }.
-        by(1)
+      begin
+        {}.fetch(:missing_key)
+      rescue KeyError => exception
+        Harbinger.call(channels: [:database, :logger], reporters: [exception])
+      end
 
       message = DatabaseChannelMessage.last
 
@@ -31,7 +27,7 @@ module Harbinger
       page.find(:xpath, "//a[@href='#{harbinger.message_path(message.to_param)}']").click
 
       expect(page.html).to have_tag('.message') do
-        with_tag('.message-contexts-detail', text: 'exception')
+        with_tag('.message-reporters-detail', text: 'exception')
         with_tag('.message-state-detail', text: 'new')
       end
     end

data/spec/lib/harbinger/message_spec.rb

@@ -9,7 +9,7 @@ module Harbinger
     When { message.append('other_container', 'other_key', 'other_value')}
 
     Then { expect(message.attributes).to eq({ 'container.key' => ['value'], 'other_container.other_key' => ['other_value']}) }
-    And { expect(message.contexts).to eq(['container', 'other_container']) }
+    And { expect(message.reporters).to eq(['container', 'other_container']) }
 
   end
 end

data/spec/lib/harbinger/reporters_spec.rb

@@ -2,6 +2,8 @@ require 'spec_fast_helper'
 require 'harbinger/reporters'
 
 module Harbinger
+  class Request
+  end
   describe Reporters do
     context '.find_for' do
       Given(:reporter) { double('Reporter') }
@@ -41,6 +43,12 @@ module Harbinger
         When(:result) { described_class.find_for(context) }
         Then { expect(result).to be_an_instance_of(Reporters::NullReporter) }
       end
+
+      context 'module conversion' do
+        Given(:context) { ::Harbinger::Request.new }
+        When(:result) { described_class.find_for(context) }
+        Then { expect(result).to be_an_instance_of(Reporters::RequestReporter) }
+      end
     end
   end
 end

data/spec/lib/harbinger_spec.rb

@@ -14,7 +14,7 @@ describe Harbinger do
     Given(:channel_name) { 'channel_double' }
     Given(:channel) { double('Channel', deliver: true) }
     Given(:message) { Harbinger::Message.new }
-    When { Harbinger.call(contexts: [user, request], message: message, channels: channel_name) }
+    When { Harbinger.call(reporters: [user, request], message: message, channels: channel_name) }
     Then do expect(message.attributes).to eq(
         'user.username' => [user.username],
         'request.path' => [request.path],
@@ -27,7 +27,7 @@ describe Harbinger do
 
   context '.build_message' do
     Given(:message) { Harbinger::Message.new }
-    When { Harbinger.build_message(contexts: [user, request], message: message) }
+    When { Harbinger.build_message(reporters: [user, request], message: message) }
     Then do expect(message.attributes).to eq(
         'user.username' => [user.username],
         'request.path' => [request.path],

data/spec/models/harbinger/database_channel_message_spec.rb

@@ -57,10 +57,10 @@ module Harbinger
           by(3)
       end
 
-      it 'assigns :contexts' do
+      it 'assigns :reporters' do
         storage = described_class.new
         expect { described_class.store_message(message, storage) }.
-          to change { storage.attributes.values_at('contexts', 'state') }.
+          to change { storage.attributes.values_at('reporters', 'state') }.
           from([nil, nil]).to(['exception,user', 'new'])
       end
     end

data/spec/views/harbinger/messages/index.html.erb_spec.rb

@@ -8,13 +8,15 @@ describe 'harbinger/messages/index.html.erb', type: :view do
   let(:message) do
     double(
       'Message',
-      contexts: ['Hello','World'],
+      reporters: ['Hello','World'],
       state: 'new',
-      created_at: created_at
+      created_at: created_at,
+      message_object_id: '123456'
     )
   end
   let(:harbinger) { double("Engine", message_path: true, messages_path: '/messages/') }
   it 'renders the object and fieldsets' do
+    expect(view).to receive(:paginate).with([message])
     expect(harbinger).to receive(:message_path).with(message.to_param).and_return("/messages/#{message.to_param}")
     render template: "harbinger/messages/index.html.erb", locals: { messages: [message], harbinger: harbinger }
     expect(rendered).to have_tag('.search-form') do
@@ -23,8 +25,9 @@ describe 'harbinger/messages/index.html.erb', type: :view do
 
     expect(rendered).to have_tag('.message') do
       with_tag(".detail.message-created-at-detail a time", text: created_at.to_s)
-      with_tag('.detail.message-contexts-detail', text: 'Hello')
-      with_tag('.detail.message-contexts-detail', text: 'World')
+      with_tag('.detail.message-object-id-detail', text: message.message_object_id)
+      with_tag('.detail.message-reporters-detail', text: 'Hello')
+      with_tag('.detail.message-reporters-detail', text: 'World')
       with_tag('.detail.message-state-detail', text: 'new')
     end
   end

data/spec/views/harbinger/messages/show.html.erb_spec.rb

@@ -10,9 +10,10 @@ describe 'harbinger/messages/show.html.erb', type: :view do
   let(:message) do
     double(
       'Message',
-      contexts: ['Hello','World'],
+      reporters: ['Hello','World'],
       state: 'new',
       created_at: created_at,
+      message_object_id: '123456',
       elements: [netid_element, request_referrer_element]
     )
   end
@@ -20,9 +21,11 @@ describe 'harbinger/messages/show.html.erb', type: :view do
     render template: 'harbinger/messages/show',
       locals: { message: message }
     expect(rendered).to have_tag('article.message') do
-      with_tag('.term.message-contexts-term')
-      with_tag('.detail.message-contexts-detail', text: 'Hello')
-      with_tag('.detail.message-contexts-detail', text: 'World')
+      with_tag('.term.message-reporters-term')
+      with_tag('.detail.message-reporters-detail', text: 'Hello')
+      with_tag('.detail.message-reporters-detail', text: 'World')
+      with_tag('.term.message-object-id-term')
+      with_tag('.detail.message-object-id-detail', text: '123456')
       with_tag('.term.message-state-term')
       with_tag('.detail.message-state-detail', text: 'new')
       with_tag('.term.message-created-at-term')

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: harbinger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement