standard_exceptions 0.1.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gary@buzzware.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gary McGhee
+
+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,32 @@
+# StandardExceptions
+
+This is a library of standard exceptions for any project, and nothing else.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'standard_exceptions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install standard_exceptions
+
+## Usage
+
+Just use these standard exceptions for everything, add your own in the same format, and we can start to handle exceptions sanely and reliably.  
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/standard_exceptions. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/lib/standard_exceptions/application.rb

@@ -0,0 +1,16 @@
+# Application Errors
+module StandardExceptions::Application
+
+	class Failed < ::StandardExceptions::Http::UnprocessableEntity
+		MESSAGE = 'The requested operation was not successful.'
+	 end
+
+	class ValidationFailed < Failed
+		MESSAGE = 'The requested operation was not successful due to validation errors.'
+		attr_writer :errors
+		def errors
+			@errors or inner && inner.respond_to?(:errors) && inner.errors
+		end
+	end
+
+end

data/lib/standard_exceptions/application_methods.rb

@@ -0,0 +1,15 @@
+module StandardExceptions::ApplicationMethods
+
+	include ::StandardExceptions::Application
+
+	module_function
+
+  def validation_failed!(message=nil)
+    raise ValidationFailed.new(message)
+  end
+
+	def failed!(message=nil)
+    raise Failed.new(message)
+  end
+
+end

data/lib/standard_exceptions/http.rb

@@ -0,0 +1,55 @@
+# HTTP Status Errors
+module StandardExceptions::Http
+
+	class BadRequest < StandardExceptions::Exception
+		MESSAGE = 'The request was not processed due to a syntax error.'
+		STATUS = 400
+	end
+	class Unauthorized < StandardExceptions::Exception
+		MESSAGE = 'The request was not processed because it lacked acceptable authentication credentials.'
+		STATUS = 401
+	end
+	#PaymentRequired	402
+	class Forbidden < StandardExceptions::Exception
+		MESSAGE = 'The server understood the request but refuses to authorize it.'
+		STATUS = 403
+	end
+	class NotFound < StandardExceptions::Exception
+		MESSAGE = 'The server did not find the requested resource.'
+		STATUS = 404
+	end
+	# MethodNotAllowed	405
+	# NotAcceptable	406
+	# ProxyAuthenticationRequired	407
+	# RequestTimeout	408
+	# Conflict	409
+	# Gone	410
+	# LengthRequired	411
+	# PreconditionFailed	412
+	# RequestEntityTooLarge	413
+	# RequestURITooLong	414
+	# UnsupportedMediaType	415
+	# RequestedRangeNotSatisfiable	416
+	# ExpectationFailed	417
+	class UnprocessableEntity < StandardExceptions::Exception
+		MESSAGE = 'The server understands the request but was unable to process it.'
+		STATUS = 422
+	end
+	# Locked	423
+	# FailedDependency	424
+	# UpgradeRequired	426
+	class InternalServerError < StandardExceptions::Exception
+		MESSAGE = 'The server encountered an unexpected condition that prevented it from fulfilling the request.'
+		STATUS = 500
+	end
+	# class NotImplemented	501
+	# class BadGateway	502
+	# class ServiceUnavailable < Exception
+	# 	STATUS = 503
+	# end
+	# GatewayTimeout	504
+	# HTTPVersionNotSupported	505
+	# InsufficientStorage	507
+	# NotExtended	510
+
+end

data/lib/standard_exceptions/http_methods.rb

@@ -0,0 +1,26 @@
+module StandardExceptions::HttpMethods
+
+	include ::StandardExceptions::Http
+
+	module_function
+
+	# HTTP Status Errors
+
+	def unauthorized!(message=nil)
+    raise Unauthorized.new(message)
+  end
+
+  def forbidden!(message=nil)
+    raise Forbidden.new(message)
+  end
+
+	def not_found!(message=nil)
+		raise NotFound.new(message)
+  end
+
+	def internal_server_error!(message=nil)
+    raise InternalServerError.new(message)
+  end
+
+	# Application Errors
+end

data/lib/standard_exceptions/version.rb

@@ -0,0 +1,3 @@
+module StandardExceptions
+  VERSION = "0.1.3"
+end

data/lib/standard_exceptions.rb

@@ -0,0 +1,45 @@
+require "standard_exceptions/version"
+
+module StandardExceptions
+
+	# messages are based on http://httpstatuses.com
+
+	class Exception < ::StandardError
+		MESSAGE = 'An error occurred that could not be identified'
+		STATUS = 500
+
+		attr_accessor :status
+
+		# eg. 'Not Found'
+		def self.human_name(e_class=self)
+			i = e_class.name.rindex('::')
+      base_name = e_class.name[(i+2)..-1]
+			base_name.split(/(?=[A-Z])/).join(' ')
+		end
+
+		def human_name
+			self.class.human_name
+		end
+
+		attr_writer :inner
+		def inner
+			@inner || self.cause
+		end
+
+		def initialize(message=nil,status=nil,inner=nil)
+			super(message || self.class::MESSAGE)
+			@status = (status || self.class::STATUS)
+			@inner = inner
+		end
+	end
+end
+
+require 'standard_exceptions/http'
+require 'standard_exceptions/application'
+require 'standard_exceptions/http_methods'
+require 'standard_exceptions/application_methods'
+
+module StandardExceptions::Methods
+	include StandardExceptions::HttpMethods
+	include StandardExceptions::ApplicationMethods
+end

data/standard_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 'standard_exceptions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "standard_exceptions"
+  spec.version       = StandardExceptions::VERSION
+  spec.authors       = ["Gary McGhee"]
+  spec.email         = ["contact@buzzware.com.au"]
+
+  spec.summary       = %q{This is a library of standard exceptions for any project, and nothing else.}
+  spec.description   = %q{There is great benefit in adopting a standard library of exceptions. Projects and libraries can all assume the same set of exception classes will be raised and caught using the built in language rescue keyword which filters on class. It becomes especially powerful for building API's, where specific exception classes can be made to return specific HTTP status codes. This libary also provides helper bang-methods eg. unauthorised! for raising these standard kinds of errors}
+  spec.homepage      = "http://standardexceptions.org"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/standard_exceptions.iml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.bundle" />
+      <excludeFolder url="file://$MODULE_DIR$/vendor/bundle" />
+    </content>
+    <orderEntry type="jdk" jdkName="RVM: ruby-2.2.5" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.12.5, RVM: ruby-2.2.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, RVM: ruby-2.2.5) [gem]" level="application" />
+  </component>
+</module>

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: standard_exceptions
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Gary McGhee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: There is great benefit in adopting a standard library of exceptions.
+  Projects and libraries can all assume the same set of exception classes will be
+  raised and caught using the built in language rescue keyword which filters on class.
+  It becomes especially powerful for building API's, where specific exception classes
+  can be made to return specific HTTP status codes. This libary also provides helper
+  bang-methods eg. unauthorised! for raising these standard kinds of errors
+email:
+- contact@buzzware.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/compiler.xml"
+- ".idea/copyright/profiles_settings.xml"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/standard_exceptions.rb
+- lib/standard_exceptions/application.rb
+- lib/standard_exceptions/application_methods.rb
+- lib/standard_exceptions/http.rb
+- lib/standard_exceptions/http_methods.rb
+- lib/standard_exceptions/version.rb
+- standard_exceptions.gemspec
+- standard_exceptions.iml
+homepage: http://standardexceptions.org
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: This is a library of standard exceptions for any project, and nothing else.
+test_files: []