invalid_model-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df1242852f66172d00295ccb760575223afa3eb03dc8603862d39c9ed3638f9b
+  data.tar.gz: 2ee8cb553eca6bcbc2c17e81cf35410d3e5f2a58de5a5deffa2f133701464e29
+SHA512:
+  metadata.gz: 45263b982a706e315c9557a594fff5c9a23c186dafacac70fe4ccd4df8dc8535e23baea9e0d147eca3f08c1468074326d4c13ee71c8d2b888ff2a47818ee4c6b
+  data.tar.gz: 529e8846f8f95c50d327c08c847e2683d237f79302ba603d4dacb5987ca0516897f00e09df071a345d7ac4a9dff87a7d1a35097ad2bb8b79e09ecfe5633dc6b8

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Konstantin Munteanu
+
+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,60 @@
+# InvalidModel Serializer
+
+You are using one of the many ruby `json_api` serializer gems like `active_model_serializers` or `fast_jsonapi`, but are not satisfied with the rendering of validation errors?
+
+This gem is trying to fit this gap.
+
+## Usage
+
+Add the gem to your Gemfile
+
+```ruby
+gem 'invalid_model-serializer'
+```
+
+To generate a `json-api` compliant error hash simply call
+```ruby
+InvalidModel::Serializer.new(invalid_model).serializable_hash
+```
+
+Which should parse your `ActiveModel` compatible errors and produce something like:
+
+```json
+{
+  "errors": [
+    {
+      "code": "validation_error/too_short",
+      "detail": "Name is too short (minimum is 6 characters)",
+      "meta": {
+        "count": 6
+      },
+      "source": {
+        "pointer": "/data/attributes/name"
+      },
+      "status": "400"
+    }
+  ]
+}
+```
+
+### Rails
+
+In a rails controller you could for example use:
+
+```ruby
+def create
+  ...
+  if @record.save
+    head :no_content
+  else
+    render json: InvalidModel::Serializer.new(@record).serializable_hash, status: :bad_request
+  end
+end
+```
+
+### Options
+
+You can pass options to the serializer as 2nd argument. The following keys are supported:
+* `code_format`: Override the default format. This string will be passed through a `format` method so you can use some placeholders like `type` and `attribute`.
+* `status`: Set a different status, default is `400`
+* `each_serializer`: Use your own serializer for error objects.

data/lib/invalid_model.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+
+module InvalidModel
+  autoload :Error,           'invalid_model/error'
+  autoload :ErrorSerializer, 'invalid_model/error_serializer'
+
+  include ActiveSupport::Configurable
+
+  config_accessor(:default_code_format) { 'validation_error/%<type>s' }
+  config_accessor(:default_status) { '400' }
+end

data/lib/invalid_model/error.rb

@@ -0,0 +1,24 @@
+module InvalidModel
+  class Error
+    def self.from_hash(errors_object, attribute, hash)
+      new(errors_object, attribute, hash[:error], hash.except(:error))
+    end
+
+    attr_reader :attribute, :errors_object, :type, :meta
+
+    def initialize(errors_object, attribute, type, meta)
+      @errors_object = errors_object
+      @attribute = attribute
+      @type = type
+      @meta = meta
+    end
+
+    def detail
+      @errors_object.full_message(attribute, errors_object.generate_message(attribute, type, meta))
+    end
+
+    def model_name
+      errors_object.instance_variable_get(:@base).model_name
+    end
+  end
+end

data/lib/invalid_model/error_serializer.rb

@@ -0,0 +1,48 @@
+module InvalidModel
+  class ErrorSerializer
+    def initialize(error, options = {})
+      @error = error
+      @options = options
+    end
+
+    def serializable_hash
+      {
+        code:   code,
+        detail: detail,
+        meta:   meta.presence,
+        source: source,
+        status: status
+      }.compact
+    end
+
+    private
+
+    attr_reader :error
+
+    delegate :attribute, :detail, :meta, :model_name, :type, to: :error
+
+    def code
+      if @options[:code]&.respond_to?(:call)
+        @options[:code].call error
+      elsif @options[:code]
+        @options[:code]
+      else
+        format code_format, attribute: attribute, model: model_name.singular, type: type
+      end
+    end
+
+    def code_format
+      @options[:code_format] || InvalidModel.default_code_format
+    end
+
+    def source
+      return if attribute == :base
+
+      {pointer: "/data/attributes/#{attribute}"}
+    end
+
+    def status
+      @options[:status] || InvalidModel.default_status
+    end
+  end
+end

data/lib/invalid_model/serializer.rb

@@ -0,0 +1,33 @@
+require 'invalid_model'
+
+module InvalidModel
+  class Serializer
+    def initialize(resource, options = {})
+      @resource = resource
+      @options = options
+    end
+
+    def serializable_hash
+      {
+        errors: errors_list.map { |error| each_serializer_klass.new(error, @options).serializable_hash }
+      }
+    end
+
+    private
+
+    def each_serializer_klass
+      @options[:each_serializer] || ErrorSerializer
+    end
+
+    def errors_object
+      @resource.errors
+    end
+
+    def errors_list
+      list = errors_object.details.map do |key, array|
+        array.map { |error| Error.from_hash(errors_object, key, error) }
+      end
+      list.flatten
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: invalid_model-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mkon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.2
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- konstantin@munteanu.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/invalid_model.rb
+- lib/invalid_model/error.rb
+- lib/invalid_model/error_serializer.rb
+- lib/invalid_model/serializer.rb
+homepage: https://github.com/mkon/unprocessable_entitiy_serializer
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Serialize models with validation errors to json-api errors.
+test_files: []