flexirest 1.3.32 → 1.3.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d818096fc6d03908005c35317dbc5e0ab2f03994
-  data.tar.gz: a4ed3f0e1e7db9dd92d4c5fca478b0fc385edca3
+  metadata.gz: 1c372f15d7e88d296232e1e055cb598419ca3d2c
+  data.tar.gz: c61b9f302f68cde71be0d091288e10f5b994c342
 SHA512:
-  metadata.gz: 35af9776e44f7b291ba41753f4cb7efef1f2441ccd0aed3fd41474b27dce714d7951cfc9a6ad5fe98996e9399b3ecece34d9b00dab65b77a93fd38eac88ea07f
-  data.tar.gz: 45228f5f5c0fbcfde18bfa4bf5dac900024d9e45bd11d7957c80181da011e0ee253dbe59b55526b4fbf71199844b3bbc6b350874d851be3f6abf8527ae8dfd00
+  metadata.gz: '007239649da6105e553e6779858fc70951ff66825262300636254c34a749598839ad64c63bb145357b09bd07f85897b731d59b16c7a4354efd67d6f738fce30f'
+  data.tar.gz: fa9cbd5356984fc31ae87634833893cbc02b3586ad185324c85fe6458cedf6663e9303b93e437ffdecb09f09b5c88818e4570fd72508d402ba4da3807d74ac76

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.33
+
+Feature:
+
+- Allowed specifying custom message for validation failures
+
 ## 1.3.32
 
 Bugfix:

data/README.md

@@ -959,7 +959,7 @@ You can create validations on your objects just like Rails' built in ActiveModel
 class Person < Flexirest::Base
   validates :first_name, presence: true #ensures that the value is present and not blank
   validates :last_name, existence: true #ensures that the value is non-nil only
-  validates :password, length: {within:6..12}
+  validates :password, length: {within:6..12}, message: "Invalid password length, must be 6-12 characters"
   validates :post_code, length: {minimum:6, maximum:8}
   validates :salary, numericality: true, minimum: 20_000, maximum: 50_000
   validates :age, numericality: { minumum: 18, maximum: 65 }
@@ -977,7 +977,7 @@ Note: the block based validation is responsible for adding errors to `object._er
 
 Validations are run when calling `valid?` or when calling any API on an instance (and then only if it is `valid?` will the API go on to be called).
 
-`full_error_messages` returns an array of attributes with their associated error messages, i.e. `["age must be at least 18"]`
+`full_error_messages` returns an array of attributes with their associated error messages, i.e. `["age must be at least 18"]`. Custom messages can be specified by passing a `:message` option to `validates`. This differs slightly from ActiveRecord in that it's an option to `validates` itself, not a part of a final hash.
 
 #### Permitting nil values
 The default behavior for `:length`, `:numericality` and `:inclusion` validators is to fail when a `nil` value is encountered. You can prevent `nil` attribute values from triggering validation errors for attributes that may permit `nil` by adding the `:allow_nil => true` option. Adding this option with a `true` value to `:length`, `:numericality` and `:inclusion` validators will permit `nil` values and not trigger errors. Some examples are:

data/Ruby-on-Rails-Integration.md

@@ -15,12 +15,12 @@ gem 'flexirest'
 
 ## Configuration
 
-It's possible to explicit specify the `base_url` in the Model Class. If you have an common API Endpoint it makes sense to setup an initializer in `config/initializer` or use the `Rails.application.configure` namespace.
+It's possible to explicit specify the `base_url` in the Model Class. If you have an common API Endpoint it makes sense to setup an initializer in `config/initializers` or use the `Rails.application.configure` namespace.
 
-This example use a custom file in `config/initializer` to setup the API endpoint. Either set a fixed URL or use environment variables if you would like to follow the [12factor](http://12factor.net/config) rules for preparing your application running on cloud infrastructure like heroku.
+This example use a custom file in `config/initializers` to setup the API endpoint. Either set a fixed URL or use environment variables if you would like to follow the [12factor](http://12factor.net/config) rules for preparing your application running on cloud infrastructure like heroku.
 
 ```ruby
