validate-response 0.0.5

data/lib/tasks/validate_response_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :validate_response do
+#   # Task goes here
+# end

data/lib/validate-response.rb

@@ -0,0 +1,137 @@
+# -*- encoding: utf-8 -*-
+# ---------------------------------------------------------------
+# Класс приводит к единообразной структуре сообщения об ошибках
+# одного или нескольких объектов ActiveRecord.
+#
+# Пример использования:
+#   render json: {
+#     result: @user.update_attributes(params[:user]),
+#     validates: ValidateResponse.new(@user.contacts)
+#   }
+#
+# Поддерживаются объекты разных моделей
+#   a.update_attributes(...)
+#   b.update_attributes(...)
+#   ValidateResponse.new(a, b)
+#
+# nil - Используется для обозначения *new_record* записей (еще не сохраненных в базе)
+#
+# Примеры заполнения:
+#   Пример 1:
+#     ValidateResponse.new(@user.contacts)
+#
+#   Пример 2:
+#     ValidateResponse.new(@room)
+#
+#   Пример 3:
+#     x = ValidateResponse.new()
+#     x << contact1
+#     x << contact2
+#     x << contact3 << contact4
+#
+#   Пример 4 (ручное заполнение):
+#     x = ValidateResponse.new()
+#     x[:users, 1] = {
+#       name: 'ошибка такая-то',
+#       age: ['несоответствие 1', 'несоответствие 2']
+#     }
+#     x[:users, nil] = {
+#       name: 'ошибка такая-то',
+#       age: ['несоответствие 1', 'несоответствие 2']
+#     }
+#
+#   Пример 5 (ручное заполнение):
+#     x = ValidateResponse.new()
+#     x[:users] = {
+#       1 => {
+#         name: 'ошибка такая-то',
+#         age: ['несоответствие 1', 'несоответствие 2']
+#       },
+#       nil => {
+#         name: 'ошибка такая-то',
+#         age: ['несоответствие 1', 'несоответствие 2']
+#       }
+#     }
+# ----------------------------------------------------------------
+class ValidateResponse
+  class Engine < Rails::Engine
+  end
+
+  class ValidateResponse::InvalidErrorsObject < StandardError
+  end
+
+  # @param [ActiveModel::Base, ...] *errors_object
+  def initialize(*errors_objects)
+    @errors = {}
+    add *errors_objects
+  end
+
+  def to_json
+    @errors.to_json
+  end
+
+  def to_hash
+    @errors
+  end
+
+  def [](*key)
+    case key.length
+      when 1 then @errors[key[0].to_sym]
+      when 2 then ((@errors[key[0].to_sym] ||= {})[key[1]] ||= {})
+    end
+  end
+
+  def []=(*key, content)
+    case key.length
+      when 1 then (@errors[key[0].to_sym] ||= {}).merge!(prepare_group content)
+      when 2 then (@errors[key[0].to_sym] ||= {})[key[1]] = prepare_hash_with_messages content
+    end
+  end
+
+  def add(*errors_objects)
+    errors_objects.flatten.each{ |errors_object| self << errors_object }
+  end
+
+  def <<(errors_object)
+    check_errors_object errors_object
+    return self if errors_object.errors.count.zero?
+    record_type = errors_object.class.name.tableize.to_sym
+    record_id   = errors_object.id
+    @errors[record_type] ||= {}
+    @errors[record_type][record_id] ||= {}
+    #@errors[record_type][record_id] = Hash[errors_object.errors]
+    record_errors = (@errors[record_type][record_id] ||= {})
+    Hash[errors_object.errors].each do |field, messages|
+      record_errors[field] ||= []
+      record_errors[field] |= messages
+    end
+    self
+  end
+
+  # Aliases
+  alias_method :to_s,    :to_hash
+  alias_method :inspect, :to_hash
+  alias_method :errors,  :to_hash
+
+  protected
+
+  def prepare_messages_array(messages)
+    messages.is_a?(Array) ? messages : [messages]
+  end
+
+  def prepare_hash_with_messages(messages_hash)
+    messages_hash.reduce({}) do |res, (key, val)|
+      res[key.to_sym] = prepare_messages_array(val); res
+    end
+  end
+
+  def prepare_group(group)
+    group.reduce({}) do |res, (key, val)|
+      res[key] = prepare_hash_with_messages(val); res
+    end
+  end
+
+  def check_errors_object(errors_object)
+    raise InvalidErrorsObject.new('Wrong type of object that contains validation errors') unless errors_object.kind_of?(ActiveRecord::Base)
+  end
+end

data/lib/validate-response/version.rb

@@ -0,0 +1,3 @@
+class ValidateResponse
+  VERSION = '0.0.5'
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "validate_response"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end