jsonapi-rails 0.1.1.beta4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e8e67bf5e4b3dd0ba9c9a3cf32325bfadd1c14
-  data.tar.gz: 643e26ce20f6f6107752ee0a4df1e0eccfc633f1
+  metadata.gz: d03b1dcb88e6112b5b8c82e1fb400ce802fe66a5
+  data.tar.gz: cf69d3e19c4e73a5cdf1b7543e0620ee2f6d4504
 SHA512:
-  metadata.gz: d7845abcc10f12cc53d941a4bb271a3137c938dc93ff8e0c0fa8fbed5325123dd2e984dea105924dbad7819359e43cf64e596fc88fb2eb68b1203c72ffca3afd
-  data.tar.gz: be4b0bdcb39e0fc48b497629ffe216b82817bb04e7d6c84b04b0279650b654acc1f6759e4bf3ce632266d6c368801323e0065038475039469a40973752e4a75b
+  metadata.gz: 0233e1af894d9227ba5b396c669c500c9f244d258bf6ac66e85936566b93be555837d6be3ecb041b000aa989b6a699ab113eab73fac15c99aa1358bc441569fc
+  data.tar.gz: 42665fbd7fc8d29d251573d20fc3a3aba19f03e1390f7bbb86fea6a337e19dc30d9435a29ef48e6474b01da41c1213cca4d5e04c1886dc0f1d475bb6b252e763

data/README.md

@@ -1,10 +1,11 @@
 # jsonapi-rails