-# config/initializer/flexirest.rb
+# config/initializers/flexirest.rb
 Flexirest::Base.base_url = ENV.fetch("API_ENDPOINT_URL")
 ```
 

data/lib/flexirest/validation.rb

@@ -24,63 +24,63 @@ module Flexirest
         validation[:options].each do |type, options|
           if type == :presence
             if value.nil?
-              @errors[validation[:field_name]] << "must be present"
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be present")
             elsif value.blank?
-              @errors[validation[:field_name]] << "must be present"
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be present")
             end
           elsif type == :existence
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil"
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil")
             end
           elsif type == :length
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil" unless allow_nil
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil") unless allow_nil
             else
               if options[:within]
-                @errors[validation[:field_name]] << "must be within range #{options[:within]}" unless options[:within].include?(value.to_s.length )
+                @errors[validation[:field_name]] << (validation[:options][:message] || "must be within range #{options[:within]}") unless options[:within].include?(value.to_s.length )
               end
               if options[:minimum]
-                @errors[validation[:field_name]] << "must be at least #{options[:minimum]} characters long" unless value.to_s.length >= options[:minimum]
+                @errors[validation[:field_name]] << (validation[:options][:message] || "must be at least #{options[:minimum]} characters long") unless value.to_s.length >= options[:minimum]
               end
               if options[:maximum]
-                @errors[validation[:field_name]] << "must be no more than #{options[:maximum]} characters long" unless value.to_s.length <= options[:maximum]
+                @errors[validation[:field_name]] << (validation[:options][:message] || "must be no more than #{options[:maximum]} characters long") unless value.to_s.length <= options[:maximum]
               end
             end
           elsif type == :numericality
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil" unless allow_nil
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil") unless allow_nil
             else
               numeric = (true if Float(value) rescue false)
               if !numeric
-                @errors[validation[:field_name]] << "must be numeric"
+                @errors[validation[:field_name]] << (validation[:options][:message] || "must be numeric")
               else
                 if options.is_a?(Hash)
                   if options[:minimum]
-                    @errors[validation[:field_name]] << "must be at least #{options[:minimum]}" unless value.to_f >= options[:minimum]
+                    @errors[validation[:field_name]] << (validation[:options][:message] || "must be at least #{options[:minimum]}") unless value.to_f >= options[:minimum]
                   end
                   if options[:maximum]
-                    @errors[validation[:field_name]] << "must be no more than #{options[:maximum]}" unless value.to_f <= options[:maximum]
+                    @errors[validation[:field_name]] << (validation[:options][:message] || "must be no more than #{options[:maximum]}") unless value.to_f <= options[:maximum]
                   end
                 end
               end
             end
           elsif type == :minimum
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil" unless allow_nil
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil") unless allow_nil
             else
-              @errors[validation[:field_name]] << "must be at least #{options}" unless value.to_f >= options.to_f
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be at least #{options}") unless value.to_f >= options.to_f
             end
           elsif type == :maximum
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil" unless allow_nil
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil") unless allow_nil
             else
-              @errors[validation[:field_name]] << "must be no more than #{options}" unless value.to_f <= options.to_f
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be no more than #{options}") unless value.to_f <= options.to_f
             end
           elsif type == :inclusion
             if value.nil?
-              @errors[validation[:field_name]] << "must be not be nil" unless allow_nil
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be not be nil") unless allow_nil
             else
-              @errors[validation[:field_name]] << "must be included in #{options[:in].join(", ")}" unless options[:in].include?(value)
+              @errors[validation[:field_name]] << (validation[:options][:message] || "must be included in #{options[:in].join(", ")}") unless options[:in].include?(value)
             end
           end
         end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.32"
+  VERSION = "1.3.33"
 end

data/spec/lib/validation_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe "Flexirest::Validation" do
   class SimpleValidationExample < OpenStruct
     include Flexirest::Validation
-    validates :first_name, presence: true
+    validates :first_name, presence: true, message: "Sorry, something went wrong"
     validates :middle_name, length: { minimum: 2, maximum: 30 }, allow_nil: true
     validates :last_name, existence: true
     validates :nick_name, length: { minimum: 2, maximum: 30 }
@@ -34,6 +34,13 @@ describe "Flexirest::Validation" do
       expect(a._errors[:first_name].size).to eq(1)
     end
 
+    it "should return a custom error if specified and a validation fails" do
+      a = SimpleValidationExample.new
+      a.first_name = nil
+      a.valid?
+      expect(a._errors[:first_name][0]).to eq("Sorry, something went wrong")
+    end
+
     it "should be invalid if a required value is present but blank" do
       a = SimpleValidationExample.new
       a.first_name = ""
@@ -60,7 +67,7 @@ describe "Flexirest::Validation" do
       a.first_name = "John"
       a.valid?
       expect(a._errors[:first_name]).to be_empty
-    end    
+    end
   end
 
   context "when validating existence" do
@@ -83,7 +90,7 @@ describe "Flexirest::Validation" do
       a.last_name = "John"
       a.valid?
       expect(a._errors[:last_name]).to be_empty
-    end 
+    end
   end
 
   context "when validating length" do
@@ -116,7 +123,7 @@ describe "Flexirest::Validation" do
       a.valid?
       expect(a._errors[:post_code].size).to eq(1)
     end
-    
+
     it "should be valid if a length is nil and allow_nil option is true" do
       a = SimpleValidationExample.new
       a.valid?
@@ -155,13 +162,13 @@ describe "Flexirest::Validation" do
         a = SimpleValidationExample.new(salary:100_000)
         a.valid?
         expect(a._errors[:salary].size).to be > 0
-      end      
+      end
 
       it "should be valid that a numeric field is above or equal to a minimum" do
         a = SimpleValidationExample.new(salary:30_000)
         a.valid?
         expect(a._errors[:salary].size).to eq(0)
-      end 
+      end
 
       it "should be valid if a value is nil and allow_nil option is true" do
         a = SimpleValidationExample.new
@@ -205,13 +212,13 @@ describe "Flexirest::Validation" do
         a = SimpleValidationExample.new(age: 70)
         a.valid?
         expect(a._errors[:age].size).to be > 0
-      end      
+      end
 
       it "should be valid that a numeric field is above or equal to a minimum" do
         a = SimpleValidationExample.new(age: 30)
         a.valid?
         expect(a._errors[:age].size).to eq(0)
-      end 
+      end
     end
   end
 
@@ -219,15 +226,15 @@ describe "Flexirest::Validation" do
     it "should be invalid if the value is not contained in the list" do
       a = SimpleValidationExample.new(suffix: "Baz")
       a.valid?
-      expect(a._errors[:suffix].size).to be > 0      
+      expect(a._errors[:suffix].size).to be > 0
     end
 
     it "should be valid if the value is contained in the list" do
       a = SimpleValidationExample.new(suffix: "Dr.")
       a.valid?
-      expect(a._errors[:suffix].size).to eq(0)       
+      expect(a._errors[:suffix].size).to eq(0)
     end
-    
+
     it "should be valid if the value is nil and allow_nil option is true" do
       a = SimpleValidationExample.new
       a.valid?
@@ -270,7 +277,7 @@ describe "Flexirest::Validation" do
       a = ValidationExample2.new(first_name:"Johnny")
       a.valid?
       expect(a._errors[:first_name]).to be_empty
-    end    
+    end
   end
 
   describe "#full_error_messages" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.32
+  version: 1.3.33
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler