rails_api_response 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3485708caa34322f2416eed7749890e004f44d
-  data.tar.gz: 3fb33a780733351f370219949e5cfa7bd52f064d
+  metadata.gz: c6d9be4a0aaa2bf0b0e478d2936fddcc5630779c
+  data.tar.gz: 82144d92f08778ce572927128fe5e73e01ddadc0
 SHA512:
-  metadata.gz: c40a93ef967a197e5bb44e5fe5567507439c0a89e72aed3e260074f1fdea928b3a891ecedcbd30bb7342177afe304a25c15a3fde027b4ec19818d68e9ff01392
-  data.tar.gz: b495356b589b14e63ff0322756927c48fee8eb194523dfa1b58f788f71ef5d59c6dbe4fcda76bcaab86f064afe6f8b381bc31aa8363b0b3dbaafd5304023d396
+  metadata.gz: 10de55f39939989213d726cb1c88d86af60924b106b7dd0366a4b861444a4413cea0e2af8976b32058276e69c5029e5711124a4d2a97a8af8b40b28a8f37f9cc
+  data.tar.gz: 6ac818c31773010cea83b8f81c8964553c51dd42b97e1b1b80be8a270a78b5e1088e793d7c6d45c6f043bdab4cc9e25e3034c3856fe6657ec9fac93a320e0579

data/README.md

@@ -2,8 +2,6 @@
 
 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/rails_api_response`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +20,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add the line `include RailsApiResponse::ControllerHelpers::Responses` to the controller where you want to you response format. (Recommended: base or application controller).
+
+Response success: `respond_success message: "Create user successfully", data: {}`.
+
+Response error: `respond_error message: "Create user failed", data: {}` or `respond_error instance: @user, data: {}` (with instance param, the format will be got from errors and full message from instance.
+
+Response with customer code: `respond_json code: 200, message: "", data: {}`.
+
+The last format will be always `{ code: 200, metadata: { message: '' }, data: {} }`
 
 ## Development
 

data/lib/rails_api_response/controller_helpers/responses.rb

@@ -12,6 +12,10 @@ module RailsApiResponse
         render json: ResponseTemplate.error(metadata, data)
       end
 
+      def respond_exception_error(exception:, data: {})
+        render json: ResponseTemplate.error(error_exception_metadata(exception), data)
+      end
+
       def respond_create_success(message: "", data: {})
         render json: ResponseTemplate.create_success(message_metadata(message), data)
       end
@@ -45,6 +49,14 @@ module RailsApiResponse
         }
       end
 
+      # Convert exception to metadata
+      def error_exception_metadata(exception)
+        {
+            message: exception.message,
+            error_details: exception.backtrace
+        }
+      end
+
       # Convert message text to error metadata
       def message_metadata(message)
         { message: message }

data/lib/rails_api_response/version.rb

@@ -1,3 +1,3 @@
 module RailsApiResponse
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_response
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Vinh Chau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler