jsonapi-realizer 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f40c79b4a4ecf49431c220d161c065737e744f420250dec013011c11647af5
-  data.tar.gz: 923505a0c13a519bf0db6aa7b2ce260884a9bfd309476987e32e802f0affc0bc
+  metadata.gz: 161aa73d85429aefb08d235f632784acb2275bd05516394b77053b224acbfbd0
+  data.tar.gz: 33731346eaf5fbd9e8bdba67100208762b3848702d9a761c005bd68548384379
 SHA512:
-  metadata.gz: d6c3c50ddb0321258311a199b4e2c4eb7946ec35981865696662cad16563d40bbdb8d745f9e215cfb5fdc894fa54897410cf3bf347ac7eeb14015271a74f38e5
-  data.tar.gz: 710585e9ed18604598d2eb52ac48e935ae3cfb85f462b84284fee06a2d660f2df3b6896a33ce3ba86a063843de28b5ea07c18e132666cda3e511e841fef9fcac
+  metadata.gz: d2e2a566ec1566f01174e21acea1a9ebe28b6eeddb2795eb7be29b3598e41e6cfe8c9762d662cb460177a3ea4136cc86855da84ad39227b51703c30e4613e881
+  data.tar.gz: 65c70a8803f5e66496cb807ae42571b3a3535272a8e8df7c86d087ce27256446f90ab66cc7ef869b14eff8c70c1c7dc963690a1b716dc338b31f368df7e7f1ce

data/README.md

@@ -7,25 +7,6 @@
 
 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.
 
-A successful JSON:API request can be annotated as:
-
-```
-JSONAPIRequest -> (BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)) -> JSONAPIResponse
-```
-
-The `jsonapi-serializers` library provides this shape:
-
-```
-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:
-
-```
-BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)
-```
-
-
 ## Using
 
 In order to use this library you'll want to have some models:
@@ -59,7 +40,7 @@ class ProfileRealizer
 
   register :profiles, class_name: "Profile", adapter: :active_record
 
-  has_many :photos, as: :photos
+  has_many :photos
 
   has :name
 end
@@ -78,9 +59,6 @@ Once you've designed your resources, we just need to use them! In this example,
 ``` ruby
 class PhotosController < ApplicationController
   def create
-    validate_parameters!
-    authenticate_session!
-
     realization = JSONAPI::Realizer.create(params, headers: request.headers)
 
     ProcessPhotosService.new(realization.model)
@@ -89,9 +67,6 @@ class PhotosController < ApplicationController
   end
 
   def index
-    validate_parameters!
-    authenticate_session!
-
     realization = JSONAPI::Realizer.index(params, headers: request.headers, type: :photos)
 
     # See: pundit for `authorize()`
@@ -103,6 +78,67 @@ class PhotosController < ApplicationController
 end
 ```
 
+### Policies
+
+Most times you will want to control what a person sees when they as for your data. We have created interfaces for this use-case and we'll show how you can use pundit (or any PORO) to constrain your in/out.
+
+First up is the policy itself:
+
+``` ruby
+class PhotoPolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    def resolve
+      case
+      when relation.with_role_state?(:administrator)
+        relation
+      when requester.with_onboarding_state?(:completed)
+        relation.where(photographer: requester)
+      else
+        relation.none
+      end
+    end
+
+    def sanitize(action, params)
+      case action
+      when :index
+        params.permit(:fields, :include, :filter)
+      else
+        params
+      end
+    end
+  end
+
+  def index?
+    requester.with_onboarding_state?(:completed)
+  end
+end
+```
+
+``` ruby
+class PhotoRealizer
+  include JSONAPI::Realizer::Resource
+
+  register :photos, class_name: "Photo", adapter: :active_record
+
+  has_one :photographer, as: :profiles
+
+  has :title
+  has :src
+end
+```
+
+``` ruby
+class PhotosController < ApplicationController
+  def index
+    realization = JSONAPI::Realizer.index(policy(Photo).sanitize(:index, params), headers: request.headers, type: :posts)
+
+    # See: pundit for `policy_scope()`
+    # See: pundit for `authorize()`
+    render json: JSONAPI::Serializer.serialize(authorize(policy_scope(realization.models)), is_collection: true)
+  end
+end
+```
+
 ### Adapters
 
 There are two core adapters:
@@ -121,7 +157,7 @@ An adapter must provide the following interfaces:
   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:
+You can also provide custom adapter interfaces like below, which will use `active_record`'s `find_many_via`, `assign_relationships_via`, `update_via`, `includes_via`, and `sparse_fields_via`:
 
 ``` ruby
 class PhotoRealizer
