rocket_pants 1.4.1 → 1.5.0

data/lib/rocket_pants.rb

@@ -7,7 +7,8 @@ require 'moneta'
 require 'moneta/memory'
 
 module RocketPants
-  require 'rocket_pants/exceptions'
+  require 'rocket_pants/error'
+  require 'rocket_pants/errors'
 
   # Set up the routing in advance.
   require 'rocket_pants/routing'
@@ -39,6 +40,7 @@ module RocketPants
   autoload :UrlFor,             'rocket_pants/controller/url_for'
 
   mattr_accessor :caching_enabled, :header_metadata
+
   self.caching_enabled = false
   self.header_metadata = false
 
@@ -51,6 +53,39 @@ module RocketPants
     def cache
       @@cache ||= Moneta::Memory.new
     end
+
+    def env
+      @@env ||= default_env
+    end
+
+    def env=(value)
+      value = value.presence && ActiveSupport::StringInquirer.new(value)
+      @@env = value
+    end
+
+    def default_env
+      env = Rails.env.to_s if defined?(Rails.env)
+      env ||= ENV['RAILS_ENV'].presence || ENV['RACK_ENV'].presence || "development"
+      ActiveSupport::StringInquirer.new env
+    end
+
+    def default_pass_through_errors
+      env.development? || env.test?
+    end
+
+    def pass_through_errors
+      if defined?(@@pass_through_errors) && [true, false].include?(@@pass_through_errors)
+        @@pass_through_errors
+      else
+        @@pass_through_errors = default_pass_through_errors
+      end
+    end
+    alias pass_through_errors? pass_through_errors
+
+    def pass_through_errors=(value)
+      @@pass_through_errors = value
+    end
+
   end
 
 end

data/lib/rocket_pants/active_record.rb

@@ -0,0 +1,19 @@
+# Provides a bunch of default active record integration entry points.
+module RocketPants
+  module ActiveRecordIntegration
+    extend ActiveSupport::Concern
+
+    included do
+      map_error! ActiveRecord::RecordNotFound, RocketPants::NotFound
+      map_error!(ActiveRecord::RecordNotSaved) { RocketPants::InvalidResource.new nil }
+      map_error! ActiveRecord::RecordInvalid do |exception|
+        RocketPants::InvalidResource.new exception.record.errors
+      end
+    end
+
+    ActiveSupport.on_load :active_record do
+      RocketPants::Base.send :include, RocketPants::ActiveRecordIntegration
+    end
+
+  end
+end

data/lib/rocket_pants/base.rb

@@ -1,4 +1,4 @@
-require 'rocket_pants/exceptions'
+require 'rocket_pants/errors'
 
 module RocketPants
 

data/lib/rocket_pants/client.rb

@@ -2,7 +2,7 @@ require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'
 
-require 'rocket_pants/exceptions'
+require 'rocket_pants/errors'
 
 require 'api_smith'
 require 'will_paginate/collection'

data/lib/rocket_pants/controller/error_handling.rb

@@ -13,8 +13,15 @@ module RocketPants
 
     module ClassMethods
 
-      def map_error!(from, to)
-        error_mapping[from] = to
+      # Declares that a given error class (e.g. ActiveRecord::RecordNotFound)
+      # should map to a second value - either an Exception class Or, more usefully,
+      # a callable object.
+      # @param [Class] from the exception class to map from.
+      # @param [Class, #call] to the callable to map to, or a callback block.
+      def map_error!(from, to = nil, &blk)
+        to = (to || blk)
+        raise ArgumentError, "Either an option must be provided or a block given." unless to
+        error_mapping[from] = (to || blk)
         rescue_from from, :with => :render_error
       end
 
@@ -47,7 +54,8 @@ module RocketPants
       # TODO: Add in notification hooks for non-standard exceptions.
       name    = lookup_error_name(exception)
       message = (exception.message == exception.class.name) ? 'An unknown error has occurred.' : exception.message
-      I18n.t name, lookup_error_context(exception).reverse_merge(:scope => :"rocket_pants.errors", :default => message)
+      context = lookup_error_context(exception).reverse_merge(:scope => :"rocket_pants.errors", :default => message)
+      I18n.t name, context.except(:metadata)
     end
 
     # Lookup error name will automatically handle translating errors to a
@@ -77,12 +85,17 @@ module RocketPants
       exception.respond_to?(:context) ? exception.context : {}
     end
 
-    # Returns extra error details for a given object, making it useable
-    # for hooking in external exceptions.
     def lookup_error_extras(exception)
       {}
     end
 
