mini_api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a8f16f154f4f5c49499da422027fefd65c8c89b19ef9b59aef90dcf2f13f8c
-  data.tar.gz: 061a3a10595c82455343eab9c59f4bcf2a734ec5a2a04d69bd8ac5575b682096
+  metadata.gz: d964fdc02d20eb94726fd7ce97316402f97369aa0639f6ae8f4c4761d1359ed4
+  data.tar.gz: 76c2ac644e655cec1b23199c843c56008b23730e671d40499dac66c305f34f6f
 SHA512:
-  metadata.gz: f295a7cf808f32dc15f06766259116e95f66e4ca7143777a4d32b20c6f11cb2e33a71355e474ac29d8c46e529cf1e4dc481fe9a1a1027f72ab4e0488116bcdaf
-  data.tar.gz: 85dc53237ece21101a3dd3ffd346e42e52327dabd3f06cc0592452cc69437fe95b5941f77913642c1ce61c33a359161edb08445a4d065bb929b401bb2cdf33c3
+  metadata.gz: a84f16e06ce682471041e1a6c03cc9d991f482db377854cd0c6a533b570867654bf77cea9e7074a8a5ee2f7f219ae3fb22d192dc8ad3d8ac4bdc0b4b0cc57fe2
+  data.tar.gz: 85d339e62fa8195be1d02289e6fb00759b1a401cc428029a2cae6deb39403d24cf34f487bc21f493eed3d67c8f904f1ffbeb139f8191946490c7065ae53821f7

data/README.md

@@ -3,12 +3,13 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/ec2939be693459b7ce4d/test_coverage)](https://codeclimate.com/github/leoncruz/api-responder/test_coverage)
 
 # Mini Api
-A gem to standardize json responses in Rails applications, highly inspired on [Responders](https:github.com/heartcombo/responders)
+A gem to standardize json responses in Rails applications, highly inspired on [Responders](https://github.com/heartcombo/responders)
 
 ## Table of Contents
 - [Usage](#usage)
   - [Respondering json](#respondering-json)
   - [Success and failure actions](#success-and-failure-actions)
+  - [Transform keys](#transform-keys)
 - [Overriding response](#overriding-response)
 - [Pagination](#pagination)
 - [Contributing](#contributing)
@@ -141,6 +142,20 @@ 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
 
+### 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,32 @@ module MiniApi
     def respond
       success = @options[:success] != false
 
+      data = transform_keys
+
       @controller.render(
         json: {
           success: success,
-          data: @resource,
+          data: data,
           message: @options[:message] || nil
         },
         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
@@ -23,9 +24,15 @@ module MiniApi
         if resource_has_errors?
           { errors: @resource.errors.messages }.merge(body)
         else
-          { data: serialiable_body(@resource) }.merge(body)
+          { 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
     end
 
@@ -40,9 +47,9 @@ module MiniApi
 
       return :unprocessable_entity if resource_has_errors?
 
-      return :created if @resource.previously_new_record?
+      return :created if previously_new_record?
 
-      return :no_content unless @resource.persisted?
+      return :no_content if destroyed?
 
       :ok
     end
@@ -57,5 +64,17 @@ module MiniApi
         default: ''
       )
     end
+
+    def previously_new_record?
+      return true if @resource.is_a?(ActiveRecord::Base) && @resource.previously_new_record?
+
+      false
+    end
+
+    def destroyed?
+      return true if @resource.is_a?(ActiveRecord::Base) && !@resource.persisted?
+
+      false
+    end
   end
 end

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 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.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Leon Cruz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-17 00:00:00.000000000 Z
+date: 2023-06-19 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