@@ -149,12 +185,32 @@ class PhotoRealizer
 end
 ```
 
+### Notes
+
+A successful JSON:API request can be annotated as:
+
+```
+JSONAPIRequest -> (BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)) -> JSONAPIResponse
+```
+
+The `jsonapi-serializers` library provides this shape:
+
+```
+JSONAPIRequest -> (Record | Array<Record>) -> JSONAPIResponse
+```
+
+But it leaves fetching/creating/updating/destroying the records up to you! This is where jsonapi-realizer comes into play, as it provides this shape:
+
+```
+BusinessLayer -> JSONAPIRequest -> (Record | Array<Record>)
+```
+
 
 ## Installing
 
 Add this line to your application's Gemfile:
 
-    gem "jsonapi-realizer", "2.0.0"
+    gem "jsonapi-realizer", "3.0.0"
 
 And then execute:
 
@@ -164,6 +220,10 @@ Or install it yourself with:
 
     $ gem install jsonapi-realizer
 
+### Rails
+
+There's nothing extremely special about a rails application, but if you want to use jsonapi-realizer in development mode you'll probably want to turn on `eager_loading` (by setting it to `true` in `config/environments/development.rb`) or by adding `app/realizers` to the `eager_load_paths`.
+
 
 ## Contributing
 

data/lib/jsonapi/realizer.rb

@@ -1,10 +1,12 @@
 require "ostruct"
 require "active_support/concern"
 require "active_support/core_ext/enumerable"
+require "active_support/core_ext/string"
 
 module JSONAPI
   module Realizer
     require_relative "realizer/version"
+    require_relative "realizer/error"
     require_relative "realizer/action"
     require_relative "realizer/adapter"
     require_relative "realizer/resource"

data/lib/jsonapi/realizer/action.rb

@@ -7,9 +7,14 @@ module JSONAPI
       require_relative "action/index"
 
       attr_reader :payload
+      attr_reader :headers
 
-      def initialize
-        raise NoMethodError, "must implement this function"
+      def initialize(payload:, headers:)
+        raise Error::MissingAcceptHeader unless headers.key?("Accept")
+        raise Error::InvalidAcceptHeader unless headers.fetch("Accept") == "application/vnd.api+json"
+        raise Error::TooManyRootProperties if payload.key?("data") && payload.key?("errors")
+        raise Error::IncludeWithoutDataProperty if payload.key?("include") && !payload.key?("data")
+        raise Error::MalformedDataRootProperty unless payload.key?("data") && data.kind_of?(Array) || data.kind_of?(Hash) || data.nil?
       end
 
       def call; end
@@ -35,7 +40,7 @@ module JSONAPI
       end
 
       private def relation_after_fields(relation)
-        if includes.any?
+        if fields.any?
           resource_class.sparse_fields_call(relation, fields)
         else
           relation
@@ -51,22 +56,18 @@ module JSONAPI
       end
 
       private def data
-        payload.fetch("data", {})
-      end
-
-      private def id
-        data.fetch("id", nil) || payload.fetch("id", nil)
+        payload.fetch("data")
       end
 
       private def type
-        (@type || data.fetch("type")).to_s.dasherize
+        data["type"].to_s.dasherize if data
       end
 
       private def attributes
         data.
           fetch("attributes", {}).
           transform_keys(&:underscore).
-          select(&resource_class.method(:valid_attribute?))
+          select(&resource_class.method(:valid_attribute?)) if data
       end
 
       private def relationships
@@ -74,7 +75,7 @@ module JSONAPI
           fetch("relationships", {}).
           transform_keys(&:underscore).
           select(&resource_class.method(:valid_relationship?)).
-          transform_values(&method(:as_relationship))
+          transform_values(&method(:as_relationship)) if data
       end
 
       private def as_relationship(value)
@@ -86,24 +87,54 @@ module JSONAPI
         )
       end
 
-      private def includes
+      def includes
+        return [] unless payload.key?("include")
+
         payload.
-          fetch("include", []).
+          fetch("include").
           # "carts.cart-items,carts.cart-items.product,carts.billing-information,payments"
-          map { |path| path.split(/\s*,\s*/) }.
+          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?))
+          select do |chain|
+            # ["carts", "cart_items"]
+            chain.reduce(resource_class) do |last_resource_class, key|
+              break unless last_resource_class
+
+              JSONAPI::Realizer.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class if last_resource_class.valid_includes?(key)
+            end
+          end
+          # [["carts", "cart_items", "product"], ["payments"]]
       end
 
-      private def fields
+      def fields
+        return [] unless payload.key?("fields")
+
         payload.
-          fetch("fields", []).
+          fetch("fields").
+          # "title,active-photographer.email,active-photographer.posts.title"
           split(/\s*,\s*/).
-          select(&resource_class.method(:valid_sparse_field?))
+          # ["title", "active-photographer.email", "active-photographer.posts.title"]
+          map { |path| path.gsub("-", "_") }.
+          # ["title", "active_photographer.email", "active_photographer.posts.title"]
+          map { |path| path.split(".") }.
+          # [["title"], ["active_photographer", "email"], ["active_photographer", "posts", "title"]]
+          select do |chain|
+            # ["active_photographer", "email"]
+            chain.reduce(resource_class) do |last_resource_class, key|
+              break unless last_resource_class
+
+              if last_resource_class.valid_includes?(key)
+                JSONAPI::Realizer.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class
+              elsif last_resource_class.valid_sparse_field?(key)
+                last_resource_class
+              end
+            end
+          end
+          # [["title"], ["active_photographer", "email"]]
       end
 
       private def configuration

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

@@ -7,7 +7,17 @@ module JSONAPI
         def initialize(payload:, headers:)
           @payload = payload
           @headers = headers
+
+          raise Error::MissingContentTypeHeader unless headers.key?("Content-Type")
+          raise Error::InvalidContentTypeHeader unless headers.fetch("Content-Type") == "application/vnd.api+json"
+
+          super(payload: payload, headers: headers)
+
           @resource = resource_class.new(relation.new)
+
+          raise Error::MissingRootProperty unless payload.key?("data") || payload.key?("errors") || payload.key?("meta")
+          raise Error::MissingTypeResourceProperty if payload.key?("data") && data.kind_of?(Hash) && !data.key?("type")
+          raise Error::MissingTypeResourceProperty if payload.key?("data") && data.kind_of?(Array) && !data.all? {|resource| resource.key?("type")}
         end
 
         def call
@@ -20,6 +30,10 @@ module JSONAPI
         def model
           resource.model
         end
+
+        private def id
+          payload.fetch("id", nil)
+        end
       end
     end
   end

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

@@ -23,7 +23,7 @@ RSpec.describe JSONAPI::Realizer::Action::Create do
             },
             "relationships" => {
               "active-photographer" => {
-                "data" => { "type" => "photographer-people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
+                "data" => { "type" => "photographer-accounts", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
               }
             }
           }
@@ -37,72 +37,78 @@ RSpec.describe JSONAPI::Realizer::Action::Create do
         }
       end
 
-      before do
-        People::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
-          id: "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9",
-          name: "Kurtis Rainbolt-Greene"
-        }
-      end
-
-      it "is the right model" do
-        subject
+      shared_examples "api" do
+        it "is the right model" do
+          subject
 
-        expect(action.model).to be_a_kind_of(Photo)
-      end
+          expect(action.model).to be_a_kind_of(Photo)
+        end
 
-      it "assigns the id attribute" do
-        subject
+        it "assigns the id attribute" do
+          subject
 
-        expect(action.model).to have_attributes(id: "550e8400-e29b-41d4-a716-446655440000")
-      end
+          expect(action.model).to have_attributes(id: "550e8400-e29b-41d4-a716-446655440000")
+        end
 
-      it "assigns the title attribute" do
-        subject
+        it "assigns the title attribute" do
+          subject
 
-        expect(action.model).to have_attributes(title: "Ember Hamster")
-      end
+          expect(action.model).to have_attributes(title: "Ember Hamster")
+        end
 
-      it "assigns the alt_text attribute" do
-        subject
+        it "assigns the alt_text attribute" do
+          subject
 
-        expect(action.model).to have_attributes(alt_text: "A hamster logo.")
-      end
+          expect(action.model).to have_attributes(alt_text: "A hamster logo.")
+        end
 
-      it "assigns the src attribute" do
-        subject
+        it "assigns the src attribute" do
+          subject
 
-        expect(action.model).to have_attributes(src: "http://example.com/images/productivity.png")
-      end
+          expect(action.model).to have_attributes(src: "http://example.com/images/productivity.png")
+        end
 
-      it "assigns the updated_at attribute" do
-        subject
+        it "assigns the updated_at attribute" do
+          subject
 
-        expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
-      end
+          expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
+        end
 
-      it "assigns the active_photographer attribute" do
-        subject
+        it "assigns the active_photographer attribute" do
+          subject
 
-        expect(action.model).to have_attributes(active_photographer: a_kind_of(People))
+          expect(action.model).to have_attributes(active_photographer: a_kind_of(Account))
+        end
       end
 
-      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"
-            )
+      context "in a memory store", memory: true do
+        before do
+          Account::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
+            id: "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9",
+            name: "Kurtis Rainbolt-Greene"
           }
-        )
+        end
+
+        include_examples "api"
+
+        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
   end

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

@@ -8,12 +8,23 @@ module JSONAPI
           @payload = payload
           @headers = headers
           @type = type
+
+          super(payload: payload, headers: headers)
+
           @resources = adapter.find_many_via_call(relation).map(&resource_class.method(:new))
         end
 
         def models
           resources.map(&:model)
         end
+
+        private def data
+          payload["data"]
+        end
+
+        private def type
+          @type.to_s.dasherize if @type
+        end
       end
     end
   end

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

@@ -21,21 +21,27 @@ RSpec.describe JSONAPI::Realizer::Action::Index do
         }
       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"
-        }
+      shared_examples "api" do
+        it "returns a list of photos" do
+          expect(subject).to include(a_kind_of(Photo), a_kind_of(Photo))
+        end
       end
 
-      it "returns a list of photos" do
-        expect(subject).to include(a_kind_of(Photo), a_kind_of(Photo))
+      context "in a memory store", memory: true do
+        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
+
+        include_examples "api"
       end
     end
   end

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

@@ -9,12 +9,29 @@ module JSONAPI
           @payload = payload
           @headers = headers
           @type = type
+
+          super(payload: payload, headers: headers)
+
           @resource = resource_class.new(adapter.find_via_call(relation, id))
         end
 
         def model
           resource.model
         end
+
+        private def data
+          payload["data"]
+        end
+
+        private def type
+          @type.to_s.dasherize if @type
+        end
+
+        private def id
+          return data.fetch("id", nil) if data
+
+          payload.fetch("id", nil)
+        end
       end
     end
   end

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

@@ -23,25 +23,31 @@ RSpec.describe JSONAPI::Realizer::Action::Show do
         }
       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
+      shared_examples "api" do
+        it "returns a photo model" do
+          expect(subject).to be_a_kind_of(Photo)
+        end
 
-      it "returns a photo model" do
-        expect(subject).to be_a_kind_of(Photo)
+        it "returns the photos attributes" do
+          expect(subject).to have_attributes(title: "Ember Fox", src: "http://example.com/images/productivity-2.png")
+        end
       end
 
-      it "returns the photos attributes" do
-        expect(subject).to have_attributes(title: "Ember Fox", src: "http://example.com/images/productivity-2.png")
+      context "in a memory store", memory: true do
+        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
+
+        include_examples "api"
       end
     end
   end

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

@@ -7,7 +7,17 @@ module JSONAPI
         def initialize(payload:, headers:)
           @payload = payload
           @headers = headers
+
+          raise Error::MissingContentTypeHeader unless headers.key?("Content-Type")
+          raise Error::InvalidContentTypeHeader unless headers.fetch("Content-Type") == "application/vnd.api+json"
+
+          super(payload: payload, headers: headers)
+
           @resource = resource_class.new(adapter.find_via_call(relation, id))
+
+          raise Error::MissingRootProperty unless payload.key?("data") || payload.key?("errors") || payload.key?("meta")
+          raise Error::MissingTypeResourceProperty if payload.key?("data") && data.kind_of?(Hash) && !data.key?("type")
+          raise Error::MissingTypeResourceProperty if payload.key?("data") && data.kind_of?(Array) && !data.all? {|resource| resource.key?("type")}
         end
 
         def call
@@ -19,6 +29,12 @@ module JSONAPI
         def model
           resource.model
         end
+
+        private def id
+          return data.fetch("id", nil) if data
+
+          payload.fetch("id", nil)
+        end
       end
     end
   end

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

@@ -6,9 +6,82 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
   describe "#call" do
     subject { action.call }
 
-    context "with no top-level data and good headers"
-    context "with no top-level data and bad headers"
-    context "with a good payload and bad headers"
+    context "with no top-level data and no content-type header no accept headers" do
+      let(:payload) do
+        {}
+      end
+      let(:headers) do
+        {}
+      end
+
+      it "raises an exception" do
+        expect {subject}.to raise_exception(JSONAPI::Realizer::Error::MissingContentTypeHeader)
+      end
+    end
+
+    context "with no top-level data and good content-type header no accept headers" do
+      let(:payload) do
+        {}
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/vnd.api+json",
+        }
+      end
+
+      it "raises an exception" do
+        expect {subject}.to raise_exception(JSONAPI::Realizer::Error::MissingAcceptHeader)
+      end
+    end
+
+    context "with no top-level data and wrong content-type header" do
+      let(:payload) do
+        {}
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/json"
+        }
+      end
+
+      it "raises an exception" do
+        expect {subject}.to raise_exception(JSONAPI::Realizer::Error::InvalidContentTypeHeader)
+      end
+    end
+
+    context "with no top-level data and good content-type header and wrong accept header" do
+      let(:payload) do
+        {}
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/vnd.api+json",
+          "Accept" => "application/json"
+        }
+      end
+
+      it "raises an exception" do
+        expect {subject}.to raise_exception(JSONAPI::Realizer::Error::InvalidAcceptHeader)
+      end
+    end
+
+    context "with wrong top-level data and good headers" do
+      let(:payload) do
+        {
+          "data" => ""
+        }
+      end
+      let(:headers) do
+        {
+          "Content-Type" => "application/vnd.api+json",
+          "Accept" => "application/vnd.api+json"
+        }
+      end
+
+      it "raises an exception" do
+        expect {subject}.to raise_exception(JSONAPI::Realizer::Error::MalformedDataRootProperty)
+      end
+    end
 
     context "with a good payload and good headers" do
       let(:payload) do
@@ -23,7 +96,7 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
             },
             "relationships" => {
               "active-photographer" => {
-                "data" => { "type" => "photographer-people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
+                "data" => { "type" => "photographer-accounts", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
               }
             }
           }
@@ -36,77 +109,83 @@ RSpec.describe JSONAPI::Realizer::Action::Update do
         }
       end
 
-      before do
-        People::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
-          id: "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9",
-          name: "Kurtis Rainbolt-Greene"
-        }
-        Photo::STORE["550e8400-e29b-41d4-a716-446655440000"] = {
-          id: "550e8400-e29b-41d4-a716-446655440000",
-          title: "Ember Hamster",
-          src: "http://example.com/images/productivity.png"
-        }
-      end
-
-      it "is the right model" do
-        subject
+      shared_examples "api" do
+        it "is the right model" do
+          subject
 
-        expect(action.model).to be_a_kind_of(Photo)
-      end
+          expect(action.model).to be_a_kind_of(Photo)
+        end
 
-      it "assigns the title attribute" do
-        subject
+        it "assigns the title attribute" do
+          subject
 
-        expect(action.model).to have_attributes(title: "Ember Hamster 2")
-      end
+          expect(action.model).to have_attributes(title: "Ember Hamster 2")
+        end
 
-      it "assigns the alt_text attribute" do
-        subject
+        it "assigns the alt_text attribute" do
+          subject
 
-        expect(action.model).to have_attributes(alt_text: "A hamster logo.")
-      end
+          expect(action.model).to have_attributes(alt_text: "A hamster logo.")
+        end
 
-      it "assigns the src attribute" do
-        subject
+        it "assigns the src attribute" do
+          subject
 
-        expect(action.model).to have_attributes(src: "http://example.com/images/productivity-2.png")
-      end
+          expect(action.model).to have_attributes(src: "http://example.com/images/productivity-2.png")
+        end
 
-      it "assigns the updated_at attribute" do
-        subject
+        it "assigns the updated_at attribute" do
+          subject
 
-        expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
-      end
+          expect(action.model).to have_attributes(updated_at: a_kind_of(Time))
+        end
 
-      it "assigns the active_photographer attribute" do
-        subject
+        it "assigns the active_photographer attribute" do
+          subject
 
-        expect(action.model).to have_attributes(active_photographer: a_kind_of(People))
+          expect(action.model).to have_attributes(active_photographer: a_kind_of(Account))
+        end
       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"
-            )
+      context "in a memory store", memory: true do
+        before do
+          Account::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
+            id: "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9",
+            name: "Kurtis Rainbolt-Greene"
           }
-        ).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"
-            )
+          Photo::STORE["550e8400-e29b-41d4-a716-446655440000"] = {
+            id: "550e8400-e29b-41d4-a716-446655440000",
+            title: "Ember Hamster",
+            src: "http://example.com/images/productivity.png"
           }
-        )
+        end
+
+        include_examples "api"
+
+        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
   end

data/lib/jsonapi/realizer/action_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+RSpec.describe JSONAPI::Realizer::Action do
+  let(:action) do
+    Class.new(described_class) do
+      def initialize(payload:, type:)
+        @payload = payload
+        @type = type
+      end
+    end.new(payload: payload, type: :photos)
+  end
+
+  describe "#includes" do
+    subject { action.includes }
+
+    context "with a two good and one bad" do
+      let(:payload) do
+        {
+          "include" => "active_photographer,active_photographer.posts.comments,active_photographer.posts"
+        }
+      end
+
+      it "contains only the two good" do
+        expect(subject).to eq([["active_photographer"], ["active_photographer", "posts"]])
+      end
+    end
+  end
+
+  describe "#fields" do
+    subject { action.fields }
+
+    context "with a two good and one bad" do
+      let(:payload) do
+        {
+          "fields" => "title,active_photographer.posts.comments.body,active_photographer.name"
+        }
+      end
+
+      it "contains only the two good" do
+        expect(subject).to eq([["title"], ["active_photographer", "name"]])
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error.rb

@@ -0,0 +1,15 @@
+module JSONAPI
+  module Realizer
+    class Error < StandardError
+      require_relative "error/include_without_data_property"
+      require_relative "error/invalid_accept_header"
+      require_relative "error/invalid_content_type_header"
+      require_relative "error/malformed_data_root_property"
+      require_relative "error/missing_accept_header"
+      require_relative "error/missing_content_type_header"
+      require_relative "error/missing_root_property"
+      require_relative "error/missing_type_resource_property"
+      require_relative "error/too_many_root_properties"
+    end
+  end
+end

data/lib/jsonapi/realizer/error/include_without_data_property.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class IncludeWithoutDataProperty < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/invalid_accept_header.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class InvalidAcceptHeader < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/invalid_content_type_header.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class InvalidContentTypeHeader < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/malformed_data_root_property.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class MalformedDataRootProperty < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/missing_accept_header.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class MissingAcceptHeader < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/missing_content_type_header.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class MissingContentTypeHeader < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/missing_root_property.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class MissingRootProperty < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/missing_type_resource_property.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class MissingTypeResourceProperty < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/error/too_many_root_properties.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module Realizer
+    class Error
+      class TooManyRootProperties < Error
+
+      end
+    end
+  end
+end

data/lib/jsonapi/realizer/resource.rb

@@ -51,11 +51,11 @@ module JSONAPI
         end
 
         def valid_sparse_field?(name)
-          attribute(name).fetch(:selectable)
+          attribute(name).selectable if attribute(name)
         end
 
         def valid_includes?(name)
-          relationship(name).fetch(:includable)
+          relationship(name).includable if relationship(name)
         end
 
         def has(name, selectable: true)
@@ -66,12 +66,12 @@ module JSONAPI
           relationships.public_send("#{name}=", OpenStruct.new({name: name, as: as, includable: includable}))
         end
 
-        def has_one(name, as: name, includable: true)
-          has_related(name, as: name, includable: includable)
+        def has_one(name, as: name.to_s.pluralize.dasherize, includable: true)
+          has_related(name, as: as.to_s.dasherize, includable: includable)
         end
 
-        def has_many(name, as: name, includable: true)
-          has_related(name, as: name, includable: includable)
+        def has_many(name, as: name.to_s.dasherize, includable: true)
+          has_related(name, as: as.to_s.dasherize, includable: includable)
         end
 
         def adapter

data/lib/jsonapi/realizer/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Realizer
-    VERSION = "2.0.3"
+    VERSION = "3.0.0"
   end
 end

data/lib/jsonapi/realizer_spec.rb

@@ -98,7 +98,7 @@ RSpec.describe JSONAPI::Realizer do
             },
             "relationships" => {
               "active-photographer" => {
-                "data" => { "type" => "photographer-people", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
+                "data" => { "type" => "photographer-accounts", "id" => "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9" }
               }
             }
           }
@@ -112,7 +112,7 @@ RSpec.describe JSONAPI::Realizer do
       end
 
       before do
-        People::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
+        Account::STORE["4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9"] = {
           id: "4b8a0af6-953d-4729-8b9a-1fa4eb18f3c9",
           name: "Kurtis Rainbolt-Greene"
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-realizer
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
@@ -128,10 +142,21 @@ files:
 - lib/jsonapi/realizer/action/show_spec.rb
 - lib/jsonapi/realizer/action/update.rb
 - lib/jsonapi/realizer/action/update_spec.rb
+- lib/jsonapi/realizer/action_spec.rb
 - lib/jsonapi/realizer/adapter.rb
 - lib/jsonapi/realizer/adapter/active_record.rb
 - lib/jsonapi/realizer/adapter/memory.rb
 - lib/jsonapi/realizer/adapter_spec.rb
+- lib/jsonapi/realizer/error.rb
+- lib/jsonapi/realizer/error/include_without_data_property.rb
+- lib/jsonapi/realizer/error/invalid_accept_header.rb
+- lib/jsonapi/realizer/error/invalid_content_type_header.rb
+- lib/jsonapi/realizer/error/malformed_data_root_property.rb
+- lib/jsonapi/realizer/error/missing_accept_header.rb
+- lib/jsonapi/realizer/error/missing_content_type_header.rb
+- lib/jsonapi/realizer/error/missing_root_property.rb
+- lib/jsonapi/realizer/error/missing_type_resource_property.rb
+- lib/jsonapi/realizer/error/too_many_root_properties.rb
 - lib/jsonapi/realizer/resource.rb
 - lib/jsonapi/realizer/version.rb
 - lib/jsonapi/realizer/version_spec.rb