exception-ketchup 0.1.0

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,64 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to nil and saved in location specified by config.assets.prefix
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Prepend all log lines with the following tags
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/i18n-js.yml

@@ -0,0 +1,22 @@
+# Split context in several files.
+# By default only one file with all translations is exported and
+# no configuration is required. Your settings for asset pipeline
+# are automatically recognized.
+#
+# If you want to split translations into several files or specify
+# locale contexts that will be exported, just use this file to do
+# so.
+#
+# If you're going to use the Rails 3.1 asset pipeline, change
+# the following configuration to something like this:
+#
+#   translations:
+#     - file: "app/assets/javascripts/i18n/translations.js"
+#
+# If you're running an old version, you can use something
+# like this:
+#
+#   translations:
+#     - file: "public/javascripts/translations.js"
+#       only: "*"
+#

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '68faf9f19b750d5ba1172eb6ffec6fa9746e9eb64bc9a74f2aea4a49dca8fdd61fd12a31444b5e86c005814fbbaabed00fbbc558a495ca16a6f974441a63ac63'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/mongoid.yml

@@ -0,0 +1,80 @@
+development:
+  # Configure available database sessions. (required)
+  sessions:
+    # Defines the default session. (required)
+    default:
+      # Defines the name of the default database that Mongoid can connect to.
+      # (required).
+      database: dummy_development
+      # Provides the hosts the default session can connect to. Must be an array
+      # of host:port pairs. (required)
+      hosts:
+        - localhost:27017
+      options:
+        # Change whether the session persists in safe mode by default.
+        # (default: false)
+        # safe: false
+
+        # Change the default consistency model to :eventual or :strong.
+        # :eventual will send reads to secondaries, :strong sends everything
+        # to master. (default: :eventual)
+        # consistency: :eventual
+
+        # How many times Moped should attempt to retry an operation after
+        # failure. (default: 30)
+        # max_retries: 30
+
+        # The time in seconds that Moped should wait before retrying an
+        # operation on failure. (default: 1)
+        # retry_interval: 1
+  # Configure Mongoid specific options. (optional)
+  options:
+    # Configuration for whether or not to allow access to fields that do
+    # not have a field definition on the model. (default: true)
+    # allow_dynamic_fields: true
+
+    # Enable the identity map, needed for eager loading. (default: false)
+    # identity_map_enabled: false
+
+    # Includes the root model name in json serialization. (default: false)
+    # include_root_in_json: false
+
+    # Include the _type field in serializaion. (default: false)
+    # include_type_for_serialization: false
+
+    # Preload all models in development, needed when models use
+    # inheritance. (default: false)
+    # preload_models: false
+
+    # Protect id and type from mass assignment. (default: true)
+    # protect_sensitive_fields: true
+
+    # Raise an error when performing a #find and the document is not found.
+    # (default: true)
+    # raise_not_found_error: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method. (default: false)
+    # scope_overwrite_exception: false
+
+    # Skip the database version check, used when connecting to a db without
+    # admin access. (default: false)
+    # skip_version_check: false
+
+    # User Active Support's time zone in conversions. (default: true)
+    # use_activesupport_time_zone: true
+
+    # Ensure all times are UTC in the app side. (default: false)
+    # use_utc: false
+test:
+  sessions:
+    default:
+      database: dummy_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong
+        # In the test environment we lower the retries and retry interval to
+        # low amounts for fast failures.
+        max_retries: 1
+        retry_interval: 0

