simple_jsonapi 1.0.0

data/test/resources/sparse_fieldset_test.rb

@@ -0,0 +1,160 @@
+require 'test_helper'
+
+class SparseFieldsetTest < Minitest::Spec
+  class Order < TestModel
+    attr_accessor :customer_name, :description
+    attr_writer :line_items
+
+    def line_items
+      @line_items ||= []
+    end
+  end
+
+  class LineItem < TestModel
+    attr_accessor :order_id, :product, :quantity
+  end
+
+  class Product < TestModel
+    attr_accessor :name, :price
+  end
+
+  class OrderSerializer < SimpleJsonapi::Serializer
+    attribute :customer_name
+    attribute :description
+    has_many :line_items do
+      data(&:line_items)
+    end
+    has_many :products do
+      data { |o| o.line_items.flat_map(&:product).compact.uniq }
+    end
+  end
+
+  class LineItemSerializer < SimpleJsonapi::Serializer
+    attribute :order_id
+    attribute :quantity
+    has_one :product do
+      data(&:product)
+    end
+  end
+
+  class ProductSerializer < SimpleJsonapi::Serializer
+    attribute :name
+  end
+
+  let(:order) do
+    Order.new(id: 1, customer_name: "Miguel", description: "10 things", line_items: [line_item])
+  end
+  let(:line_item) do
+    LineItem.new(id: 11, order_id: 1, product: product, quantity: 10)
+  end
+  let(:product) do
+    Product.new(id: 21, name: "Thing", price: 5.99)
+  end
+
+  let(:attributes) { serialized.dig(:data, :attributes) }
+  let(:relationships) { serialized.dig(:data, :relationships) }
+
+  describe "Sparse fieldsets" do
+    describe "for the base resources" do
+      describe "without a fields parameter" do
+        let(:serialized) { SimpleJsonapi.render_resource(order) }
+
+        it "renders all the attributes" do
+          assert_equal [:customer_name, :description], attributes.keys
+        end
+
+        it "renders all the relationships" do
+          assert_equal [:line_items, :products], relationships.keys
+        end
+      end
+
+      describe "with fields specified" do
+        let(:serialized) { SimpleJsonapi.render_resource(order, fields: { orders: "customer_name,products" }) }
+
+        it "renders only the requested attributes" do
+          assert_equal [:customer_name], attributes.keys
+        end
+
+        it "renders only the requested relationships" do
+          assert_equal [:products], relationships.keys
+        end
+      end
+
+      describe "with an empty list" do
+        let(:serialized) { SimpleJsonapi.render_resource(order, fields: { orders: "" }) }
+
+        it "renders none of the attributes" do
+          refute serialized[:data].key?(:attributes)
+        end
+
+        it "renders none of the relationships" do
+          refute serialized[:data].key?(:relationships)
+        end
+      end
+    end
+
+    describe "for related resources" do
+      let(:included_line_item) do
+        serialized[:included].find { |res| res[:type] == "line_items" }
+      end
+      let(:included_product) do
+        serialized[:included].find { |res| res[:type] == "products" }
+      end
+
+      describe "without a fields parameter" do
+        let(:serialized) do
+          SimpleJsonapi.render_resource(
+            order,
+            include: "line_items,line_items.product",
+          )
+        end
+
+        it "renders all the attributes" do
+          assert_equal [:order_id, :quantity], included_line_item[:attributes].keys
+        end
+
+        it "renders all the relationships" do
+          assert_equal [:product], included_line_item[:relationships].keys
+        end
+      end
+
+      describe "with fields specified" do
+        let(:serialized) do
+          SimpleJsonapi.render_resource(
+            order,
+            include: "line_items,line_items.product",
+            fields: { line_items: "order_id,product", products: "name" },
+          )
+        end
+
+        it "renders only the requested attributes" do
+          assert_equal [:order_id], included_line_item[:attributes].keys
+          assert_equal [:name], included_product[:attributes].keys
+        end
+
+        it "renders only the requested relationships" do
+          assert_equal [:product], included_line_item[:relationships].keys
+        end
+      end
+
+      describe "with an empty list" do
+        let(:serialized) do
+          SimpleJsonapi.render_resource(
+            order,
+            include: "line_items,products",
+            fields: { line_items: "", products: "" },
+          )
+        end
+
+        it "renders none of the attributes" do
+          refute included_line_item.key?(:attributes)
+          refute included_product.key?(:attributes)
+        end
+
+        it "renders none of the relationships" do
+          refute included_line_item.key?(:relationships)
+        end
+      end
+    end
+  end
+end

