jsonapi-realizer 6.0.0.rc1 → 6.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8297880001a46f1294e598d9d83f5dab3059c3af75fcc490279f18401b110c6
-  data.tar.gz: 07a0d04b94d9ca5d105f191d615fc242d4bf63fbd04f674f646aad267eba7e58
+  metadata.gz: d793387ade1272c7e808efdf832b814e5e27c5f8774e8504a77179c330882969
+  data.tar.gz: ad543bd542140615082ce32ec252d51e773376040a1a7d8c16df6c93d7bba1ce
 SHA512:
-  metadata.gz: a125e92782429f6d6f4fafd9d8fc4cbb082862b4c388d39d6e1b77d653a1ebba33edbff192077ca42df15d18a5ab3f6d246aad4d6f4eac812e25f92ad516d33a
-  data.tar.gz: cfcc9de3e9fd407613065c7f3328899b52fafd802e95bfc9766b53690911101059f01880a3b9b1308d2698a3976b3d22441b858e6540749b650a954c4772e366
+  metadata.gz: daebfcf746fcf038f60777f2edf677798e764f2078556d0218c23dc295230144b7053dcf502e1692c45e514ff2dff09d369f0690b8d1069bc73b388c0c421939
+  data.tar.gz: 4e5ce6aa5fab832de40dee2d0d00f12047839decc9ca25090fa87cd059ecec81d30d4472ea8b722d3793dae72d603f97ba822692369e5694bb224b40fce146c0

data/README.md

