error_responder 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0f03a0c2ca978d3cf0c46b0279831fe688e3168
-  data.tar.gz: 93b6c5e5214ada20ef702b958c5c7d098ce83a75
+  metadata.gz: fe2e88742a39fd8c0f5e8474bd4779b850ee53ba
+  data.tar.gz: 3d6bd8e66527e3e337b5f28945e2b5c2f88d1362
 SHA512:
-  metadata.gz: daeacff19b90d5f0fd689dd3b910aceddc7faa38c32db0241fd91308076b403163ebd61c04caea48cdf163184a03e00bc85d84987f5af1b1a2b0d1e9d1fe4858
-  data.tar.gz: 36bb15c49d6ec472530366565a2b09469e6a3222db12be6e829ba558c47e19d6fbe873d885fc5ad790361b7b374601794676252a89f37df12f365c4aa1f30147
+  metadata.gz: bdb111b60d949383bf999df88fad59e02af215b8e68c46b1e619d831b28e024d46e80cdf6594289b26c9aec749cb9a7c133ee00771c414df996f7ce97ee49de2
+  data.tar.gz: 3ea3a397c7da9f9671f0d951120021e010411bb1b241c74009736e1fe94788e80c5f66274dd966ab219a6cfec7e4a7cf0a43ba67363094cfeca249bcc5fdede5

data/README.md

@@ -1,28 +1,88 @@
-# ErrorResponder
-Short description and motivation.
+[![Gem Version](https://badge.fury.io/rb/error_responder.svg)](https://badge.fury.io/rb/error_responder)
 
-## Usage
-How to use my plugin.
+### Error responder for Rails API 
+#### Generator of standard HTTP responses and error serializer for models.
 
-## Installation
-Add this line to your application's Gemfile:
+### Getting Started
+
+Add it to your Gemfile:
 
 ```ruby
 gem 'error_responder'
 ```
 
-And then execute:
-```bash
-$ bundle
+#### 1) Generate standard HTTP responses
+
+```ruby
+err_respond(err_code, key: nil, message: nil)
+```
+
+
+#### 2) Generate responce with model validation errors
+
+```ruby
+serialize_errors(errors, options = {})
+```
+
+### Usage example
+
+#### 1) Generate standard HTTP responses
+
+```ruby
+err_respond 404
+```
+
+Will be generated:
+
+```json
+{
+    "status": "404",
+    "info": "Not Found",
+    "errors": {}
+}
 ```
 
-Or install it yourself as:
-```bash
-$ gem install error_responder
+You can pass a custom error message:
+```ruby
+err_respond 404, key: 'user', message: 'Not present in database.'
+```
+
+Will be generated:
+
+```json
+{
+    "status": "404",
+    "info": "Not Found",
+    "errors": {
+        "user": "Not present in database."
+    }
+}
 ```
 
-## Contributing
-Contribution directions go here.
+#### 2) Generate responce with model validation errors
+
+```ruby
+@user = User.new(user_params)
+if @user.save
+  # ...
+else
+  serialize_errors(@user.errors)
+end
+```
+
+Will be generated (model errors):
+
+```json
+{
+    "status": 409,
+    "info": "Conflict",
+    "errors": {
+        "username": "Username can't be blank.",
+        "first_name": "First name can't be blank.",
+        "last_name": "Last name can't be blank."
+    }
+}
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/error_responder/extenders/serialize.rb

@@ -17,6 +17,8 @@ module ErrorResponder
           return if errors.nil?
 
           json = {}
+          json[:status] = 409
+          json[:info]   = Rack::Utils::HTTP_STATUS_CODES[409]
           json[:errors] = {}
 
           errors.to_hash(true).each do |key, message|

data/lib/error_responder/version.rb

@@ -1,3 +1,3 @@
 module ErrorResponder
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_responder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Vadim Stroganov