simple_jsonapi 1.0.0

data/test/errors/error_serializer_test.rb

@@ -0,0 +1,229 @@
+require 'test_helper'
+
+class ErrorSerializerTest < Minitest::Spec
+  class Problem < TestModel
+    attr_accessor :id, :name, :number, :date
+  end
+
+  class DefaultsSerializer < SimpleJsonapi::ErrorSerializer
+  end
+
+  class BlocksSerializer < SimpleJsonapi::ErrorSerializer
+    id(&:id)
+    status { "422" }
+    code(&:number)
+    title(&:name)
+    detail { |err| "#{err.name} #{err.number}" }
+    source do
+      pointer { |err| "/to/#{err.name}" }
+      parameter { |err| err.class.name }
+    end
+    about_link { |err| "https://www.patientslikeme.com/error/#{err.id}" }
+    meta(:date) { |err| err.date&.iso8601 }
+  end
+
+  class ProcsSerializer < SimpleJsonapi::ErrorSerializer
+    id ->(err) { err.id }
+    status ->(_err) { "422" }
+    code ->(err) { err.number }
+    title ->(err) { err.name }
+    detail ->(err) { "#{err.name} #{err.number}" }
+    source do
+      pointer ->(err) { "/to/#{err.name}" }
+      parameter ->(err) { err.class.name }
+    end
+    about_link ->(err) { "https://www.patientslikeme.com/error/#{err.id}" }
+    meta :date, ->(err) { err.date&.iso8601 }
+  end
+
+  class ValuesSerializer < SimpleJsonapi::ErrorSerializer
+    id "42"
+    status "422"
+    code "the_code"
+    title "the title"
+    detail "the details"
+    source do
+      pointer "/to/somewhere"
+      parameter "the_parameter"
+    end
+    about_link "https://www.patientslikeme.com/errors"
+    meta :date, "2017-01-01"
+  end
+
+  let(:problem) { Problem.new(id: 12, name: "BadThing", number: "999", date: Date.new(2017, 7, 1)) }
+
+  let(:default_serialized) do
+    SimpleJsonapi.render_errors(problem, serializer: DefaultsSerializer)[:errors].first
+  end
+  let(:blocks_serialized) do
+    SimpleJsonapi.render_errors(problem, serializer: BlocksSerializer)[:errors].first
+  end
+  let(:procs_serialized) do
+    SimpleJsonapi.render_errors(problem, serializer: ProcsSerializer)[:errors].first
+  end
+  let(:values_serialized) do
+    SimpleJsonapi.render_errors(problem, serializer: ValuesSerializer)[:errors].first
+  end
+
+  describe SimpleJsonapi::ErrorSerializer do
+    describe "id property" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:id)
+      end
+
+      it "accepts a block" do
+        assert_equal "12", blocks_serialized[:id]
+      end
+
+      it "accepts a proc" do
+        assert_equal "12", procs_serialized[:id]
+      end
+
+      it "accepts a value" do
+        assert_equal "42", values_serialized[:id]
+      end
+    end
+
+    describe "status property" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:status)
+      end
+
+      it "accepts a block" do
+        assert_equal "422", blocks_serialized[:status]
+      end
+
+      it "accepts a proc" do
+        assert_equal "422", procs_serialized[:status]
+      end
+
+      it "accepts a value" do
+        assert_equal "422", values_serialized[:status]
+      end
+    end
+
+    describe "code property" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:code)
+      end
+
+      it "accepts a block" do
+        assert_equal "999", blocks_serialized[:code]
+      end
+
+      it "accepts a proc" do
+        assert_equal "999", procs_serialized[:code]
+      end
+
+      it "accepts a value" do
+        assert_equal "the_code", values_serialized[:code]
+      end
+    end
+
+    describe "title property" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:title)
+      end
+
+      it "accepts a block" do
+        assert_equal "BadThing", blocks_serialized[:title]
+      end
+
+      it "accepts a proc" do
+        assert_equal "BadThing", procs_serialized[:title]
+      end
+
+      it "accepts a value" do
+        assert_equal "the title", values_serialized[:title]
+      end
+    end
+
+    describe "detail property" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:detail)
+      end
+
+      it "accepts a block" do
+        assert_equal "BadThing 999", blocks_serialized[:detail]
+      end
+
+      it "accepts a proc" do
+        assert_equal "BadThing 999", procs_serialized[:detail]
+      end
+
+      it "accepts a value" do
+        assert_equal "the details", values_serialized[:detail]
+      end
+    end
+
+    describe "source object" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:source)
+      end
+    end
+
+    describe "source pointer property" do
+      it "accepts a block" do
+        assert_equal "/to/BadThing", blocks_serialized.dig(:source, :pointer)
+      end
+
+      it "accepts a proc" do
+        assert_equal "/to/BadThing", procs_serialized.dig(:source, :pointer)
+      end
+
+      it "accepts a value" do
+        assert_equal "/to/somewhere", values_serialized.dig(:source, :pointer)
+      end
+    end
+
+    describe "source parameter property" do
+      it "accepts a block" do
+        assert_equal problem.class.name, blocks_serialized.dig(:source, :parameter)
+      end
+
+      it "accepts a proc" do
+        assert_equal problem.class.name, procs_serialized.dig(:source, :parameter)
+      end
+
+      it "accepts a value" do
+        assert_equal "the_parameter", values_serialized.dig(:source, :parameter)
+      end
+    end
+
+    describe "about link" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:links)
+      end
+
+      it "accepts a block" do
+        assert_equal "https://www.patientslikeme.com/error/12", blocks_serialized.dig(:links, :about)
+      end
+
+      it "accepts a proc" do
+        assert_equal "https://www.patientslikeme.com/error/12", procs_serialized.dig(:links, :about)
+      end
+
+      it "accepts a value" do
+        assert_equal "https://www.patientslikeme.com/errors", values_serialized.dig(:links, :about)
+      end
+    end
+
+    describe "meta information" do
+      it "is excluded by default" do
+        refute default_serialized.key?(:meta)
+      end
+
+      it "accepts a block" do
+        assert_equal "2017-07-01", blocks_serialized.dig(:meta, :date)
+      end
+
+      it "accepts a proc" do
+        assert_equal "2017-07-01", procs_serialized.dig(:meta, :date)
+      end
+
+      it "accepts a value" do
+        assert_equal "2017-01-01", values_serialized.dig(:meta, :date)
+      end
+    end
+  end
+end

