apiable_model_errors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac03665a8b0e776827ef06713dc1bbaf02395d24
+  data.tar.gz: bd876bf793d113b27749f3fd6ed266dc5613a1f4
+SHA512:
+  metadata.gz: e7117ef3e97f0cf9acf70b5fcc057bbfe45f4a8d564cbb34fdd878e0e2a96f271550ea7de1d3697fbc9a4e5e873cbf7b99d4efe9298aa0409c05c3a89019f30e
+  data.tar.gz: 7274e7ce09b19d90cf66d56fb0b706da54e25fb9258686fa69e64fe65f634f3eafbe64b65f3e64fb793a8869428cd3565e615e075b8db7e591e602899a506630

data/Gemfile

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "https://rubygems.org"
+group :development do
+  gem "activemodel"
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/MIT-LICENCE

@@ -0,0 +1,20 @@
+Copyright 2016 Adam Cooke.
+
+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,70 @@
+# APIable Model Errors
+
+ActiveModel provides a great framework for handling validations
+for models. It easily allows you to add any validation message to
+any attribute however these arbitary strings aren't very helpful
+if you want to deliver validation errors to APIs. API developers
+don't want to see `Number is too long (maximum is 5 characters)`,
+they would much rather see something they can handle programatically
+like `too_long` or `blank`.
+
+This gem extends the `ActiveModel::Errors` class to allow for a
+more API-friendly hash of errors to be returned.
+
+## Installation
+
+```ruby
+gem "apiable_model_errors"
+```
+
+## Usage
+
+Once you've installed the gems, you can call the `to_api_hash`
+method on any `ActiveModel::Errors` object.
+
+```ruby
+user = User.new(params)
+unless user.valid?
+  user.errors.to_api_hash
+end
+```
+
+## Example Output
+
+When using this you'll receive a ruby hash however you can easily
+convert this into JSON by calling `to_json` on the hash.
+
+```javascript
+{
+  "name":[
+    {
+      "code":"too_long",
+      "message":"is too long (maximum is 4 characters)",
+      "options":{
+        "count":4
+      }
+    }
+  ]
+}
+```
+
+As you can see you'll receive the code, the actual translated
+message from ActiveModel and any options.
+
+## `has_message?`
+
+In addition to provide the `to_api_hash` method, we also provide
+a method called `has_message?` which allows you to determine if a
+message exists for a given attribute. This is similar to the
+`added?` however does not require that you provide all options to
+see if a message has been added.
+
+```ruby
+# See if there are any :too_long messages on the name attribute
+user.errors.has_message?(:name, :too_long)
+# See if there are any :too_long messages on the name attribute
+# with the options provided.
+user.errors.has_message?(:name, :too_long, :count => 4)
+# See if there are any :blank messages on the name attribute
+user.errors.has_message?(:name, :blank)
+```

data/apiable_model_errors.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name        = "apiable_model_errors"
+  s.version     = "1.0.0"
+  s.authors     = ["Adam Cooke"]
+  s.email       = ["adam@atechmedia.com"]
+  s.homepage    = "http://adamcooke.io"
+  s.licenses    = ['MIT']
+  s.summary     = "Provide ActiveModel errors in an format suitable for API consumers"
+  s.description = "Avoid sending plain text messages to API consumers by sending them more detailed information about validation errors."
+  s.files = Dir["**/*"]
+  s.add_dependency "activemodel", ">= 4.0", "< 5.0"
+end

data/lib/apiable_model_errors.rb

@@ -0,0 +1,72 @@
+require 'active_model'
+
+module ApiableModelErrors
+
+  def self.included(base)
+    base.alias_method_chain :add, :api_errors
+    base.alias_method_chain :clear, :api_errors
+    base.alias_method_chain :delete, :api_errors
+  end
+
+  def to_api_hash
+    errors_for_api.each_with_object({}) do |(attribute, errors), hash|
+      hash[attribute] = []
+      errors.each_with_index do |(message, options), index|
+        if message.is_a?(String)
+          error = {:message => message}
+        else
+          error = {
+            :code => message,
+            :message => messages[attribute][index],
+            :options => options
+          }
+        end
+        hash[attribute] << error
+      end
+    end
+  end
+
+  def errors_for_api
+    @errors_for_api ||= {}
+  end
+
+  def clear_with_api_errors
+    clear_without_api_errors.tap do
+      @errors_for_api = {}
+    end
+  end
+
+  def delete_with_api_errors(key)
+    delete_without_api_errors(key).tap do
+      errors_for_api.delete(key)
+    end
+  end
+
+  def add_with_api_errors(attribute, message = :invalid, options = {})
+    add_without_api_errors(attribute, message, options).tap do
+      errors_for_api[attribute] ||= []
+      errors_for_api[attribute] << [message, options || {}]
+    end
+  end
+
+  def has_message?(attribute, message, options = nil)
+    if errors = errors_for_api[attribute]
+      if error = errors.select { |e| e[0] == message }.first
+        if options.nil?
+          true # No options specified, if it exists, it's here
+        elsif options == error[1]
+          true # The options match those on the subejct
+        else
+          false # The options selected don't match those on the error
+        end
+      else
+        false # No errors of this type
+      end
+    else
+      false # No errors for this attribute
+    end
+  end
+
+end
+
+ActiveModel::Errors.send :include, ApiableModelErrors

