jsonapi-hanami 0.1.1.beta1 → 0.1.1.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94e7c1facd5e28912e6075ba466857778aa4bea7
-  data.tar.gz: 9a59bdd9aa7c79c08fb6f0cf7b3da9b4092a268f
+  metadata.gz: b0b7a3e38db607b870ef29a1c25959f8eff78b4d
+  data.tar.gz: 61936fb8435c552b44a5f7b498efbcd436c7d168
 SHA512:
-  metadata.gz: 4af00dfe4cc9636eb6960a93cf5f8752310fa125c2f2d22ea06a76051e20fd81af970a3eae760c5962926fbc521b9737f37add926686798de865055cfa8ef423
-  data.tar.gz: c78e95aaff61c47b5a28890e2d694910e1a081e66c4f6093b91e64b16d80e7cd019940e822197f632ba699403af0e9478d804c0d9b9ea11ca9534c69ce6b8fce
+  metadata.gz: eefac983e6f2d404a2f85ae2d7469a5bb5f7370062dcf5b41e3363479f2449f5d45eb447b640a32cce1bf1bdbc492e47faa789607645c5cb35240561eb908c7f
+  data.tar.gz: e0a1656fa2b6f5eb1913efbd377c411fff3339c62619b83e3d786316e022f3017cef1093b9d783a9aec63795cf8723c4da288880313766231ac7719587365e86

data/README.md

@@ -40,9 +40,21 @@ module API::Controllers::Posts
     end
 
     def call(params)
-      User.new(params[:user])
-      # ...
-      self.body = jsonapi_render(resources)
+      unless params.valid?
+        self.errors = params.errors
+        return
+      end
+
+      repo = UserRepository.new
+      user = repo.create(params[:user])
+
+      self.data = user
+      self.meta = { foo: 'bar' }
+      self.links = { self: 'foo://bar' }
+      self.jsonapi = { version: '1.0', meta: { foo: 'bar' } }
+      # Also available:
+      #  self.included = { posts: [:author, comments: [:author]] }
+      #  self.fields = { posts: [:title, :date], users: [:name] }
     end
   end
 end

data/lib/jsonapi/hanami/action.rb

@@ -1,13 +1,13 @@
-require 'jsonapi/hanami/renderer'
-require 'jsonapi/hanami/deserializable'
+require 'jsonapi/hanami/deserialization'
+require 'jsonapi/hanami/rendering'
 
 module JSONAPI
   module Hanami
     module Action
       def self.included(base)
         base.class_eval do
-          include Renderer
-          include Deserializable
+          include Deserialization
+          include Rendering
         end
       end
     end

data/lib/jsonapi/hanami/commands/generate/deserializable.rb

@@ -0,0 +1,12 @@
+require 'hanami/commands/generate/abstract'
+require 'hanami/application_name'
+
+module Hanami
+  module Commands
+    class Generate
+      class Deserializable < Abstract
+
+      end
+    end
+  end
+end

data/lib/jsonapi/hanami/{deserializable.rb → deserialization.rb}

@@ -3,7 +3,7 @@ require 'jsonapi/parser'
 
 module JSONAPI
   module Hanami
-    module Deserializable
+    module Deserialization
       def self.included(base)
         base.extend ClassMethods
       end
@@ -13,19 +13,21 @@ module JSONAPI
           if klass.nil?
             klass = Class.new(JSONAPI::Deserializable::Resource, &block)
           end
-          use DeserializableResource, key, klass
+          use DeserializeResource, key, klass
         end
 
         def deserializable_relationship(key, klass = nil, &block)
           if klass.nil?
             klass = Class.new(JSONAPI::Deserializable::Relationship, &block)
           end
-          use DeserializableRelationship, key, klass
+          use DeserializeRelationship, key, klass
         end
       end
 
-      class DeserializableMiddleware
+      class DeserializationMiddleware
         ROUTER_PARAMS = 'router.params'.freeze
+        ROUTER_PARSED_BODY = 'router.parsed_body'.freeze
+        JSONAPI_KEYS = [:data, :meta, :links, :jsonapi].freeze
 
         def initialize(app, key, klass)
           @app = app
@@ -34,22 +36,29 @@ module JSONAPI
         end
 
         def call(env)
-          env[ROUTER_PARAMS].tap do |body|
-            parser.parse!(body)
-            deserialized_hash = @deserializable_class.call(body)
-            body.replace(@deserializable_key => deserialized_hash)
+          body = env[ROUTER_PARSED_BODY]
+          parser.parse!(body)
+          deserialized_hash = @deserializable_class.call(body)
+          params = env[ROUTER_PARAMS]
+          # TODO(beauby): Actually replace the request body upstream instead
+          #   of hacking it here.
+          params[:_jsonapi] = {}
+          JSONAPI_KEYS.each do |key|
+            params[:_jsonapi][key] = params.delete(key) if params.key?(key)
           end
+          params[@deserializable_key] = deserialized_hash
+
           @app.call(env)
         end
       end
 
-      class DeserializableResource < DeserializableMiddleware
+      class DeserializeResource < DeserializationMiddleware
         def parser
           JSONAPI::Parser::Resource
         end
       end
 
-      class DeserializableRelationship < DeserializableMiddleware
+      class DeserializeRelationship < DeserializationMiddleware
         def parser
           JSONAPI::Parser::Relationship
         end

data/lib/jsonapi/hanami/generators/deserializable.rb

