saoshyant 1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e8f5039563d5adf7b102e4735e3af9f7ac53b003ec45116e49b8bfb2556a5b9
-  data.tar.gz: a7510586753167922756af504696d79e707b65e43baecba6b9be4120565b6b46
+  metadata.gz: 2148ce17d37d35084ad0b7a83ef4b556d2bf5de51e18cd3e8690f9edddaaf064
+  data.tar.gz: 3e53a5664c30efe33da7aa56c1583a3797374e6efcf6275cd06e674d5af68c00
 SHA512:
-  metadata.gz: 8a557ab6a290bd574415a47f05791be506a465cc5f39df37005e26ff3d5c2c9a55fc1d50194b01de286b3bae12847fe22dfd7e9083356812528e8fdbdb1eae40
-  data.tar.gz: 0af188cc8d2ca50bc0462781c5b3d8188dc987021c8041baa22c9b360d1ebd5a36e05b634123124fbb13681f08e7f430a95cbfe77da4bb06d14a33f3bf6eca62
+  metadata.gz: c4ed69be543e4865f580e149974f24b4ff78b91aa4ccef8a68646e60d1a797b2b81cdd94e202d5311125e08b8ca6b5f72f2a143daf39aa93fef88b705d367f5f
+  data.tar.gz: 2e4804f2911e02da1706709b8a8454eb38a31e158b3d7f1786a14a0d03ca40a21c521d2c5fa39b4dfa5d5fe38c611c435388ba9ddc94000928436edfc77fa57c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 majid imanzade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Saoshyant
+
+**Saoshyant is an exception handler Gem** that allows you to customize your exceptions to have a custom reaction when error raised in rails Application.
+
+When you Encountering to an error in Rails Application it shows Red Page and explains Exception. With Saoshyant you can log or render error with custom status code.
+
+the Most Usage of Saoshyant is in Rest Apis Applications that you need to render errors with custom error code and messages.
+
+## Requirements
+* Rails: 3.0.0+
+
+## Installation
+Add Saoshyant to your Gemfile:
+```sh
+gem 'saoshyant'
+```
+
+## Getting Start
+
+in blowe Example we want to render `Exceptions` messages in json format.
+
+```rb
+class PageController < ApplicationController
+  include Saoshyant
+
+  def initialize		
+    saoshyant do |status_code, msg, exception_klass|
+      render json: {message: msg, error_class_name: exception_klass}, status: status_code
+    end
+  end
+end
+
+```
+
+### How Customize Status Code and Log
+default status code in saoshyant gem is `500` error code and it doesnt log Exceptions.
+
+if you want to customize Status Code and Log you can use `saoshyant_option` methode:
+```rb
+saoshyant_option(ExceptionClass, StatusCode, LogFlag)
+```
+```rb
+class PageController < ApplicationController
+  include Saoshyant
+
+  def initialize
+    saoshyant_option(NameError, 402, true)
+    saoshyant do |status_code, msg, exception_klass|
+      render json: {message: msg, error_class_name: exception_klass}, status: status_code
+    end
+  end
+end
+
+```

data/saoshyant.gemspec

@@ -1,12 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = 'saoshyant'
-  s.version     = '1.2'
+  s.version     = '1.2.1'
   s.date        = '2020-02-10'
   s.summary     = "Handle Rails Exception"
-  s.description = "when exceptoin raised we dont want see it in ugly and red display, saoshyant present it in json response"
+  s.description = "Handle Unexpected Controller Exceptions using Saoshyant."
   s.authors     = ["Majid Imanzade"]
   s.email       = 'majidimanzade1@gmail.com'
   s.homepage    = 'https://rubygems.org/gems/saoshyant'
+  s.homepage    = "http://github.com/majidimanzade/saoshyant"
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saoshyant
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.1
 platform: ruby
 authors:
 - Majid Imanzade
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: when exceptoin raised we dont want see it in ugly and red display, saoshyant
-  present it in json response
+description: Handle Unexpected Controller Exceptions using Saoshyant.
 email: majidimanzade1@gmail.com
 executables: []
 extensions: []
@@ -63,13 +62,15 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- LICENSE
+- README.md
 - lib/exception_handler.rb
 - lib/exception_logger.rb
 - lib/saoshyant.rb
 - saoshyant.gemspec
 - spec/saoshyant_test.rb
 - spec/spec_helper.rb
-homepage: https://rubygems.org/gems/saoshyant
+homepage: http://github.com/majidimanzade/saoshyant
 licenses:
 - MIT
 metadata: {}