saoshyant 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a61410a83892b4511dc858709e1033c89da482294e1f1d6f82f8a2b1c207ace4
-  data.tar.gz: 5a737800386ce2c20444b6ed92d89ed3e75fb4f8e47b73f69c1e8dd8e2e44f54
+  metadata.gz: 2148ce17d37d35084ad0b7a83ef4b556d2bf5de51e18cd3e8690f9edddaaf064
+  data.tar.gz: 3e53a5664c30efe33da7aa56c1583a3797374e6efcf6275cd06e674d5af68c00
 SHA512:
-  metadata.gz: f24478979654ab6feea4b97d6c97749405f532b52298cc13ba701f4a7d69792184dc00467d2f11004d93a12b7011fcb7431553a53740e774d9460199cfe1911e
-  data.tar.gz: 655f889ffbc6a39ac65a56a32a13dd25221624b438459b6eb0621a34770fa8f3658f91365e6dbd73b6440c2f9b4764bd2fe9201f60baaf9b957dbc1b10d0efe6
+  metadata.gz: c4ed69be543e4865f580e149974f24b4ff78b91aa4ccef8a68646e60d1a797b2b81cdd94e202d5311125e08b8ca6b5f72f2a143daf39aa93fef88b705d367f5f
+  data.tar.gz: 2e4804f2911e02da1706709b8a8454eb38a31e158b3d7f1786a14a0d03ca40a21c521d2c5fa39b4dfa5d5fe38c611c435388ba9ddc94000928436edfc77fa57c

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_WITH: "development:test"

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

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/lib/exception_handler.rb

@@ -0,0 +1,19 @@
+module Saoshyant
+	class ExceptionHandler
+		
+		DEFAULT_ERROR_CODE = 500
+
+		def self.code_status exception, exception_klasses
+			exception_klasses.key?(exception.class) ? exception_klasses[exception.class][:code] : DEFAULT_ERROR_CODE
+		end
+
+		def self.log_status exception, exception_klasses
+			exception_klasses.key?(exception.class) ? exception_klasses[exception.class][:log] : false
+		end
+
+		def self.validate_arguments code, log
+			raise "Invalid code status" unless code.kind_of?(Integer)
+			raise "Invalid log status, it should be Boolean" unless !!log == log
+		end
+	end
+end

data/lib/saoshyant.rb

@@ -1,20 +1,34 @@
 require 'rails'
 require 'exception_logger'
-require 'json_exception_handeler'
+require 'exception_handler'
 
 module Saoshyant
 	extend ActiveSupport::Concern
+	include ActiveSupport::Rescuable
+
+	@@exception_klasses = {}
+	@@block = nil
 
-	DEFAULT_ERROR_CODE = 500
 	included do
-		rescue_from Exception, with: :render_exception
+		rescue_from Exception, with: :execute_exception
+	end
+
+	def saoshyant_option(exception_klass, code, log = false)
+		Saoshyant::ExceptionHandler.validate_arguments(code, log)
+		return if @@exception_klasses.key?(exception_klass)
+
+		@@exception_klasses.merge!(exception_klass => {code: code, log: log})
+	end
+
+	def saoshyant(&block)
+		@@block = block
 	end
 
-	def render_exception ex
-		code = Saoshyant::JsonExceptionHandeler.code_status ex
-		log = Saoshyant::JsonExceptionHandeler.log_status ex
+	def execute_exception ex
+		code = Saoshyant::ExceptionHandler.code_status ex, @@exception_klasses
+		log = Saoshyant::ExceptionHandler.log_status ex, @@exception_klasses
 
 		Saoshyant::ExceptionLogger.log(ex.message) if log == true
-		render json: {status: 'error', :message => ex.message, :exception_type => ex.class.inspect}, status: code
+		@@block.call(code, ex.message, ex.class.inspect)
 	end
 end

data/saoshyant.gemspec

@@ -1,16 +1,18 @@
-# require 'version'
-
 Gem::Specification.new do |s|
   s.name        = 'saoshyant'
-  s.version     = '1.0.1'
+  s.version     = '1.2.1'
   s.date        = '2020-02-10'
-  s.summary     = "Handle Rails Exception Apis"
-  s.description = "when exceptoin raised we dont want see it in ugly and red display, saoshyant present it in json response"
+  s.summary     = "Handle Rails Exception"
+  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")
   s.require_paths = ['lib']
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec")
 end

data/spec/saoshyant_test.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+include Saoshyant
+
+describe Saoshyant do
+	describe 'JsonExceptionHandeler' do
+		it 'expect get error for invalid code status' do
+			expect{ saoshyant_option(NameError, '200', false) }.to raise_error(RuntimeError)
+		end
+
+		it 'expect get error for invalid log status' do
+			expect{ saoshyant_option(NameError, 203, 'true') }.to raise_error(RuntimeError)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'saoshyant'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saoshyant
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Majid Imanzade
@@ -9,23 +9,68 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2020-02-10 00:00:00.000000000 Z
-dependencies: []
-description: when exceptoin raised we dont want see it in ugly and red display, saoshyant
-  present it in json response
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Handle Unexpected Controller Exceptions using Saoshyant.
 email: majidimanzade1@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
 - ".gitignore"
+- ".rspec"
 - Gemfile
-- Rackfile
+- LICENSE
+- README.md
+- lib/exception_handler.rb
 - lib/exception_logger.rb
-- lib/json_exception_handeler.rb
 - lib/saoshyant.rb
-- lib/version.rb
 - saoshyant.gemspec
-homepage: https://rubygems.org/gems/saoshyant
+- spec/saoshyant_test.rb
+- spec/spec_helper.rb
+homepage: http://github.com/majidimanzade/saoshyant
 licenses:
 - MIT
 metadata: {}
@@ -47,5 +92,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Handle Rails Exception Apis
+summary: Handle Rails Exception
 test_files: []

data/Rackfile

@@ -1,8 +0,0 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/lib/json_exception_handeler.rb

@@ -1,27 +0,0 @@
-module Saoshyant
-	class JsonExceptionHandeler
-
-		@@exception_klasses = {}
-
-		def self.customize(exception_klass, code, log = false)
-			validate_arguments code, log
-			return if @@exception_klasses.key?(exception_klass)
-
-			@@exception_klasses.merge!(exception_klass => {code: code, log: log})
-		end
-
-		private
-		def self.code_status exception
-			@@exception_klasses.key?(exception.class) ? @@exception_klasses[exception.class][:code] : DEFAULT_ERROR_CODE
-		end
-
-		def self.log_status exception
-			@@exception_klasses.key?(exception.class) ? @@exception_klasses[exception.class][:log] : false
-		end
-
-		def self.validate_arguments code, log
-			raise "Invalid code status" unless code.kind_of?(Integer)
-			raise "Invalid log status, it should be Boolean" unless !!log == log
-		end
-	end
-end

data/lib/version.rb

@@ -1,5 +0,0 @@
-module Saoshyant
-  class Version
-    GEM_VERSION = "0.0.1"
-  end
-end