-Rails integration for [jsonapi-rb](https://github.com/jsonapi-rb/jsonapi-rb).
+Rails integration for [jsonapi-rb](http://jsonapi-rb.org).
 
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/jsonapi-rails.svg)](https://badge.fury.io/rb/jsonapi-rails)
-[![Build Status](https://secure.travis-ci.org/jsonapi-rb/rails.svg?branch=master)](http://travis-ci.org/jsonapi-rb/rails?branch=master)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/jsonapi-rails.svg?branch=master)](http://travis-ci.org/jsonapi-rb/rails?branch=master)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
 
 ## Installation
 
@@ -16,85 +17,10 @@ And then execute:
 ```
 $ bundle
 ```
-Or install it manually as:
-```
-$ gem install jsonapi-rails
-```
-
-## Usage
-
-### Serialization
-
-Example:
-```ruby
-# app/serializable/serializable_user.rb
-class SerializableUser < JSONAPI::Serializable::Model
-  type 'users'
-
-  attribute :name
-  attribute :email do
-    "#{@model.name}@foo.bar"
-  end
-
-  has_many :posts do
-    # data is auto-inferred
-    link(:related) { @url_helpers.user_posts(@model) }
-    meta foo: :bar
-  end
-
-  has_many :comments do
-    data do
-      @user.comments.order(:desc)
-    end
-  end
-
-  has_many :reviews, Foo::Bar::SerializableRev
 
-  link(:self) { @url_helpers.user_url(@model.id) }
-  meta do
-    { foo: 'bar' }
-  end
-end
+## Usage and documentation
 
-# app/controllers/users_controller.rb
-# ...
-user = User.find_by(id: id)
-render jsonapi: user, include: { posts: [:comments] }, meta: { foo: 'bar' }
-# ...
-```
-
-### Deserialization
-
-Example:
-```ruby
-class PostsController < ActionController::Base
-  deserializable_resource :post, only: [:create, :update] do
-    attribute :title
-    attribute :date
-    has_one :author do |rel, id, type|
-      field user_id: id
-      field user_type: type
-    end
-    has_many :comments
-  end
-
-  def create_params
-    params.require(:user).permit!
-  end
-
-  def create
-    create_params[:title]
-    create_params[:date]
-    create_params[:comment_ids]
-    create_params[:comment_types]
-    create_params[:user_id]
-    create_params[:user_type]
-    # ...
-  end
-end
-
-
-```
+See [jsonapi-rb.org/guides](http://jsonapi-rb.org/guides).
 
 ## License
 

data/lib/generators/jsonapi/serializable/templates/serializable.rb.erb

@@ -1,11 +1,9 @@
 <% module_namespacing do -%>
-class Serializable<%= class_name %> < JSONAPI::Serializable::Model
+class Serializable<%= class_name %> < JSONAPI::Serializable::Resource
   type '<%= type %>'
-
 <% attr_names.each do |attr| -%>
   attribute :<%= attr %>
 <% end -%>
-
 <% has_one_rel_names.each do |rel| -%>
   has_one :<%= rel %>
 <% end -%>

data/lib/jsonapi/rails.rb

@@ -1,6 +1,3 @@
 require 'jsonapi/deserializable'
 require 'jsonapi/serializable'
-
-require 'jsonapi/rails/deserializable/resource_extensions'
-
 require 'jsonapi/rails/railtie'

data/lib/jsonapi/rails/action_controller.rb

@@ -11,27 +11,27 @@ module JSONAPI
       end
 
       module ClassMethods
-        def deserializable_resource(key, *args, &block)
-          klass = args.shift unless args.first.is_a?(Hash)
-          options = args.first || {}
-          if klass.nil?
-            klass = Class.new(JSONAPI::Deserializable::Resource, &block)
-          end
-          use DeserializeResource, key, klass, options
+        def deserializable_resource(key, options = {}, &block)
+          _deserializable(key, options,
+                          JSONAPI::Deserializable::Resource, &block)
         end
 
-        def deserializable_relationship(key, *args, &block)
-          klass = args.shift unless args.first.is_a?(Hash)
-          options = args.first || {}
-          if klass.nil?
-            klass = Class.new(JSONAPI::Deserializable::Relationship, &block)
-          end
-          use DeserializeResource, key, klass, options
+        def deserializable_relationship(key, options = {}, &block)
+          _deserializable(key, options,
+                          JSONAPI::Deserializable::Relationship, &block)
+        end
+
+        # @api private
+        def _deserializable(key, options, fallback, &block)
+          options = options.dup
+          klass = options.delete(:class) || Class.new(fallback, &block)
+          use Deserialization, key, klass, options
         end
       end
 
-      class DeserializationMiddleware
-        JSONAPI_KEYS = %w(data meta links jsonapi).freeze
+      class Deserialization
+        REQUEST_PARAMETERS_KEY =
+          'action_dispatch.request.request_parameters'.freeze
         def initialize(app, key, klass)
           @app = app
           @deserializable_key = key
@@ -40,32 +40,15 @@ module JSONAPI
 
         def call(env)
           request = Rack::Request.new(env)
-          body = request.params.slice(*JSONAPI_KEYS)
-          parser.parse!(body)
+          body = JSON.parse(request.body.read)
           deserialized_hash = @deserializable_class.call(body)
-          jsonapi = {}
-          JSONAPI_KEYS.each do |key|
-            next unless request.params.key?(key)
-            jsonapi[key.to_sym] = request.delete_param(key)
+          (env[REQUEST_PARAMETERS_KEY] ||= {}).tap do |request_parameters|
+            request_parameters[@deserializable_key] = deserialized_hash
           end
-          request.update_param(:_jsonapi, jsonapi)
-          request.update_param(@deserializable_key, deserialized_hash)
 
           @app.call(env)
         end
       end
-
-      class DeserializeResource < DeserializationMiddleware
-        def parser
-          JSONAPI::Parser::Resource
-        end
-      end
-
-      class DeserializeRelationship < DeserializationMiddleware
-        def parser
-          JSONAPI::Parser::Relationship
-        end
-      end
     end
   end
 end

data/lib/jsonapi/rails/railtie.rb

@@ -10,6 +10,10 @@ module JSONAPI
     class Railtie < ::Rails::Railtie
       MEDIA_TYPE = 'application/vnd.api+json'.freeze
       PARSER = JSONAPI::Rails.parser
+      RENDERERS = {
+        jsonapi:       JSONAPI::Rails.rails_renderer(SuccessRenderer),
+        jsonapi_error: JSONAPI::Rails.rails_renderer(ErrorRenderer)
+      }.freeze
 
       initializer 'jsonapi-rails.action_controller' do
         ActiveSupport.on_load(:action_controller) do
@@ -17,26 +21,29 @@ module JSONAPI
           include ::JSONAPI::Rails::ActionController
 
           Mime::Type.register MEDIA_TYPE, :jsonapi
+
           if ::Rails::VERSION::MAJOR >= 5
             ::ActionDispatch::Request.parameter_parsers[:jsonapi] = PARSER
           else
             ::ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
           end
 
-          ::ActionController::Renderers.add :jsonapi do |json, options|
-            unless json.is_a?(String)
-              json = JSONAPI::Rails::Renderer.render(json, options)
-            end
-            self.content_type ||= Mime[:jsonapi]
-            self.response_body = json
+          RENDERERS.each do |key, renderer|
+            ::ActionController::Renderers.add(key, &renderer)
           end
 
-          ::ActionController::Renderers.add :jsonapi_errors do |json, options|
-            unless json.is_a?(String)
-              json = JSONAPI::Rails::ErrorRender.render_errors(json, options)
+          JSONAPI::Deserializable::Resource.configure do |config|
+            config.default_has_one do |key, _rel, id, type|
+              key  = key.to_s.singularize
+              type = type.to_s.singularize.camelize
+              { "#{key}_id".to_sym => id, "#{key}_type".to_sym => type }
+            end
+
+            config.default_has_many do |key, _rel, ids, types|
+              key   = key.to_s.singularize
+              types = types.map { |t| t.to_s.singularize.camelize }
+              { "#{key}_ids".to_sym => ids, "#{key}_types".to_sym => types }
             end
-            self.content_type ||= Mime[:jsonapi]
-            self.response_body = json
           end
         end
       end

data/lib/jsonapi/rails/renderer.rb

@@ -2,15 +2,15 @@ require 'jsonapi/serializable/renderer'
 
 module JSONAPI
   module Rails
-    class Renderer
+    class SuccessRenderer
       def self.render(resources, options)
-        # TODO(beauby): handle status option.
         opts = options.dup
         # TODO(beauby): Move this to a global configuration.
         default_exposures = {
           url_helpers: ::Rails.application.routes.url_helpers
         }
         opts[:expose] = default_exposures.merge!(opts[:expose] || {})
+        opts[:jsonapi] = opts.delete(:jsonapi_object)
 
         JSONAPI::Serializable::Renderer.render(resources, opts)
       end
@@ -22,5 +22,16 @@ module JSONAPI
         JSONAPI::Serializable::ErrorRenderer.render(errors, options)
       end
     end
+
+    module_function
+
+    # @api private
+    def rails_renderer(renderer)
+      proc do |json, options|
+        json = renderer.render(json, options) unless json.is_a?(String)
+        self.content_type ||= Mime[:jsonapi]
+        self.response_body = json
+      end
+    end
   end
 end

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta4
+  version: 0.1.1
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jsonapi-deserializable
+  name: jsonapi-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: jsonapi-parser
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
-  type: :runtime
+        version: '5.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: jsonapi-serializable
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta4
+        version: '0'
 - !ruby/object:Gem::Dependency
   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
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 description: Efficient, convenient, non-intrusive JSONAPI framework for Rails.
 email:
 - lucas.hosseini@gmail.com
@@ -88,19 +102,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/generators/jsonapi/deserializable/USAGE
-- lib/generators/jsonapi/deserializable/deserializable_generator.rb
-- lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb
 - lib/generators/jsonapi/serializable/USAGE
 - lib/generators/jsonapi/serializable/serializable_generator.rb
 - lib/generators/jsonapi/serializable/templates/serializable.rb.erb
 - lib/jsonapi/rails.rb
 - lib/jsonapi/rails/action_controller.rb
-- lib/jsonapi/rails/deserializable/resource_extensions.rb
 - lib/jsonapi/rails/parser.rb
 - lib/jsonapi/rails/railtie.rb
 - lib/jsonapi/rails/renderer.rb
-homepage: https://github.com/jsonapi-rb/rails
+homepage: https://github.com/jsonapi-rb/jsonapi-rails
 licenses:
 - MIT
 metadata: {}
@@ -115,12 +125,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: jsonapi-rb integrations for Rails.

data/lib/generators/jsonapi/deserializable/USAGE

@@ -1,5 +0,0 @@
-Description:
-    Generates a deserializable resource for the given model.
-
-Example:
-    `rails generate jsonapi:deserializable User`

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

@@ -1,55 +0,0 @@
-module Jsonapi
-  class DeserializableGenerator < ::Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
-
-    # TODO(beauby): Implement generator-level whitelisting.
-    # TODO(beauby): Implement versioning.
-
-    def copy_deserializable_file
-      template 'deserializable.rb.erb',
-               File.join('app/deserializable', class_path,
-                         "deserializable_#{file_name}.rb")
-    end
-
-    private
-
-    def model_klass
-      # TODO(beauby): Ensure the model class exists.
-      class_name.safe_constantize
-    end
-
-    def attr_names
-      attrs = model_klass.new.attribute_names - %w(id created_at updated_at)
-      fk_attrs = model_klass.reflect_on_all_associations(:belongs_to)
-                            .map(&:foreign_key)
-      attrs - fk_attrs
-    end
-
-    def has_one_rels
-      has_one = model_klass.reflect_on_all_associations(:has_one)
-      belongs_to = model_klass.reflect_on_all_associations(:belongs_to)
-
-      has_one + belongs_to
-    end
-
-    def has_one_id_field_name(rel_name)
-      "#{rel_name}_id"
-    end
-
-    def has_one_type_field_name(rel_name)
-      "#{rel_name}_type"
-    end
-
-    def has_many_rels
-      model_klass.reflect_on_all_associations(:has_many)
-    end
-
-    def has_many_id_field_name(rel_name)
-      "#{rel_name.to_s.singularize}_ids"
-    end
-
-    def has_many_type_field_name(rel_name)
-      "#{rel_name.to_s.singularize}_types"
-    end
-  end
-end

data/lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb

@@ -1,34 +0,0 @@
-<% module_namespacing do -%>
-class Deserializable<%= class_name %> < JSONAPI::Deserializable::Resource
-  id
-
-<% attr_names.each do |attr| -%>
-  attribute :<%= attr %>
-<% end -%>
-
-<% has_one_rels.each do |reflection| -%>
-  has_one :<%= reflection.name %> do
-    field :<%= has_one_id_field_name(reflection.name) %> do |rel|
-      rel['data'] && rel['data']['id']
-    end
-<% if reflection.polymorphic? -%>
-    field :<%= has_one_type_field_name(reflection.name) %> do
-      rel['data'] && rel['data']['type']
-    end
-<% end -%>
-  end
-<% end -%>
-<% has_many_rels.each do |reflection| -%>
-  has_many :<%= reflection.name %> do
-    field :<%= has_many_id_field_name(reflection.name) %> do |rel|
-      rel['data'].map { |ri| ri['id'] }
-    end
-<% if reflection.polymorphic? -%>
-    field :<%= has_one_type_field_name(reflection.name) %> do
-      rel['data'].map { |ri| ri['type'] }
-    end
-<% end -%>
-  end
-<% end -%>
-end
-<% end -%>

data/lib/jsonapi/rails/deserializable/resource_extensions.rb

@@ -1,27 +0,0 @@
-require 'jsonapi/deserializable/resource'
-
-module JSONAPI
-  module Rails
-    module Deserializable
-      module ResourceExtensions
-        def deserialize_has_one_rel!(rel, &block)
-          id = rel['data'] && rel['data']['id']
-          type = rel['data'] && rel['data']['type'].singularize.camelize
-          instance_exec(rel, id, type, &block)
-        end
-
-        def deserialize_has_many_rel!(rel, &block)
-          ids = rel['data'].map { |ri| ri['id'] }
-          types = rel['data'].map { |ri| ri['type'].singularize.camelize }
-          instance_exec(rel, ids, types, &block)
-        end
-      end
-    end
-  end
-
-  module Deserializable
-    class Resource
-      prepend JSONAPI::Rails::Deserializable::ResourceExtensions
-    end
-  end
-end