egregious 0.2.2 → 0.2.3

data/Gemfile

@@ -3,3 +3,9 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in egregious.gemspec
 gemspec
 
+if RUBY_VERSION < '1.9'
+  gem 'mongoid', '< 3'
+  gem 'bson_ext'
+else
+  gem 'mongoid', '>= 3'
+end

data/README

@@ -1,15 +1,18 @@
 Update Log:
+  Version 0.2.3 released to https://rubygems.org/gems/egregious on 7.23.2013
+        Merged pull requests:
+          Mongoid integration (#6)
+        Bug Fix: Bad Rails test
+        Updated rails and rack dependencies
   Version 0.2.2 released to https://rubygems.org/gems/egregious on 2.15.2013
       Merged pull requests:
         Compatibility with Rails::API (#5)
-        Thank you dwbutler! Keep those pull requests coming.
 
   Version 0.2.1 released to https://rubygems.org/gems/egregious on 9.21.2012
     Merged pull requests:
       Bug Fix: should translate status code Symbol to right HTTP STATUS CODE -  avinasha
       Fixes teapot bug with rails 3.2.8. -  kbrown 
       Note: version 0.2.0 does not work with rails 3.2.8 you should update to 0.2.1
-    Thank you avinasha and kbrown along with all the other forks! Keep those pull requests coming.
 
 If you would like to contribute take a look at the issues feature list, fork and issue a pull request!
 
@@ -29,8 +32,8 @@ provide the caller context information.
 
  What egregious can do:
 
- * Defines default exception handling for most common ruby, rails, warden and cancan exceptions.
-   (warden and cancan are optional)
+ * Defines default exception handling for most common ruby, rails, warden, cancan and mongoid exceptions.
+   (warden, cancan and mongoid are optional)
  * Catches defined exceptions using a rescue_with returning the status code defined for each exception
    and well structured json, xml
  * For html production requests attempts to load the html error pages for the mapped status code,
@@ -42,7 +45,8 @@ provide the caller context information.
 
 
 REQUIRES:
-  Rails 3.x
+  rails ~> 3.1.12
+  rack  >= 1.3.6
 
 USAGE:
 1) Add to your Gemfile:
@@ -99,4 +103,4 @@ def build_html_file_path(status)
 end
 
 KNOWN ISSUES:
-* If you use CanCan or Devise you must have Egregious after CanCan/Devise in your Gemfile, if not it will not handle those errors correctly.
+* If you use Mongoid, CanCan or Devise you must have Egregious after CanCan/Devise in your Gemfile, if not it will not handle those errors correctly.

data/egregious.gemspec

@@ -18,15 +18,19 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+
+  s.add_runtime_dependency "rails", '~> 3.1.12'
+  s.add_runtime_dependency "rack", '>= 1.3.6'
+  s.add_runtime_dependency "htmlentities"
+
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
   s.add_development_dependency "json"
   s.add_development_dependency "hpricot"
   s.add_development_dependency "warden"
   s.add_development_dependency "cancan"
+  s.add_development_dependency "mongoid"
+  s.add_development_dependency "bson_ext"
 
-  s.add_runtime_dependency "rails", '>= 3.0.1'
-  s.add_runtime_dependency "rack"
-  s.add_runtime_dependency "htmlentities"
 
 end

data/lib/egregious.rb

@@ -75,6 +75,23 @@ module Egregious
                                ActiveRecord::UnknownAttributeError=>status_code(:bad_request)
                              })
     end
