mini_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d964fdc02d20eb94726fd7ce97316402f97369aa0639f6ae8f4c4761d1359ed4
-  data.tar.gz: 76c2ac644e655cec1b23199c843c56008b23730e671d40499dac66c305f34f6f
+  metadata.gz: bf126960ba6eec18c20dcf69715848c827eef16840540c45fe0d76fc1a61341c
+  data.tar.gz: 69caf5e66fdacee7e9b5a4c5271387e0823f6f10f90373b9cdd149966563ad3f
 SHA512:
-  metadata.gz: a84f16e06ce682471041e1a6c03cc9d991f482db377854cd0c6a533b570867654bf77cea9e7074a8a5ee2f7f219ae3fb22d192dc8ad3d8ac4bdc0b4b0cc57fe2
-  data.tar.gz: 85d339e62fa8195be1d02289e6fb00759b1a401cc428029a2cae6deb39403d24cf34f487bc21f493eed3d67c8f904f1ffbeb139f8191946490c7065ae53821f7
+  metadata.gz: 11a71582b7e0ed144cc0d3256dabc4c2e7f2f459c81459f2d809af16ddd02de0ee9ec9af45cdc6fbaae4d2c809857148b668e47186c0c110a1b708153f687373
+  data.tar.gz: c34d2b7773016ccd2328778d1d8b9a9be5cca14c403684b3870dfe47d3fe5988ae3acad1ec0bcb2453468304b4a329e16a35aa7f72efec48f64d9da1ca2fcf19

data/README.md

@@ -9,6 +9,8 @@ A gem to standardize json responses in Rails applications, highly inspired on [R
 - [Usage](#usage)
   - [Respondering json](#respondering-json)
   - [Success and failure actions](#success-and-failure-actions)
+  - [Errors](#errors)
+  - [Message](#message)
   - [Transform keys](#transform-keys)
 - [Overriding response](#overriding-response)
 - [Pagination](#pagination)
@@ -142,6 +144,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 `active_model_serializers` to create a error serializer
+as a nested class in your serializer. Example:
+```ruby
+class UserSerializer < ActiveModel::Serializer
+  attributes :id, :first_name, :last_name
+
+  class Error < ActiveModel::Serializer
+    attributes :user
+
+    def user
+      {
+        first_name: object.errors[:first_name],
+        last_name: object.errors[:last_name],
+      }
+    end
+  end
+end
+```
+The response will be like:
+```json
+{
+  "success": false,
+  "errors": {
+    "user": {
+      "first_name": "can't be blank",
+      "last_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
+
 ### 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

@@ -22,7 +22,7 @@ module MiniApi
 
       body =
         if resource_has_errors?
-          { errors: @resource.errors.messages }.merge(body)
+          errors.merge(body)
         else
           { data: serialiable_body(@resource).as_json }.merge(body)
         end
@@ -42,6 +42,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?
 
@@ -57,12 +65,23 @@ module MiniApi
     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: ''
-      )
+      model_path = "mini_api.messages.#{@resource.model_name.i18n_key}"
+
+      if I18n.exists? model_path
+        I18n.t(
+          kind,
+          scope: "#{model_path}.#{@controller.action_name}",
+          resource_name: @resource.class.model_name.human,
+          default: ''
+        )
+      else
+        I18n.t(
+          kind,
+          scope: [:mini_api, :messages, :actions, @controller.action_name],
+          resource_name: @resource.class.model_name.human,
+          default: ''
+        )
+      end
     end
 
     def previously_new_record?

data/lib/mini_api/serialization.rb

@@ -12,5 +12,11 @@ module MiniApi
 
       @controller.get_serializer(resource)
     end
+
+    def get_error_serializer(resource)
+      serializer_class = @controller.get_serializer(resource)
+
+      "#{serializer_class.serializer}::Error".safe_constantize
+    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.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Leon Cruz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails