exceptions-resource 0.0.1p01

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2002338e27658b3366f4bd4748244ee7de86dd70
+  data.tar.gz: 429c9c169ca6c43149f66101b89ed7b0e89309c9
+SHA512:
+  metadata.gz: bd27f05adbee686ebac0dcd257b1f33745142e163c1ad7006ac2996a0bfbc76d3bd23cef3579e82f23d52a189ee403cb97ecd94102b949c6d53375d35e4f857c
+  data.tar.gz: 83e5a14e3a37026d95b1af57ffb488e047e0e2fe82cf9d4de41b2ecb3fd46c15af6688c4923f949a52557d144b77cb46bc5882b5f9d5711a79ffe87d37b56e22

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exceptions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Douglas Rossignolli
+
+MIT License
+
+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,114 @@
+# Exceptions
+
+This small lib will play with many kinds of exceptions and return then as json with all needed informations to build awesome errors responses
+needs `ActiveModel` as dependency if you aren't working with rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exceptions', github: 'xdougx/exceptions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exceptions
+
+## Usage
+
+Its simple to use for a model
+
+``` ruby
+redaction = Redaction.new
+redaction.valid?
+exception = Exceptions::Model.build(redaction)
+ap exception.error # awesome print to help us
+```
+
+### Result
+``` json
+{
+  "error": {
+    "model": "Redaction",
+    "field": "redaction[subject]",
+    "attribute": "subject",
+    "message": "can't be blank",
+    "full_message": "Subject can't be blank"
+  }
+}
+```
+
+If you need to build a exception just with a message
+
+``` ruby
+exception = Exceptions::Simple.build(field: "Name", message: "is needed to be filled")
+ap exception.error
+```
+
+### Result
+``` json
+{
+  "error": {
+    "message": "is needed to be filled",
+    "full_message": "Name is needed to be filled",
+    "field": "Name"
+  }
+}
+```
+
+Need an application exception?
+
+``` ruby
+exception = Exceptions::UnauthorizedApplication.build(message: "You have no permission to access this API")
+ap exception.error
+```
+
+### Result
+``` json
+{
+  "error": {
+    "message": "You have no permission to access this API"
+  }
+}
+```
+
+### Build your exception
+
+``` ruby
+class Exceptions::MyAppException
+
+  def error
+    { 
+      error: { 
+        error_code: self.error_code, 
+        message: self.message,
+      } 
+    }
+  end
+
+  def message 
+    self.object.message
+  end
+
+  def error_code
+    if self.object.error_code
+  end
+
+  def status
+    :unprocessable_entity
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/exceptions/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/exceptions.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exceptions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exceptions-resource"
+  spec.version       = Exceptions::VERSION
+  spec.authors       = ["Douglas Rossignolli"]
+  spec.email         = ["douglas.rossignolli@gmail.com"]
+  spec.summary       = %q{This small lib have many exceptions to work with rested exceptions and ActiveModel errors}
+  spec.description   = %q{This small lib will play with many kinds of exceptions and return then as json with all needed informations to build awesome errors responses}
+  spec.homepage      = "https://github.com/xdougx/exceptions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/exceptions/base.rb

@@ -0,0 +1,29 @@
+class Exceptions::Base < StandardError
+	attr_accessor :object, :type
+
+	# starts a new instance with an object
+	# @param [Object] object
+	def initialize object
+		self.object = object
+	end
+
+	# standard error for Models
+	# @param [ActiveRecord::Base] object
+	# @return [Exceptions::Base]
+	def self.build object
+		exception = new object
+		return exception
+	end
+
+	# return if is as simple error
+	# @return [Boolean]
+	def simple?
+		self.class.name.demodulize.tableize.singularize == "simple"
+	end
+
+	# return if is as model error
+	# @return [Boolean]
+	def model?
+		self.class.name.demodulize.tableize.singularize == "model"
+	end		
+end

data/lib/exceptions/model.rb

@@ -0,0 +1,88 @@
+class Exceptions::Model < Exceptions::Base
+
+	# for model errors this method build a hash with all necessary information
+	# @return [String] json string
+	def error
+		self.is_nested? ? self.build_nested : self.build_normal
+	end
+
+	def build_nested
+		{ 
+			error: { 
+				model: self.nested_model.camelcase, 
+				field: "#{self.nested_model}[#{self.nested_attr}]",
+				attribute: self.nested_attr, 
+				message: self.message,
+				full_message: "#{self.nested_attr_human} #{self.message}"
+			} 
+		}
+	end
+
+	def build_normal
+		{ 
+			error: { 
+				model: self.model.camelcase, 
+				field: "#{self.model}[#{self.attribute}]",
+				attribute: self.attribute, 
+				message: self.message,
+				full_message: "#{self.attribute_human} #{self.message}"
+			} 
+		}
+	end
+
+	# return what model is
+	# @return [String]
+	def model
+		self.object.class.name.demodulize.tableize.singularize.downcase
+	end
+
+	def attribute
+		self.object.errors.first[0]
+	end
+
+	def model_human
+		self.object.class.model_name.human.demodulize.tableize.singularize.downcase
+	end
+
+	def attribute_human
+		self.object.class.human_attribute_name(self.object.errors.first[0])
+	end
+
+	# return the error message
+	# @return [String]
+	def message 
+		"#{self.object.errors.first[1]}"
+	end
+
+	def status
+		:unprocessable_entity
+	end
+
+	def is_nested?
+		attribute = self.object.errors.first[0]
+
+		if self.object.errors.first[0].to_s.split(".").size > 1
+			self.object.respond_to?(attribute) ? false : true
+		else
+			false
+		end
+	end
+
+	def nested_model
+		self.object.errors.first[0].to_s.split(".").first.singularize.downcase
+	end
+
+	def nested_model_human
+		self.nested_model.capitalize.constantize.model_name.human
+	end
+
+	def nested_attr
+		self.object.errors.first[0].to_s.split(".").last
+	end
+
+	def nested_attr_human
+		self.nested_model.capitalize.constantize.human_attribute_name(self.nested_attr)
+	end
+
+
+end

data/lib/exceptions/resource.rb

@@ -0,0 +1,26 @@
+class Exceptions::Resource < Exceptions::Base
+	# for standard errors this method build a hash
+	# @return [String] json string
+	def error
+		{
+			error: { 
+				model: self.object["model"],
+				attribute: self.object["attribute"],
+				field: self.object["field"],
+				message: self.object["message"],
+				full_message: "#{self.object["attribute"]} #{self.object["message"]}"
+			} 
+		}
+	end
+
+	# return the error message
+	# @return [String]
+	def message
+		self.error[:message]
+	end
+
+	# return the error status
+	def status
+		:not_acceptable
+	end
+end

data/lib/exceptions/simple.rb

@@ -0,0 +1,31 @@
+# represents the simple errors
+module Exceptions
+	class Simple < Base
+		attr_accessor :status
+
+	
+		# for standard errors this method build a hash
+		# @return [String] json string
+		def error
+			{ 
+				error: { 
+					message: self.object[:message],
+					full_message: "#{self.object[:field]} #{self.object[:message]} ",
+					field: self.object[:field]
+				} 
+			}
+		end
+
+		# return the error message
+		# @return [String]
+		def message
+			self.object[:message]
+		end
+
+		# return the error status
+		def status
+			:not_acceptable
+		end
+
+	end
+end

data/lib/exceptions/unauthorized_application.rb

@@ -0,0 +1,29 @@
+# represents the simple errors
+module Exceptions
+	class UnauthorizedApplication < Base
+		attr_accessor :status
+
+	
+		# for standard errors this method build a hash
+		# @return [String] json string
+		def error
+			{ 
+				error: { 
+					message: self.object[:message]
+				} 
+			}
+		end
+
+		# return the error message
+		# @return [String]
+		def message
+			self.object[:message]
+		end
+
+		# return the error status
+		def status
+			:unauthorized
+		end
+
+	end
+end

data/lib/exceptions/version.rb

@@ -0,0 +1,3 @@
+module Exceptions
+  VERSION = "0.0.1p01"
+end

data/lib/exceptions.rb

@@ -0,0 +1,7 @@
+module Exceptions
+end
+require 'exceptions/base'
+require 'exceptions/model'
+require 'exceptions/resource'
+require 'exceptions/simple'
+require 'exceptions/unauthorized_application'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: exceptions-resource
+version: !ruby/object:Gem::Version
+  version: 0.0.1p01
+platform: ruby
+authors:
+- Douglas Rossignolli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: This small lib will play with many kinds of exceptions and return then
+  as json with all needed informations to build awesome errors responses
+email:
+- douglas.rossignolli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exceptions.gemspec
+- lib/exceptions.rb
+- lib/exceptions/base.rb
+- lib/exceptions/model.rb
+- lib/exceptions/resource.rb
+- lib/exceptions/simple.rb
+- lib/exceptions/unauthorized_application.rb
+- lib/exceptions/version.rb
+homepage: https://github.com/xdougx/exceptions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This small lib have many exceptions to work with rested exceptions and ActiveModel
+  errors
+test_files: []