+    
+    if defined?(Mongoid)
+      require 'egregious/extensions/mongoid'
+      
+      exception_codes.merge!({
+                               Mongoid::Errors::InvalidFind=>status_code(:bad_request),
+                               Mongoid::Errors::DocumentNotFound=>status_code(:not_found),
+                               Mongoid::Errors::Validations=>status_code(:unprocessable_entity)
+                             })
+      
+      if Mongoid::VERSION > '3'
+        exception_codes.merge!({
+                                 Mongoid::Errors::ReadonlyAttribute=>status_code(:forbidden),
+                                 Mongoid::Errors::UnknownAttribute=>status_code(:bad_request)
+                               })
+      end
+    end
 
     if defined?(Warden)
       exception_codes.merge!({
@@ -92,7 +109,7 @@ module Egregious
   end
 
   @@exception_codes = self._load_exception_codes
-  @@root = defined?(Rail) ? Rails.root : nil
+  @@root = defined?(Rails) ? Rails.root : nil
 
   # exposes the root of the app
   def self.root

data/lib/egregious/extensions/mongoid.rb

@@ -0,0 +1,26 @@
+if defined?(Mongoid)
+  # Customize the error information Egregious returns for MongoidErrors
+  module Mongoid
+    module Errors
+      class MongoidError
+        def to_xml
+          "<errors><error>#{HTMLEntities.new.encode(@problem || to_s)}</error><type>#{self.exception_type}</type></errors>"
+        end
+
+        def to_json
+          "{\"error\":#{ActiveSupport::JSON.encode(@problem || to_s)}, \"type\":\"#{self.exception_type}\"}"
+        end
+      end
+      
+      class Validations
+        def to_xml
+          "<errors><error>#{HTMLEntities.new.encode(self.document.errors.full_messages.join(', ').gsub(/\r/, ' ').gsub(/\n/, ' ').squeeze(' '))}</error><type>#{self.exception_type}</type></errors>"
+        end
+
+        def to_json
+          "{\"error\":#{ActiveSupport::JSON.encode(self.document.errors.full_messages.join(', ').gsub(/\r/, ' ').gsub(/\n/, ' ').squeeze(' '))}, \"type\":\"#{self.exception_type}\"}"
+        end
+      end
+    end
+  end
+end

data/lib/egregious/version.rb

@@ -1,3 +1,3 @@
 module Egregious
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/egregious_spec.rb

@@ -10,6 +10,8 @@ describe Egregious do
   describe 'status_code' do
     it "should translate Symbol to right HTTP STATUS CODE" do
       status_code(:bad_request).should == 400
+      status_code(:unauthorized).should == 401
+      status_code(:unprocessable_entity).should == 422
     end
   end
 
@@ -96,6 +98,21 @@ describe Egregious do
         exception_codes[CanCan::AuthorizationNotPerformed].should ==  Egregious.status_code(:unauthorized)
       end
     end
+    
+    if defined?(Mongoid)
+      it "should return expected errors for Mongoid" do
+        exception_codes[Mongoid::Errors::InvalidFind].should == Egregious.status_code(:bad_request)
+        exception_codes[Mongoid::Errors::DocumentNotFound].should == Egregious.status_code(:not_found)
+        exception_codes[Mongoid::Errors::Validations].should == Egregious.status_code(:unprocessable_entity)
+      end
+      
+      if Mongoid::VERSION > '3'
+        it "should return expected errors for Mongoid 3+" do
+          exception_codes[Mongoid::Errors::ReadonlyAttribute].should ==  Egregious.status_code(:forbidden)
+          exception_codes[Mongoid::Errors::UnknownAttribute].should == Egregious.status_code(:bad_request)
+        end
+      end
+    end
   end
 
   describe "status_code_for_exception" do

data/spec/exceptions_spec.rb

@@ -40,4 +40,49 @@ describe Exception do
     end
     X::Y::Z.new.exception_type.should == 'Z'
   end
+end
+
+if defined?(Mongoid)
+  class TestModel
+    include Mongoid::Document
+    
+    field :foo
+    validates_presence_of :foo
+  end
+
+  
+  describe Mongoid::Errors::MongoidError do
+    let(:exception) { Mongoid::Errors::InvalidFind.new }
+    let(:error_message) { "Calling Document.find with nil is invalid." }
+    
+    it "should output json with a short problem description" do
+      result = JSON.parse(exception.to_json)
+      result['error'].should =~ /#{error_message}/
+    end
+    
+    it "should output xml with a short problem description" do
+      doc = Hpricot.XML(exception.to_xml)
+      (doc/:errors).each do |error|
+         HTMLEntities.new.decode((error/:error).inner_html).should =~ /#{error_message}/
+      end
+    end
+  end
+  
+  describe Mongoid::Errors::Validations do
+    let(:model) { TestModel.create }
+    let(:exception) { Mongoid::Errors::Validations.new(model) }
+    let(:error_message) { model.errors.full_messages.first }
+    
+    it "should output json with a short summary" do
+      result = JSON.parse(exception.to_json)
+      result['error'].should == error_message
+    end
+    
+    it "should output xml with a short problem description" do
+      doc = Hpricot.XML(exception.to_xml)
+      (doc/:errors).each do |error|
+         HTMLEntities.new.decode((error/:error).inner_html).should == error_message
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ require 'active_support/test_case'
 require 'action_controller'
 require 'warden'
 require 'cancan'
+require 'mongoid'
 
 require 'egregious' # and any other gems you need
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egregious
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,49 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -28,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -44,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hpricot
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: warden
+  name: hpricot
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -76,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cancan
+  name: warden
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,30 +124,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: cancan
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -124,14 +156,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: bson_ext
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -154,6 +186,7 @@ files:
 - egregious.gemspec
 - lib/egregious.rb
 - lib/egregious/extensions/exception.rb
+- lib/egregious/extensions/mongoid.rb
 - lib/egregious/version.rb
 - spec/egregious_spec.rb
 - spec/exceptions_spec.rb