@@ -5,78 +5,84 @@
   - [![Version](http://img.shields.io/gem/v/jsonapi-realizer.svg?style=flat-square)](https://rubygems.org/gems/jsonapi-realizer)
 
 
-This library handles incoming [json:api](https://www.jsonapi.org) payloads and turns them, via an adapter system, into data models for your business logic.
+This library handles incoming [json:api](https://www.jsonapi.org) payloads and turns them, via an adapter system, into native data models. While designed with rails in mind, this library doesn't require rails to use.
+
 
 ## Using
 
 In order to use this library you'll want to have some models:
 
-``` ruby
-class Photo < ApplicationRecord
-  belongs_to :photographer, class_name: "Profile"
-end
 
+``` ruby
 class Profile < ApplicationRecord
   has_many :photos
 end
 ```
 
-*Note: They don't have to be ActiveRecord models, but we have built-in support for that library (adapter-based).*
-
-Second you'll need some realizers:
-
 ``` ruby
-class PhotoRealizer
-  include JSONAPI::Realizer::Resource
-
-  register :photos, class_name: "Photo", adapter: :active_record
+class Photo < ApplicationRecord
+  belongs_to :photographer, class_name: "Profile"
+end
+```
 
-  has_one :photographer, as: :profiles
+*Note: They don't have to be ActiveRecord models, but we have built-in support for that library (via an adapter).*
 
-  has :title
-  has :src
-end
+Second you'll need some realizers:
 
+``` ruby
 class ProfileRealizer
   include JSONAPI::Realizer::Resource
 
-  register :profiles, class_name: "Profile", adapter: :active_record
+  type :profiles, class_name: "Profile", adapter: :active_record
 
-  has_many :photos
+  has_many :photos, class_name: "PhotoRealizer"
 
   has :name
 end
 ```
 
-You can define aliases for these properties:
-
 ``` ruby
-has_many :doctors, as: :users
+class PhotoRealizer
+  include JSONAPI::Realizer::Resource
+
+  type :photos, class_name: "Photo", adapter: :active_record
 
-has :title, as: :name
+  has_one :photographer, as: :profiles, class_name: "ProfileRealizer"
+
+  has :title
+  has :src
+end
 ```
 
-Once you've designed your resources, we just need to use them! In this example, we'll use controllers from Rails:
+Now that we have these we can invoke them in the controller:
 
 ``` ruby
 class PhotosController < ApplicationController
   def create
-    realization = JSONAPI::Realizer.create(params, headers: request.headers)
+    realizer = PhotoRealizer.new(
+      :intent => :create,
+      :parameters => params,
+      :headers => request.headers
+    )
 
-    ProcessPhotosService.new(realization.model)
+    realizer.object.save!
 
-    render json: JSONAPI::Serializer.serialize(realization.model)
+    render json: realizer.object.to_json
   end
 
   def index
-    realization = JSONAPI::Realizer.index(params, headers: request.headers, type: :photos)
+    realizer = PhotoRealizer.new(
+      :intent => :index,
+      :parameters => params,
+      :headers => request.headers
+    )
 
-    render json: JSONAPI::Serializer.serialize(realization.models, is_collection: true)
+    render json: realizer.object.to_json
   end
 end
 ```
 
-Notice that we pass `realization.model` to `ProcessPhotosService`, that's because `jsonapi-realizer` doesn't do the act of saving, creating, or destroying! We just ready up the records for you to handle (including errors).
+Notice that we have to handle creating the model ourselves with `realizer.object.save!`. `jsonapi-realizer` doesn't act on a request, it only prepares you to act on the request.
 
 
 ### Adapters
@@ -88,33 +94,38 @@ There are two core adapters:
 
 An adapter must provide the following interfaces:
 
-  0. `find_one`, describes how to find the model
-  0. `find_many`, describes how to find many models
-  0. `write_attributes`, describes how to write a set of properties
-  0. `write_relationships`, describes how to write a set of relationships
-  0. `includes_via`, describes how to eager include related models
-  0. `sparse_fields`, describes how to only return certain fields
+  0. `find_many(scope)`, describes how to find many records
+  0. `find_one(scope, id)`, describes how to find one record
+  0. `filtering(scope, filters)`, describes how to filter records by a set of properties
+  0. `sorting(scope, sorts)`, describes how to sort records
+  0. `paginate(scope, per, offset)`, describes how to page records
+  0. `write_attributes(model, attributes)`, describes how to write a set of properties
+  0. `write_relationships(model, relationships)`, describes how to write a set of relationships
+  0. `include_relationships(scope, includes)`, describes how to eager include related models
 
-You can also provide custom adapter interfaces like below, which will use `active_record`'s `find_many`, `write_relationships`, `update_via`, `includes_via`, and `sparse_fields`:
+You can also provide custom adapter interfaces like below:
 
 ``` ruby
-class PhotoRealizer
-  include JSONAPI::Realizer::Resource
-
-  register :photos, class_name: "Photo", adapter: :active_record
-
-  adapter.find_one do |model_class, id|
-    model_class.where { id == id or slug == id }.first
-  end
+JSONAPI::Realizer.configuration do |let|
+  let.adapter_mappings = {
+    active_record_postgres_pagination: PostgresActiveRecordPaginationAdapter
+  }
+end
+```
 
-  adapter.write_attributes do |model, attributes|
-    model.update_columns(attributes)
+``` ruby
+module PostgresActiveRecordPaginationAdapter < JSONAPI::Realizer::Adapter::ActiveRecord
+  def paginate(scope, per, offset)
+    scope.offset(offset).limit(per)
   end
+end
+```
 
-  has_one :photographer, as: :profiles
+``` ruby
+class PhotoRealizer
+  include JSONAPI::Realizer::Resource
 
-  has :title
-  has :src
+  type :photos, class_name: "Photo", adapter: :active_record_postgres_pagination
 end
 ```
 

data/lib/jsonapi/realizer/adapter.rb

@@ -33,6 +33,8 @@ module JSONAPI
         raise(ArgumentError, "need to provide a Adapter#write_relationships interface") unless respond_to?(:write_relationships)
         raise(ArgumentError, "need to provide a Adapter#include_relationships interface") unless respond_to?(:include_relationships)
         raise(ArgumentError, "need to provide a Adapter#paginate interface") unless respond_to?(:paginate)
+        raise(ArgumentError, "need to provide a Adapter#sorting interface") unless respond_to?(:sorting)
+        raise(ArgumentError, "need to provide a Adapter#filtering interface") unless respond_to?(:filtering)
       end
     end
   end

data/lib/jsonapi/realizer/resource.rb

@@ -322,7 +322,7 @@ module JSONAPI
         end
 
         def attribute(name)
-          configuration.attributes.fetch(name.to_sym){raise(Error::ResourceRelationshipNotFound, name: name, realizer: self)}
+          configuration.attributes.fetch(name.to_sym){raise(Error::ResourceAttributeNotFound, name: name, realizer: self)}
         end
 
         def relation(name)

data/lib/jsonapi/realizer/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Realizer
-    VERSION = "6.0.0.rc1"
+    VERSION = "6.0.0.rc2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-realizer
 version: !ruby/object:Gem::Version
-  version: 6.0.0.rc1
+  version: 6.0.0.rc2
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop