harbinger 0.0.1.pre → 0.1.0

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.1"
+  - "2.1.2"
+
+gemfile:
+  - gemfiles/rails4.gemfile
+  - gemfiles/rails4.1.gemfile
+
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
+script: 'COVERAGE=true rake spec:travis'
+
+bundler_args: --without headless debug
+
+before_install:
+  - gem install bundler

data/Gemfile

@@ -3,12 +3,32 @@ source "https://rubygems.org"
 # Declare your gem's dependencies in harbinger.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
-gemspec
+gemspec path: File.expand_path('..', __FILE__)
 
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
 
-# To use debugger
-# gem 'debugger'
+gem 'capybara', require: false
+gem 'coveralls', require: false
+if ! ENV['TRAVIS']
+  gem 'simplecov', require: false
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-rails'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier-guard'
+  gem 'sexp_processor'
+  gem 'ruby_parser'
+  gem 'pry', '~> 0.9.7'
+  gem 'pry-nav'
+  gem 'byebug'
+end
+
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path("../spec/internal", __FILE__))
+
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end

data/README.md

@@ -1,29 +1,10 @@
 # Harbinger
 
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'harbinger'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install harbinger
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( http://github.com/<my-github-username>/harbinger/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[![Version](https://badge.fury.io/rb/harbinger.png)](http://badge.fury.io/rb/harbinger)
+[![Build Status](https://travis-ci.org/ndlib/harbinger.png?branch=master)](https://travis-ci.org/ndlib/harbinger)
+[![Code Climate](https://codeclimate.com/github/ndlib/harbinger.png)](https://codeclimate.com/github/ndlib/harbinger)
+[![Coverage Status](https://img.shields.io/coveralls/ndlib/harbinger.svg)](https://coveralls.io/r/ndlib/harbinger)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/github/ndlib/harbinger/master/frames/)
+[![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+A Rails engine for arbitrary message creation and delivery.

data/Rakefile

@@ -1 +1,47 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  APP_RAKEFILE = File.expand_path('../spec/internal/Rakefile', __FILE__)
+  load 'rails/tasks/engine.rake'
+rescue LoadError
+  puts "Unable to load all app tasks for #{APP_RAKEFILE}"
+end
+
+require 'engine_cart/rake_task'
+# http://stackoverflow.com/questions/23165506/rails-spring-breaking-generators
+# https://github.com/cbeer/engine_cart/issues/15
+EngineCart.rails_options = '--skip-spring'
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all) do
+    ENV['COVERAGE'] = 'true'
+  end
+
+  desc 'Run the Travis CI specs'
+  task :travis do
+    ENV['RAILS_ENV'] = 'test'
+    spec_helper = File.expand_path('../spec/spec_slow_helper.rb', __FILE__)
+    ENV['SPEC_OPTS'] = "--profile 20 --require #{spec_helper}"
+    Rake::Task['engine_cart:clean'].invoke
+    Rake::Task['engine_cart:generate'].invoke
+    Rake::Task['spec:all'].invoke
+  end
+end
+
+begin
+  Rake::Task['default'].clear
+rescue RuntimeError
+  puts 'Unable to find :default rake task; No worries.'
+end
+
+Rake::Task['spec'].clear
+
+task spec: 'spec:all'
+task default: 'spec:travis'

data/app/controllers/harbinger/messages_controller.rb

@@ -0,0 +1,24 @@
+module Harbinger
+  class MessagesController < ActionController::Base
+
+    def index
+      messages
+    end
+
+    def show
+      message
+    end
+
+    protected
+
+    def messages
+      @messages ||= DatabaseChannelMessage.search(q: params[:q])
+    end
+
+    def message
+      @message ||= DatabaseChannelMessage.find(params[:id])
+    end
+
+    helper_method :message, :messages
+  end
+end

data/app/models/harbinger/database_channel_message.rb

@@ -0,0 +1,51 @@
+require 'active_record'
+require 'harbinger/database_channel_message_element'
+
+module Harbinger
+  class DatabaseChannelMessage < ActiveRecord::Base
+    self.table_name = 'harbinger_messages'
+    has_many :elements, class_name: 'Harbinger::DatabaseChannelMessageElement', foreign_key: :message_id
+
+    def contexts=(values)
+      super(Array.wrap(values).join(','))
+    end
+
+    def contexts
+      super.split(',')
+    end
+
+    def self.store_message(message, storage = new)
+      storage.contexts = message.contexts
+      storage.state = 'new'
+      message.attributes.each do |key, value|
+        storage.elements.build(key: key, value: value)
+      end
+      storage.save!
+    end
+
+    def self.search(params = {})
+      search_text(params[:q]).
+        search_state(params[:state]).
+        ordered
+    end
+
+    # Search the message and its elements for the matching text.
+    scope :search_text, lambda { |text|
+      if text
+        where(
+          arel_table[:contexts].matches("#{text}%").
+          or(
+            arel_table[:id].
+            in(Arel::SqlLiteral.new(DatabaseChannelMessageElement.search_text(text).select(:message_id).to_sql))
+          )
+        )
+      else
+        all
+      end
+    }
+
+    scope :search_state, ->(state) { state ? where(arel_table[:state].eq(state)) : all }
+
+    scope :ordered, -> { order(arel_table[:created_at].desc) }
+  end
+end

data/app/models/harbinger/database_channel_message_element.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+require 'harbinger/database_channel_message'
+
+module Harbinger
+  class DatabaseChannelMessageElement < ActiveRecord::Base
+    self.table_name = 'harbinger_message_elements'
+    belongs_to :message, class_name: 'Harbinger::DatabaseChannelMessage', foreign_key: :message_id
+    serialize :value
+
+    scope :search_text, lambda { |text|
+      if text
+        # Using %text% because I am serializing the data.
+        where(arel_table[:value].matches("%#{text}%"))
+      else
+        self
+      end
+    }
+  end
+end

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

@@ -0,0 +1,43 @@
+<%= form_tag harbinger.messages_path, :method => :get, :class => "search-form" do %>
+  <fieldset>
+    <legend class="accessible-hidden">Search Messages</legend>
+    <%= label_tag :message_search, "Search Text", :class => "accessible-hidden" %>
+    <%= text_field_tag(
+      :q,
+      params[:q],
+      :class => "q search-query",
+      :id => "message_search",
+      :placeholder => "Search text of messages",
+      :size => "30",
+      :tabindex => "1",
+      :type => "search",
+    )%><button type="submit" class="search-submit btn btn-primary" id="keyword-search-submit" tabindex="2">
+      <i class="icon-search icon-white"></i><span class="accessible-hidden">Search</span>
+    </button>
+  </fieldset>
+<% end %>
+
+<table>
+  <caption>Messages</caption>
+  <thead>
+    <tr>
+      <th>Created At</th>
+      <th>Contexts</th>
+      <th>State</th>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% 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>
+        <ul><% message.contexts.each do |context| %>
+          <li class="detail message-contexts-detail"><%= context %></li>
+        <% end %></ul>
+      </td>
+      <td class="detail message-state-detail"><%= message.state %></td>
+      <td class="actions">&nbsp;</td>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,24 @@
+<article class="message">
+  <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>
+      <% 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">
+    <dl class="message-elements">
+      <% message.elements.each do |element| %>
+      <% dom_class_prefix = element.key.gsub(/_+/, '-') %>
+      <dt class="term <%= dom_class_prefix %>-term"><%= element.key %></dt>
+      <dd class="detail <%= dom_class_prefix %>-detail"><%= element.value %></dd>
+      <% end %>
+    </dl>
+  </section>
+</article>

data/config/routes.rb

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

data/db/migrate/20140310185338_create_harbinger_database_channel_message.rb

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

data/db/migrate/20140310185339_create_harbinger_database_channel_message_elements.rb

@@ -0,0 +1,14 @@
+class CreateHarbingerDatabaseChannelMessageElements < ActiveRecord::Migration
+  def change
+    create_table :harbinger_message_elements do |t|
+      t.integer :message_id
+      t.string :key
+      t.text :value, limit: 2147483647
+      t.timestamps
+    end
+    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/gemfiles/rails4.1.gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+file = File.expand_path("../../Gemfile", __FILE__)
+
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end
+gem 'sass', '~> 3.2.15'
+gem 'sprockets', '~> 2.11.0'
+
+gem 'rails', '4.1.0'

data/gemfiles/rails4.gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+file = File.expand_path("../../Gemfile", __FILE__)
+
+if File.exists?(file)
+  puts "Loading #{file} ..." if $DEBUG # `ruby -d` or `bundle -v`
+  instance_eval File.read(file)
+end
+
+gem 'sass', '~> 3.2.15'
+gem 'sprockets', '~> 2.11.0'
+
+gem 'rails', '4.0.3'

data/harbinger.gemspec

@@ -6,18 +6,33 @@ require 'harbinger/version'
 Gem::Specification.new do |spec|
   spec.name          = "harbinger"
   spec.version       = Harbinger::VERSION
-  spec.authors       = ["Jeremy Friesen"]
-  spec.email         = ["jeremy.n.friesen@gmail.com"]
-  spec.summary       = %q{An exception tracking Rails engine}
-  spec.description   = %q{An exception tracking Rails engine}
-  spec.homepage      = ""
+  spec.authors       = [
+    "Jeremy Friesen"
+  ]
+  spec.email         = [
+    "jeremy.n.friesen@gmail.com"
+  ]
+  spec.summary       = %q{A Rails engine for arbitrary message creation and delivery.}
+  spec.description   = %q{A Rails engine for arbitrary message creation and delivery.}
+  spec.homepage      = "https://github.com/ndlib/harbinger"
   spec.license       = "Apache2"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) do |f|
+    f == 'bin/rails' ? nil : File.basename(f)
+  end.compact
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  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'
+
 end

data/lib/generators/harbinger/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+module Harbinger
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    class_option :skip_database_channel, default: false, type: :boolean
+
+    def install_database_channel
+      if ! options[:skip_database_channel]
+        rake 'harbinger:install:migrations'
+      end
+    end
+
+    def install_configuration_file
+      template "harbinger_initializer.rb.erb", "config/initializers/harbinger_initializer.rb"
+    end
+
+    def install_routes
+      route 'mount Harbinger::Engine => "/harbinger"'
+    end
+
+  end
+end

data/lib/generators/harbinger/install/templates/harbinger_initializer.rb.erb

@@ -0,0 +1,6 @@
+Harbinger.configure do |config|
+
+  # See Harbinger::Channels for more information
+  config.default_channels = [:logger, :database]
+
+end