+    # Returns extra error details for a given object, making it useable
+    # for hooking in external exceptions.
+    def lookup_error_metadata(exception)
+      context = lookup_error_context exception
+      context.fetch(:metadata, {}).merge lookup_error_extras(exception)
+    end
+
     # Renders an exception as JSON using a nicer version of the error name and
     # error message, following the typically error standard as laid out in the JSON
     # api design.
@@ -95,13 +108,18 @@ module RocketPants
         klass < StandardError and error_mapping.has_key?(klass)
       end
       if normalised_class
-        exception = error_mapping[normalised_class].new(exception.message)
+        mapped = error_mapping[normalised_class]
+        if mapped.respond_to?(:call)
+          exception = mapped.call(exception)
+        else
+          exception = mapped.new exception.message
+        end
       end
       self.status = lookup_error_status(exception)
       render_json({
         :error             => lookup_error_name(exception).to_s,
         :error_description => lookup_error_message(exception)
-      }.merge(lookup_error_extras(exception)))
+      }.merge(lookup_error_metadata(exception)))
     end
 
   end

data/lib/rocket_pants/controller/rescuable.rb

@@ -8,7 +8,7 @@ module RocketPants
     include ActiveSupport::Rescuable
 
     DEFAULT_NOTIFIER_CALLBACK = lambda do |controller, exception, req|
