http-errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a271c0fe06315eced591d92050aea5e00c78c8d54b15a4dd1716ec99f5ced8e
+  data.tar.gz: 9c4649b2a906dcb41dce8da9f5ee08de560cade21d29a54ef686e8762eb05080
+SHA512:
+  metadata.gz: 769b0fdac3e1f9251e60384dfa59dbd0c18b6ec4d5ad9e697699136903b4d63aa4e9ebde5a75187a6a523e91d938d6935c5f2c8062dae621a1eff4bdd92bd840
+  data.tar.gz: 94eb2f036196a25ff6b8b2cba58a78c4bfe1e7205ef1df494df0f3b52137631420350f0b533580970ee7f11df4c8ca250695589a6b6cd659224b8f167261e161

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in http_errors.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    http-errors (0.1.0)
+      activesupport (~> 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  http-errors!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emil Kampp
+
+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,51 @@
+# HTTP errors
+
+Simple HTTP errors for your Ruby application. You can see [a complete list of http errors here](https://httpstatuses.com).
+
+## Usage
+
+Install it
+
+```
+gem 'http-errors', require: 'http_error'
+```
+
+Then in your application you can raise an HTTP error
+
+```ruby
+raise HttpError::Unauthorized
+```
+
+You can also set some detail information about the error
+
+```ruby
+raise HttpError::Unauthorized, 'Invalid email or password'
+```
+
+In your ApplicationController you can then handle the errors like this
+
+```ruby
+class ApplicationController < ActionController::Base
+  include HttpError::Response
+end
+```
+
+Or you can implement your own handler for all `HttpError`s
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from HttpError::Error do |error|
+    # Handle the error here
+  end
+end
+```
+
+Or for a specific, single error
+
+```ruby
+class ApplicationController < ActionController::Base
+  rescue_from HttpError::Teapot do |error|
+    render json: { error: 'This is silly' }, status: 418
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "http_errors"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/http_errors.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "http_error/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "http-errors"
+  spec.version       = HttpErrors::VERSION
+  spec.authors       = ["Emil Kampp"]
+  spec.email         = ["emil@kampp.me"]
+
+  spec.summary       = 'Easy way to raise HTTP errors from your ruby application'
+  spec.description   = 'Easy way to raise HTTP errors from your ruby application'
+  spec.homepage      = "https://github.com/YouWeApS/arctic-gems-http_errors"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "activesupport", "~> 5.1"
+end

data/lib/http_error.rb

@@ -0,0 +1,14 @@
+# Gems
+require 'active_support/all'
+
+# Framework
+require "http_error/version"
+require "http_error/response"
+
+# Errors
+require "http_error/bad_request"
+require "http_error/forbidden"
+require "http_error/internal_server_error"
+require "http_error/not_implemented"
+require "http_error/teapot"
+require "http_error/unauthorized"

data/lib/http_error/bad_request.rb

@@ -0,0 +1,8 @@
+require "http_error/error"
+
+module HttpError
+  class BadRequest< Error
+    self.status = 400
+    self.message = 'Bad request'
+  end
+end

data/lib/http_error/error.rb

@@ -0,0 +1,17 @@
+module HttpError
+  # InternalServerError is used by all other errors to inherit from
+  class Error < StandardError
+    class << self
+      attr_accessor :status
+      attr_accessor :message
+    end
+
+    def status
+      self.class.status
+    end
+
+    def error
+      message || self.class.message
+    end
+  end
+end

data/lib/http_error/forbidden.rb

@@ -0,0 +1,9 @@
+require "http_error/error"
+
+module HttpError
+  # InternalServerError is used by all other errors to inherit from
+  class Forbidden < Error
+    self.status = 403
+    self.message = 'Forbidden'
+  end
+end

data/lib/http_error/internal_server_error.rb

@@ -0,0 +1,8 @@
+require "http_error/error"
+
+module HttpError
+  class InternalServerError < Error
+    self.status = 500
+    self.message = 'Internal server error'
+  end
+end

data/lib/http_error/not_implemented.rb

@@ -0,0 +1,8 @@
+require "http_error/error"
+
+module HttpError
+  class NotImplemented < Error
+    self.status = 501
+    self.message = 'Not implemented'
+  end
+end

data/lib/http_error/response.rb

@@ -0,0 +1,20 @@
+module HttpError
+  module Response
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from HttpError::Error do |error|
+        Rails.logger.debug "Rescuing from #{error.class}. Status: #{error.status}. Message: #{error.message}"
+
+        hash = {
+          error: error.message,
+        }
+
+        render \
+          text: error.message,
+          json: hash,
+          status: error.status
+      end
+    end
+  end
+end

data/lib/http_error/teapot.rb

@@ -0,0 +1,8 @@
+require "http_error/error"
+
+module HttpError
+  class Teapot < Error
+    self.status = 418
+    self.message = "I'm a teapot"
+  end
+end

data/lib/http_error/unauthorized.rb

@@ -0,0 +1,9 @@
+require "http_error/error"
+
+module HttpError
+  # InternalServerError is used by all other errors to inherit from
+  class Unauthorized < Error
+    self.status = 401
+    self.message = 'Unauthorized'
+  end
+end

data/lib/http_error/version.rb

@@ -0,0 +1,3 @@
+module HttpErrors
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: http-errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emil Kampp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Easy way to raise HTTP errors from your ruby application
+email:
+- emil@kampp.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- http_errors.gemspec
+- lib/http_error.rb
+- lib/http_error/bad_request.rb
+- lib/http_error/error.rb
+- lib/http_error/forbidden.rb
+- lib/http_error/internal_server_error.rb
+- lib/http_error/not_implemented.rb
+- lib/http_error/response.rb
+- lib/http_error/teapot.rb
+- lib/http_error/unauthorized.rb
+- lib/http_error/version.rb
+homepage: https://github.com/YouWeApS/arctic-gems-http_errors
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Easy way to raise HTTP errors from your ruby application
+test_files: []