@@ -0,0 +1,7 @@
+p "zizi"
+Hanami::CliSubCommands::Generate.define_commands do
+  desc 'deserializable', 'Generate deserializable class.'
+  def deserializable(application_name = :app, resource_name)
+
+  end
+end

data/lib/jsonapi/hanami/rendering.rb

@@ -0,0 +1,67 @@
+require 'jsonapi/serializable'
+require 'jsonapi/hanami/rendering/dsl'
+
+module JSONAPI
+  module Hanami
+    module Rendering
+      def self.included(base)
+        base.class_eval do
+          include JSONAPI::Hanami::Rendering::DSL
+
+          after do
+            _jsonapi_render if @_body.nil?
+          end
+        end
+      end
+
+      def _jsonapi_render
+        if @_jsonapi.key?(:errors)
+          _jsonapi_render_error
+        else
+          _jsonapi_render_success
+        end
+      end
+
+      def _jsonapi_render_success
+        self.format = :jsonapi if @format.nil?
+        return unless @_jsonapi.key?(:data)
+        self.body = JSONAPI::Serializable::Renderer.render(@_jsonapi[:data],
+                                                           _jsonapi_params)
+      end
+
+      # NOTE(beauby): It might be worth factoring those methods out into a
+      #   class.
+      def _jsonapi_params
+        # TODO(beauby): Inject global params (toplevel jsonapi, etc.).
+        @_jsonapi.dup.merge!(expose: _jsonapi_exposures)
+      end
+
+      def _jsonapi_exposures
+        { routes: routes }.merge!(exposures)
+      end
+
+      def _jsonapi_render_error
+        document =
+          JSONAPI::Serializable::ErrorRenderer.render(@_jsonapi[:errors],
+                                                      _jsonapi_error_params)
+        self.status = _jsonapi_error_status unless @_status
+        self.format = :jsonapi if @format.nil?
+        self.body   = document
+      end
+
+      def _jsonapi_error_status
+        # TODO(beauby): Set HTTP status code accordingly.
+        400
+      end
+
+      def _jsonapi_error_params
+        @_jsonapi
+      end
+
+      def _jsonapi_errors
+        # TODO(beauby): Implement inferrence for Hanami::Validations.
+        @_jsonapi[:errors]
+      end
+    end
+  end
+end

data/lib/jsonapi/hanami/rendering/dsl.rb

@@ -0,0 +1,47 @@
+module JSONAPI
+  module Hanami
+    module Rendering
+      module DSL
+        def data=(value)
+          (@_jsonapi ||= {}).merge!(data: value)
+        end
+
+        def errors=(value)
+          (@_jsonapi ||= {}).merge!(errors: value)
+        end
+
+        def include=(value)
+          (@_jsonapi ||= {}).merge!(include: value)
+        end
+
+        def fields=(value)
+          (@_jsonapi ||= {}).merge!(fields: value)
+        end
+
+        def meta=(value)
+          (@_jsonapi ||= {}).merge!(meta: value)
+        end
+
+        def links=(value)
+          (@_jsonapi ||= {}).merge!(links: value)
+        end
+
+        def jsonapi=(value)
+          (@_jsonapi ||= {}).merge!(jsonapi: value)
+        end
+
+        def serializable_class=(value)
+          (@_jsonapi ||= {}).merge!(class: value)
+        end
+
+        def serializable_namespace=(value)
+          (@_jsonapi ||= {}).merge!(namespace: value)
+        end
+
+        def serializable_inferer=(value)
+          (@_jsonapi ||= {}).merge!(inferer: value)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-hanami
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta1
+  version: 0.1.1.beta2
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta2
+        version: 0.1.1.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta2
+        version: 0.1.1.beta3
 - !ruby/object:Gem::Dependency
   name: jsonapi-parser
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta2
+        version: 0.1.1.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta2
+        version: 0.1.1.beta3
 - !ruby/object:Gem::Dependency
   name: jsonapi-deserializable
   requirement: !ruby/object:Gem::Requirement
@@ -70,31 +70,31 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-description: Efficiently build and consume JSON API documents.
+        version: '3.5'
+description: Efficient, convenient, non-intrusive JSONAPI framework for Hanami.
 email: lucas.hosseini@gmail.com
 executables: []
 extensions: []
@@ -104,8 +104,11 @@ files:
 - lib/generators/hanami/serializable.rb
 - lib/jsonapi/hanami.rb
 - lib/jsonapi/hanami/action.rb
-- lib/jsonapi/hanami/deserializable.rb
-- lib/jsonapi/hanami/renderer.rb
+- lib/jsonapi/hanami/commands/generate/deserializable.rb
+- lib/jsonapi/hanami/deserialization.rb
+- lib/jsonapi/hanami/generators/deserializable.rb
+- lib/jsonapi/hanami/rendering.rb
+- lib/jsonapi/hanami/rendering/dsl.rb
 homepage: https://github.com/jsonapi-rb/hanami
 licenses:
 - MIT
@@ -129,5 +132,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Hanami plugin for (de)serialization of JSON API resources.
+summary: jsonapi-rb integrations for Hanami.
 test_files: []

data/lib/jsonapi/hanami/renderer.rb

@@ -1,13 +0,0 @@
-require 'jsonapi/renderer'
-
-module JSONAPI
-  module Hanami
-    module Renderer
-      def jsonapi_render(resources, params = {})
-        # TODO(beauby): Serializable inference with helpers injection.
-        # TODO(beauby): Inject global params (toplevel jsonapi, etc.).
-        JSONAPI::Renderer.new(resources, params).as_json
-      end
-    end
-  end
-end