mini_api 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6068dbc415de617d267b2e42d438eb85f36fdbbf0d083cf63efe86042130f96
-  data.tar.gz: 31f694de691b4c4d271d0d38273a5df7476aa6bb2118ecceadeca639ca7883f9
+  metadata.gz: bf126960ba6eec18c20dcf69715848c827eef16840540c45fe0d76fc1a61341c
+  data.tar.gz: 69caf5e66fdacee7e9b5a4c5271387e0823f6f10f90373b9cdd149966563ad3f
 SHA512:
-  metadata.gz: 287a2711d205b18d07fb6295e36bf132ef64953aa6d91a2f2f8699fdecaf82cc5fe0cd3a2292235f523ecf36ce6983c40b6d99a3a5d89418fe295ef4c834275c
-  data.tar.gz: 8045d230ca7765a976b34ec73b5fe9020bdf7b40f662de12a1e1b5a0e72cd2c446c3d859f91e0921467c179eb6a6b0aa2fdc2af39dc3ba169586937775934d2f
+  metadata.gz: 11a71582b7e0ed144cc0d3256dabc4c2e7f2f459c81459f2d809af16ddd02de0ee9ec9af45cdc6fbaae4d2c809857148b668e47186c0c110a1b708153f687373
+  data.tar.gz: c34d2b7773016ccd2328778d1d8b9a9be5cca14c403684b3870dfe47d3fe5988ae3acad1ec0bcb2453468304b4a329e16a35aa7f72efec48f64d9da1ca2fcf19

data/README.md

@@ -9,6 +9,9 @@ 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)
 - [Contributing](#contributing)
@@ -141,6 +144,64 @@ 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`
+
+To change the transform operation, simply adds a initializer on initilizations folder with content:
+```ruby
+MiniApi::Config.configure do |config|
+  config.transform_params_keys_to = :snake_case
+  config.transform_response_keys_to = :camel_lower
+end
+```
+The option `transform_params_keys_to` will transform request params.
+The option `transform_response_keys_to` will transform responses.
+
 ## Overriding response
 
 You can override the `status`, `message` and `sucess` keys simply informing values to `render_json`. Example:

data/lib/mini_api/case_transform.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'mini_api/config'
+require 'mini_api/exceptions/case_transform_option_invalid'
+
+module MiniApi
+  module CaseTransform
+    module_function
+
+    def transform(object, transform_to = :snake_case)
+      object.deep_transform_keys do |key|
+        case transform_to
+        when :camel_case
+          key.to_s.camelize
+        when :camel_lower
+          key.to_s.camelize(:lower)
+        when :snake_case
+          key.to_s.underscore
+        else
+          raise CaseTransformOptionInvalid, "option #{transform_to} is not supported."
+        end
+      end
+    end
+
+    def request_params_keys(params)
+      transform(params, Config.transform_params_keys_to)
+    end
+
+    def response_keys(response)
+      transform(response, Config.transform_response_keys_to)
+    end
+  end
+end

data/lib/mini_api/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MiniApi
+  class Config
+    include ActiveSupport::Configurable
+
+    # permitted values are: [:camel_case, :camel_lower, snake_case]
+    config_accessor :transform_params_keys_to, instance_accessor: false, default: :snake_case
+    config_accessor :transform_response_keys_to, instance_accessor: false, default: :snake_case
+  end
+end

data/lib/mini_api/default_responder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'mini_api/case_transform'
+
 module MiniApi
   class DefaultResponder
     def initialize(controller, resource, options = {})
@@ -11,14 +13,39 @@ module MiniApi
     def respond
       success = @options[:success] != false
 
+      data = transform_keys
+
+      body =
+        if success
+          { data: data }
+        else
+          { errors: data }
+        end
+
       @controller.render(
         json: {
           success: success,
-          data: @resource,
-          message: @options[:message] || nil
+          message: @options[:message] || nil,
+          **body
         },
         status: @options[:status] || :ok
       )
     end
+
+    private
+
+    def transform_keys
+      return CaseTransform.response_keys(@resource) if @resource.is_a?(Hash)
+
+      return @resource unless @resource.is_a?(Array)
+
+      @resource.map do |item|
+        if item.is_a?(Hash)
+          CaseTransform.response_keys(item)
+        else
+          item
+        end
+      end
+    end
   end
 end

data/lib/mini_api/exceptions/case_transform_option_invalid.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MiniApi
+  class CaseTransformOptionInvalid < StandardError; end
+end

data/lib/mini_api/model_responder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'mini_api/serialization'
+require 'mini_api/case_transform'
 
 module MiniApi
   # class to handle json render of ActiveRecord::Base instances and ActiveModel::Model's
@@ -21,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
@@ -30,6 +31,8 @@ module MiniApi
       # 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
     end
 
@@ -39,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?
 
@@ -54,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/relation_responder.rb

@@ -2,6 +2,7 @@
 
 require 'mini_api/exceptions/kaminari_not_installed'
 require 'mini_api/serialization'
+require 'mini_api/case_transform'
 
 module MiniApi
   class RelationResponder
@@ -16,6 +17,10 @@ module MiniApi
     def respond
       meta, collection = extract_meta_and_collection
 
+      meta = CaseTransform.response_keys(meta)
+
+      collection = transform_case(collection.as_json)
+
       @controller.render json: {
         success: @options[:success] || true,
         data: collection,
@@ -40,6 +45,10 @@ module MiniApi
       ]
     end
 
+    def transform_case(collection)
+      collection.map { |item| CaseTransform.response_keys(item) }
+    end
+
     def transform_resource_to_collection
       unless defined?(Kaminari)
         raise KaminariNotInstalled, 'The Kaminari gem is not installed. Install to perform pagination operations'

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.2'
+  VERSION = '0.1.4'
 end

data/lib/mini_api.rb

@@ -2,9 +2,23 @@
 
 require 'mini_api/railtie'
 require 'mini_api/responder'
+require 'mini_api/case_transform'
 
 # Entrypoint module
 module MiniApi
+  extend ActiveSupport::Concern
+
+  included do
+    include CaseTransform
+
+    before_action :transform_params
+
+    def transform_params
+      self.params =
+        ActionController::Parameters.new(CaseTransform.request_params_keys(request.parameters))
+    end
+  end
+
   def render_json(resource, options = {})
     responder = Responder.new(self, resource, options)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  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
@@ -35,7 +35,10 @@ files:
 - README.md
 - Rakefile
 - lib/mini_api.rb
+- lib/mini_api/case_transform.rb
+- lib/mini_api/config.rb
 - lib/mini_api/default_responder.rb
+- lib/mini_api/exceptions/case_transform_option_invalid.rb
 - lib/mini_api/exceptions/kaminari_not_installed.rb
 - lib/mini_api/locales/en.yml
 - lib/mini_api/model_responder.rb