data/test/root_objects_test.rb

@@ -0,0 +1,165 @@
+require_relative 'test_helper'
+
+class RootObjectsTest < Minitest::Spec
+  class Order < TestModel
+  end
+
+  class OrderSerializer < SimpleJsonapi::Serializer
+  end
+
+  describe "Root data object" do
+    describe "for a singular resource" do
+      it "is nil when given nil" do
+        serialized = SimpleJsonapi.render_resource(nil)
+        assert_includes serialized.keys, :data
+        assert_nil serialized[:data]
+      end
+
+      it "is an object when given a single object" do
+        serialized = SimpleJsonapi.render_resource(Order.new)
+        assert_instance_of Hash, serialized[:data]
+      end
+
+      it "raises an error when given an array" do
+        ex = assert_raises(SimpleJsonapi::SerializerInferenceError) do
+          SimpleJsonapi.render_resource([Order.new])
+        end
+        assert_match(/Unable to infer serializer for Array/, ex.message)
+      end
+    end
+
+    describe "for a collection of resources" do
+      it "is an array when given an empty array" do
+        serialized = SimpleJsonapi.render_resources([])
+        assert_instance_of Array, serialized[:data]
+        assert_equal 0, serialized[:data].size
+      end
+
+      it "is an array when given a single object" do
+        serialized = SimpleJsonapi.render_resources(Order.new)
+        assert_instance_of Array, serialized[:data]
+        assert_equal 1, serialized[:data].size
+      end
+
+      it "is an array when given a one-element array" do
+        serialized = SimpleJsonapi.render_resources([Order.new])
+        assert_instance_of Array, serialized[:data]
+        assert_equal 1, serialized[:data].size
+      end
+
+      it "is an array when given a multiple-element array" do
+        serialized = SimpleJsonapi.render_resources([Order.new, Order.new])
+        assert_instance_of Array, serialized[:data]
+        assert_equal 2, serialized[:data].size
+      end
+    end
+
+    describe "when rendering errors" do
+      it "is omitted" do
+        serialized = SimpleJsonapi.render_errors([])
+        refute_includes serialized.keys, :data
+      end
+    end
+  end
+
+  describe "Root errors object" do
+    it "is omitted when given an empty array" do
+      serialized = SimpleJsonapi.render_errors([])
+      refute serialized.key?(:errors)
+    end
+
+    it "is an array when given a single error" do
+      serialized = SimpleJsonapi.render_errors(StandardError.new)
+      assert_instance_of Array, serialized[:errors]
+      assert_equal 1, serialized[:errors].size
+    end
+
+    it "is an array when given an array of errors" do
+      serialized = SimpleJsonapi.render_errors([StandardError.new, StandardError.new])
+      assert_instance_of Array, serialized[:errors]
+      assert_equal 2, serialized[:errors].size
+    end
+
+    it "is omitted when rendering resources" do
+      serialized = SimpleJsonapi.render_resources([])
+      refute serialized.key?(:errors)
+    end
+  end
+
+  describe "Root links object" do
+    it "renders links on the document root" do
+      serialized = SimpleJsonapi.render_resource(
+        Order.new,
+        links: {
+          self: {
+            href: "http://www.example.com/api",
+            meta: { count: 10 },
+          },
+          about: "http://www.example.com/about",
+        },
+      )
+
+      assert_equal %i[self about], serialized[:links].keys
+      assert_equal "http://www.example.com/api", serialized.dig(:links, :self, :href)
+      assert_equal 10, serialized.dig(:links, :self, :meta, :count)
+      assert_equal "http://www.example.com/about", serialized.dig(:links, :about)
+    end
+
+    it "omits the links object by default" do
+      serialized = SimpleJsonapi.render_resource(Order.new)
+      refute_includes serialized.keys, :links
+    end
+
+    it "omits the links object if the links param is empty" do
+      serialized = SimpleJsonapi.render_resource(Order.new, links: {})
+      refute_includes serialized.keys, :links
+    end
+
+    it "raises an error if the provided links are not a Hash" do
+      ex = assert_raises(ArgumentError) do
+        SimpleJsonapi.render_resource(Order.new, links: "not a hash")
+      end
+      assert_match(/Expected links to be NilClass or Hash/, ex.message)
+    end
+  end
+
+  describe "Root meta object" do
+    it "renders meta properties on the document root" do
+      serialized = SimpleJsonapi.render_resource(
+        Order.new,
+        meta: {
+          scalar: "hello world",
+          array: %w[one two three],
+        },
+      )
+
+      assert_equal %i[scalar array], serialized[:meta].keys
+      assert_equal "hello world", serialized.dig(:meta, :scalar)
+      assert_equal %w[one two three], serialized.dig(:meta, :array)
+    end
+
+    it "omits the meta object by default" do
+      serialized = SimpleJsonapi.render_resource(Order.new)
+      refute_includes serialized.keys, :meta
+    end
+
+    it "omits the meta object if the meta param is empty" do
+      serialized = SimpleJsonapi.render_resource(Order.new, meta: {})
+      refute_includes serialized.keys, :meta
+    end
+
+    it "raises an error if the provided meta is not a Hash" do
+      ex = assert_raises(ArgumentError) do
+        SimpleJsonapi.render_resource(Order.new, meta: "not a hash")
+      end
+      assert_match(/Expected meta to be NilClass or Hash/, ex.message)
+    end
+  end
+
+  describe "Root jsonapi object" do
+    it "is not present" do
+      serialized = SimpleJsonapi.render_resource(Order.new)
+      refute_includes serialized.keys, :jsonapi
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'active_support'
+ActiveSupport::TestCase.test_order = :random # if we don't set this, active_support gives a warning
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/reporters'
+require 'mocha/minitest'
+require 'pry'
+require 'pp'
+
+require 'simple_jsonapi'
+
+if ENV['BUILD_NUMBER']
+  Minitest::Reporters.use!(
+    [MiniTest::Reporters::DefaultReporter.new, MiniTest::Reporters::JUnitReporter.new('test/reports')],
+    ENV,
+    Minitest.backtrace_filter,
+  )
+else
+  Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new, ENV, Minitest.backtrace_filter)
+end
+
+class TestModel
+  attr_accessor :id
+
+  def initialize(attrs = {})
+    attrs.each { |k, v| send("#{k}=", v) }
+  end
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: simple_jsonapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PatientsLikeMe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library for building JSONAPI documents in Ruby.
+email:
+- engineers@patientslikeme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Jenkinsfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_jsonapi.rb
+- lib/simple_jsonapi/definition/attribute.rb
+- lib/simple_jsonapi/definition/base.rb
+- lib/simple_jsonapi/definition/concerns/has_links_object.rb
+- lib/simple_jsonapi/definition/concerns/has_meta_object.rb
+- lib/simple_jsonapi/definition/error.rb
+- lib/simple_jsonapi/definition/error_source.rb
+- lib/simple_jsonapi/definition/link.rb
+- lib/simple_jsonapi/definition/meta.rb
+- lib/simple_jsonapi/definition/relationship.rb
+- lib/simple_jsonapi/definition/resource.rb
+- lib/simple_jsonapi/error_serializer.rb
+- lib/simple_jsonapi/errors/bad_request.rb
+- lib/simple_jsonapi/errors/exception_serializer.rb
+- lib/simple_jsonapi/errors/wrapped_error.rb
+- lib/simple_jsonapi/errors/wrapped_error_serializer.rb
+- lib/simple_jsonapi/helpers/exceptions.rb
+- lib/simple_jsonapi/helpers/serializer_inferrer.rb
+- lib/simple_jsonapi/helpers/serializer_methods.rb
+- lib/simple_jsonapi/node/attributes.rb
+- lib/simple_jsonapi/node/base.rb
+- lib/simple_jsonapi/node/data/collection.rb
+- lib/simple_jsonapi/node/data/singular.rb
+- lib/simple_jsonapi/node/document/base.rb
+- lib/simple_jsonapi/node/document/collection.rb
+- lib/simple_jsonapi/node/document/errors.rb
+- lib/simple_jsonapi/node/document/singular.rb
+- lib/simple_jsonapi/node/error.rb
+- lib/simple_jsonapi/node/error_source.rb
+- lib/simple_jsonapi/node/errors.rb
+- lib/simple_jsonapi/node/included.rb
+- lib/simple_jsonapi/node/object_links.rb
+- lib/simple_jsonapi/node/object_meta.rb
+- lib/simple_jsonapi/node/relationship.rb
+- lib/simple_jsonapi/node/relationship_data/base.rb
+- lib/simple_jsonapi/node/relationship_data/collection.rb
+- lib/simple_jsonapi/node/relationship_data/singular.rb
+- lib/simple_jsonapi/node/relationships.rb
+- lib/simple_jsonapi/node/resource/base.rb
+- lib/simple_jsonapi/node/resource/full.rb
+- lib/simple_jsonapi/node/resource/linkage.rb
+- lib/simple_jsonapi/parameters/fields_spec.rb
+- lib/simple_jsonapi/parameters/include_spec.rb
+- lib/simple_jsonapi/parameters/sort_spec.rb
+- lib/simple_jsonapi/serializer.rb
+- lib/simple_jsonapi/version.rb
+- simple_jsonapi.gemspec
+- test/errors/bad_request_test.rb
+- test/errors/error_serializer_test.rb
+- test/errors/exception_serializer_test.rb
+- test/errors/wrapped_error_serializer_test.rb
+- test/errors/wrapped_error_test.rb
+- test/parameters/fields_spec_test.rb
+- test/parameters/include_spec_test.rb
+- test/parameters/sort_spec_test.rb
+- test/resources/attributes_test.rb
+- test/resources/extras_test.rb
+- test/resources/id_and_type_test.rb
+- test/resources/inclusion_test.rb
+- test/resources/links_test.rb
+- test/resources/meta_test.rb
+- test/resources/relationships_test.rb
+- test/resources/sorting_test.rb
+- test/resources/sparse_fieldset_test.rb
+- test/root_objects_test.rb
+- test/test_helper.rb
+homepage: https://www.patientslikeme.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A library for building JSONAPI documents in Ruby.
+test_files:
+- test/errors/bad_request_test.rb
+- test/errors/error_serializer_test.rb
+- test/errors/exception_serializer_test.rb
+- test/errors/wrapped_error_serializer_test.rb
+- test/errors/wrapped_error_test.rb
+- test/parameters/fields_spec_test.rb
+- test/parameters/include_spec_test.rb
+- test/parameters/sort_spec_test.rb
+- test/resources/attributes_test.rb
+- test/resources/extras_test.rb
+- test/resources/id_and_type_test.rb
+- test/resources/inclusion_test.rb
+- test/resources/links_test.rb
+- test/resources/meta_test.rb
+- test/resources/relationships_test.rb
+- test/resources/sorting_test.rb
+- test/resources/sparse_fieldset_test.rb
+- test/root_objects_test.rb
+- test/test_helper.rb