act_as_jsonapi 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b66ec4025d3d67ed9b8e004a649098e95d3bf87a51e4be2aa0cd993fef86490
+  data.tar.gz: c83d9bf7ed1a77ea18e8b76b70ef5b7c9954bcfaf84991fed7bfebea471cf2b7
+SHA512:
+  metadata.gz: 43bfc7efca48c8e84fb9b398d116cfa2b5e4b880115cc63674e7ec7f9be6f2da2340960c4b9a35b8f321b172ff006847621f902d7b175bdf3de4a347482941cb
+  data.tar.gz: b4832bc2cc42fac707f4fe81d06694fd29a5644f7c44c188ca6475adbff65b280800704126803993d373bd036600ab2b59c275267a30bb88d316dc10f561c1a2

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-03-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at lizzydw@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in act_as_jsonapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 leizzer
+
+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,152 @@
+# ActAsJsonapi
+
+Act as JSONAPI is a small and flexible gem on top of `jsonapi_serializer` and `pundit` gems.
+
+By including Act as JSONAPI in your controllers you instantly
+get all basic controller actions for the model and authorization checks.
+
+Plus formatted responses with meta, links and pagination as in JSON:API documentation
+and consistent error formatting.
+
+You can override the model and serializer if the name of the controller doesn't match the model.
+The json formatter and errors can be used separatly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'act_as_jsonapi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install act_as_jsonapi
+
+## Notes
+Project isn't fully polished so there are some considerations to have while adding the gem to a project.
+
+Notes:
+- ActAsJsonapi assumes the project will use `pundnit`.
+- Project needs to have gem `jsonapi-serializer` in Gemfile.
+- Project needs some kinde of pagination gem like `kaminari` that adds the `#page` method.
+- Project needs to respond to `current_user` for Pundit. Gem like `devise` can be used.
+
+## Usage
+
+To get all actions, error handling and serialization at once. (Controller includes Formatter and JSONErrors)
+
+This will give BooksController the methods `#index`, `#show`, `#update` and `#destroy`, with authorization checks.
+The model and serializer are atomatically loaded based on the name of the controller and it expects that Rails
+conventions were followed.
+```ruby
+class BooksController < ApplicationController
+  include ActAsJsonapi::Controller
+end
+```
+
+If you want to include the just `render_json_api` method.
+```ruby
+class BooksController < ApplicationController
+  include ActAsJsonapi::Formatter
+
+  def index
+    render_json_api BookSerializer.new(@books).serializable_hash
+  end
+end
+```
+
+Just the error handling
+```ruby
+class BooksController < ApplicationController
+  include ActAsJsonapi::JSONErrors
+
+  def index
+    #your code...
+    render_error :unprocessable_entity, :err_workflow_update, 'my message'
+  end
+end
+```
+
+Using `rescue_errors` examples
+```ruby
+class ApplicationController < ActionController::API
+  include ActAsJsonapi::JSONErrors
+
+  rescue_from ActionController::ParameterMissing, with: :render_bad_request
+  rescue_from ActionController::BadRequest, with: :render_bad_request
+  rescue_from ActiveRecord::RecordNotFound, with: :render_not_found
+  rescue_from Pundit::NotAuthorizedError, with: :render_forbidden
+end
+```
+
+```ruby
+class ApplicationController < ApplicationController
+  include ActAsJsonapi::JSONErrors
+
+  rescue_from ActiveRecord::RecordNotFound, :with => :err_record_not_found
+
+  private
+
+  def err_record_not_found(ex)
+    render_error :unprocessable_entity, :err_record_not_found, ex.message
+  end
+end
+```
+
+## Overriding
+
+`ActAsJsonapi::Controller` provides two handy class methods to change the model and/or serializer name.
+
+```ruby
+class API::Inventory < ApplicationController
+  include ActAsJsonapi::Controller
+
+  model_set Book
+  serializer_set BookSerializer
+
+  #...
+end
+```
+
+Another common practice is to override the `_resource` and `_resources` methods
+
+```ruby
+class BookController < ApplicationController
+  include ActAsJsonapi::Controller
+
+  #...
+
+  private
+
+  def _resource
+    @_resouce = #Complex query that returns one Book
+  end
+
+  def _resources
+    @_resouces = #Complex query that returns a collection of Books
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/act_as_jsonapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/act_as_jsonapi/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActAsJsonapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/act_as_jsonapi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/act_as_jsonapi.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/act_as_jsonapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "act_as_jsonapi"
+  spec.version       = ActAsJsonapi::VERSION
+  spec.authors       = ["leizzer"]
+
+  spec.summary       = "Light weight gem on top of `jsonapi_serializer` and `pundit` to keep controllers DRY"
+  spec.description   = "Act as JSONAPI is a small and flexible gem on top of `jsonapi_serializer`. \
+  By including Act as JSONAPI in your controllers you instantly \
+  get all basic controller actions for the model. You can override the model and serializer if \
+  the name of the controller doesn't match the model. \
+  The json formatter and errors can be used separatly."
+  spec.homepage      = "https://github.com/leizzer/act_as_jsonapi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/leizzer/act_as_jsonapi"
+  spec.metadata["changelog_uri"] = "https://github.com/leizzer/act_as_jsonapi/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+
+  spec.add_dependency "jsonapi-serializer", "~> 2.2.0"
+  spec.add_dependency "activesupport", "~> 7.0"
+  spec.add_dependency "pundit", "~> 2.1"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "act_as_jsonapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/act_as_jsonapi/controller.rb

@@ -0,0 +1,189 @@
+require "pundit"
+require_relative 'formatter'
+require_relative 'json_errors'
+
+module ActAsJsonapi
+  module Controller
+    extend ActiveSupport::Concern
+    include Formatter
+    include JSONErrors
+
+    def self.include(base)
+      base.include Pundit
+
+      base.extend ClassMethods
+    end
+
+    def index
+      authorize model
+
+      render_json_api serializer.new(_resources, serializer_options).serializable_hash
+    end
+
+    def show
+      authorize _resource
+
+      render_not_found && return if _resource.kind_of? NilClass
+
+      render_json_api serializer.new(_resource).serializable_hash
+    end
+
+    def update
+      authorize model
+
+      render_not_found && return if _resource.kind_of? NilClass
+
+      if _resource.update_attributes _resource_params
+        render_json_api serializer.new(_resource).serializable_hash, status: :reset_content
+      else
+        render_unprocessable_entity
+      end
+    end
+
+    def destroy
+      authorize _resource
+
+      _resource.destroy
+      render_json_api serializer.new(_resource).serializable_hash, status: :no_content
+    end
+
+    module ClassMethods
+      def new(*args, &block)
+        instance = super
+        instance.instance_variable_set :@model, @model if @model
+        instance.instance_variable_set :@serializer, @serializer if @serializer
+        instance
+      end
+
+      def model_set(model)
+        @model = model
+      end
+
+      def serializer_set(serializer)
+        @serializer = serializer
+      end
+    end
+
+    private
+
+    def page
+      @page ||= params[:page] || 1
+    end
+
+    def limit
+      @limit ||= params[:limit] || 10
+    end
+
+    def meta
+      @meta ||= params[:meta].eql?("true")
+    end
+
+    def filter
+      @filter ||= params[:filter] || {}
+    end
+
+    def model
+      @model ||= controller_name.classify.constantize
+    end
+
+    def serializer
+      @serializer ||= "#{model.name}Serializer".constantize
+    end
+
+    def set_resource=(val)
+      @_resource = val
+    end
+
+    def _resource
+      @_resource ||= policy_scope(model).find_by_id(params[:id])
+    end
+
+    def _resources
+      @_resources ||= apply_filter(policy_scope(model))
+        .page(page)
+        .per(limit)
+    end
+
+    def resource_params
+      params.require(:data)
+    end
+
+    def serializer_options
+      {
+        params: {meta: meta},
+        links: serializer_links,
+        meta: serializer_meta,
+        include: serializer_include
+      }
+    end
+
+    def serializer_include
+      @serializer_include ||= []
+    end
+
+    def serializer_meta
+      @serializer_meta ||= {
+        pages: { total: _resources.total_pages, current: _resources.current_page },
+        results: { total: _resources.total_count, current: _resources.size }
+      }
+    end
+
+    def serializer_links
+      @serializer_links ||= {
+        nav: {
+          self: get_link_for(:self),
+          first: get_link_for(:first),
+          last: get_link_for(:last),
+          prev: get_link_for(:prev),
+          next: get_link_for(:next)
+        }
+      }
+    end
+
+    def get_link_for(keyword)
+      case keyword
+      when :self
+        index_url(page: page, limit: limit)
+      when :first
+        index_url(page: 1, limit: limit)
+      when :last
+        index_url(page: _resources.total_pages, limit: limit)
+      when :prev
+        index_url(page: _resources.prev_page, limit: limit) unless _resources.first_page?
+      when :next
+        index_url(page: _resources.next_page, limit: limit) unless _resources.last_page?
+      end
+    end
+    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/AbcSize
+
+    def index_url(options)
+      unless ENV['HOST']
+        raise "Environment variable 'HOST' not defined"
+      end
+
+      url_for controller: controller_name,
+        action: :index,
+        host: ENV['HOST'],
+        **options
+    end
+
+    def allowed_filters
+      model.column_names
+    end
+
+    def valid_filters
+      filter.select { |_filter| allowed_filters.include? _filter }
+    end
+
+    def valid_values_from_filter(field)
+      filter[field].split(',').reject(&:blank?).map {|val| "%#{val}%" }
+    end
+
+    def apply_filter(scope)
+      valid_filters.each_pair do |field, values|
+        scope = scope.where("#{field}::text ILIKE ANY ( array[?] )", valid_values_from_filter(field))
+      end
+      scope
+    end
+  end
+end

data/lib/act_as_jsonapi/formatter.rb

@@ -0,0 +1,18 @@
+module ActAsJsonapi
+  module Formatter
+    extend ActiveSupport::Concern
+
+    # Render json response and set content type to 'application/vnd.api+json'
+    def render_json_api(serializable_hash, options = {})
+      options.merge!(json_api_content_type)
+      args = { json: serializable_hash }.merge(options)
+      render args
+    end
+
+    private
+
+    def json_api_content_type
+      { content_type: 'application/vnd.api+json' }
+    end
+  end
+end

data/lib/act_as_jsonapi/json_errors.rb

@@ -0,0 +1,65 @@
+require_relative 'status_code_response'
+require_relative 'request_error_serializer'
+
+module ActAsJsonapi
+  module JSONErrors
+    extend ActiveSupport::Concern
+
+    def serializable(error_status, detail, detail_meta)
+      StatusCodeResponse.serializable(error_status, detail, detail_meta)
+    end
+
+    def translate_detail_code(detail_code)
+      detail = I18n.t("error_messages.#{detail_code.to_s}")
+      return detail unless detail.include?("translation missing")
+      detail = I18n.t("error_messages.err_standard")
+    end
+
+    def render_error(error_status, detail_code = nil, detail_meta = nil )
+      detail = translate_detail_code(detail_code)
+      serializer = ::RequestErrorSerializer.new serializable(error_status, detail , detail_meta)
+      render_json_api serializer, status: error_status
+    end
+
+    def render_not_found
+      render_error :not_found
+    end
+
+    def render_bad_request
+      render_error :bad_request
+    end
+
+    def render_not_authorized
+      render_error :unauthorized
+    end
+
+    def render_forbidden(ex)
+      render_error :forbidden, :err_forbidden, ex.message
+    end
+
+    def render_failed_dependency
+      render_error :failed_dependency
+    end
+
+    def render_unprocessable_entity
+      render_error :unprocessable_entity
+    end
+
+    def render_service_unavailable
+      render_error :service_unavailable
+    end
+
+    def render_conflict_request
+      render_error :conflict
+    end
+
+    private
+
+    # Render json response and set content type to 'application/vnd.api+json'
+    def render_json_api(serializable_hash, options = {})
+      options[:content_type] = 'application/vnd.api+json'
+      args = { json: serializable_hash }.merge(options)
+      render args
+    end
+  end
+end

data/lib/act_as_jsonapi/jsonapi_error_serializer.rb

@@ -0,0 +1,36 @@
+require 'jsonapi/serializer'
+
+module JSONAPI
+  # This module allows serialization of custom error objects to remain compliant
+  # with JSON:API specification
+  module ErrorSerializer
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :with_root_key
+
+      include JSONAPI::Serializer
+
+      def initialize(resource, options = {})
+        if resource.is_a? StandardError
+          resource
+        else
+          resource = Array.wrap(resource)
+          resource.collect! { |res| OpenStruct.new(res) }
+        end
+        super
+        @with_root_key = options[:with_root_key] != false
+      end
+
+      def hash_for_one_record
+        serialized_hash = [super[:data].dig(:attributes)]
+        !with_root_key ? serialized_hash : { errors: serialized_hash }
+      end
+
+      def hash_for_collection
+        serialized_hash = super[:data]&.map { |err| err[:attributes] }
+        !with_root_key ? serialized_hash : { errors: serialized_hash }
+      end
+    end
+  end
+end

data/lib/act_as_jsonapi/request_error_serializer.rb

@@ -0,0 +1,39 @@
+require_relative 'jsonapi_error_serializer'
+
+# Request Error Serializer
+# Provides additional information about problems encountered while performing
+# a request operation.  The possible attributes are:
+#   +id+      a unique identifier for this particular occurrence of the problem.
+#   +title+   a short, human-readable summary of the problem
+#   +detail+  a human-readable explanation specific to this occurrence of the problem
+#   +code+    an application-specific error code, expressed as a string value.
+#   +status+  the HTTP status code applicable to this problem, expressed as a string value.
+class RequestErrorSerializer
+  include JSONAPI::ErrorSerializer
+
+  attributes  :id,
+              :title,
+              :detail,
+              :code,
+              :status,
+              :meta
+
+  # This is a generic active model error serializer that transform an
+  # ActiveModel::Errors object to a JSON:API compliant error serializer
+  # @params [ActiveModel::Errors] ActiveModel::Errors object
+  def self.from_active_model_errors(errors)
+    error_array = errors.full_messages.map do |error_msg|
+      {
+        id: SecureRandom.uuid,
+        title: error_msg,
+        detail: error_msg,
+        code: 'CLIENT400',
+        status: '400',
+        meta: {error: error_msg}
+      }
+    end
+
+    new(error_array)
+  end
+end
+

data/lib/act_as_jsonapi/status_code_response.rb

@@ -0,0 +1,41 @@
+module ActAsJsonapi
+  module StatusCodeResponse
+    SYMBOL_TO_STATUS_CODE = Rack::Utils::SYMBOL_TO_STATUS_CODE
+    STATUS_CODE_TO_SYMBOL = SYMBOL_TO_STATUS_CODE.invert
+
+    def self.serializable(error_status, detail, detail_meta)
+      if error_status.kind_of? Integer
+        serializable_from_int(error_status, detail, detail_meta)
+      else
+        serializable_from_sym(error_status, detail, detail_meta)
+      end
+    end
+
+    def self.serializable_from_int(code, detail, detail_meta)
+      code_i = code.to_i
+      error_sym = STATUS_CODE_TO_SYMBOL[code_i]
+
+      return {} unless error_sym
+
+      serializable error_sym, detail, detail_meta
+    end
+
+    def self.serializable_from_sym(error_sym, detail, detail_meta)
+      status_code = SYMBOL_TO_STATUS_CODE[error_sym]
+
+      return {} unless status_code
+      error_name = error_sym.to_s
+
+      {
+        id: SecureRandom.uuid,
+        title: error_name.gsub(/_/, ' '),
+        detail: detail,
+        code: status_code.to_s,
+        status: status_code.to_s,
+        meta: {
+          error: detail_meta
+        }
+      }
+    end
+  end
+end

data/lib/act_as_jsonapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActAsJsonapi
+  VERSION = "0.1.2"
+end

data/lib/act_as_jsonapi.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActAsJsonapi
+  require_relative "act_as_jsonapi/version"
+  require_relative "act_as_jsonapi/controller"
+  require_relative "act_as_jsonapi/formatter"
+  require_relative "act_as_jsonapi/json_errors"
+
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: act_as_jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- leizzer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Act as JSONAPI is a small and flexible gem on top of `jsonapi_serializer`.   By
+  including Act as JSONAPI in your controllers you instantly   get all basic controller
+  actions for the model. You can override the model and serializer if   the name of
+  the controller doesn't match the model.   The json formatter and errors can be used
+  separatly.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- act_as_jsonapi.gemspec
+- bin/console
+- bin/setup
+- lib/act_as_jsonapi.rb
+- lib/act_as_jsonapi/controller.rb
+- lib/act_as_jsonapi/formatter.rb
+- lib/act_as_jsonapi/json_errors.rb
+- lib/act_as_jsonapi/jsonapi_error_serializer.rb
+- lib/act_as_jsonapi/null_object.rb
+- lib/act_as_jsonapi/request_error_serializer.rb
+- lib/act_as_jsonapi/status_code_response.rb
+- lib/act_as_jsonapi/version.rb
+homepage: https://github.com/leizzer/act_as_jsonapi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/leizzer/act_as_jsonapi
+  source_code_uri: https://github.com/leizzer/act_as_jsonapi
+  changelog_uri: https://github.com/leizzer/act_as_jsonapi/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Light weight gem on top of `jsonapi_serializer` and `pundit` to keep controllers
+  DRY
+test_files: []