problem_details-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28c3dbae235a1977ebf1b0020708b00eeda28fe6
+  data.tar.gz: 54405d35d097d1da2cc1bea4f5f4259dff67df0b
+SHA512:
+  metadata.gz: 4b975fa68bf2a498d167e74a2a1d0cf529699f3d6e68140d29519dd1dc38430771111b300ae47517298435c745a2e0f15a068883f99528e4f6bdd095fc58439e
+  data.tar.gz: 441cb4d5c915e25043e741f6f47686fa5d07ade7fe79dfcbcdad66bb4304d18b5f83cea12fb3b6b303e3c4ba6be3a9b8091647bff892db7d81599cf8ec128aa8

data/lib/problem_details-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'problem_details/rails'

data/lib/problem_details/rails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ProblemDetails
+  module Rails
+    require 'problem_details'
+    require_relative 'rails/config'
+    require_relative 'rails/railtie' if defined?(::Rails)
+  end
+end

data/lib/problem_details/rails/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ProblemDetails
+  module Rails
+    # Configures global settings for ProblemDetails::Rails
+    #   ProblemDetails::Rails.configure do |config|
+    #     config.default_json_content_type = 'application/json'
+    #   end
+    class << self
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Config.new
+      end
+    end
+
+    class Config
+      attr_accessor :default_json_content_type
+
+      def initialize
+        @default_json_content_type = 'application/problem+json'
+      end
+    end
+  end
+end

data/lib/problem_details/rails/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ProblemDetails
+  class Railtie < ::Rails::Railtie
+    initializer 'problem_details.initialize' do |_app|
+      ActiveSupport.on_load(:action_controller) do
+        require 'problem_details'
+        require 'problem_details/rails/render_option_builder'
+
+        ActionController::Renderers.add :problem do |content, options|
+          builder = ProblemDetails::Rails::RenderOptionBuilder.new(content, options)
+          render(**builder.build)
+        end
+      end
+    end
+  end
+end

data/lib/problem_details/rails/render_option_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ProblemDetails
+  module Rails
+    # A builder to build a hash that is passed to ActionController's render method.
+    class RenderOptionBuilder
+      # @param [Hash] content given as a value of :problem key of render method.
+      # @param [Hash] options options of render method.
+      def initialize(content, options)
+        @content = content
+        @options = options.dup
+      end
+
+      # @return [Hash] build a hash being passed to render method.
+      def build
+        content_type = @options.delete(:content_type) || ProblemDetails::Rails.config.default_json_content_type
+        status = @options.delete(:status) || :ok
+        document = ProblemDetails::Document.new(status: status, **@content)
+        { json: document.to_h, status: status, content_type: content_type, **@options }
+      end
+    end
+  end
+end

data/problem_details-rails.gemspec

@@ -0,0 +1,29 @@
+# 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-rails'
+  spec.version       = ProblemDetails::VERSION
+  spec.authors       = ['Nobuhiro Nikushi']
+  spec.email         = ['deneb.ge@gmail.com']
+
+  spec.summary       = 'Add a :problem renderer that renponds with RFC 7807 Problem Details format'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/nikushi/problem_details'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files|grep rails`.split($OUTPUT_RECORD_SEPARATOR).reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'problem_details', ProblemDetails::VERSION
+  spec.add_dependency 'actionpack', '>= 4.0'
+  spec.add_dependency 'activesupport', '>= 4.0'
+  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,134 @@
+--- !ruby/object:Gem::Specification
+name: problem_details-rails
+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: problem_details
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.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: Add a :problem renderer that renponds with RFC 7807 Problem Details format
+email:
+- deneb.ge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/problem_details-rails.rb
+- lib/problem_details/rails.rb
+- lib/problem_details/rails/config.rb
+- lib/problem_details/rails/railtie.rb
+- lib/problem_details/rails/render_option_builder.rb
+- problem_details-rails.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: Add a :problem renderer that renponds with RFC 7807 Problem Details format
+test_files: []