problem_details 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 279ec9da84ba4698847e7ab6cf8ebb09760c8141
+  data.tar.gz: b1f21ed649e8873860fc8b40aa769389789b963e
+SHA512:
+  metadata.gz: 7c16cc005ec9b2e9f396f6847677fd66fb82d9859c4d17e4a52f74f7ee3c2bcafe6c47d0f220c5ce3565a006bd458f9e28911c6f7a7ac86417ebaff0252ccf9f
+  data.tar.gz: c8956e2c8fffa9ad141fad4b225733c7109372b33c039a7c2f7c2a4d060479367623478554b1962b393141a4ac4af8b28d064c2eb2573fcdae38b655a727a178

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nobuhiro Nikushi
+
+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,155 @@
+# ProblemDetails [![Build Status](https://travis-ci.org/nikushi/problem_details.svg?branch=master)](https://travis-ci.org/nikushi/problem_details)
+
+ProblemDetails is an implementation of [RFC7807 Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807).
+
+The RFC defines a "problem detail" as a way to inform errors to clients as machine readable form in a HTTP response
+to avoid the need to define new error response formats for HTTP APIs.
+
+This library also works with Rails, by the `problem` renderer that helps to respond with the problem detail form.
+
+Currently only JSON serialization is supported.
+
+## Features
+
+* Provides the class that implements a Problem Details JSON Object.
+* With Rails, automatically adds the renderer to respond with `Content-Type: application/problem+json` which works with `render` in controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'problem_details'
+```
+
+Or if you use with Rails, add below line instead.
+
+```ruby
+gem 'problem_details-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Build a problem
+
+```ruby
+require 'problem_details'
+
+ProblemDetails::Document.new(status: 404).to_json
+```
+
+will produce:
+
+```json
+{
+  "type": "about:blank",
+  "title": "Not Found",
+  "status": 404
+}
+```
+
+As above, the value of `type` will be presented as `about:blank` by default if the value is ommited, also the value of `title` is filled automatically from the status code. These are described in [Predefined Problem Types](https://tools.ietf.org/html/rfc7807#section-4.2):
+
+> The "about:blank" URI, when used as a problem type, indicates that the problem has no additional semantics beyond that of the HTTP status code.
+
+> When "about:blank" is used, the title SHOULD be the same as the recommended HTTP status phrase for that code (e.g., "Not Found" for 404, and so on)
+
+But you may also have the need to add some little hint, e.g. as a custom detail of the problem:
+
+```ruby
+ProblemDetails::Document.new(status: 503, detail: 'Database not reachable').to_json
+```
+
+will produce:
+
+```json
+{
+  "type": "about:blank",
+  "title": "Service Unavailable",
+  "status": 503,
+  "detail": "Database not reachable"
+}
+```
+
+You can build a problem with any additional members which are described as [extension members](https://tools.ietf.org/html/rfc7807#section-3.2).
+
+```ruby
+ProblemDetails::Document.new(
+  status: :forbidden,
+  type: 'https://example.com/probs/out-of-credit',
+  balance: 30,
+  accounts: ['/account/12345', '/account/67890'],
+).to_json
+```
+
+will produce(note that `balance` and `accounts` are extention members):
+
+```json
+{
+  "type": "https://example.com/probs/out-of-credit",
+  "title": "Forbidden",
+  "status": 403,
+  "balance": 30,
+  "accounts": [
+    "/account/12345",
+    "/account/67890"
+  ]
+}
+```
+
+### With Rails
+
+Once `render_problems-rails` gem is installed into a Rails system, a problem can be rendered with the problem detail form with `Content-Type: application/problem+json`.
+
+For example, respond with validation error messages:
+
+```ruby
+# app/controllers/api/posts_controller.rb
+class Api::PostsController < ApplicationController
+  def create
+    @post = Post.new(params[:post])
+    if @post.save
+      render json: @post
+    else
+      render problem: { errors: @post.errors }, status: :unprocessable_entity
+    end
+  end
+end
+```
+
+With `render problem: { ... }`, generated HTTP response will be like:
+
+```
+HTTP/1.1 422 Unprocessable Entity
+Content-Type: application/problem+json; charset=utf-8
+
+{
+  "type": "about:blank",
+  "title": "Unprocessable Entity",
+  "status": 422,
+  "errors": {
+    "body": [
+      "can't be blank"
+    ]
+  }
+}
+```
+
+
+## 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/nikushi/problem_details.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_helper'
+require 'rspec/core/rake_task'
+
+# For multiple gems
+# ref https://github.com/bkeepers/dotenv/blob/master/Rakefile
+
+namespace 'problem_details' do
+  Bundler::GemHelper.install_tasks name: 'problem_details'
+end
+
+namespace 'problem_details-rails' do
+  class ProblemDetailsRailsGemHelper < Bundler::GemHelper
+    def guard_already_tagged; end # noop
+
+    def tag_version; end # noop
+  end
+
+  ProblemDetailsRailsGemHelper.install_tasks name: 'problem_details-rails'
+end
+
+desc 'build gem'
+task build: ['problem_details:build', 'problem_details-rails:build']
+
+desc 'build and install'
+task install: ['problem_details:install', 'problem_details-rails:install']
+
+desc 'release'
+task release: ['problem_details:release', 'problem_details-rails:release']
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'problem_details'
+
+# 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/lib/problem_details.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'problem_details/version'
+require 'problem_details/document'
+
+module ProblemDetails
+end

data/lib/problem_details/document.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rack/utils'
+
+# An object representing RFC 7807 Problem Details
+module ProblemDetails
+  # The class that implements a Problem Details JSON object described in RFC 7807.
+  class Document
+    attr_accessor :type, :title, :status, :detail, :instance
+
+    def initialize(params = {})
+      params = params.dup
+      @type = params.delete(:type) || 'about:blank'
+      @status = Rack::Utils.status_code(params.delete(:status)) if params.key?(:status)
+      @title = params.delete(:title) || (@status ? ::Rack::Utils::HTTP_STATUS_CODES[@status] : nil)
+      @detail = params.delete(:detail)
+      @instance = params.delete(:instance)
+      @extentions = params
+    end
+
+    def to_h
+      h = {}
+      %i[type title status detail instance].each do |key|
+        value = public_send(key)
+        h[key] = value if value
+      end
+      h.merge(@extentions)
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/problem_details/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ProblemDetails
+  VERSION = '0.1.0'
+end

data/problem_details.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'problem_details/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'problem_details'
+  spec.version       = ProblemDetails::VERSION
+  spec.authors       = ['Nobuhiro Nikushi']
+  spec.email         = ['deneb.ge@gmail.com']
+
+  spec.summary       = 'An implementation of RFC 7807 Problem Details for HTTP APIs'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/nikushi/problem_details'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files|grep -v rails`.split($OUTPUT_RECORD_SEPARATOR).reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: problem_details
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobuhiro Nikushi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: An implementation of RFC 7807 Problem Details for HTTP APIs
+email:
+- deneb.ge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/problem_details.rb
+- lib/problem_details/document.rb
+- lib/problem_details/version.rb
+- problem_details.gemspec
+homepage: https://github.com/nikushi/problem_details
+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: An implementation of RFC 7807 Problem Details for HTTP APIs
+test_files: []