jsonapi-realizer 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3e9f32f5798910d492d81a0564ff99337b65577d7f0fff93cc1b627c53e0bd2
-  data.tar.gz: 754cf56ffe68f405a1b68ee3d2ebb2da4d8b89146f6048e6e5c4d9755b72ff93
+  metadata.gz: 38b5321aa71d6cd99b39ddb9fb9a3e09679239a8eed202403a82fe0191d1eb06
+  data.tar.gz: e0ff4d86639cef636a852196af3cca83d10e335eda4bbaf322e7b79f63da56f9
 SHA512:
-  metadata.gz: '076844edcdb11676eb825d8707c331fc00736cf5c31e2b345fb134cb28363315ee317d046830aa4d654741560a66ad5a2caef71cd224b12c372b427d9517cf26'
-  data.tar.gz: 6216f9f0c53cf4b27f25f4c90e768092525e477de0156d9fbbdd09d4e952513a3f73b8247b803d9325a3883f6f2d07a1a8b846a2986c6c9de839210c6de37cab
+  metadata.gz: 6bfa065c4d7b383210a0be470f5d95e497da056e4df74beb10ced42920d6e66c09d9b9025c2397a98bad14268d330faaa021320b8fbae0d8144be5d77c3d095b
+  data.tar.gz: 9e2c5b864c0b3d067a88863bdc23f3bf839ecb3bb1da93b0423948f02e0b2dc8b8789cecb4bd1d677055ac0c83d5f25eb5c50b6bed7a60e8044dd2c299dfca3e

data/README.md

