sinatra-errorcodes 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 955dff502f8318ac98c598638126e203d488f644
-  data.tar.gz: be2d2ca28b7a20e970849601518a05d334e8dc54
+  metadata.gz: 890a05336d2bddbd8d7d3853e026a208b0ba2945
+  data.tar.gz: f36c90ad4904d41dd79995f6a165ebc140a291e4
 SHA512:
-  metadata.gz: 3f983f48c729fb9ee14c48be464ae7f0d1922777b99228f29538e90b652f5eefdebbfe87e12e9bc014c11f184c84b4e38a635e700eb47b73cb9f37fb41060786
-  data.tar.gz: 1d1ebf1d01f8dbfbfda412650fb351129920c6bf85124682cdcc6a3310a15c9755f063a688da89fe957cc701c6b93c065f7e4272f2bff4e52b414d1b21fa3e61
+  metadata.gz: 283b8983a22483d30ce378c144f69ee4aca0187b9cd5305192fd9d8889b9e5e0dd5cd3d987b2193dd857802c2dadf87423694e81f8eefec829374723b897e543
+  data.tar.gz: 2d986cb131b7c770a374f13b738b7c0df41acb470d9e895416a4681987d5918bbc53a35ac5a63cc6d946ec2df3c935b2505c1ee2f36750b4e2ce5a7865b7f334

data/.gitignore

@@ -2,6 +2,7 @@
 Gemfile.lock
 
 .byebug_history
+.ruby-version
 
 /.bundle/
 /.yardoc

data/README.md

@@ -4,13 +4,13 @@
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 > Gem of HTTP error status code class pack
 
-=======
 ## Table of Contents
