mini_api 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d964fdc02d20eb94726fd7ce97316402f97369aa0639f6ae8f4c4761d1359ed4
-  data.tar.gz: 76c2ac644e655cec1b23199c843c56008b23730e671d40499dac66c305f34f6f
+  metadata.gz: 3fbf83309b4f2fccd1e62e7e53cb0bf955472f68f1aa0a5a57517976c478fc97
+  data.tar.gz: 343a0d838eeb146e2c35dd7a483872825b330caa0afd54267ed34e9fe164f13a
 SHA512:
-  metadata.gz: a84f16e06ce682471041e1a6c03cc9d991f482db377854cd0c6a533b570867654bf77cea9e7074a8a5ee2f7f219ae3fb22d192dc8ad3d8ac4bdc0b4b0cc57fe2
-  data.tar.gz: 85d339e62fa8195be1d02289e6fb00759b1a401cc428029a2cae6deb39403d24cf34f487bc21f493eed3d67c8f904f1ffbeb139f8191946490c7065ae53821f7
+  metadata.gz: 76fa5b3615b1a7dee108f5c236356398cde720a9f281314c3dca45616eaf4cc1d7c0baf5a02b991219bfb7d49c7937f43a2a29514749d064ec4b4ad33d55aa92
+  data.tar.gz: ee55e68cde7652108534bd1d62c9462303b64e92b62be836b240cacb4cb1354983e7818d46dbe25da61ea7c69f638201b27c393498a076609433e94c069e44ff

data/README.md