-      # Do nothing by default...
+      # Does nothing
     end
     
     NAMED_NOTIFIER_CALLBACKS = {
@@ -52,6 +52,7 @@ module RocketPants
     def process_action(*args)
       super
     rescue Exception => exception
+      raise if RocketPants.pass_through_errors?
       # Otherwise, use the default built in handler.
       logger.error "Exception occured: #{exception.class.name} - #{exception.message}"
       logger.error "Exception backtrace:"

data/lib/rocket_pants/error.rb

@@ -0,0 +1,59 @@
+module RocketPants
+  
+  # Represents the standard error type as defined by the API.
+  # RocketPants::Error instances will be caught and automatically rendered as JSON
+  # by the controller during processing.
+  class Error < StandardError
+    
+    # @overload error_name
+    #   Returns the error name for this error class, defaulting to
+    #   the class name underscorized minus _error.
+    #   @return [Symbol] the given errors name.
+    # @overload error_name(value)
+    #   Sets the error name for the current class.
+    #   @param [#to_sym] the name of this error.
+    def self.error_name(value = nil)
+      if value.nil?
+        @name ||= name.underscore.split("/").last.sub(/_error$/, '').to_sym
+      else
+        @name = (value.presence && value.to_sym)
+      end
+    end
+    
+    # @overload http_status
+    #   Returns the http status code of this error, defaulting to 400 (Bad Request).
+    # @overload http_status(value)
+    #   Sets the http status code for this error to a given symbol / integer.
+    #   @param value [String, Fixnum] value the new status code.
+    def self.http_status(value = nil)
+      if value.nil?
+        @http_status ||= 400
+      else
+        @http_status = (value.presence && value)
+      end
+    end
+    
+    # Gets the name of this error from the class.
+    def error_name
+      self.class.error_name
+    end
+    
+    # Gets the http status of this error from the class.
+    def http_status
+      self.class.http_status
+    end
+    
+    # Setter for optional data about this error, used for translation.
+    attr_writer :context
+    
+    # Gets the context for this error, defaulting to nil.
+    # @return [Hash] the context for this param.
+    def context
+      @context ||= {}
+    end
+    
+    error_name :unknown
+
+  end
+  
+end

data/lib/rocket_pants/{exceptions.rb → errors.rb}

@@ -1,60 +1,6 @@
 module RocketPants
-  
-  # Represents the standard error type as defined by the API.
-  # RocketPants::Error instances will be caught and automatically rendered as JSON
-  # by the controller during processing.
-  class Error < StandardError
-    
-    # @overload error_name
-    #   Returns the error name for this error class, defaulting to
-    #   the class name underscorized minus _error.
-    #   @return [Symbol] the given errors name.
-    # @overload error_name(value)
-    #   Sets the error name for the current class.
-    #   @param [#to_sym] the name of this error.
-    def self.error_name(value = nil)
-      if value.nil?
-        @name ||= name.underscore.split("/").last.sub(/_error$/, '').to_sym
-      else
-        @name = (value.presence && value.to_sym)
-      end
-    end
-    
-    # @overload http_status
-    #   Returns the http status code of this error, defaulting to 400 (Bad Request).
-    # @overload http_status(value)
-    #   Sets the http status code for this error to a given symbol / integer.
-    #   @param value [String, Fixnum] value the new status code.
-    def self.http_status(value = nil)
-      if value.nil?
-        @http_status ||= 400
-      else
-        @http_status = (value.presence && value)
-      end
-    end
-    
-    # Gets the name of this error from the class.
-    def error_name
-      self.class.error_name
-    end
-    
-    # Gets the http status of this error from the class.
-    def http_status
-      self.class.http_status
-    end
-    
-    # Setter for optional data about this error, used for translation.
-    attr_writer :context
-    
-    # Gets the context for this error, defaulting to nil.
-    # @return [Hash] the context for this param.
-    def context
-      @context ||= {}
-    end
-    
-    error_name :unknown
 
-  end
+  require 'rocket_pants/error'
   
   # A simple map of data about errors that the rocket pants system can handle.
   class Errors
@@ -111,5 +57,28 @@ module RocketPants
     register! :bad_request,     :http_status => :bad_request
     
   end
+
+  class InvalidResource < RocketPants::Error
+    http_status :unprocessable_entity
+    error_name  :invalid_resource
+
+    # Errors are ActiveModel Errors
+    attr_reader :errors
+
+    def initialize(errors, *args)
+      @errors = errors
+      super *args
+    end
+
+    def context
+      super.tap do |ctx|
+        extras            = (ctx[:metadata] ||= {})
+        extras[:messages] = errors.to_hash if errors
+      end
+    end
+
+    Errors.add self
+    
+  end
   
 end

data/lib/rocket_pants/locale/en.yml

@@ -5,4 +5,6 @@ en:
       unauthenticated: "This action requires authentication to continue."
       invalid_version: "This action is not available in the given version of the api."
       not_implemented: "The feature you requested has not yet been implemented and hence is currently unavailable."
-      not_found: "The requested resource could not be found."
+      not_found: "The requested resource could not be found."
+      bad_request: "The data given to this server does not meet our criteria."
+      invalid_resource: "The current resource was deemed invalid."

data/lib/rocket_pants/railtie.rb

@@ -1,9 +1,10 @@
 module RocketPants
   class Railtie < Rails::Railtie
 
-    config.rocket_pants                 = ActiveSupport::OrderedOptions.new
-    config.rocket_pants.use_caching     = nil
-    config.rocket_pants.header_metadata = nil
+    config.rocket_pants                     = ActiveSupport::OrderedOptions.new
+    config.rocket_pants.use_caching         = nil
+    config.rocket_pants.header_metadata     = nil
+    config.rocket_pants.pass_through_errors = nil
 
     config.i18n.railties_load_path << File.expand_path('../locale/en.yml', __FILE__)
 
@@ -12,10 +13,11 @@ module RocketPants
     end
 
     initializer "rocket_pants.configuration" do |app|
-      rp_config = app.config.rocket_pants
-      rp_config.use_caching = Rails.env.production? if rp_config.use_caching.nil?
-      RocketPants.caching_enabled = rp_config.use_caching
-      RocketPants.header_metadata = rp_config.header_metadata unless rp_config.header_metadata.nil?
+      rp_config                       = app.config.rocket_pants
+      rp_config.use_caching           = Rails.env.production? if rp_config.use_caching.nil?
+      RocketPants.caching_enabled     = rp_config.use_caching
+      RocketPants.header_metadata     = rp_config.header_metadata unless rp_config.header_metadata.nil?
+      RocketPants.pass_through_errors = rp_config.pass_through_errors unless rp_config.pass_through_errors.nil?
       # Set the rocket pants cache if present.
       RocketPants.cache = rp_config.cache if rp_config.cache
     end
@@ -38,6 +40,12 @@ module RocketPants
       end
     end
 
+    initializer "rocket_pants.setup_activerecord" do
+      if defined?(ActiveRecord)
+        require 'rocket_pants/active_record'
+      end
+    end
+
     rake_tasks do
       load "rocket_pants/tasks/rocket_pants.rake"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocket_pants
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -243,6 +243,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rocket_pants/active_record.rb
 - lib/rocket_pants/base.rb
 - lib/rocket_pants/cache_middleware.rb
 - lib/rocket_pants/cacheable.rb
@@ -258,7 +259,8 @@ files:
 - lib/rocket_pants/controller/respondable.rb
 - lib/rocket_pants/controller/url_for.rb
 - lib/rocket_pants/controller/versioning.rb
-- lib/rocket_pants/exceptions.rb
+- lib/rocket_pants/error.rb
+- lib/rocket_pants/errors.rb
 - lib/rocket_pants/locale/en.yml
 - lib/rocket_pants/railtie.rb
 - lib/rocket_pants/routing.rb