jsonapi-rails 0.1.1.beta1 → 0.1.1.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 149fb06216ef18af6baa06e71acca5d6fa7cbeda
-  data.tar.gz: b83bbdc7d9d5739a7361eb294b28b1b1ff53a8d2
+  metadata.gz: a2187b8d1ba0e20c3d0e23745e04e2072b56e43a
+  data.tar.gz: 6bb485f12b4d58a8132388faf76695cd503ddf94
 SHA512:
-  metadata.gz: 785524db1f37f2b08fb6f2c96d1811f8ba5364dfc7ae92a3d1b47c211a44f88fc4ab85575e70bbc2fd0c56a640f8a1fa199adea2debff6a07b591370df1078df
-  data.tar.gz: 4672480284c03e809ecbb527aa8cad84593ef358e936182a1c3ae17aaea19ddad0ad27ed5f6ba817b6d52791cb11099d4523ff8cb37bca3621cd2657fd4b80d4
+  metadata.gz: 1ae73e72c786c2751afe9168eed6f5251ca9479bf45faca4594f08243cedca1e8aac8c59468258689601f32b228a71057d3510efb1851b664e8c14bf961da154
+  data.tar.gz: 6490dcde60b48fab7e83bc14036575a5b7644ddba4b9aac4f1b80fd77a09443aa25318bd542ceeeec2b5c6ae34c81f575fd0ba41d4b1740afa7539fede4a7fce

data/README.md

@@ -1,5 +1,10 @@
 # jsonapi-rails
-Rails plugin for building/consuming [JSON API](http://jsonapi.org) documents.
+Rails integration for [jsonapi-rb](https://github.com/jsonapi-rb/jsonapi-rb).
+
+## 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)
 
 ## Installation
 
@@ -20,18 +25,6 @@ $ gem install jsonapi-rails
 
 TODO
 
-## Contributing
-
-1. Fork the [official repository](https://github.com/beauby/jsonapi-rails).
-2. Make your changes in a topic branch.
-3. Send a pull request.
-
-Notes:
-
-* Contributions without tests won't be accepted.
-* Please don't update the Gem version.
-
 ## License
 
-It is free software, and may be redistributed under the terms specified in the
-[LICENSE](LICENSE) file.
+jsonapi-rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi/rails.rb

@@ -4,7 +4,6 @@ require 'jsonapi/renderer'
 require 'jsonapi/deserializable'
 require 'jsonapi/serializable'
 
-require 'jsonapi/rails/serializable/model_extensions'
 require 'jsonapi/rails/deserializable/resource_extensions'
 
 require 'jsonapi/rails/railtie'

data/lib/jsonapi/rails/action_controller.rb

@@ -0,0 +1,71 @@
+require 'jsonapi/deserializable'
+require 'jsonapi/parser'
+
+module JSONAPI
+  module Rails
+    module ActionController
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+        end
+      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
+        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
+        end
+      end
+
+      class DeserializationMiddleware
+        JSONAPI_KEYS = %w(data meta links jsonapi).freeze
+        def initialize(app, key, klass)
+          @app = app
+          @deserializable_key = key
+          @deserializable_class = klass
+        end
+
+        def call(env)
+          request = Rack::Request.new(env)
+          body = request.params.slice(*JSONAPI_KEYS)
+          parser.parse!(body)
+          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)
+          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/parser.rb

@@ -1,5 +1,3 @@
-require 'jsonapi/parser'
-
 module JSONAPI
   module Rails
     module_function
@@ -7,7 +5,6 @@ module JSONAPI
     def parser
       lambda do |body|
         data = JSON.parse(body)
-        JSONAPI.parse_resource!(body)
         data = { _json: data } unless data.is_a?(Hash)
         data.with_indifferent_access
       end

data/lib/jsonapi/rails/railtie.rb

@@ -1,18 +1,15 @@
 require 'rails/railtie'
 require 'action_controller'
 require 'action_controller/railtie'
+require 'active_support'
 
 require 'jsonapi/rails/parser'
-require 'jsonapi/rails/render'
+require 'jsonapi/rails/renderer'
 
 module JSONAPI
   module Rails
     class Railtie < ::Rails::Railtie
       MEDIA_TYPE = 'application/vnd.api+json'.freeze
-      HEADERS = {
-        response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
-        request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
-      }.freeze
       PARSER = JSONAPI::Rails.parser
 
       initializer 'JSONAPI::Rails.initialize' do
@@ -22,17 +19,28 @@ module JSONAPI
         else
           ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
         end
+
         ActionController::Renderers.add :jsonapi do |json, options|
           unless json.is_a?(String)
-            json = JSONAPI::Rails.render(json, options)
-                                 .to_json(options)
+            json = JSONAPI::Rails::Renderer.render(json, options)
           end
           self.content_type ||= Mime[:jsonapi]
           self.response_body = json
         end
 
-        # TODO(beauby): Add renderer for `jsonapi_errors`.
+        ActionController::Renderers.add :jsonapi_errors do |json, options|
+          unless json.is_a?(String)
+            json = JSONAPI::Rails::ErrorRender.render_errors(json, options)
+          end
+          self.content_type ||= Mime[:jsonapi]
+          self.response_body = json
+        end
       end
     end
   end
 end
+
+ActiveSupport.on_load(:action_controller) do
+  require 'jsonapi/rails/action_controller'
+  include JSONAPI::Rails::ActionController
+end

data/lib/jsonapi/rails/renderer.rb

@@ -0,0 +1,27 @@
+require 'jsonapi/serializable/renderer'
+require 'jsonapi/serializable/resource_builder'
+
+module JSONAPI
+  module Rails
+    class Renderer
+      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] || {})
+
+        JSONAPI::Serializable::Renderer.render(resources, opts)
+      end
+    end
+
+    class ErrorRenderer
+      def self.render(errors, options)
+        # TODO(beauby): SerializableError inference on AR validation errors.
+        JSONAPI::Serializable::ErrorRenderer.render(errors, options)
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta1
+  version: 0.1.1.beta2
 platform: ruby
 authors:
-- L. Preston Sego III
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -17,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
@@ -45,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
@@ -115,17 +114,16 @@ dependencies:
     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 JSONAPI documents.
+        version: '3.5'
+description: Efficient, convenient, non-intrusive JSONAPI framework for Rails.
 email:
-- LPSego3+dev@gmail.com
 - lucas.hosseini@gmail.com
 executables: []
 extensions: []
@@ -134,25 +132,17 @@ files:
 - README.md
 - lib/generators/jsonapi/deserializable/USAGE
 - lib/generators/jsonapi/deserializable/deserializable_generator.rb
-- lib/generators/jsonapi/deserializable/serializable_generator.rb
 - lib/generators/jsonapi/deserializable/templates/deserializable.rb.erb
-- lib/generators/jsonapi/deserializable/templates/serializable.rb
-- lib/generators/jsonapi/deserializable/templates/serializable.rb.erb
 - lib/generators/jsonapi/serializable/USAGE
 - lib/generators/jsonapi/serializable/serializable_generator.rb
-- lib/generators/jsonapi/serializable/templates/serializable.rb
 - lib/generators/jsonapi/serializable/templates/serializable.rb.erb
-- lib/generators/serializable_generator.rb
 - lib/jsonapi/rails.rb
-- lib/jsonapi/rails/deserializable/model_extensions.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/render.rb
-- lib/jsonapi/rails/serializable/model_extensions.rb
-- lib/jsonapi/rails/version.rb
-- lib/tasks/jsonapi/rails_tasks.rake
-homepage: https://github.com/beauby/jsonapi-rails
+- lib/jsonapi/rails/renderer.rb
+homepage: https://github.com/jsonapi-rb/rails
 licenses:
 - MIT
 metadata: {}
@@ -175,5 +165,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Rails plugin for (de)serialization of JSONAPI resources
+summary: jsonapi-rb integrations for Rails.
 test_files: []

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

@@ -1 +0,0 @@
-# Blah blah

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

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

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

@@ -1,3 +0,0 @@
-<% module_namespacing do -%>
-                           <%
-# Blah blah

data/lib/generators/serializable_generator.rb

@@ -1,5 +0,0 @@
-class SerializableGenerator < Rails::Generator::Base
-  def create_serializable_file
-    create_file
-  end
-end

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

@@ -1,20 +0,0 @@
-require 'jsonapi/deserializable/model'
-
-module JSONAPI
-  module Rails
-    module Deserializable
-      module ModelExtensions
-        def initialize(params = {})
-          params[:url_helper] ||= ::Rails.application.routes.url_helpers
-          super(params)
-        end
-      end
-    end
-  end
-
-  module Serializable
-    class Model
-      prepend JSONAPI::Rails::Serializable::ModelExtensions
-    end
-  end
-end

data/lib/jsonapi/rails/render.rb

@@ -1,33 +0,0 @@
-require 'jsonapi/renderer'
-require 'jsonapi/serializable/model'
-
-module JSONAPI
-  module Rails
-    module_function
-
-    def render(resources, options)
-      unless resources.respond_to?(:jsonapi_type)
-        resources = serializable_resources_for(resources)
-      end
-      JSONAPI::Renderer.new(resources, options).as_json
-    end
-
-    def serializable_resources_for(resources)
-      if resources.respond_to?(:each)
-        resources.map { |r| serializable_model_for(r) }
-      else
-        serializable_model_for(resources)
-      end
-    end
-
-    def serializable_model_for(model)
-      serializable_klass_for(model).new(model: model)
-    end
-
-    def serializable_klass_for(model)
-      # TODO(beauby): Move resource inference on class level in
-      #   jsonapi-serializable.
-      JSONAPI::Serializable::Model.new.resource_klass_for(model.class)
-    end
-  end
-end

data/lib/jsonapi/rails/serializable/model_extensions.rb

@@ -1,20 +0,0 @@
-require 'jsonapi/serializable/model'
-
-module JSONAPI
-  module Rails
-    module Serializable
-      module ModelExtensions
-        def initialize(params = {})
-          params[:url_helpers] ||= ::Rails.application.routes.url_helpers
-          super(params)
-        end
-      end
-    end
-  end
-
-  module Serializable
-    class Model
-      prepend JSONAPI::Rails::Serializable::ModelExtensions
-    end
-  end
-end

data/lib/jsonapi/rails/version.rb

@@ -1,5 +0,0 @@
-module JSONAPI
-  module Rails
-    VERSION = '0.1.0'
-  end
-end

data/lib/tasks/jsonapi/rails_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :jsonapi_rails do
-#   # Task goes here
-# end