data/test/errors/exception_serializer_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class ExceptionSerializerTest < Minitest::Spec
+  class SampleException < StandardError
+  end
+
+  let(:exception) { SampleException.new("the message") }
+  let(:serialized) do
+    SimpleJsonapi.render_errors(exception, serializer: SimpleJsonapi::Errors::ExceptionSerializer)[:errors].first
+  end
+
+  describe SimpleJsonapi::Errors::ExceptionSerializer do
+    it "sets code to the class name in snake case" do
+      assert_equal "exception_serializer_test_sample_exception", serialized[:code]
+    end
+
+    it "sets title to the class name" do
+      assert_equal "ExceptionSerializerTest::SampleException", serialized[:title]
+    end
+
+    it "sets detail to the message" do
+      assert_equal "the message", serialized[:detail]
+    end
+  end
+end

data/test/errors/wrapped_error_serializer_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+class WrappedErrorSerializerTest < Minitest::Spec
+  let(:cause) { StandardError.new("the message") }
+
+  let(:wrapped) do
+    SimpleJsonapi::Errors::WrappedError.new(
+      cause,
+      id: "the id",
+      status: "the status",
+      code: "the code",
+      title: "the title",
+      detail: "the detail",
+      source_pointer: "the source pointer",
+      source_parameter: "the source parameter",
+      about_link: "the about link",
+    )
+  end
+
+  let(:serialized) do
+    rendered_errors = SimpleJsonapi.render_errors(
+      wrapped,
+      serializer: SimpleJsonapi::Errors::WrappedErrorSerializer,
+    )
+    rendered_errors[:errors].first
+  end
+
+  describe SimpleJsonapi::Errors::WrappedErrorSerializer do
+    it "outputs the id property" do
+      assert_equal "the id", serialized[:id]
+    end
+
+    it "outputs the status property" do
+      assert_equal "the status", serialized[:status]
+    end
+
+    it "outputs the code property" do
+      assert_equal "the code", serialized[:code]
+    end
+
+    it "outputs the title property" do
+      assert_equal "the title", serialized[:title]
+    end
+
+    it "outputs the detail property" do
+      assert_equal "the detail", serialized[:detail]
+    end
+
+    it "outputs the nested source pointer" do
+      assert_equal "the source pointer", serialized[:source][:pointer]
+    end
+
+    it "outputs the nested source parameter" do
+      assert_equal "the source parameter", serialized[:source][:parameter]
+    end
+
+    it "outputs an about link" do
+      assert_equal "the about link", serialized[:links][:about]
+    end
+
+    it "omits blank properties" do
+      blank_error = SimpleJsonapi::Errors::WrappedError.new(
+        cause,
+        id: "  ",
+        status: "  ",
+        code: "  ",
+        title: "  ",
+        detail: "  ",
+        source_pointer: "  ",
+        source_parameter: "  ",
+        about_link: "  ",
+      )
+
+      rendered_errors = SimpleJsonapi.render_errors(
+        blank_error, serializer:
+        SimpleJsonapi::Errors::WrappedErrorSerializer,
+      )
+
+      serialized_blank = rendered_errors[:errors].first
+
+      refute_includes serialized_blank.keys, :id
+      refute_includes serialized_blank.keys, :status
+      refute_includes serialized_blank.keys, :code
+      refute_includes serialized_blank.keys, :title
+      refute_includes serialized_blank.keys, :detail
+      refute_includes serialized_blank.keys, :source
+      refute_includes serialized_blank.keys, :source
+      refute_includes serialized_blank.keys, :links
+    end
+  end
+end

data/test/errors/wrapped_error_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class WrappedErrorTest < Minitest::Spec
+  let(:cause) { StandardError.new("the message") }
+
+  let(:wrapped) do
+    SimpleJsonapi::Errors::WrappedError.new(
+      cause,
+      id: "the id",
+      status: "the status",
+      code: "the code",
+      title: "the title",
+      detail: "the detail",
+      source_pointer: "the source pointer",
+      source_parameter: "the source parameter",
+      about_link: "the about link",
+    )
+  end
+
+  describe SimpleJsonapi::Errors::WrappedError do
+    describe "cause" do
+      it "defaults to nil" do
+        assert_nil SimpleJsonapi::Errors::WrappedError.new.cause
+      end
+
+      it "is stored" do
+        assert_equal cause, wrapped.cause
+      end
+    end
+
+    describe "other properties" do
+      it "are stored" do
+        assert_equal "the id", wrapped.id
+        assert_equal "the status", wrapped.status
+        assert_equal "the code", wrapped.code
+        assert_equal "the title", wrapped.title
+        assert_equal "the detail", wrapped.detail
+        assert_equal "the source pointer", wrapped.source_pointer
+        assert_equal "the source parameter", wrapped.source_parameter
+        assert_equal "the about link", wrapped.about_link
+      end
+    end
+  end
+end

data/test/parameters/fields_spec_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class FieldsSpecTest < Minitest::Spec
+  describe SimpleJsonapi::Parameters::FieldsSpec do
+    describe "parsing" do
+      it "accepts comma-delimited strings" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new(
+          "orders" => "customer_name,description",
+          "line_items" => "order_id,product_id",
+        )
+
+        assert_equal [:customer_name, :description], spec[:orders]
+        assert_equal [:order_id, :product_id], spec[:line_items]
+      end
+
+      it "accepts arrays of strings" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new(
+          "orders" => ["customer_name", "description"],
+          "line_items" => ["order_id", "product_id"],
+        )
+
+        assert_equal [:customer_name, :description], spec[:orders]
+        assert_equal [:order_id, :product_id], spec[:line_items]
+      end
+
+      it "accepts arrays of symbols" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new(
+          orders: [:customer_name, :description],
+          line_items: [:order_id, :product_id],
+        )
+
+        assert_equal [:customer_name, :description], spec[:orders]
+        assert_equal [:order_id, :product_id], spec[:line_items]
+      end
+    end
+
+    describe "all_fields?" do
+      it "is true if nothing is defined for the type" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new
+        assert_equal true, spec.all_fields?(:orders)
+      end
+
+      it "is false if the type is assigned any fields" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new(
+          "orders" => "customer_name,description",
+        )
+        assert_equal false, spec.all_fields?(:orders)
+      end
+
+      it "is false if the type is assigned an empty list" do
+        spec = SimpleJsonapi::Parameters::FieldsSpec.new("orders" => "")
+        assert_equal false, spec.all_fields?(:orders)
+      end
+    end
+  end
+end