-- [Installation](#Installation)
-- [Example](#Example)
-- [Test](#Test)
-- [Contribute](#Contribute)
-- [License](#License)
+- [Installation](README.md#Installation)
+- [Usage](README.md#Usage)
+- [Example](README.md#Example)
+- [Test](README.md#Test)
+- [Contribute](README.md#Contribute)
+- [License](README.md#License)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -24,6 +24,38 @@ Or install it yourself as:
 $ gem install sinatra-errorcodes
 ```
 
+## Usage
+To use this gem, at first, you need to register `Sinatra::Errorcodes` in your configure block and call `handle_errorstatus` which wraps Sinatra's error handling block. 
+```ruby
+class AppController < Sinatra::Base
+  configure do
+    register Sinatra::Errorcodes
+    
+    handle_errorstatus # Need to add this.
+  end
+end
+```
+
+Now you can use a set of `HTTPError` class in order to halt manually with a specific HTTP status code and its message like below. The all process of these exception raising is done by `handle_errorstatus` you have just added above.
+```ruby
+...
+
+  get '/badrequest'
+    raise HTTPError::BadRequest
+  end
+  
+  get '/error'
+    raise HTTPError::InternalServerError
+  end
+  
+  # You can also raise an exception with your own custom message.
+  get '/custom'
+    raise HTTPError::InternalServerError, 'Custom error message'
+  end
+  
+...
+```
+
 ## Example
 Install gems
 ```bash
@@ -37,14 +69,12 @@ $ bundle exec rackup -p 3000
 ```
 
 ## Test
-Default task in Rakefile is test
 ```bash
-$ bundle exec rake
+$ bundle exec rake spec
 ```
 
 ## Contribute
-Bug reports and pull requests are welcome on GitHub at https://github.com/IzumiSy/sinatra-errorcodes. 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.
-
+PRs accepted.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/example/base.rb

@@ -1,12 +1,10 @@
 class BaseController < Sinatra::Base
   configure do
-    helpers Sinatra::Errorcodes
+    register Sinatra::Errorcodes
+
+    handle_errorstatus
 
     set :raise_errors, false
     set :show_exceptions, false
   end
-
-  error do |e|
-    handle_errorcode(e)
-  end
 end

data/lib/4xx_errors.rb

@@ -1,108 +1,140 @@
 require_relative "./error_base"
 
 module HTTPError
+
+  # 400 Bad Request
   class BadRequest < ErrorBase
-    CODE = 400
-    MESSAGE = "Bad Request"
+    CODE = Rack::Utils.status_code(:bad_request)
   end
 
+  # 401 Unauthorized
   class Unauthorized < ErrorBase
-    CODE = 401
-    MESSAGE = "Unauthorized"
+    CODE = Rack::Utils.status_code(:unauthorized)
   end
 
+  # 402 Payment Required
   class PaymentRequired < ErrorBase
-    CODE = 402
-    MESSAGE = "Payment Required"
+    CODE = Rack::Utils.status_code(:payment_required)
   end
 
+  # 403 Forbidden
   class Forbidden < ErrorBase
-    CODE = 403
-    MESSAGE = "Forbidden"
+    CODE = Rack::Utils.status_code(:forbidden)
   end
 
+  # 404 Not Found
   class NotFound < ErrorBase
-    CODE = 404
-    MESSAGE = "Not Found"
+    CODE = Rack::Utils.status_code(:not_found)
   end
 
-  class MethodNotAllows < ErrorBase
-    CODE = 405
-    MESSAGE = "Method Not Allowed"
+  # 405 Method Not Allowed
+  class MethodNotAllowed < ErrorBase
+    CODE = Rack::Utils.status_code(:method_not_allowed)
   end
 
+  # 406 Not Acceptable
   class NotAccpetable < ErrorBase
-    CODE = 406
-    MESSAGE = "Not Acceptable"
+    CODE = Rack::Utils.status_code(:not_acceptable)
   end
 
+  # 407 Proxy Authentication Required
   class ProxyAuthenticationRequired < ErrorBase
-    CODE = 407
-    MESSAGE = "Proxy Authentication Required"
+    CODE = Rack::Utils.status_code(:proxy_authentication_required)
   end
 
+  # 408 Request Timeout
   class RequestTimeout < ErrorBase
-    CODE = 408
-    MESSAGE = "Request Timeout"
+    CODE = Rack::Utils.status_code(:request_timeout)
   end
 
+  # 409 Conflict
   class Conflict < ErrorBase
-    CODE = 409
-    MESSAGE = "Conflict"
+    CODE = Rack::Utils.status_code(:conflict)
   end
 
+  # 410 Gone
   class Gone < ErrorBase
-    CODE = 410
-    MESSAGE = "Gone"
+    CODE = Rack::Utils.status_code(:gone)
   end
 
+  # 411 Length Required
   class LengthRequired < ErrorBase
-    CODE = 411
-    MESSAGE = "Length Required"
+    CODE = Rack::Utils.status_code(:length_required)
   end
 
+  # 412 Precondition Failed
   class PreconditionFailed < ErrorBase
-    CODE = 412
-    MESSAGE = "Precondition Failed"
+    CODE = Rack::Utils.status_code(:precondition_failed)
   end
 
+  # 413 Payload Too Large
   class PayloadTooLarge < ErrorBase
-    CODE = 413
-    MESSAGE = "Payload Too Large"
+    CODE = Rack::Utils.status_code(:payload_too_large)
   end
 
+  # 414 URI Too Long
   class UriTooLong < ErrorBase
-    CODE = 414
-    MESSAGE = "URI Too Long"
+    CODE = Rack::Utils.status_code(:uri_too_long)
   end
 
+  # 415 Unsupported Media Type
   class UnsupportedMediaType < ErrorBase
-    CODE = 415
-    MESSAGE = "Unsupported Media Type"
+    CODE = Rack::Utils.status_code(:unsupported_media_type)
   end
 
+  # 416 Range Not Satisfiable
   class RangeNotSatisfiable < ErrorBase
-    CODE = 416
-    MESSAGE = "Range Not Satisfiable"
+    CODE = Rack::Utils.status_code(:range_not_satisfiable)
   end
 
+  # 417 Expectation Failed
   class ExpectationFailed < ErrorBase
-    CODE = 417
-    MESSAGE = "Expectation Failed"
+    CODE = Rack::Utils.status_code(:expectation_failed)
   end
 
+  # 421 Misdirected Request
   class MisdirectedRequest < ErrorBase
-    CODE = 421
-    MESSAGE = "Misdirected Request"
+    CODE = Rack::Utils.status_code(:misdirected_failed)
+  end
+
+  # 422 Unprocessable Entity
+  class UnprocessableEntity < ErrorBase
+    CODE = Rack::Utils.status_code(:unprocessable_entity)
+  end
+
+  # 423 Locked
+  class Locked < ErrorBase
+    CODE = Rack::Utils.status_code(:locked)
+  end
+
+  # 424 Failed Dependency
+  class FailedDependency < ErrorBase
+    CODE = Rack::Utils.status_code(:failed_dependency)
   end
 
+  # 426 Upgrade Required
   class UpgradeRequired < ErrorBase
-    CODE = 426
-    MESSAGE = "Upgrade Required"
+    CODE = Rack::Utils.status_code(:upgrade_required)
   end
 
+  # 428 Precondition Required
+  class PreconditionRequired < ErrorBase
+    CODE = Rack::Utils.status_code(:precondition_required)
+  end
+
+  # 429 Too Many Requests
+  class TooManyRequests < ErrorBase
+    CODE = Rack::Utils.status_code(:too_many_requests)
+  end
+
+  # 431 Request Header Fields Too Large
+  class RequestHeaderFieldsTooLarge < ErrorBase
+    CODE = Rack::Utils.status_code(:request_header_fields_too_large)
+  end
+
+  # 451 Unavailable For Legal Reasons
   class UnavailableForLegalReasons < ErrorBase
-    CODE = 451
-    MESSAGE = "Unavailable For Legal Reasons"
+    CODE = Rack::Utils.status_code(:unavailable_for_legal_reasons)
   end
+
 end

data/lib/5xx_errors.rb

@@ -1,33 +1,60 @@
 require_relative "./error_base"
 
 module HTTPError
+
+  # 500 Internal Server Error
   class InternalServerError < ErrorBase
-    CODE = 500
-    MESSAGE = "Internal Server Error"
+    CODE = Rack::Utils.status_code(:internal_server_error)
   end
 
+  # 501 Not Implemented
   class NotImplemented < ErrorBase
-    CODE = 501
-    MESSAGE = "Not Impemented"
+    CODE = Rack::Utils.status_code(:not_implemented)
   end
 
+  # 502 Bad Gateway
   class BadGateway < ErrorBase
-    CODE = 502
-    MESSAGE = "Bad Gateway"
+    CODE = Rack::Utils.status_code(:bad_gateway)
   end
 
+  # 503 Service Unavailable
   class ServiceUnavailable < ErrorBase
-    CODE = 503
-    MESSAGE = "Service Unavailable"
+    CODE = Rack::Utils.status_code(:service_unavailable)
   end
 
+  # 504 Gateway Timeout
   class GatewayTimeout < ErrorBase
-    CODE = 504
-    MESSAGE = "Gateway Timeout"
+    CODE = Rack::Utils.status_code(:gateway_timeout)
   end
 
+  # 505 HTTP Version Not Supported
   class HTTPVersionNotSupported < ErrorBase
-    CODE = 505
-    MESSAGE = "HTTP Version Not Supported"
+    CODE = Rack::Utils.status_code(:http_version_not_supported)
+  end
+
+  # 506 Variant Also Negotiates
+  class VariantAlsoNegotiates < ErrorBase
+    CODE = Rack::Utils.status_code(:variant_also_negotiates)
+  end
+
+  # 507 Insufficient Storage
+  class InsufficientStorage < ErrorBase
+    CODE = Rack::Utils.status_code(:insufficient_storage)
+  end
+
+  # 508 Loop Detected
+  class LoopDetected < ErrorBase
+    CODE = Rack::Utils.status_code(:loop_detected)
+  end
+
+  # 510 Not Extended
+  class NotExtended < ErrorBase
+    CODE = Rack::Utils.status_code(:not_extended)
   end
+
+  # 511 Network Authentication Required
+  class NetworkAuthenticationRequired < ErrorBase
+    CODE = Rack::Utils.status_code(:network_authentication_required)
+  end
+
 end

data/lib/error_base.rb

@@ -1,15 +1,16 @@
 class ErrorBase < StandardError
   def initialize( *message )
-    _v = message.join(' ')
-    @_msg = !_v.empty? ? _v : self.class::MESSAGE
+    _message = message.join(' ')
     @_code = self.class::CODE
+    @_msg = _message.empty? ?
+      Rack::Utils::HTTP_STATUS_CODES[@_code] : _message
   end
 
   def code
     @_code
   end
 
-  def message
+  def msg
     @_msg
   end
 end

data/lib/sinatra/errorcodes.rb

@@ -9,12 +9,14 @@ module Sinatra
   include HTTPError
 
   module Errorcodes
-    def handle_errorcode(e)
-      if e.is_a? ErrorBase
-        halt e.code, e.message
+    def handle_errorstatus
+      error do |e|
+        if e.is_a? ErrorBase
+          halt e.code, e.msg
+        end
       end
     end
   end
 
-  helpers Errorcodes
+  register Errorcodes
 end

data/lib/sinatra/errorcodes/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Errorcodes
-    VERSION = "0.1.2"
+    VERSION = "0.2.1"
   end
 end

data/spec/sinatra/errorcodes_spec.rb

@@ -7,12 +7,10 @@ describe Sinatra::Errorcodes do
 
   it 'provides status 500' do
     expect(HTTPError::InternalServerError::CODE).to be 500
-    expect(HTTPError::InternalServerError::MESSAGE).to eq 'Internal Server Error'
   end
 
   it 'provides status 400' do
     expect(HTTPError::BadRequest::CODE).to be 400
-    expect(HTTPError::BadRequest::MESSAGE).to eq 'Bad Request'
   end
 
   it 'returns status 500 ' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-errorcodes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - IzumiSy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra