problem_details 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 279ec9da84ba4698847e7ab6cf8ebb09760c8141
-  data.tar.gz: b1f21ed649e8873860fc8b40aa769389789b963e
+SHA256:
+  metadata.gz: 3dbc10dcfafafc3f0a5ab8e133bed56285533a9adcba459171f4d57c9d9b3136
+  data.tar.gz: a34e365906ec1b5d4d4d8946369a053c40debef9d871e84482369995ef011f9c
 SHA512:
-  metadata.gz: 7c16cc005ec9b2e9f396f6847677fd66fb82d9859c4d17e4a52f74f7ee3c2bcafe6c47d0f220c5ce3565a006bd458f9e28911c6f7a7ac86417ebaff0252ccf9f
-  data.tar.gz: c8956e2c8fffa9ad141fad4b225733c7109372b33c039a7c2f7c2a4d060479367623478554b1962b393141a4ac4af8b28d064c2eb2573fcdae38b655a727a178
+  metadata.gz: bb93e0090a87c06f4021b5a70e3056c7c187629d93d6383aaa61153108dad7ae7dd426f2874af0434c3a3c8b4efc960fad76a32434737673afff9aa21e523d3b
+  data.tar.gz: 673be8931bf5b2ebabd6818b9e40f023bc8304c6d83dafd363721598df28aa83fca8d8b56e1061e3701ccf6fced41ae3de26d2b7af2da99c47851ed6933a889d

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## 0.2.3 / 2021-09-03
+
+* Support the `#to_hash` implicit conversion protocol (#8) by @stevenharman
+
+## 0.2.2 / 2019-10-30
+
+* Remove default about:blank type (#5) by @akrawchyk
+
+## 0.2.1 / 2018-03-31
+
+* Clarify supported ruby/gem versions
+
+## 0.2.0 / 2018-03-20
+
+### Enhancements:
+* Introduce a new gem, `sinatra-problem_details`, the Sinatra problem detail extension.
+
+## 0.1.0 / 2018-03-26
+
+* First release
+* Initial implementation of `problem_details`
+* Rails renderer feature by `problem_details-rails`

data/README.md

@@ -1,11 +1,14 @@
-# ProblemDetails [![Build Status](https://travis-ci.org/nikushi/problem_details.svg?branch=master)](https://travis-ci.org/nikushi/problem_details)
+# ProblemDetails
+
+[![CI](https://github.com/nikushi/problem_details/actions/workflows/ci.yml/badge.svg)](https://github.com/nikushi/problem_details/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/problem_details.svg)](https://badge.fury.io/rb/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.
+This library also works with Rails and Sinatra, by the `problem` renderer that helps to respond with the problem detail form.
 
 Currently only JSON serialization is supported.
 
@@ -14,6 +17,12 @@ Currently only JSON serialization is supported.
 * 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.
 
+## Supported Versions
+
+* Ruby 2.4.x, 2.5.x, 2.6.x
+* Rails 4.x, 5.x
+* Sinatra >= 1.4
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,6 +37,12 @@ Or if you use with Rails, add below line instead.
 gem 'problem_details-rails'
 ```
 
+With Sinatra, add below line instead.
+
+```ruby
+gem 'sinatra-problem_details'
+```
+
 And then execute:
 
     $ bundle
@@ -40,24 +55,28 @@ And then execute:
 require 'problem_details'
 
 ProblemDetails::Document.new(status: 404).to_json
+
+# Or status code symbol can be specified as well.
+ProblemDetails::Document.new(status: :not_found).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):
+As above, the value of `type` is implied to be `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)
 
+> ..."about:blank" URI is the default value for that ["type"] member.  Consequently, any problem details object not carrying an explicit "type" member implicitly uses this URI.
+
 But you may also have the need to add some little hint, e.g. as a custom detail of the problem:
 
 ```ruby
@@ -68,7 +87,6 @@ will produce:
 
 ```json
 {
-  "type": "about:blank",
   "title": "Service Unavailable",
   "status": 503,
   "detail": "Database not reachable"
@@ -103,7 +121,7 @@ will produce(note that `balance` and `accounts` are extention members):
 
 ### 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`.
+Once `problem_details-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:
 
@@ -128,7 +146,6 @@ HTTP/1.1 422 Unprocessable Entity
 Content-Type: application/problem+json; charset=utf-8
 
 {
-  "type": "about:blank",
   "title": "Unprocessable Entity",
   "status": 422,
   "errors": {
@@ -139,6 +156,52 @@ Content-Type: application/problem+json; charset=utf-8
 }
 ```
 
+### With Sinatra
+
+Install `sinatra-problems_details` into a sinatra app, a problem is be rendered as well with `Content-Type: application/problem+json`.
+
+#### Classic Application
+
+```ruby
+require 'sinatra'
+require 'sinatra-problem_details'
+
+get '/' do
+  status 400
+  problem foo: 'bar'
+end
+```
+
+#### Modular Application
+
+```ruby
+require 'sinatra/base'
+require 'sinatra-problem_details'
+
+class MyApp < Sinatra::Base
+  register Sinatra::ProblemDetails
+
+  get '/' do
+    status 400
+    problem foo: 'bar'
+  end
+end
+```
+
+#### Response
+
+The sinatra apps defined in the previous sections will render:
+
+```
+HTTP/1.1 400 Bad Request
+Content-Type: application/problem+json
+
+{
+  "title": "Bad Request",
+  "status": 400,
+  "foo": "bar"
+}
+```
 
 ## Development
 

data/Rakefile

@@ -6,6 +6,23 @@ require 'rspec/core/rake_task'
 # For multiple gems
 # ref https://github.com/bkeepers/dotenv/blob/master/Rakefile
 
+# === helpers ===
+def source_version
+  @source_version ||= File.read(File.expand_path("../VERSION", __FILE__)).strip
+end
+
+# == release ====
+desc "Commits the version"
+task :commit_version do
+  sh <<-SH
+    gsed -i "s/.*VERSION.*/  VERSION = '#{source_version}'/" lib/problem_details/version.rb
+    gsed -i "s/.*VERSION.*/    VERSION = '#{source_version}'/" problem_details-rails/lib/problem_details/rails/version.rb
+    gsed -i "s/.*VERSION.*/    VERSION = '#{source_version}'/" sinatra-problem_details/lib/sinatra/problem_details/version.rb
+  SH
+
+  sh "git commit --allow-empty -a -m '#{source_version} release'"
+end
+
 namespace 'problem_details' do
   Bundler::GemHelper.install_tasks name: 'problem_details'
 end
@@ -17,17 +34,47 @@ namespace 'problem_details-rails' do
     def tag_version; end # noop
   end
 
-  ProblemDetailsRailsGemHelper.install_tasks name: 'problem_details-rails'
+  ProblemDetailsRailsGemHelper.install_tasks dir: File.join(__dir__, 'problem_details-rails'), name: 'problem_details-rails'
+end
+
+namespace 'sinatra-problem_details' do
+  class SinatraProblemDetailsGemHelper < Bundler::GemHelper
+    def guard_already_tagged; end # noop
+
+    def tag_version; end # noop
+  end
+
+  SinatraProblemDetailsGemHelper.install_tasks dir: File.join(__dir__, 'sinatra-problem_details'), name: 'sinatra-problem_details'
 end
 
 desc 'build gem'
-task build: ['problem_details:build', 'problem_details-rails:build']
+task build: ['problem_details:build', 'problem_details-rails:build', 'sinatra-problem_details:build']
 
 desc 'build and install'
-task install: ['problem_details:install', 'problem_details-rails:install']
+task install: ['problem_details:install', 'problem_details-rails:install', 'sinatra-problem_details:build']
 
 desc 'release'
-task release: ['problem_details:release', 'problem_details-rails:release']
+task release: ['problem_details:release', 'problem_details-rails:release', 'sinatra-problem_details:release']
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+task default: 'spec:all'
+
+namespace :spec do
+  dirs = %w(
+    .
+    problem_details-rails
+    sinatra-problem_details
+  )
+
+  desc "Run all specs"
+  task :all do
+    dirs.each do |d|
+      Dir.chdir(d) do
+        Bundler.with_clean_env do
+          sh 'bundle --quiet'
+          sh 'bundle exec rake spec'
+        end
+      end
+    end
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.3

data/lib/problem_details/document.rb

@@ -11,7 +11,7 @@ module ProblemDetails
 
     def initialize(params = {})
       params = params.dup
-      @type = params.delete(:type) || 'about:blank'
+      @type = params.delete(:type)
       @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)
@@ -19,7 +19,7 @@ module ProblemDetails
       @extentions = params
     end
 
-    def to_h
+    def to_hash
       h = {}
       %i[type title status detail instance].each do |key|
         value = public_send(key)
@@ -27,9 +27,10 @@ module ProblemDetails
       end
       h.merge(@extentions)
     end
+    alias_method :to_h, :to_hash
 
     def to_json
-      to_h.to_json
+      to_hash.to_json
     end
   end
 end

data/lib/problem_details/version.rb

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

data/lib/problem_details.rb

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

data/problem_details.gemspec

@@ -1,27 +1,31 @@
 # frozen_string_literal: true
-
+version = File.read(File.expand_path('VERSION', __dir__)).strip
 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.version       = 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.files         = Dir['lib/**/*.rb'] + %w[
+    CHANGELOG.md
+    LICENSE.txt
+    README.md
+    Rakefile
+    problem_details.gemspec
+    VERSION
+  ]
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rack'
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'rack', '>= 1.1.0'
+  spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: problem_details
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Nobuhiro Nikushi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-26 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.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
@@ -73,15 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- VERSION
 - lib/problem_details.rb
 - lib/problem_details/document.rb
 - lib/problem_details/version.rb
@@ -98,15 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An implementation of RFC 7807 Problem Details for HTTP APIs

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -1,7 +0,0 @@
-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/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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