data/spec/dummy/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/lib/controller_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+FakeTestController = Class.new(ApplicationController) do
+
+  respond_to :json
+
+  ketchup_exceptions do |c|
+    c.rescue_errors = [
+      { :error => Mongoid::Errors::DocumentNotFound, :with => :document_not_found } ,
+      { :error => ArgumentError, :with => :document_not_found} 
+    ]
+  end
+
+  def operation_failed(error)
+    respond_with({:error => "Operation could not be operated."})
+  end
+
+  def document_not_found(error)
+    respond_with({:error => "Operation could not be operated."})
+  end
+
+  def respond_with_error(error)
+    document_not_found(error)
+  end
+
+  def show
+    @author = Author.find(params[:id])
+    respond_with @author
+  end
+
+end
+
+describe "exception handling within controller", :type => :controller do
+  let(:recipients){ %W(ds@test.com da@test.com) }
+
+  before do 
+    Ketchup::Exception.setup do |config|
+      config.subject = "Test Error"
+      config.recipients = recipients
+      config.sender = "foo@example.com"
+      config.template_path = "notifications"
+      config.environment = :test
+    end
+
+    Author = Class.new do
+      include Mongoid::Document
+
+      store_in :authors
+    end
+
+  end
+
+  describe FakeTestController do 
+
+    before do
+      @controller = FakeTestController.new
+    end
+
+    it "handles with custom method" do
+      Author.should_receive(:find).and_raise(Mongoid::Errors::DocumentNotFound)
+      expect do 
+        get :show, :id => "50e3f7e6f1a8f299cb000001" , :format => "json" 
+      end.to change(ActionMailer::Base.deliveries, :size).by(1)
+      result = ActiveSupport::JSON.decode(response.body)
+      result.should have_key("error")
+    end
+
+    context "mailing is disabled" do
+      before do
+        Ketchup::Exception.setup do |config|
+          config.subject = "Test Error"
+          config.recipients = recipients
+          config.sender = "foo@example.com"
+          config.template_path = "notifications"
+          config.deliver_mail = false
+          config.environment = :test
+        end
+
+      end
+    
+      it "did not send mails" do
+        Author.should_receive(:find).any_number_of_times.and_raise(Mongoid::Errors::DocumentNotFound)
+        expect do 
+          get :show, :id => "50e3f7e6f1a8f299cb000001" , :format => "json" 
+        end.to_not change(ActionMailer::Base.deliveries, :size).by(1)
+        expect do 
+          get :show, :id => "50e3f7e6f1a8f299cb000001" , :format => "json" 
+        end.to change(Ketchup::Exception::Error, :count).by(1)
+      end
+    end
+
+    context "persist to database if disabled" do
+
+      before do
+        Ketchup::Exception.setup do |config|
+          config.subject = "Test Error"
+          config.recipients = recipients
+          config.sender = "foo@example.com"
+          config.template_path = "notifications"
+          config.persist = false
+          config.environment = :test
+        end
+      end
+
+      it "did not save to db" do
+        Author.should_receive(:find).any_number_of_times.and_raise(Mongoid::Errors::DocumentNotFound)
+        expect do 
+          get :show, :id => "50e3f7e6f1a8f299cb000001" , :format => "json" 
+        end.to_not change(Ketchup::Exception::Error, :count).by(1)
+      end
+    end
+  end
+end

data/spec/lib/error_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Ketchup::Exception::Error do
+
+  it{should respond_to(:kind)}
+  it{should respond_to(:backtrace)}
+  it{should respond_to(:happend_at)}
+  it{should respond_to(:message)}
+
+  context "#kind" do
+
+    let(:exception){ StandardError.new("something happened") }
+    let(:error){ Ketchup::Exception::Error.new }
+
+    before do
+      error.kind = exception.class.name
+      error.backtrace = exception.backtrace
+      error.message = exception.message
+      error.happend_at = Time.now
+      error.save
+    end
+
+    subject{Ketchup::Exception::Error.last}
+
+    its(:kind){should eq "StandardError"}
+
+  end
+
+end

data/spec/lib/exception-ketchup_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Ketchup::Exception do
+
+  it { should respond_to(:setup) }
+  it { should respond_to(:environment) }
+  it { should respond_to(:subject) }
+  it { should respond_to(:template_path) }
+  it { should respond_to(:deliver_mail) }
+  it { should respond_to(:persist) }
+  it { should respond_to(:recipients) }
+  it { should respond_to(:template_path) }
+  it { should respond_to(:template_path) }
+  it { should respond_to(:exception_collection) }
+
+  context "default configuration" do
+
+    context "for environment" do
+
+      it "is production" do
+        subject.environment.should eq :production
+      end
+
+    end
+
+    context "for mailing" do
+
+      it "is enabled" do
+        subject.deliver_mail.should be true
+      end
+
+    end
+
+    context "to store errors" do
+
+      it "is errors collection" do
+        subject.exception_collection.should == :errors
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/mailer_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Ketchup::Exception::Mailer do
+  let(:recipients){ %W(ds@test.com da@test.com) }
+
+  before do 
+    Ketchup::Exception.setup do |config|
+      config.subject = "Test Error"
+      config.recipients = recipients
+      config.sender = "foo@example.com"
+      config.template_path = "notifications"
+    end
+  end
+
+  describe 'notifications' do
+    let(:error) do 
+      double("error", :message => "Tiny test error",
+             :backtrace => ["error at line 10", "wrong arguments: 1 for 0"])
+
+    end
+    let(:host){ "http://example.com"}
+    let(:mail){ Ketchup::Exception::Mailer.notification_email(error,host) }
+
+    it "renders the subject" do
+      mail.subject.should eq "Test Error"
+    end
+
+    it "renders the receiver mail" do
+      mail.to.should == recipients
+    end
+
+    it "renders the senders email" do
+      mail.from.should == [Ketchup::Exception.sender]
+    end
+
+    it "assigns @message" do
+      mail.body.encoded.should match(error.message)
+    end
+
+    it "assigns @host" do
+      mail.body.encoded.should match(host)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+require 'rspec/rails'
+require 'mongoid-rspec'
+require 'database_cleaner'
+
+ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(ENGINE_RAILS_ROOT, "spec/support/**/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.orm = "mongoid"
+  end
+
+  config.before do
+    #Mongoid.load!("#{ENGINE_RAILS_ROOT}/config/mongoid.yml", :test)
+    DatabaseCleaner.clean
+  end
+
+end