@@ -1,6 +1,6 @@
 ![](https://github.com/leoncruz/api-responder/actions/workflows/tests.yml/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ec2939be693459b7ce4d/maintainability)](https://codeclimate.com/github/leoncruz/api-responder/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ec2939be693459b7ce4d/test_coverage)](https://codeclimate.com/github/leoncruz/api-responder/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6ed70a7ed0d28e32b56c/maintainability)](https://codeclimate.com/github/leoncruz/mini_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6ed70a7ed0d28e32b56c/test_coverage)](https://codeclimate.com/github/leoncruz/mini_api/test_coverage)
 
 # Mini Api
 A gem to standardize json responses in Rails applications, highly inspired on [Responders](https://github.com/heartcombo/responders)
@@ -8,7 +8,10 @@ A gem to standardize json responses in Rails applications, highly inspired on [R
 ## Table of Contents
 - [Usage](#usage)
   - [Respondering json](#respondering-json)
+  - [Data Serialization](#data-serialization)
   - [Success and failure actions](#success-and-failure-actions)
+  - [Errors](#errors)
+  - [Message](#message)
   - [Transform keys](#transform-keys)
 - [Overriding response](#overriding-response)
 - [Pagination](#pagination)
@@ -28,7 +31,6 @@ $ bundle
 ```
 
 You must install [Kaminari](https://github.com/kaminari/kaminari) to handle pagination
-and [Active Model Serializers](http://github.com/rails-api/active_model_serializers) to handle data serialization
 
 ## Usage
 
@@ -90,6 +92,22 @@ The response will be like:
 }
 ```
 
+### Data Serialization
+
+This gem is integrated to [Alba](https://github.com/okuramasafumi/Alba) to create your `resources`. A simple resource example:
+```ruby
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name, :email
+end
+```
+When the `render_json` methods receive an instance of `user` or a `ActiveRecord::Relation` of `users` will search by `UserResource`.
+
+If you have a nested controller like: `Api::V1::UsersController`, `mini_api` will search by resources in controller namespace.
+First will search per `Api::V1::UserResource`, after `Api::UserResource` and then `UserResource` until find.
+That way, even if your `controller` and `resource` are defined in different namespace levels, `MiniApi` will find.
+
 ### Success and failure actions
 
 Many times, our controller actions need to persist or validate some data coming from request, the default approach to do that is like:
@@ -142,6 +160,50 @@ The `message` key is different based on actions on informed model: create, updat
 
 You can respond any type of data, but ActiveRecord/ActiveModel::Model and ActiveRecord::Relation has a special treatment as shown above
 
+### Errors
+To show errors of a model, by default will use the `errors.messages` method, but `MiniApi` adds an ability to `Alba` to create a error resource
+as a nested class in your resource. Example:
+
+```ruby
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name, :email
+
+  class Error
+    include Alba::Resource
+
+    attribute :user do
+      object.errors.full_messages
+    end
+  end
+end
+```
+The response will be like:
+```json
+{
+  "success": false,
+  "errors": {
+    "user": ["First name can't be blank"]
+  },
+  "message": "User could not be created."
+}
+```
+You can create serializers for non `ActiveRecord` and add a nested `Error` class too
+
+### Message
+
+The `I18n` path for the key `message` is `mini_api.messages.actions`, the controller action name and the `notice` for success actions
+or `alert` for failure actions. Example `mini_api.messages.actions.create.notice`
+
+By default support the actions: `create`, `update` and `delete`, but you can add more actions to translate
+
+You can add translation based on models, changing the `action` key for your model name. Example:
+`mini_api.messages.model_name.create.alert`. With this, is more easy personalize messages
+
+It is possible define a translation based on controller, useful if you use nested controlers. The path is:
+`min_api.messages.controller_name.action_name.alert`
+
 ### Transform keys
 
 It is possible to transform the keys of request and response. By default, will transform to `snake_case`, but the possible values are `snake_case`, `camel_lower` and `camel_case`

data/lib/mini_api/default_responder.rb

@@ -15,11 +15,18 @@ module MiniApi
 
       data = transform_keys
 
+      body =
+        if success
+          { data: data }
+        else
+          { errors: data }
+        end
+
       @controller.render(
         json: {
           success: success,
-          data: data,
-          message: @options[:message] || nil
+          message: @options[:message] || nil,
+          **body
         },
         status: @options[:status] || :ok
       )

data/lib/mini_api/model_responder.rb

@@ -2,11 +2,13 @@
 
 require 'mini_api/serialization'
 require 'mini_api/case_transform'
+require 'mini_api/translation/message'
 
 module MiniApi
   # class to handle json render of ActiveRecord::Base instances and ActiveModel::Model's
   class ModelResponder
     include Serialization
+    include Translation::Message
 
     def initialize(controller, resource, options = {})
       @controller = controller
@@ -17,20 +19,16 @@ module MiniApi
     def respond
       body = {
         success: resource_has_errors? == false,
-        message: @options[:message] || default_message
+        message: @options[:message] || message
       }
 
       body =
         if resource_has_errors?
-          { errors: @resource.errors.messages }.merge(body)
+          errors.merge(body)
         else
           { data: serialiable_body(@resource).as_json }.merge(body)
         end
 
-      # This is for an problem with ActiveModelSerializer that adds an error
-      # attribute when resource is an ActiveModel instance
-      body[:data] = body[:data].except('errors') if body[:data]&.key?('errors')
-
       body = CaseTransform.response_keys(body)
 
       @controller.render json: body, status: status_code
@@ -42,6 +40,14 @@ module MiniApi
       !@resource.errors.empty?
     end
 
+    def errors
+      error_serializer = get_error_serializer(@resource)
+
+      return { errors: @resource.errors.messages } unless error_serializer
+
+      { errors: error_serializer.new(@resource).as_json }
+    end
+
     def status_code
       return @options[:status] if @options[:status].present?
 
@@ -54,17 +60,6 @@ module MiniApi
       :ok
     end
 
-    def default_message
-      kind = resource_has_errors? ? 'alert' : 'notice'
-
-      I18n.t(
-        kind,
-        scope: [:mini_api, :messages, :actions, @controller.action_name],
-        resource_name: @resource.class.model_name.human,
-        default: ''
-      )
-    end
-
     def previously_new_record?
       return true if @resource.is_a?(ActiveRecord::Base) && @resource.previously_new_record?
 

data/lib/mini_api/serialization.rb

@@ -1,16 +1,50 @@
 # frozen_string_literal: true
 
-module MiniApi
-  #
-  # This module is responsible to handler integration with Active Model Serialier gem
-  # call the +get_serializer+ method of controller implemented by gem
-  # to find the serializer of informed object.
+require 'alba'
 
+module MiniApi
   module Serialization
+    # This method search by serializer using the module parents of controller.
+    # With this, is possible define serializers for the same resource
+    # in different controller scopes
     def serialiable_body(resource)
-      return resource unless defined?(ActiveModel::Serializer)
+      controller_scope = @controller.class.module_parents
+
+      resource_class =
+        if resource.respond_to?(:model)
+          resource.model
+        else
+          resource.class
+        end
+
+      serializer_class =
+        loop do
+          serializer_class =
+            "#{controller_scope.first}::#{resource_class}Resource".safe_constantize
+
+          break serializer_class if serializer_class
+
+          break DefaultResource if controller_scope.empty?
+
+          controller_scope.shift
+        end
+
+      serializer_class.new(resource)
+    end
+
+    # Search by the nested class +Error+ on serializer
+    # Follow the same steps for +get_serializer+
+    def get_error_serializer(resource)
+      error_serializer = serialiable_body(resource)
+
+      return unless error_serializer
+
+      "#{error_serializer.class}::Error".safe_constantize
+    end
 
-      @controller.get_serializer(resource)
+    # Empty serializer class for when resource does not have a custom class
+    class DefaultResource
+      include Alba::Resource
     end
   end
 end

data/lib/mini_api/translation/message.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module MiniApi
+  module Translation
+    # Module to handle the +message+ key on json response.
+    # Will identify if model has errors or not and define the I18n path to +notice+, for model without errors
+    # and +alert+ for model with errors.
+    # There is three possible path for messages:
+    #
+    # The path based on model name
+    # mini_api:
+    #   messages:
+    #     model_name:
+    #       action_name:
+    #         notitce:
+    #         alert:
+    #
+    # The path based on controller name
+    # mini_api:
+    #   messages:
+    #     controller:
+    #       controller_name:
+    #         action_name:
+    #           notitce:
+    #           alert:
+    #
+    # And the last, is per action path:
+    # mini_api:
+    #   messages:
+    #     actions:
+    #       create:
+    #         notice: '%{resource_name} foi criado com sucesso.'
+    #         alert: '%{resource_name} não pôde ser criado.'
+
+    module Message
+      def message
+        kind = @resource.errors.empty? ? 'notice' : 'alert'
+
+        I18n.t(
+          kind,
+          scope: model_message_path || controller_message_path || default_message_path,
+          resource_name: @resource.class.model_name.human,
+          default: ''
+        )
+      end
+
+      private
+
+      def model_message_path
+        model_path = "mini_api.messages.#{@resource.model_name.i18n_key}.#{@controller.action_name}"
+
+        model_path if I18n.exists? model_path
+      end
+
+      def controller_message_path
+        controller_path =
+          "mini_api.messages.controller.#{@controller.controller_name}.#{@controller.action_name}"
+
+        controller_path if I18n.exists? controller_path
+      end
+
+      def default_message_path
+        ['mini_api', 'messages', 'actions', @controller.action_name].join('.')
+      end
+    end
+  end
+end

data/lib/mini_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniApi
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mini_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Leon Cruz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: alba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +60,7 @@ files:
 - lib/mini_api/relation_responder.rb
 - lib/mini_api/responder.rb
 - lib/mini_api/serialization.rb
+- lib/mini_api/translation/message.rb
 - lib/mini_api/version.rb
 homepage:
 licenses: