jsonapi_responses 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9316ce4149c0d7a3e51d384918dac5519a52ff37877d5719b96d876b99d46584
-  data.tar.gz: 1659827871a95256fd7dce04ca0abe42831c8441531fc6c78ab2a36b462c7499
+  metadata.gz: d9f6ed5b04014e832e884a2425118c2d4d1e54e14d61f4d21050d35b5f6ef152
+  data.tar.gz: bf9f7e6ea7fcc880ff5771578d9f35a996bc3122404740a7a7bd3ddb8a712d05
 SHA512:
-  metadata.gz: 333f45bcd3074895bd86528e2ae42e00f446f35e2ce25961b719fef191c8152553da5bd142608d81444a2ce873ddd819521b622bb3a68e3bd8af63015f16f75f
-  data.tar.gz: cda1a85c89d7166ad767420c7baa2acfadbfc9edabe5ada776b209c759c6d7fe2595e3a26a0eebb220352bfffa838314d2cb347054f637f208f3d24c0e2d16c1
+  metadata.gz: dfa25f35fd6297541bf8ff12e8453e3434b600156f2f1a266cc0516c0ce055fb4677a2463de9cbeb03217f0c60b32870a3a2e35c9562e4166e638607dfc1b9db
+  data.tar.gz: 968e736d4b13ab8f2e8b1903667d7131e396e3ba6b0eca66d9084ae822cd95d02569b6a5976a9e1563642d9326cd3eb20f726dad9efcc0a7f46091facc67b031

data/README.md

@@ -1,28 +1,156 @@
 # JsonapiResponses
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi_responses`. To experiment with that code, run `bin/console` for an interactive prompt.
+JsonapiResponses is a Ruby gem that simplifies API response handling by allowing multiple response formats from a single endpoint. Instead of creating separate endpoints for different data requirements, this gem enables frontend applications to request varying levels of detail using the same endpoint.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_responses'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+$ bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+$ gem install jsonapi_responses
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setup
+
+1. Include the respondable module in your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::API
+  include JsonapiResponses::Respondable
+end
+```
+
+### Creating Serializers
+
+1. Create a base serializer:
+
+```ruby
+class BaseSerializer
+  attr_reader :resource, :context
+
+  def initialize(resource, context = {})
+    @resource = resource
+    @context = context
+  end
+
+  def current_user
+    @context[:current_user]
+  end
+end
+```
+
+2. Create your model serializers with different view formats:
+
+```ruby
+class DigitalProductSerializer < BaseSerializer
+  def serializable_hash
+    case context[:view]
+    when :summary
+      summary_hash
+    when :minimal
+      minimal_hash
+    else
+      full_hash
+    end
+  end
+
+  private
+
+  def full_hash
+    {
+      id: resource.id,
+      name: resource.name,
+      description: resource.description,
+      # ... more attributes
+    }
+  end
+
+  def summary_hash
+    {
+      id: resource.id,
+      name: resource.name,
+      price: resource.price,
+      # ... fewer attributes
+    }
+  end
+
+  def minimal_hash
+    {
+      id: resource.id,
+      name: resource.name,
+      # ... minimal attributes
+    }
+  end
+end
+```
+
+### Controller Implementation
+
+Use `render_with` in your controllers to handle responses. The view parameter is automatically handled from the request params:
+
+```ruby
+class Api::V1::ProductsController < ApplicationController
+  def index
+    products = Product.includes(:categories, :attachments)
+    render_with(products)
+  end
+
+  def create
+    @product = Product.new(product_params)
+    render_with(@product)
+  end
+
+  def show
+    render_with(@product)
+  end
+
+  def update
+    @product.update(product_params)
+    render_with(@product)
+  end
+
+  def destroy
+    render_with(@product)
+  end
+
+  # Optional: Override the view if needed
+  def custom_action
+    render_with(@product, context: { view: :custom_view })
+  end
+end
+```
+
+### Making Requests
+
+You can request different view formats by adding the `view` parameter:
+
+```
+GET /api/v1/digital_products            # Returns full response
+GET /api/v1/digital_products?view=summary  # Returns summary response
+GET /api/v1/digital_products?view=minimal  # Returns minimal response
+```
+
+### Performance Benefits
+
+By allowing the frontend to request only the needed data, you can:
+- Reduce response payload size
+- Improve API performance
+- Avoid creating multiple endpoints for different data requirements
+- Optimize database queries based on the requested view
 
 ## Development
 

data/lib/jsonapi_responses/engine.rb

@@ -1,14 +1,10 @@
 # lib/jsonapi_responses/engine.rb
 require 'active_support'
+require 'rails'
+
 module JsonapiResponses
   # Define Engine
   class Engine < ::Rails::Engine
     isolate_namespace JsonapiResponses
-
-    initializer 'jsonapi_responses.initialize' do
-      Rails.application.config.to_prepare do
-        ApplicationController.include JsonapiResponses::Respondable
-      end
-    end
   end
 end

data/lib/jsonapi_responses/respondable.rb

@@ -1,17 +1,20 @@
 require 'active_support/concern'
 require 'jsonapi_responses/serializable'
+require 'jsonapi_responses/user_context_provider'
 
 module JsonapiResponses
   # Respondable module
   module Respondable
     extend ActiveSupport::Concern
     include JsonapiResponses::Serializable
+    include JsonapiResponses::UserContextProvider
 
     private
 
-    def custom_response(record, options = {})
+    def render_with(record, options = {})
       action = options[:action] || action_name.to_sym
-      context = options[:context] || {}
+      context = (options[:context] || {}).merge(serialization_user)
+      context = context.merge(view: params[:view]&.to_sym) unless context.key?(:view)
       serializer_class = "#{controller_name.singularize.camelize}Serializer".constantize
       send("respond_for_#{action}", record, serializer_class, context)
     rescue NoMethodError
@@ -42,7 +45,7 @@ module JsonapiResponses
       end
     end
 
-    def respond_for_destroy(record)
+    def respond_for_destroy(record, _, _)
       if record.destroy
         render json: { message: 'register destroyed successfully' }, status: :ok
       else

data/lib/jsonapi_responses/user_context_provider.rb

@@ -0,0 +1,10 @@
+# JsonapiResponses folder
+module JsonapiResponses
+  # Create a helper to intercept de current_user
+  module UserContextProvider
+    # Este método se incluirá en el controlador y será accesible en los serializadores
+    def serialization_user
+      { current_user: current_user }
+    end
+  end
+end

data/lib/jsonapi_responses/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_responses
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Oscar Ortega
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-20 00:00:00.000000000 Z
+date: 2025-05-19 00:00:00.000000000 Z
 dependencies: []
 description: My first gem which tries to get simplier the way you responde in your
   API
@@ -27,12 +27,12 @@ files:
 - Rakefile
 - app/models/item.rb
 - app/serializers/item_serializer.rb
-- builds/jsonapi_responses-0.1.0.gem
 - config/database.yml
 - lib/jsonapi_responses.rb
 - lib/jsonapi_responses/engine.rb
 - lib/jsonapi_responses/respondable.rb
 - lib/jsonapi_responses/serializable.rb
+- lib/jsonapi_responses/user_context_provider.rb
 - lib/jsonapi_responses/version.rb
 homepage: https://www.oortega.dev/gems
 licenses: