jsonapi_responses 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90ed37460147f9a795a6297a734d47b55a7bcb4bcbb98025c294684fc9ad56c9
-  data.tar.gz: cbac58151075f09b2b62a2cecf921722f476970c6ac3ea3013869038fea9386e
+  metadata.gz: e111bc098643181daa0fe2da8c85c2fd2bc0d67f5814445312c04e505b59109b
+  data.tar.gz: 5d8d3588735b9a009e0bca5491145941b35a899c979b8076901c1088e92a3db4
 SHA512:
-  metadata.gz: bd2261e66bc0f85192da72a1a6386bac3623776e32b0dba1708c9d57cb001a3f990dbbede2c34125af9eefe2fe4bb8366f0f7bab359bf2ee971b402fa09487cc
-  data.tar.gz: 6af64f7c8dc1ac440a3b8ca1acec86bf18556cad62b0dab4fe59689431e86d3a54cc1d6ce306170e9a1eaf22f5496eb450a953fef6d5c34754cbf6a607213c22
+  metadata.gz: 74700984e823853a22dbf34c9fd50b48f66adfbc05e9789e31e4e534fd25ec8f6d62c30173e0facb54969175d025b6c97a31ebde6c77bbf56b21b4449da1ced6
+  data.tar.gz: cfdafe5edba8bea145fd890ff03175b1597aff1e51b8738b8880c0c65b1d92e598261e579a120a74e7912b4aa8833b90b14ce254f1ddb4e05d345afdd37f5c49

data/CODE_OF_CONDUCT.md

@@ -59,8 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+reported to the community leaders responsible for enforcement by opening an issue at https://github.com/oortega14/jsonapi_responses/issues.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

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

@@ -14,6 +14,7 @@ module JsonapiResponses
     def render_with(record, options = {})
       action = options[:action] || action_name.to_sym
       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

data/lib/jsonapi_responses/version.rb

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

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_responses
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Oscar Ortega
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-28 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
+description: JsonapiResponses simplifies API response handling by allowing multiple
+  response formats from a single endpoint, improving performance and reducing endpoint
+  duplication
 email:
 - ortegaoscar14@gmail.com
 executables: []
@@ -40,7 +41,11 @@ licenses:
 metadata:
   homepage_uri: https://www.oortega.dev/gems
   source_code_uri: https://github.com/oortega14/jsonapi_responses
+  documentation_uri: https://github.com/oortega14/jsonapi_responses#readme
   changelog_uri: https://github.com/oortega14/jsonapi_responses/blob/main/CHANGELOG.md
+  maintainer: Oscar Ortega
+  owner: Oscar Ortega
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -59,5 +64,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
-summary: A simple way to respond with JSON in an API
+summary: A simple way to handle multiple JSON response formats in Rails APIs
 test_files: []