jsonapi_exception 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e75f978fc1a34dd12d6dac2c3f6046986c9013a
+  data.tar.gz: 51570bdb8232a89a73532c440b117144123b5a55
+SHA512:
+  metadata.gz: a609307688946e0ae639c44f244372d03d5490034b78029900e989f9536a89165964655e6f9f624ef3311f18f938c956de3fcf8eaa6e2dc3eb487e379db2fa90
+  data.tar.gz: fe4ad4f0bcb310ec5244cdc95fc455fc232849f24e54c0e7b801ba5fea116c2afcb8d5b75c523ce1933384e723594ec0feebd98e80420cfad583d2d924b4ac7e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,71 @@
+# Built-in config:
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# We do not typically use/need class documentation
+Documentation:
+    Enabled: false
+
+Metrics/LineLength:
+    Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/RaiseArgs:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 6
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/MultilineArrayBraceLayout:
+  Enabled: false
+
+Style/MultilineHashBraceLayout:
+  Enabled: false
+
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Semicolon:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+# Run rails specific checks
+# https://github.com/bbatsov/rubocop#rails
+Rails:
+  Enabled: true
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Include:
+    # Include important files that don't end in .rb
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    # exclude files in /vendor because some CI systems put gems in here e.g.
+    # TravisCI
+    - 'vendor/**/*'
+    # exclude the autogenerated schema file as we don't have any control over
+    # its format
+    - 'db/schema.rb'
+    - 'bin/**/*'
+    - 'doc/**/*'
+    - 'db/migrate/**/*'
+    - 'db/seeds.rb'
+    - 'features/**/*.rb'
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Harton
+
+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,48 @@
+# JsonapiException
+
+We're constantly having to rescue exceptions and format them as JSONAPI, so here's an object that does it for you. :sparkles:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_exception'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi_exception
+
+## Usage
+
+In your Rails controller you can do the following:
+
+```ruby
+class WidgetController < ApplicationController::Base
+
+  rescue_from WidgetService::InsufficientWidgets do |exception|
+    render JsonapiException.new(exception, status: 416).for_render
+  end
+
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rabid/jsonapi_exception.
+
+## 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,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 "jsonapi_exception"
+
+# 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

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/jsonapi_exception.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jsonapi_exception/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_exception"
+  spec.version       = JsonapiException::VERSION
+  spec.authors       = ["James Harton"]
+  spec.email         = ["james@rabidtech.co.nz"]
+
+  spec.summary       = "Simple wrapper to turn exceptions into JSONAPI compatible hashes"
+  spec.description   = "We keep needing this, so we made it."
+  spec.homepage      = "https://github.com/rabid/jsonapi_exceptions"
+  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"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.42"
+  spec.add_development_dependency "faker"
+end

data/lib/jsonapi_exception/version.rb

@@ -0,0 +1,3 @@
+class JsonapiException
+  VERSION = "0.1.0".freeze
+end

data/lib/jsonapi_exception.rb

@@ -0,0 +1,88 @@
+require "jsonapi_exception/version"
+
+class JsonapiException
+  DEFAULT_STATUS = 422
+  MIME_TYPE = "application/vnd.api+json".freeze
+
+  def initialize(exception, opts = {})
+    @exception = exception
+    @opts      = opts
+  end
+
+  def title
+    opts.fetch(:title)
+  rescue KeyError
+    exception
+      .class
+      .to_s
+      .split("::")
+      .last
+      .scan(/([A-Z][^A-Z]*)/)
+      .join(" ")
+      .sub(/ (Error|Exception)$/, "")
+  end
+
+  def detail
+    opts.fetch(:detail, exception.message)
+  end
+
+  def status
+    opts.fetch(:status, DEFAULT_STATUS)
+  end
+
+  def id
+    opts.fetch(:id, exception.object_id)
+  end
+
+  def code
+    opts[:code]
+  end
+
+  def links
+    opts[:links]
+  end
+
+  def meta
+    return opts[:meta] if opts[:meta]
+    return unless show_exceptions?
+    {
+      class:     exception.class.to_s,
+      message:   exception.message,
+      backtrace: exception.backtrace
+    }
+  end
+
+  def as_json(*_)
+    {
+      errors: [to_h]
+    }
+  end
+
+  def to_h
+    {
+      title:  title,
+      links:  links,
+      detail: detail,
+      status: status.to_s,
+      id:     id,
+      code:   code
+    }.reject { |_, v| !v }
+  end
+
+  def for_render
+    {
+      json:         as_json,
+      status:       status,
+      content_type: MIME_TYPE
+    }
+  end
+
+  private
+
+  attr_reader :exception, :opts
+
+  def show_exceptions?
+    return false unless defined?(Rails)
+    Rails.application.config.action_dispatch.show_exceptions
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_exception
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Harton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-15 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'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.42'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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: We keep needing this, so we made it.
+email:
+- james@rabidtech.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi_exception.gemspec
+- lib/jsonapi_exception.rb
+- lib/jsonapi_exception/version.rb
+homepage: https://github.com/rabid/jsonapi_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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple wrapper to turn exceptions into JSONAPI compatible hashes
+test_files: []