data/spec/apiable_model_errors_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe ApiableModelErrors do
+
+  context "#add" do
+    it "should should add errors to the API hash too" do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, :too_long, :count => 4
+      expect(errors.errors_for_api[:example]).to be_a Array
+      expect(errors.errors_for_api[:example].size).to be 1
+      expect(errors.errors_for_api[:example][0][0]).to eq(:too_long)
+      expect(errors.errors_for_api[:example][0][1]).to eq({:count => 4})
+    end
+
+    it "should still return the full message to keep same behaviour" do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      expect(errors.add(:example, :blank)).to eq(["can't be blank"])
+    end
+  end
+
+  context "#clear" do
+    it "should clear API errors" do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, :blank
+      expect(errors.messages).to_not be_empty
+      expect(errors.errors_for_api).to_not be_empty
+      errors.clear
+      expect(errors.messages).to be_empty
+      expect(errors.errors_for_api).to be_empty
+    end
+  end
+
+  context "#delete" do
+    it "should delete a given API error" do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, :blank
+      expect {errors.delete(:example)}.to change {errors.errors_for_api.has_key?(:example)}.from(true).to(false)
+    end
+  end
+
+  context "#to_api_hash" do
+    subject(:errors) do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, :too_long, :count => 4
+      errors.add :example, :invalid
+      errors
+    end
+
+    it "shuold return a hash for returning to API consumers" do
+      expect(hash = errors.to_api_hash).to be_a(Hash)
+    end
+
+    it "should have an array of errors for each attribute" do
+      expect(errors.to_api_hash[:example]).to be_a(Array)
+    end
+
+    it "should have the code, message and options" do
+      error = errors.to_api_hash[:example][0]
+      expect(error[:code]).to eq(:too_long)
+      expect(error[:message]).to match /is too long/
+      expect(error[:options]).to be_a Hash
+    end
+  end
+
+  context "#to_api_hash (with string messages)" do
+    subject(:errors) do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, "is not unique"
+      errors
+    end
+
+    it "should not have a code or options" do
+      error = errors.to_api_hash[:example][0]
+      expect(error[:message]).to eq('is not unique')
+      expect(error.has_key?(:code)).to be false
+      expect(error.has_key?(:options)).to be false
+    end
+  end
+
+  context "#has_message?" do
+    it "should return true if the given error exists on the attribute" do
+      errors = ActiveModel::Errors.new(ExampleClass.new)
+      errors.add :example, :too_long, :count => 4
+      expect(errors.has_message?(:example, :too_long)).to be true
+      expect(errors.has_message?(:example, :too_long, :count => 4)).to be true
+      expect(errors.has_message?(:example, :too_long, :count => 3)).to be false
+    end
+  end
+
+  context "with presence validator" do
+    class PresenceExampleClass < ExampleClass
+      validates :example, :presence => true
+    end
+
+    it "should have a blank error" do
+      p = PresenceExampleClass.new(nil)
+      expect(p.valid?).to be false
+      expect(p.errors.has_message?(:example, :blank)).to be true
+    end
+  end
+
+  context "with numericality validator" do
+    class NumericalityExampleClass < ExampleClass
+      validates :example, :numericality => {:only_integer => true}
+    end
+
+    it "should have a not_a_number error" do
+      p = NumericalityExampleClass.new("potato")
+      expect(p.valid?).to be false
+      expect(p.errors.has_message?(:example, :not_a_number)).to be true
+    end
+  end
+
+  context "with length validator" do
+    class LengthExampleClass < ExampleClass
+      validates :example, :length => {:minimum => 2, :maximum => 5}
+    end
+
+    it "should have a too long error when too long" do
+      p = LengthExampleClass.new("morethanfive")
+      expect(p.valid?).to be false
+      expect(p.errors.has_message?(:example, :too_long)).to be true
+      expect(p.errors.has_message?(:example, :too_long, :count => 5)).to be true
+    end
+
+    it "should have a too short error when too long" do
+      p = LengthExampleClass.new("a")
+      expect(p.valid?).to be false
+      expect(p.errors.has_message?(:example, :too_short)).to be true
+      expect(p.errors.has_message?(:example, :too_short, :count => 2)).to be true
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.expand_path(File.join('..', '..', 'lib'), __FILE__))
+require 'apiable_model_errors'
+
+class ExampleClass
+  include ActiveModel::Validations
+  attr_reader :example
+  def initialize(example = nil)
+    @example = example
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: apiable_model_errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Avoid sending plain text messages to API consumers by sending them more
+  detailed information about validation errors.
+email:
+- adam@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- apiable_model_errors.gemspec
+- lib/apiable_model_errors.rb
+- spec/apiable_model_errors_spec.rb
+- spec/spec_helper.rb
+homepage: http://adamcooke.io
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Provide ActiveModel errors in an format suitable for API consumers
+test_files: []
+has_rdoc: