roda-contrib 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02c8c0cc04c5707343034068120ae9b8ed70cf90
-  data.tar.gz: af47f15ba933ef6a3c0dc06219a6e1a0a1f2d7dd
+  metadata.gz: 98460898008a6d9fa6213b1d5b77f524a9eac86c
+  data.tar.gz: d58b7165a2d2ba77371768f928ac5acfea445f26
 SHA512:
-  metadata.gz: 309ecb8592c05a838d39658cfad67c1d121646cc64ad0d7c54ade11ce5fadfacfb395743ddffe38d76a4de02287a401488d40c48abb965182b7cff2a59caeaa8
-  data.tar.gz: 5b9127a06f6c68c9cb3050713c923263e4cae9fdb01477b05ad1cc2238c4fc0a046a2ecfea7f2a1ef97ce090bb16f02d6a75023240b0071baf8acc8a1ba183a2
+  metadata.gz: 3c879c14dc8f0856ab6b088fd61bae9bd57e51a8704e052f1c8123e1f580b8d934462e3542cfd4ad2641fccff8c187d49701d0040264761312c07e366fb501da
+  data.tar.gz: ec7b4e96e1e8fecf2ad83e4916033083d71d61f98c28fb71ee46ce194169e000efdbbcef898c38d0caf819f4ff79bb157b3bf275ef83ae71fe268de94cc84c93

data/CHANGELOG

@@ -1,3 +1,6 @@
+= 0.3.0(2017-6-7)
+  * add json_api plugin
+
 = 0.2.0(2017-6-6)
   * add load_all plugin
   * add multi_dispatch plugin

data/README.md

@@ -21,11 +21,12 @@ Or install it yourself as:
 
 ## Usage
 
-Currently, the roda-contrib gem ships 3 plugins:
+Currently, the roda-contrib gem ships 4 plugins:
 
 * load\_all
 * multi\_dispatch
 * csrf
+* json\_api
 
 When loading plugins from this gem, you should append the 'contrib' to the
 symbol to load it. For example, if you want to use the multi\_dispatch plugin:

data/doc/release_notes/0_3_0.rdoc

@@ -0,0 +1,6 @@
+= 0.3.0 release note
+
+== New Feature
+
+* add _contrib_json_api_ plugin.
+  This plugin offers intergration with the jsonapi-rb gem

data/lib/roda/contrib/plugins/json_api.rb

@@ -0,0 +1,177 @@
+require 'rack/parser'
+require 'jsonapi/serializable'
+require 'jsonapi/deserializable'
+
+module RodaContrib
+  module Plugins
+    # This plugin intergrate Roda with the jsonapi-rb gem. It offers a simple
+    # interface to users, but a bit opinioned.
+    #
+    # === Prerequest
+    # To use this plugin, you should install the +rack-parser+ and the
+    # +jsonapi-rb+ gem first.
+    #
+    # === Configuration
+    # The +contrib_json_api+ plugin will not complain if you offer nothing to
+    # configure the boring middleware.
+    #
+    #   App.plugin :contrib_json_api
+    #
+    # You can use options pass to this plugin to configure the +Rack::Parser+.
+    #
+    #   App.plugin :contrib_json_api, {
+    #     :parser => { 'application/json' => proc { |data| MultiJSON.parse(data) } },
+    #     :handler => { 'application/json' => proc { |e, t| [400, {'Content-Type' => t}, ["broke"]] }
+    #   }
+    #
+    # Check the rack-parser documentation for more information
+    #
+    # Optionally, if you already have the rack-parser middleware and don't want
+    # to setup the middleware again, you can use +:skip_middleware+ option to
+    # do so:
+    #
+    #  App.plugin :contrib_json_api, skip_middleware: true
+    #
+    # === Usage
+    # The +contrib_json_api+ plugin only expose three methods to use.
+    #
+    # the +represent+ method is used for rendering the resources
+    #   represent rc, with: SerializableRc
+    #
+    # the +represent_err+ method is used for rendering the errors, if you don't
+    # offer a title, 'model field validation error' will be used as title. the
+    # status is default to 400.
+    #
+    #   represent rc.errors, title: 'gateway not reachable', status: 500
+    #
+    # the +json_params+ method is used to get the parsed data from the request
+    # body.
+    #
+    # a lot of options could be applied to customize the +represent+ and
+    # +represent_err+ method. Checkout the official jsonapi-rb documentation:
+    # https://jsonapi-rb.org/guides
+    #
+    # === Exmaple
+    #   class App < Roda
+    #     plugin :contrib_json_api
+    #
+    #     route do |r|
+    #       r.on 'product' do
+    #         r.is :id do |id|
+    #           @rc = Product.with_pk(id.to_i)
+    #
+    #           r.get do
+    #             represent @rc, with: SerializableProduct
+    #           end
+    #
+    #           r.post do
+    #             @rc.set_fields(json_params)
+    #             if @rc.valid?
+    #               @rc.save_changes
+    #               represent @rc, with: SerializableProduct
+    #             else
+    #               represent_err @rc.errors
+    #             end
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    module JsonApi
+      CONTENT_TYPE             = 'Content-Type'.freeze
+
+      JSONAPI_MEDIA_TYPE       = 'application/vnd.api+json'.freeze
+
+      RACK_PASER_PARAMS        = 'rack.parser.result'.freeze
+
+      DEFAULT_JSON_PARSER      = proc { |data| JSON.parse(data) }
+
+      DEFAULT_ERROR_HANDLER    = proc { |err, type|
+        e = [SerializableError.new(title: 'invalid JSON doc', err: err, status: 400)]
+        msg = JSONAPI::Serializable::ErrorRenderer.render(e, {})
+        [400, { CONTENT_TYPE => JSONAPI_MEDIA_TYPE }, [msg]]
+      }
+
+      DEFAULT_RACK_PARSER_OPTS = {
+        parsers: { JSONAPI_MEDIA_TYPE => DEFAULT_JSON_PARSER },
+        handlers: { JSONAPI_MEDIA_TYPE => DEFAULT_ERROR_HANDLER }
+      }.freeze
+
+      class SerializableError < JSONAPI::Serializable::Error
+        title { @title }
+        status { @status }
+        detail { @err.is_a?(Exception) ? @err.message : @err }
+      end
+
+      def self.configure(app, opts={})
+        return if opts[:skip_middleware]
+
+        app.instance_exec do
+          @middleware.each do |(mid, *rest), _|
+            if mid.equal?(::Rack::Parser)
+              rest[0].merge!(opts)
+              build_rack_app
+              return
+            end
+          end
+
+          if opts.empty?
+            use ::Rack::Parser, DEFAULT_RACK_PARSER_OPTS.dup
+            return
+          elsif opts[:parsers].nil? || opts[:pasers][JSONAPI_MEDIA_TYPE].nil?
+            opts[:parsers] = { JSONAPI_MEDIA_TYPE => DEFAULT_JSON_PARSER }
+            use ::Rack::Parser, opts
+          end
+        end
+      end
+
+      module InstanceMethods
+        def represent(rc, options={})
+          options[:class] = options.delete(:with) unless options[:class]
+          rendered = JSONAPI::Serializable::Renderer.render(rc, options)
+
+          response[CONTENT_TYPE] = JSONAPI_MEDIA_TYPE
+          response.write(rendered)
+          request.halt
+        end
+
+        def represent_err(errs, options={})
+          t = options.delete(:title) || 'model field validation failed'
+          s = options.delete[:status] || 400
+          e = if errs.resond_to? :full_messages
+                errs.full_messages.map { |err| SerializableError.new(title: t, err: err, status: s) }
+              else
+                [SerializableError.new(title: t, err: errs, status: s)]
+              end
+          rendered = JSONAPI::Serializable::ErrorRenderer.render(e, options)
+
+          response.status = s
+          response[CONTENT_TYPE] = JSONAPI_MEDIA_TYPE
+          response.write(rendered)
+          request.halt
+        end
+
+        def json_params
+          parse_jsonapi env[RACK_PASER_PARAMS]
+        end
+
+        private
+        def parse_jsonapi(rc, options={})
+          klass = options[:with] || JSONAPI::Deserializable::Resource
+          begin
+            result = klass.call(rc)
+          rescue JSONAPI::Parser::InvalidDocument => e
+            errs = [SerializableError.new(title: 'Invalid JSONAPI doc', error: e, status: 400)]
+            rendered = JSONAPI::Serializable::ErrorRenderer.render(errs, {})
+
+            response.status = 400
+            response[CONTENT_TYPE] = JSONAPI_MEDIA_TYPE
+            response.write(rendered)
+            request.halt
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/roda/contrib/version.rb

@@ -1,3 +1,3 @@
 module RodaContrib
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/roda/plugins/contrib_json_api.rb

@@ -0,0 +1,3 @@
+require 'roda/contrib/plugins/json_api'
+
+Roda::RodaPlugins.register_plugin(:contrib_json_api, RodaContrib::Plugins::JsonApi)

data/roda-contrib.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rack_csrf'
+  spec.add_development_dependency 'rack-parser'
+  spec.add_development_dependency 'jsonapi-rb'
 
   spec.add_dependency 'roda', '~> 2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda-contrib
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - luciusgone
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-parser
+  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'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-rb
+  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'
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +154,17 @@ files:
 - Rakefile
 - doc/release_notes/0_1_0.rdoc
 - doc/release_notes/0_2_0.rdoc
+- doc/release_notes/0_3_0.rdoc
 - lib/roda/contrib.rb
 - lib/roda/contrib/action.rb
 - lib/roda/contrib/action/dispatchable.rb
 - lib/roda/contrib/plugins/csrf.rb
+- lib/roda/contrib/plugins/json_api.rb
 - lib/roda/contrib/plugins/load_all.rb
 - lib/roda/contrib/plugins/multi_dispatch.rb
 - lib/roda/contrib/version.rb
 - lib/roda/plugins/contrib_csrf.rb
+- lib/roda/plugins/contrib_json_api.rb
 - lib/roda/plugins/contrib_load_all.rb
 - lib/roda/plugins/contrib_multi_dispatch.rb
 - roda-contrib.gemspec