rails_api_validation_errors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c67df19656e245cb94ce548bb15cc5e0e9f45f49
+  data.tar.gz: 616f41d59a76b0674d2de3839df632c039e2a439
+SHA512:
+  metadata.gz: 0d845967d8bb35854eb37a0bdab081eaebd9a3118bbe0723d94c8c101621b748582c30bc36873c60cba473418e5610c8f4ea3acca97ae54794ab9f899803329a
+  data.tar.gz: 0e7f168c9c613c5bf466eed1bf65a19afbe065f352ebd3ed66a04340807595acbf1850d6c0272a91f54cb34722520a1d3f9f1675aed77cde6da4f129414fcda9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Moritz Lawitschka
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+[![Build Status](http://img.shields.io/travis/lawitschka/rails-api-validation-errors.svg)](https://travis-ci.org/lawitschka/rails-api-validation-errors)
+[![Coverage Status](http://img.shields.io/coveralls/lawitschka/rails-api-validation-errors.svg)](https://coveralls.io/r/lawitschka/rails-api-validation-errors)
+[![Code Climate](http://img.shields.io/codeclimate/github/lawitschka/rails-api-validation-errors.svg)](https://codeclimate.com/github/lawitschka/rails-api-validation-errors)
+
+# Rails API validation errors
+
+Untranslated validation errors with all meta data for APIs behind Javascript frontends
+
+
+## Installing
+
+The easiest way to install `Rails::API::ValidationErrors` is to add it to your
+`Gemfile`:
+
+```ruby
+gem "rails_api_validation_errors"
+```
+
+Then, install it on the command line:
+
+```
+$ bundle install
+```
+
+## Usage
+
+Include `Rails::API::HashValidationErrors` in your API's base controller. This makes
+sure that Rails will not translate error messages, but returns a hash per attribute
+and error including the error key and meta information.
+
+```ruby
+class API::BaseController < ApplicationController
+  include Rails::API::HashValidationErrors
+end
+```
+
+To use the new error messages simply return the model's errors in JSON or XML
+in your controllers:
+
+```ruby
+class API::PeopleController < API::BaseController
+
+  def create
+    @person = Person.new(person_params)
+
+    if @person.valid?
+      render :json => @person
+    else
+      render :json => { :errors => @person.errors }
+    end
+  end
+
+end
+```
+
+This will result in the following JSON response in case of validation errors:
+
+```json
+{
+  "errors": {
+    "name": [
+      {
+        "message": "blank",
+        "meta":{}
+      }
+    ]
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+Bundler::GemHelper.install_tasks
+
+# If you want to make this the default task
+task :default => :spec

data/lib/rails/api/hash_validation_errors.rb

@@ -0,0 +1,13 @@
+module Rails::API::HashValidationErrors
+
+  def self.included(base)
+    base.send :around_filter, :use_hash_validation_errors
+  end
+
+  def use_hash_validation_errors(&block)
+    ActiveModel::Errors.disable_translations
+    yield
+    ActiveModel::Errors.enable_translations
+  end
+
+end

data/lib/rails_api_validation_errors/active_model_errors.rb

@@ -0,0 +1,32 @@
+# Monkey patch ActiveModel::Errors class to return a hash containing translation
+# key and options if translation is missing.
+module ActiveModel
+  class Errors
+
+    # Option to specify wether to return hash or translation. Defaults to true
+    # to keep original behaviour.
+    @@translate_message = true
+
+    def self.disable_translations
+      @@translate_message = false
+    end
+
+    def self.enable_translations
+      @@translate_message = true
+    end
+
+    # Keep original method
+    alias _generate_message generate_message
+
+    def generate_message(attribute, type = :invalid, options = {})
+      if @@translate_message
+        _generate_message(attribute, type, options)
+      else
+        type = options.delete(:message) if options[:message].is_a?(Symbol)
+
+        { :message => type, :meta => options }
+      end
+    end
+
+  end
+end

data/lib/rails_api_validation_errors/version.rb

@@ -0,0 +1,3 @@
+module RailsApiValidationErrors
+  VERSION = "1.0.0"
+end

data/lib/rails_api_validation_errors.rb

@@ -0,0 +1,12 @@
+require 'active_model'
+
+module RailsApiValidationErrors
+end
+
+module Rails
+  module API
+  end
+end
+
+require 'rails_api_validation_errors/active_model_errors'
+require 'rails/api/hash_validation_errors'

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_validation_errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Moritz Lawitschka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instead of Rails translating validation errors automatically to current
+  locale, validation errors are returned as error meta hashes easily embedded in API
+  error responses and translated in the frontend.
+email:
+- me@moritzlawitschka.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails/api/hash_validation_errors.rb
+- lib/rails_api_validation_errors.rb
+- lib/rails_api_validation_errors/active_model_errors.rb
+- lib/rails_api_validation_errors/version.rb
+homepage: https://github.com/lawitschka/rails-api-validation-errors
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Untranslated validation errors with all meta data for APIs behind Javascript
+  frontends
+test_files: []