@@ -10,7 +10,7 @@ This library handles incoming [json:api](https://www.jsonapi.org) payloads and t
 A successful JSON:API request can be annotated as:
 
 ```
-JSONAPIRequest -> (PersistanceAdapter -> JSONAPIRequest -> (Record | Array<Record>)) -> JSONAPIResponse
+JSONAPIRequest -> (BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)) -> JSONAPIResponse
 ```
 
 The `jsonapi-serializers` library provides this shape:
@@ -22,12 +22,14 @@ JSONAPIRequest -> (Record | Array<Record>) -> JSONAPIResponse
 But it leaves fetching/createing/updating/destroying the records up to you! This is where jsonapi-realizer comes into play, as it provides this shape:
 
 ```
-PersistanceAdapter -> JSONAPIRequest -> (Record | Array<Record>)
+BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)
 ```
 
 
 ## Using
 
+In order to use this library you'll want to have some models:
+
 ``` ruby
 class Photo < ApplicationRecord
   belongs_to :photographer, class_name: "Profile"
@@ -36,13 +38,15 @@ end
 class Profile < ApplicationRecord
   has_many :photos
 end
+```
+
+*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
 
-  adapter :active_record
-
-  represents :photos, class_name: "Photo"
+  register :photos, class_name: "Photo", adapter: :active_record
 
   has_one :photographer, as: :profiles
 
@@ -53,9 +57,7 @@ end
 class ProfileRealizer
   include JSONAPI::Realizer::Resource
 
-  adapter :active_record
-
-  represents :profiles, class_name: "Profile"
+  register :profiles, class_name: "Profile", adapter: :active_record
 
   has_many :photos, as: :photos
 
@@ -63,6 +65,14 @@ class ProfileRealizer
 end
 ```
 
+You can define special properties on attributes and relationships realizers:
+
+``` ruby
+has_many :doctors, as: :users, includable: false
+
+has :title, selectable: false
+```
+
 Once you've designed your resources, we just need to use them! In this example, we'll use controllers from Rails:
 
 ``` ruby
@@ -71,11 +81,24 @@ class PhotosController < ApplicationController
     validate_parameters!
     authenticate_session!
 
-    record = JSONAPI::Realizer.create(params, headers: request.headers)
+    realization = JSONAPI::Realizer.create(params, headers: request.headers)
+
+    ProcessPhotosService.new(realization.model)
+
+    render json: JSONAPI::Serializer.serialize(record)
+  end
+
+  def index
+    validate_parameters!
+    authenticate_session!
+
+    realization = JSONAPI::Realizer.index(params, headers: request.headers, type: :photos)
 
-    ProcessPhotosService.new(record)
+    # See: pundit for `authorize()`
+    authorize realization.models
 
-    JSONAPI::Serializer.serialize(record)
+    # See: pundit for `policy_scope()`
+    render json: JSONAPI::Serializer.serialize(policy_scope(record), is_collection: true)
   end
 end
 ```
@@ -89,9 +112,14 @@ There are two core adapters:
 
 An adapter must provide the following interfaces:
 
-  0. `find_via`, which tells the action how to find the model
-  0. `write_attributes_via`, which tells the action how to write an individual property
-  0. `save_via`, which tells the action how to save the model when it's done
+  0. `find_via`, describes how to find the model
+  0. `find_many_via`, describes how to find many models
+  0. `assign_attributes_via`, describes how to write a set of properties
+  0. `assign_relationships_via`, describes how to write a set of relationships
+  0. `create_via`, describes how to create the model
+  0. `update_via`, describes how to update the model
+  0. `includes_via`, describes how to eager include related models
+  0. `sparse_fields_via`, describes how to only return certain fields
 
 You can also provide custom adapter interfaces:
 
@@ -99,43 +127,20 @@ You can also provide custom adapter interfaces:
 class PhotoRealizer
   include JSONAPI::Realizer::Resource
 
-  adapter do
-    find_via do |model_class, id|
-      model_class.where { id == id or slug == id }.first
-    end
-
-    write_attributes_via do |model, attributes|
-      model.update_columns(attributes)
-    end
+  register :photos, class_name: "Photo", adapter: :active_record
 
-    save_via do |model|
-      model.save!
-      Rails.cache.write(model.cache_key, model)
-    end
+  adapter.find_via do |model_class, id|
+    model_class.where { id == id or slug == id }.first
   end
 
-  represents :photos, class_name: "Photo"
-
-  has_one :photographer, as: :profiles
-
-  has :title
-  has :src
-end
-```
-
-If you want, you can use both the regular adapters and some custom pieces:
-
-``` ruby
-class PhotoRealizer
-  include JSONAPI::Realizer::Resource
-
-  adapter :active_record do
-    find_via do |model_class, id|
-      model_class.where { id == id or slug == id }.first
-    end
+  adapter.assign_attributes_via do |model, attributes|
+    model.update_columns(attributes)
   end
 
-  represents :photos, class_name: "Photo"
+  adapter.create_via do |model|
+    model.save!
+    Rails.cache.write(model.cache_key, model)
+  end
 
   has_one :photographer, as: :profiles
 
@@ -144,11 +149,12 @@ class PhotoRealizer
 end
 ```
 
+
 ## Installing
 
 Add this line to your application's Gemfile:
 
-    gem "jsonapi-realizer", "1.0.0"
+    gem "jsonapi-realizer", "2.0.0"
 
 And then execute:
 

data/lib/jsonapi/realizer.rb

@@ -1,5 +1,6 @@
 require "ostruct"
 require "active_support/concern"
+require "active_support/core_ext/enumerable"
 
 module JSONAPI
   module Realizer
@@ -8,23 +9,44 @@ module JSONAPI
     require_relative "realizer/adapter"
     require_relative "realizer/resource"
 
-    def self.register(resource_class, model_class, type)
-      @mapping ||= {}
-      @mapping[type] = OpenStruct.new({
-        model_class: model_class,
-        type: type,
+    def self.register(resource_class:, model_class:, adapter:, type:)
+      @mapping ||= Set.new
+      @mapping << OpenStruct.new({
         resource_class: resource_class,
+        model_class: model_class,
+        adapter: adapter,
+        type: type.dasherize,
         attributes: OpenStruct.new({}),
         relationships: OpenStruct.new({})
        })
     end
 
-    def self.mapping
-      @mapping
+    def self.resource_mapping
+      @mapping.index_by(&:resource_class)
+    end
+
+    def self.type_mapping
+      @mapping.index_by(&:type)
     end
 
     def self.create(payload, headers:)
-      Create.new(payload: payload, headers: headers).call
+      enact(Create.new(payload: payload, headers: headers))
+    end
+
+    def self.update(payload, headers:)
+      enact(Update.new(payload: payload, headers: headers))
+    end
+
+    def self.show(payload, headers:, type:)
+      enact(Show.new(payload: payload, headers: headers, type: type))
+    end
+
+    def self.index(payload, headers:, type:)
+      enact(Index.new(payload: payload, headers: headers, type: type))
+    end
+
+    private_class_method def self.inact(action)
+      action.tap(&:call)
     end
   end
 end

data/lib/jsonapi/realizer/action.rb

@@ -3,37 +3,111 @@ module JSONAPI
     class Action
       require_relative "action/create"
       require_relative "action/update"
+      require_relative "action/show"
+      require_relative "action/index"
 
-      attr_reader :type
-      attr_reader :data
-      attr_reader :resource
+      attr_reader :payload
 
-      def initialize(payload:, headers:)
+      def initialize
         raise NoMethodError, "must implement this function"
       end
 
-      def call
-        raise NoMethodError, "must implement this function"
+      def call; end
+
+      private def model_class
+        resource_class.model_class
       end
 
       private def resource_class
-        JSONAPI::Realizer.mapping.fetch(type).resource_class
+        configuration.resource_class
       end
 
-      private def relationships
-        data.fetch("relationships", {})
+      private def adapter
+        configuration.adapter
+      end
+
+      private def relation_after_inclusion(relation)
+        if includes.any?
+          resource_class.include_via_call(relation, includes)
+        else
+          relation
+        end
+      end
+
+      private def relation_after_fields(relation)
+        if includes.any?
+          resource_class.sparse_fields_call(relation, fields)
+        else
+          relation
+        end
+      end
+
+      private def relation
+        relation_after_fields(
+          relation_after_inclusion(
+            model_class
+          )
+        )
+      end
+
+      private def data
+        payload.fetch("data", {})
       end
 
       private def id
-        data.fetch("id", nil)
+        data.fetch("id", nil) || payload.fetch("id", nil)
       end
 
       private def type
-        data.fetch("type")
+        (@type || data.fetch("type")).to_s.dasherize
       end
 
       private def attributes
-        data.fetch("attributes", {})
+        data.
+          fetch("attributes", {}).
+          transform_keys(&:underscore).
+          select(&resource_class.method(:valid_attribute?))
+      end
+
+      private def relationships
+        data.
+          fetch("relationships", {}).
+          transform_keys(&:underscore).
+          select(&resource_class.method(:valid_relationship?)).
+          transform_values(&method(:as_relationship))
+      end
+
+      private def as_relationship(value)
+        data = value.fetch("data")
+        mapping = JSONAPI::Realizer.type_mapping.fetch(data.fetch("type"))
+        mapping.adapter.find_via_call(
+          mapping.model_class,
+          data.fetch("id")
+        )
+      end
+
+      private def includes
+        payload.
+          fetch("include", []).
+          # "carts.cart-items,carts.cart-items.product,carts.billing-information,payments"
+          map { |path| path.split(/\s*,\s*/) }.
+          # ["carts.cart-items", "carts.cart-items.product", "carts.billing-information", "payments"]
+          map { |path| path.gsub("-", "_") }.
+          # ["carts.cart_items", "carts.cart_items.product", "carts.billing_information", "payments"]
+          map { |path| path.split(".") }.
+          # [["carts", "cart_items"], ["carts", "cart_items", "product"], ["carts", "billing_information"], ["payments"]]
+          select(&resource_class.method(:valid_includes?))
+      end
+
+      private def fields
+        payload.
+          fetch("fields", []).
+          split(/\s*,\s*/).
+          select(&resource_class.method(:valid_sparse_field?))
+      end
+
+      private def configuration
+        JSONAPI::Realizer.type_mapping.fetch(type)
       end
     end
   end

data/lib/jsonapi/realizer/action/create.rb

@@ -2,18 +2,23 @@ module JSONAPI
   module Realizer
     class Action
       class Create < Action
+        attr_accessor :resource
+
         def initialize(payload:, headers:)
-          @data = payload.fetch("data")
-          @resource = resource_class.new(resource_class.model_class.new)
+          @payload = payload
+          @headers = headers
+          @resource = resource_class.new(relation.new)
         end
 
         def call
-          resource.model.tap do |model|
-            resource_class.write_attributes_via_call(model, {id: id}) if id
-            resource_class.write_attributes_via_call(model, attributes.select(&resource.method(:valid_attribute?)))
-            resource_class.write_attributes_via_call(model, relationships.select(&resource.method(:valid_relationship?)).transform_values(&resource.method(:as_relationship)))
-            resource_class.save_via_call(model)
-          end
+          adapter.assign_attributes_via_call(resource.model, {id: id}) if id
+          adapter.assign_attributes_via_call(resource.model, attributes)
+          adapter.assign_relationships_via_call(resource.model, relationships)
+          adapter.create_via_call(resource.model)
+        end
+
+        def model
+          resource.model
         end
       end
     end

data/lib/jsonapi/realizer/action/create_spec.rb

@@ -6,6 +6,10 @@ RSpec.describe JSONAPI::Realizer::Action::Create do
   describe "#call" do
     subject { action.call }
 
+    context "with no top-level data" do
+
+    end
+
     context "with a good payload and good headers" do
       let(:payload) do
         {
@@ -14,16 +18,18 @@ RSpec.describe JSONAPI::Realizer::Action::Create do
             "type" => "photos",
             "attributes" => {
               "title" => "Ember Hamster",
+              "alt-text" => "A hamster logo.",
               "src" => "http://example.com/images/productivity.png"
             },
             "relationships" => {
-              "photographer" => {
-                "data" => { "type" => "people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
+              "active-photographer" => {
+                "data" => { "type" => "photographer-people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
               }
             }
           }
         }
       end
+
       let(:headers) do
         {
           "Content-Type" => "application/vnd.api+json",
@@ -38,20 +44,65 @@ RSpec.describe JSONAPI::Realizer::Action::Create do
         }
       end
 
-      it "creates a model" do
-        expect(subject).to be_a_kind_of(Photo)
+      it "is the right model" do
+        subject
+
+        expect(action.model).to be_a_kind_of(Photo)
+      end
+
+      it "assigns the id attribute" do
+        subject
+
+        expect(action.model).to have_attributes(id: "550e8400-e29b-41d4-a716-446655440000")
+      end
+
+      it "assigns the title attribute" do
+        subject
+
+        expect(action.model).to have_attributes(title: "Ember Hamster")
+      end
+
+      it "assigns the alt_text attribute" do
+        subject
+
+        expect(action.model).to have_attributes(alt_text: "A hamster logo.")
+      end
+
+      it "assigns the src attribute" do
+        subject
+
+        expect(action.model).to have_attributes(src: "http://example.com/images/productivity.png")
       end
 
-      it "assigns the attributes" do
-        expect(subject).to have_attributes(title: "Ember Hamster", src: "http://example.com/images/productivity.png", updated_at: a_kind_of(Time))
+      it "assigns the updated_at attribute" do
+        subject
+
+        expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
       end
 
-      it "relates the relationships" do
-        expect(subject).to have_attributes(photographer: a_kind_of(People))
+      it "assigns the active_photographer attribute" do
+        subject
+
+        expect(action.model).to have_attributes(active_photographer: a_kind_of(People))
       end
 
-      it "stores the new record" do
-        expect {subject}.to change {Photo::STORE}.from({}).to({"550e8400-e29b-41d4-a716-446655440000" => hash_including(id: "550e8400-e29b-41d4-a716-446655440000", title: "Ember Hamster", src: "http://example.com/images/productivity.png")})
+      it "creates the new record" do
+        expect {
+          subject
+        }.to change {
+          Photo::STORE
+        }.from(
+          {}
+        ).to(
+          {
+            "550e8400-e29b-41d4-a716-446655440000" => hash_including(
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              title: "Ember Hamster",
+              alt_text: "A hamster logo.",
+              src: "http://example.com/images/productivity.png"
+            )
+          }
+        )
       end
     end
   end

data/lib/jsonapi/realizer/action/index.rb

@@ -0,0 +1,20 @@
+module JSONAPI
+  module Realizer
+    class Action
+      class Index < Action
+        attr_accessor :resources
+
+        def initialize(payload:, headers:, type:)
+          @payload = payload
+          @headers = headers
+          @type = type
+          @resources = adapter.find_many_via_call(relation).map(&resource_class.method(:new))
+        end
+
+        def models
+          resources.map(&:model)
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/action/index_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+RSpec.describe JSONAPI::Realizer::Action::Index do
+  let(:action) { described_class.new(payload: payload, headers: headers, type: :photos) }
+
+  describe "#models" do
+    subject { action.models }
+
+    context "with no top-level data" do
+
+    end
+
+    context "with a good payload and good headers" do
+      let(:payload) do
+        {}
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/vnd.api+json",
+          "Accept" => "application/vnd.api+json"
+        }
+      end
+
+      before do
+        Photo::STORE["550e8400-e29b-41d4-a716-446655440000"] = {
+          id: "550e8400-e29b-41d4-a716-446655440000",
+          title: "Ember Hamster",
+          src: "http://example.com/images/productivity.png"
+        }
+        Photo::STORE["d09ae4c6-0fc3-4c42-8fe8-6029530c3bed"] = {
+          id: "d09ae4c6-0fc3-4c42-8fe8-6029530c3bed",
+          title: "Ember Fox",
+          src: "http://example.com/images/productivity-2.png"
+        }
+      end
+
+      it "returns a list of photos" do
+        expect(subject).to include(a_kind_of(Photo), a_kind_of(Photo))
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/action/show.rb

@@ -0,0 +1,21 @@
+module JSONAPI
+  module Realizer
+    class Action
+      class Show < Action
+
+        attr_accessor :resource
+
+        def initialize(payload:, headers:, type:)
+          @payload = payload
+          @headers = headers
+          @type = type
+          @resource = resource_class.new(adapter.find_via_call(relation, id))
+        end
+
+        def model
+          resource.model
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/action/show_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+RSpec.describe JSONAPI::Realizer::Action::Show do
+  let(:action) { described_class.new(payload: payload, headers: headers, type: :photos) }
+
+  describe "#model" do
+    subject { action.model }
+
+    context "with no top-level data" do
+
+    end
+
+    context "with a good payload and good headers" do
+      let(:payload) do
+        {
+          "id" => "d09ae4c6-0fc3-4c42-8fe8-6029530c3bed"
+        }
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/vnd.api+json",
+          "Accept" => "application/vnd.api+json"
+        }
+      end
+
+      before do
+        Photo::STORE["550e8400-e29b-41d4-a716-446655440000"] = {
+          id: "550e8400-e29b-41d4-a716-446655440000",
+          title: "Ember Hamster",
+          src: "http://example.com/images/productivity.png"
+        }
+        Photo::STORE["d09ae4c6-0fc3-4c42-8fe8-6029530c3bed"] = {
+          id: "d09ae4c6-0fc3-4c42-8fe8-6029530c3bed",
+          title: "Ember Fox",
+          src: "http://example.com/images/productivity-2.png"
+        }
+      end
+
+      it "returns a photo model" do
+        expect(subject).to be_a_kind_of(Photo)
+      end
+
+      it "returns the photos attributes" do
+        expect(subject).to have_attributes(title: "Ember Fox", src: "http://example.com/images/productivity-2.png")
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/action/update.rb

@@ -2,22 +2,22 @@ module JSONAPI
   module Realizer
     class Action
       class Update < Action
+        attr_accessor :resource
+
         def initialize(payload:, headers:)
-          @data = payload.fetch("data")
-          @resource = resource_class.new(
-            resource_class.find_via_call(
-              resource_class.model_class,
-              id
-            )
-          )
+          @payload = payload
+          @headers = headers
+          @resource = resource_class.new(adapter.find_via_call(relation, id))
         end
 
         def call
-          @resource.model.tap do |model|
-            resource_class.write_attributes_via_call(model, attributes.select(&resource.method(:valid_attribute?)))
-            resource_class.write_attributes_via_call(model, relationships.select(&resource.method(:valid_relationship?)).transform_values(&resource.method(:as_relationship)))
-            resource_class.save_via_call(model)
-          end
+          adapter.assign_attributes_via_call(resource.model, attributes)
+          adapter.assign_relationships_via_call(resource.model, relationships)
+          adapter.update_via_call(resource.model)
+        end
+
+        def model
+          resource.model
         end
       end
     end

data/lib/jsonapi/realizer/action/update_spec.rb

@@ -6,6 +6,10 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
   describe "#call" do
     subject { action.call }
 
+    context "with no top-level data" do
+
+    end
+
     context "with a good payload and good headers" do
       let(:payload) do
         {
@@ -14,11 +18,12 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
             "type" => "photos",
             "attributes" => {
               "title" => "Ember Hamster 2",
+              "alt-text" => "A hamster logo.",
               "src" => "http://example.com/images/productivity-2.png"
             },
             "relationships" => {
-              "photographer" => {
-                "data" => { "type" => "people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
+              "active-photographer" => {
+                "data" => { "type" => "photographer-people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
               }
             }
           }
@@ -43,20 +48,65 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
         }
       end
 
-      it "creates a model" do
-        expect(subject).to be_a_kind_of(Photo)
+      it "is the right model" do
+        subject
+
+        expect(action.model).to be_a_kind_of(Photo)
       end
 
-      it "assigns the attributes" do
-        expect(subject).to have_attributes(title: "Ember Hamster 2", src: "http://example.com/images/productivity-2.png", updated_at: a_kind_of(Time))
+      it "assigns the title attribute" do
+        subject
+
+        expect(action.model).to have_attributes(title: "Ember Hamster 2")
       end
 
-      it "relates the relationships" do
-        expect(subject).to have_attributes(photographer: a_kind_of(People))
+      it "assigns the alt_text attribute" do
+        subject
+
+        expect(action.model).to have_attributes(alt_text: "A hamster logo.")
+      end
+
+      it "assigns the src attribute" do
+        subject
+
+        expect(action.model).to have_attributes(src: "http://example.com/images/productivity-2.png")
       end
 
-      it "saves the record" do
-        expect {subject}.to change {Photo::STORE}.from({"550e8400-e29b-41d4-a716-446655440000" => hash_including(id: "550e8400-e29b-41d4-a716-446655440000", title: "Ember Hamster", src: "http://example.com/images/productivity.png")}).to({"550e8400-e29b-41d4-a716-446655440000" => hash_including(id: "550e8400-e29b-41d4-a716-446655440000", title: "Ember Hamster 2", src: "http://example.com/images/productivity-2.png")})
+      it "assigns the updated_at attribute" do
+        subject
+
+        expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
+      end
+
+      it "assigns the active_photographer attribute" do
+        subject
+
+        expect(action.model).to have_attributes(active_photographer: a_kind_of(People))
+      end
+
+      it "updates the record" do
+        expect {
+          subject
+        }.to change {
+          Photo::STORE
+        }.from(
+          {
+            "550e8400-e29b-41d4-a716-446655440000" => hash_including(
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              title: "Ember Hamster",
+              src: "http://example.com/images/productivity.png"
+            )
+          }
+        ).to(
+          {
+            "550e8400-e29b-41d4-a716-446655440000" => hash_including(
+              id: "550e8400-e29b-41d4-a716-446655440000",
+              title: "Ember Hamster 2",
+              alt_text: "A hamster logo.",
+              src: "http://example.com/images/productivity-2.png"
+            )
+          }
+        )
       end
     end
   end

data/lib/jsonapi/realizer/adapter.rb

@@ -1,32 +1,93 @@
 module JSONAPI
   module Realizer
-    module Adapter
+    class Adapter
       require_relative "adapter/active_record"
       require_relative "adapter/memory"
 
       MAPPINGS = {
-        memory: JSONAPI::Realizer::Adapter::Memory,
-        active_record: JSONAPI::Realizer::Adapter::ActiveRecord,
+        memory: JSONAPI::Realizer::Adapter::MEMORY,
+        active_record: JSONAPI::Realizer::Adapter::ACTIVE_RECORD,
       }
 
-      def self.adapt(resource, interface, &block)
-        if interface.kind_of?(Symbol)
-          if JSONAPI::Realizer::Adapter::MAPPINGS.key?(interface)
-            resource.include(JSONAPI::Realizer::Adapter::MAPPINGS.fetch(interface))
-          else
-            raise ArgumentError, "you've given an invalid adapter alias: #{interface}, we support #{JSONAPI::Realizer::Adapter::MAPPINGS.keys}"
-          end
+      def initialize(interface)
+        if JSONAPI::Realizer::Adapter::MAPPINGS.key?(interface.to_sym)
+          instance_eval(&JSONAPI::Realizer::Adapter::MAPPINGS.fetch(interface.to_sym))
         else
-          resource.include(interface)
+          raise ArgumentError, "you've given an invalid adapter alias: #{interface}, we support #{JSONAPI::Realizer::Adapter::MAPPINGS.keys}"
         end
 
-        if block_given?
-          resource.instance_eval(&block)
-        end
+        raise ArgumentError, "need to provide a Adapter.find_via interface" unless instance_variable_defined?(:@find_via_call)
+        raise ArgumentError, "need to provide a Adapter.find_many_via_call interface" unless instance_variable_defined?(:@find_many_via_call)
+        raise ArgumentError, "need to provide a Adapter.assign_attributes_via interface" unless instance_variable_defined?(:@assign_attributes_via_call)
+        raise ArgumentError, "need to provide a Adapter.assign_relationships_via interface" unless instance_variable_defined?(:@assign_relationships_via_call)
+        raise ArgumentError, "need to provide a Adapter.create_via interface" unless instance_variable_defined?(:@create_via_call)
+        raise ArgumentError, "need to provide a Adapter.update_via interface" unless instance_variable_defined?(:@update_via_call)
+        raise ArgumentError, "need to provide a Adapter.sparse_fields interface" unless instance_variable_defined?(:@sparse_fields_call)
+        raise ArgumentError, "need to provide a Adapter.include_via interface" unless instance_variable_defined?(:@include_via_call)
+      end
+
+      def find_via(&callback)
+        @find_via_call = callback
+      end
+
+      def find_many_via(&callback)
+        @find_many_via_call = callback
+      end
+
+      def create_via(&callback)
+        @create_via_call = callback
+      end
+
+      def update_via(&callback)
+        @update_via_call = callback
+      end
+
+      def assign_attributes_via(&callback)
+        @assign_attributes_via_call = callback
+      end
+
+      def assign_relationships_via(&callback)
+        @assign_relationships_via_call = callback
+      end
+
+      def sparse_fields(&callback)
+        @sparse_fields_call = callback
+      end
+
+      def include_via(&callback)
+        @include_via_call = callback
+      end
+
+      def find_via_call(model_class, id)
+        @find_via_call.call(model_class, id)
+      end
+
+      def find_many_via_call(model_class)
+        @find_many_via_call.call(model_class)
+      end
+
+      def create_via_call(model)
+        @create_via_call.call(model)
+      end
+
+      def update_via_call(model)
+        @update_via_call.call(model)
+      end
+
+      def assign_attributes_via_call(model, attributes)
+        @assign_attributes_via_call.call(model, attributes)
+      end
+
+      def assign_relationships_via_call(model, relationships)
+        @assign_relationships_via_call.call(model, relationships)
+      end
+
+      def sparse_fields_call(model_class, fields)
+        @sparse_fields_call.call(model_class, fields)
+      end
 
-        raise ArgumentError, "need to provide a Adapter.find_via interface" unless resource.instance_variable_defined?(:@find_via_call)
-        raise ArgumentError, "need to provide a Adapter.write_attributes_via interface" unless resource.instance_variable_defined?(:@write_attributes_via_call)
-        raise ArgumentError, "need to provide a Adapter.save_via interface" unless resource.instance_variable_defined?(:@save_via_call)
+      def include_via_call(model_class, includes)
+        @include_via_call.call(model_class, includes)
       end
     end
   end

data/lib/jsonapi/realizer/adapter/active_record.rb

@@ -1,21 +1,43 @@
 module JSONAPI
   module Realizer
-    module Adapter
-      module ActiveRecord
-        extend ActiveSupport::Concern
+    class Adapter
+      ACTIVE_RECORD = Proc.new do
+        find_many_via do |model_class|
+          model_class.all
+        end
+
+        find_via do |model_class, id|
+          model_class.find(id)
+        end
 
-        included do
-          find_via do |model_class, id|
-            model_class.find(id)
-          end
+        assign_attributes_via do |model, attributes|
+          model.assign_attributes(attributes)
+        end
+
+        assign_relationships_via do |model, relationships|
+          model.assign_attributes(relationships)
+        end
 
-          write_attributes_via do |model, attributes|
-            model.assign_attributes(attributes)
-          end
+        sparse_fields do |model_class, fields|
+          model_class.select(fields)
+        end
+
+        include_via do |model_class, includes|
+          model_class.includes(includes.map(&(recursively_nest = -> (chains) do
+            if chains.size == 1
+              chains.first
+            else
+              {chains.first => recursively_nest.call(chains.drop(1))}
+            end
+          end)))
+        end
+
+        create_via do |model|
+          model.create!
+        end
 
-          save_via do |model|
-            model.save!
-          end
+        update_via do |model|
+          model.update!
         end
       end
     end

data/lib/jsonapi/realizer/adapter/memory.rb

@@ -1,24 +1,43 @@
 module JSONAPI
   module Realizer
-    module Adapter
-      module Memory
-        extend ActiveSupport::Concern
+    class Adapter
+      MEMORY = Proc.new do
+        find_many_via do |model_class|
+          model_class.all
+        end
 
-        included do
-          find_via do |model_class, id|
-            model_class.fetch(id)
-          end
+        find_via do |model_class, id|
+          model_class.fetch(id)
+        end
+
+        assign_attributes_via do |model, attributes|
+          model.assign_attributes(attributes)
+        end
+
+        assign_relationships_via do |model, relationships|
+          model.assign_attributes(relationships)
+        end
+
+        sparse_fields do |model_class, fields|
+          model_class
+        end
 
-          write_attributes_via do |model, attributes|
-            model.assign_attributes(attributes)
+        include_via do |model_class, includes|
+          model_class
+        end
+
+        create_via do |model|
+          model.assign_attributes(id: model.id || SecureRandom.uuid)
+          model.assign_attributes(updated_at: Time.now)
+          model.class.const_get("STORE")[model.id] = model.class.const_get("ATTRIBUTES").inject({}) do |hash, key|
+            hash.merge({ key => model.public_send(key) })
           end
+        end
 
-          save_via do |model|
-            model.assign_attributes(id: model.id || SecureRandom.uuid)
-            model.assign_attributes(updated_at: Time.now)
-            model_class.const_get("STORE")[model.id] = model_class.const_get("ATTRIBUTES").inject({}) do |hash, key|
-              hash.merge({ key => model.public_send(key) })
-            end
+        update_via do |model|
+          model.assign_attributes(updated_at: Time.now)
+          model.class.const_get("STORE")[model.id] = model.class.const_get("ATTRIBUTES").inject({}) do |hash, key|
+            hash.merge({ key => model.public_send(key) })
           end
         end
       end

data/lib/jsonapi/realizer/adapter_spec.rb

@@ -23,11 +23,15 @@ RSpec.describe JSONAPI::Realizer::Adapter do
 
     end
 
-    context "when the write_attributes_via interface isn't defined" do
+    context "when the assign_attributes_via interface isn't defined" do
 
     end
 
-    context "when the save_via interface isn't defined" do
+    context "when the create_via interface isn't defined" do
+
+    end
+
+    context "when the update_via interface isn't defined" do
 
     end
   end

data/lib/jsonapi/realizer/resource.rb

@@ -1,19 +1,17 @@
 module JSONAPI
   module Realizer
     class Resource
-      extend ActiveSupport::Concern
-
       attr_reader :model
 
       def initialize(model)
         @model = model
       end
 
-      def relationship(name)
-        relationships.public_send(name.to_sym)
+      private def attribute(name)
+        attributes.public_send(name.to_sym)
       end
 
-      def attribute(name)
+      private def relationship(name)
         relationships.public_send(name.to_sym)
       end
 
@@ -25,15 +23,6 @@ module JSONAPI
         configuration.relationships
       end
 
-      private def as_relationship(value)
-        data = value.fetch("data")
-        mapping = JSONAPI::Realizer.mapping.fetch(data.fetch("type"))
-        mapping.resource_class.find_via_call(
-          mapping.model_class,
-          data.fetch("id")
-        )
-      end
-
       private def model_class
         configuration.model_class
       end
@@ -42,60 +31,48 @@ module JSONAPI
         self.class.configuration
       end
 
-      def valid_attribute?(name, value)
-        attributes.respond_to?(name.to_sym)
-      end
-
-      def valid_relationship?(name, value)
-        relationships.respond_to?(name.to_sym)
-      end
-
-      def self.represents(type, class_name:)
-        @configuration = JSONAPI::Realizer.register(self, class_name.constantize, type.to_s)
-      end
-
-      def self.adapter(interface, &block)
-        JSONAPI::Realizer::Adapter.adapt(self, interface, &block)
+      def self.attribute(name)
+        attributes.public_send(name.to_sym)
       end
 
-      def self.find_via(&finder)
-        @find_via_call = finder
+      def self.relationship(name)
+        relationships.public_send(name.to_sym)
       end
 
-      def self.find_via_call(model_class, id)
-        @find_via_call.call(model_class, id)
+      def self.valid_attribute?(name, value)
+        attributes.respond_to?(name.to_sym)
       end
 
-      def self.save_via(&saver)
-        @save_via_call = saver
+      def self.valid_relationship?(name, value)
+        relationships.respond_to?(name.to_sym)
       end
 
-      def self.save_via_call(model)
-        @save_via_call.call(model)
+      def self.valid_sparse_field?(name)
+        attribute(name).fetch(:selectable)
       end
 
-      def self.write_attributes_via(&writer)
-        @write_attributes_via_call = writer
+      def self.valid_includes?(name)
+        relationship(name).fetch(:includable)
       end
 
-      def self.write_attributes_via_call(model, attributes)
-        @write_attributes_via_call.call(model, attributes)
+      def self.has(name, selectable: true)
+        attributes.public_send("#{name}=", OpenStruct.new({name: name, selectable: selectable}))
       end
 
-      def self.has_one(name, as: name)
-        relationships.public_send("#{name}=", OpenStruct.new({name: name, as: as}))
+      def self.has_related(name, as: name, includable: true)
+        relationships.public_send("#{name}=", OpenStruct.new({name: name, as: as, includable: includable}))
       end
 
-      def self.has(name)
-        attributes.public_send("#{name}=", OpenStruct.new({name: name}))
+      def self.has_one(name, as: name, includable: true)
+        has_related(name, as: name, includable: includable)
       end
 
-      def self.relationship(name)
-        relationships.public_send(name.to_sym)
+      def self.has_many(name, as: name, includable: true)
+        has_related(name, as: name, includable: includable)
       end
 
-      def self.attribute(name)
-        relationships.public_send(name.to_sym)
+      def self.adapter
+        configuration.adapter
       end
 
       def self.attributes
@@ -110,12 +87,17 @@ module JSONAPI
         configuration.model_class
       end
 
+      def self.register(type, class_name:, adapter:)
+        JSONAPI::Realizer.register(
+          resource_class: self,
+          model_class: class_name.constantize,
+          adapter: JSONAPI::Realizer::Adapter.new(adapter),
+          type: type.to_s
+        )
+      end
+
       def self.configuration
-        if @configuration
-          @configuration
-        else
-          raise ArgumentError, "you need to have the resource configured"
-        end
+        JSONAPI::Realizer.resource_mapping.fetch(self)
       end
     end
   end

data/lib/jsonapi/realizer/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Realizer
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-realizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,10 @@ files:
 - lib/jsonapi/realizer/action.rb
 - lib/jsonapi/realizer/action/create.rb
 - lib/jsonapi/realizer/action/create_spec.rb
+- lib/jsonapi/realizer/action/index.rb
+- lib/jsonapi/realizer/action/index_spec.rb
+- lib/jsonapi/realizer/action/show.rb
+- lib/jsonapi/realizer/action/show_spec.rb
 - lib/jsonapi/realizer/action/update.rb
 - lib/jsonapi/realizer/action/update_spec.rb
 - lib/jsonapi/realizer/adapter.rb