jsonapi-rails 0.1.1.beta2 → 0.1.1.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2187b8d1ba0e20c3d0e23745e04e2072b56e43a
-  data.tar.gz: 6bb485f12b4d58a8132388faf76695cd503ddf94
+  metadata.gz: 3e7688f7537e54bd034bb90534c54b24a45b6609
+  data.tar.gz: 5ccdd0a8cec51bc47b4bf9975ee4b4ac4ac2679f
 SHA512:
-  metadata.gz: 1ae73e72c786c2751afe9168eed6f5251ca9479bf45faca4594f08243cedca1e8aac8c59468258689601f32b228a71057d3510efb1851b664e8c14bf961da154
-  data.tar.gz: 6490dcde60b48fab7e83bc14036575a5b7644ddba4b9aac4f1b80fd77a09443aa25318bd542ceeeec2b5c6ae34c81f575fd0ba41d4b1740afa7539fede4a7fce
+  metadata.gz: 473e402fc57f365aad748692290a4c4f675d6309e4b95f1d76426c40b5b6b48dce57417581463754184a3572b3ad50e1e02de24dafb4650d9db8c64d46494fee
+  data.tar.gz: 4d152fc21a5bfedbcb86c6504621230ae47e4a0ed8126bc03c056d3128b40a6ce2a709a5eb56e472dd1a10c66442fbb273582322954b3fcc9b2f2b0be5cbf701

data/README.md

@@ -23,7 +23,78 @@ $ gem install jsonapi-rails
 
 ## Usage
 
-TODO
+### 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
+
+# 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
+
+
+```
 
 ## License
 

data/lib/jsonapi/rails/railtie.rb

@@ -1,6 +1,5 @@
 require 'rails/railtie'
 require 'action_controller'
-require 'action_controller/railtie'
 require 'active_support'
 
 require 'jsonapi/rails/parser'
@@ -12,35 +11,35 @@ module JSONAPI
       MEDIA_TYPE = 'application/vnd.api+json'.freeze
       PARSER = JSONAPI::Rails.parser
 
-      initializer 'JSONAPI::Rails.initialize' do
-        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
+      initializer 'jsonapi-rails.action_controller' do
+        ActiveSupport.on_load(:action_controller) do
+          require 'jsonapi/rails/action_controller'
+          include ::JSONAPI::Rails::ActionController
 
-        ActionController::Renderers.add :jsonapi do |json, options|
-          unless json.is_a?(String)
-            json = JSONAPI::Rails::Renderer.render(json, options)
+          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
           end
-          self.content_type ||= Mime[:jsonapi]
-          self.response_body = json
-        end
 
-        ActionController::Renderers.add :jsonapi_errors do |json, options|
-          unless json.is_a?(String)
-            json = JSONAPI::Rails::ErrorRender.render_errors(json, options)
+          ::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
-          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

@@ -1,5 +1,4 @@
 require 'jsonapi/serializable/renderer'
-require 'jsonapi/serializable/resource_builder'
 
 module JSONAPI
   module Rails

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta2
+  version: 0.1.1.beta3
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer