rocket_pants-core 2.0.0.pre.1

data/lib/rocket_pants/core.rb

@@ -0,0 +1,4 @@
+module RocketPants
+  require 'rocket_pants/error'
+  require 'rocket_pants/errors'
+end

data/lib/rocket_pants/error.rb

@@ -0,0 +1,61 @@
+require 'active_support/core_ext/object/blank'
+
+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/errors.rb

@@ -0,0 +1,90 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+
+module RocketPants
+
+  require 'rocket_pants/error'
+
+  # A simple map of data about errors that the rocket pants system can handle.
+  class Errors
+
+    @@errors = {}
+
+    # Returns a hash of all known errors, keyed by their error name.
+    # @return [Hash{Symbol => RocketPants::Error}] the hash of known errors.
+    def self.all
+      @@errors.dup
+    end
+
+    # Looks up a specific error from the given name, returning nil if none are found.
+    # @param [#to_sym] name the name of the error to look up.
+    # @return [Error, nil] the error class if found, otherwise nil.
+    def self.[](name)
+      @@errors[name.to_sym]
+    end
+
+    # Adds a given Error class in the list of all errors, making it suitable
+    # for lookup via [].
+    # @see Errors[]
+    # @param [Error] error the error to register.
+    def self.add(error)
+      @@errors[error.error_name] = error
+    end
+
+    # Creates an error class to represent a given error state.
+    # @param [Symbol] name the name of the given error
+    # @param [Hash] options the options used to create the error class.
+    # @option options [Symbol] :class_name the name of the class (under `RocketPants`), defaulting to the classified name.
+    # @option options [Symbol] :error_name the name of the error, defaulting to the name parameter.
+    # @option options [Symbol] :http_status the status code for the given error, doing nothing if absent.
+    # @example Adding a RocketPants::NinjasUnavailable class w/ `:service_unavailable` as the status code:
+    #   register! :ninjas_unavailable, :http_status => :service_unavailable
+    def self.register!(name, options = {})
+      klass_name = (options[:class_name] || name.to_s.classify).to_sym
+      base_klass = options[:base] || Error
+      raise ArgumentError, ":base must be a subclass of RocketPants::Error" unless base_klass <= Error
+      klass = Class.new(base_klass)
+      klass.error_name(options[:error_name] || name.to_s.underscore)
+      klass.http_status(options[:http_status]) if options[:http_status].present?
+      (options[:under] || RocketPants).const_set klass_name, klass
+      add klass
+      klass
+    end
+
+    # The default set of exceptions.
+    register! :throttled,       http_satus: :service_unavailable
+    register! :unauthenticated, http_satus: :unauthorized
+    register! :invalid_version, http_satus: :not_found
+    register! :not_implemented, http_satus: :service_unavailable
+    register! :not_found,       http_satus: :not_found
+    register! :bad_request,     http_satus: :bad_request
+    register! :conflict,        http_satus: :conflict
+    register! :forbidden,       http_satus: :forbidden
+
+  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-core.rb

@@ -0,0 +1 @@
+require 'rocket_pants/core'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rocket_pants-core
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre.1
+  prerelease: 6
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ! 'RocketPants core provides functionality for RocketPants shared between
+  different '
+email:
+- sutto@sutto.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rocket_pants/core.rb
+- lib/rocket_pants/error.rb
+- lib/rocket_pants/errors.rb
+- lib/rocket_pants-core.rb
+homepage: http://github.com/filtersquad
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Shared utilities for RocketPants - an opionionated set of API tools for Rails
+test_files: []