api_responser 1.0.0 → 1.0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81300d06901f90334a8a2f47154ca0773836b4b0a640923059b62d1e86e48eac
-  data.tar.gz: d189a7133d7679a0e788d75d21eeb7bf041166dfd0677326cdc4227c0be97cac
+  metadata.gz: adee3e3b70fb9ad9b4848000ade2e3e920119d0497ab3d427456016ca1c4e6a4
+  data.tar.gz: 18df245fb706daad93eb2130a6a4472d3686f6c3df167ba80e25f8a0d60e9838
 SHA512:
-  metadata.gz: 332bc07fd3079cb4c7bb8743609a146dac88e225bf5c71ecb5f94456b3b34794cb66bc0a7c82468fa2b4b8f46e3a9fd58313a5dc8f733a8fa88d139f63d1af7d
-  data.tar.gz: da4e7d004677798c5ac679c31af48c5fa413ade46f12bdc69cceefa0b3abb56a804b305c44a951673a257bafa69b9a1e8cb8276c54a8f49d738b48df58668672
+  metadata.gz: 1bf274f302575673ef57194ffca8bf312ebbcaa7411cd3ba12c846275fbc30884b34b33f2de024884f95641d40d4f0426eaf4162726b20f1e5a125c424ab3126
+  data.tar.gz: 302d3c281bc263de67aa3d477b843f4ed7e473526f057cb92488aae5519124a43ff34dc175050276174d03ad8b39b05e83a2f50bacdbbb1c4e028f7347e70d60

data/app/views/api_responser/error.json.erb

@@ -1 +1 @@
-{"status":"error","code":<%= @code %>,"message":"<%= @message %>"}
+{"data": {"status":"error","code":<%= @code %>,"message":"<%= @message %>"}}

data/app/views/api_responser/success.json.erb

@@ -1 +1 @@
-{"status":"success","code":<%= @code %>,"message":"<%= @message %>","records":<%= @records.to_json %>,"records_count":<%= @records_count %>}
+{"data": {"status":"success","code":<%= @code %>,"message":"<%= @message %>","records":<%= @records.to_json %>,"records_count":<%= @records_count %>}}

data/lib/api_responser.rb

@@ -11,16 +11,28 @@ module ApiResponser
     success_render(code: 200, message: i18n_message(__method__, status:"success"), records: records)
   end
 
-  def record_created
-    api_success(code: 201)
+  def record_created(records = nil)
+    if records.nil?
+      api_success(code: 201)
+    else
+      success_render(code: 201, message: i18n_message(__method__, status:"success"), records: records)
+    end
   end
 
-  def record_updated
-    api_success(code: 204)
+  def record_updated(records = nil)
+    if records.nil?
+      api_success(code: 204)
+    else
+      success_render(code: 204, message: i18n_message(__method__, status:"success"), records: records)
+    end
   end
 
-  def record_deleted
-    api_success(code: 204)
+  def record_deleted(records = nil)
+    if records.nil?
+      api_success(code: 204)
+    else
+      success_render(code: 204, message: i18n_message(__method__, status:"success"), records: records)
+    end
   end
 
   # Error responses
@@ -48,8 +60,8 @@ module ApiResponser
     error_render(code: 400, message: i18n_message(__method__, status:"error"), debug_message: debug_message, report:report)
   end
 
-  def unauthorized(debug_message = "", report:false)
-    error_render(code: 401, message: i18n_message(__method__, status:"error"), debug_message: debug_message, report:report)
+  def unauthorized(debug_message = "", message: nil,report:false)
+    error_render(code: 401, message: message.nil? ? i18n_message(__method__, status:"error") : message, debug_message: debug_message, report:report)
   end
 
   def forbidden(debug_message = "", report:false)
@@ -105,7 +117,7 @@ module ApiResponser
     @message = message
     @records = records
     @records_count = determine_records_count(records, records_count)
-    {json:ERB.new(file_read("success")).result(binding), status: code}
+    {json: ERB.new(file_read("success")).result(binding), status: code}
   end
 
   def error_render(code: 500, message: "", debug_message: "", report: false)

data/readme.md

@@ -122,12 +122,13 @@ def record_not_deleted(message, debug_message = "", report:false)
 The *debug_message* argument is optional.\
 The *report* argument is optional and is useful if you would like to handle *debug_message*.\
 The *debug_message* is useful for providing the real reason for the error (if *report* is **true**). 
+The *message* argument is optional and is useful if you would like to provide your custom message. For example "Incorrect login or password"
 
 ```ruby
 def bad_request(debug_message = "", report:false)
 ```
 ```ruby
-def unauthorized(debug_message = "", report:false)
+def unauthorized(debug_message = "", message:nil, report:false)
 ```
 ```ruby
 def forbidden(debug_message = "", report:false)
@@ -144,7 +145,7 @@ Templates should be located in **app/views/api_responser/**
 The default templates are:
 #### success.json.erb
 ``` ruby
-{
+"data":{
   "status": "success",
   "code": <%= @code %>,
   "message": "<%= @message %>",
@@ -154,7 +155,7 @@ The default templates are:
 ```
 ####  error.json.erb
 ``` ruby
-{
+"data":{
   "status": "error",
   "code": <%= @code %>,
   "message": "<%= @message %>"
@@ -165,7 +166,7 @@ The default templates are:
 The gem provides a default error handler in **ApiResponserHelper**:
 ``` ruby
 module ApiResponserHelper
-  def error_handling(code: nil, debug_message: nil, message: nil)
+  def self.error_handling(code: nil, debug_message: nil, message: nil)
     Logger.new(STDOUT).fatal("Error with code #{code}. Debug message: #{debug_message}. Message: #{message}")
   end
 end
@@ -183,8 +184,13 @@ Default localization located in config/locale/en.yml
 
 ## Example
 ```ruby
+
 class ApplicationController < ActionController::Base
+  #include ApiResponser in ApplicationController
   include ApiResponser
+end
+
+class SomeController < ApplicationController
   before_action do
     set_model_variable("ModelName")
   end  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_responser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.0.8
 platform: ruby
 authors:
 - Nazim Mehdiyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 description: "\n    The api_responser gem provides a standardized way to handle API
   responses in a Rails application. \n    It includes methods for rendering success
   and error responses, making it easier to manage and maintain \n    consistent response