simple_jsonapi_rails 1.0.0

data/test/dummy/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+/node_modules
+/yarn-error.log
+
+.byebug_history

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/controllers/api_controller.rb

@@ -0,0 +1,3 @@
+class ApiController < ActionController::Base
+  include SimpleJsonapi::Rails::ActionController
+end

data/test/dummy/app/controllers/orders/relationships/items_controller.rb

@@ -0,0 +1,10 @@
+class Orders::Relationships::ItemsController < ApiController
+  def add
+  end
+
+  def remove
+  end
+
+  def replace
+  end
+end

data/test/dummy/app/controllers/orders_controller.rb

@@ -0,0 +1,38 @@
+class OrdersController < ApiController
+  jsonapi_deserialize :order
+
+  SORT_OPTIONS = {
+    customer_name: "lower(customer_name)",
+    date: "date",
+  }.freeze
+
+  def index
+    orders = Order.all
+      # order(jsonapi.sort_sql(SORT_OPTIONS, :name, :asc)).
+      # paginate(jsonapi.will_paginate_options)
+
+    render jsonapi_resources: orders, serializer: OrderSerializer,
+      include: jsonapi.include_params
+  end
+
+  def show
+    order = Order.find(params[:id])
+    render jsonapi_resource: order, serializer: OrderSerializer
+  end
+
+  def create
+    order = Order.create!(order_params)
+    render jsonapi_resource: order, serializer: OrderSerializer, status: :created
+  end
+
+  def update
+    order = Order.find(params[:id]).update!(order_params)
+    render jsonapi_resource: order, serializer: OrderSerializer, status: :ok
+  end
+
+  private
+
+  def order_params
+    params.require(:order).permit(:customer_name, :date)
+  end
+end

data/test/dummy/app/models/order.rb

@@ -0,0 +1,4 @@
+class Order < ActiveRecord::Base
+  validates :customer_name, presence: true
+  validates :date, presence: true
+end

data/test/dummy/app/serializers/order_serializer.rb

@@ -0,0 +1,6 @@
+class OrderSerializer < SimpleJsonapi::Serializer
+  type "orders"
+
+  attribute :customer_name
+  attribute :date
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,13 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults 5.1
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/test/dummy/config/database.yml

@@ -0,0 +1,7 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,44 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,44 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.seconds.to_i}",
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  Rails.application.routes.default_url_options = { host: 'localhost', port: 80, protocol: 'http' }
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  # hello: "Hello world"

data/test/dummy/config/puma.rb

@@ -0,0 +1,56 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# If you are preloading your application and using Active Record, it's
+# recommended that you close any connections to the database before workers
+# are forked to prevent connection leakage.
+#
+# before_fork do
+#   ActiveRecord::Base.connection_pool.disconnect! if defined?(ActiveRecord)
+# end
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted, this block will be run. If you are using the `preload_app!`
+# option, you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, as Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+#
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  resources :orders do
+    jsonapi_to_many_relationship(:orders, :items)
+  end
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,24 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+# Shared secrets are available across all environments.
+
+# shared:
+#   api_key: a1B2c3D4e5F6
+
+# Environmental secrets are only available for that specific environment.
+
+development:
+  secret_key_base: 3b243cd72ec1cc96362ffa02d3c7174630a78e52228ecce3fd5e247cf443a46725537f7fdeb9a0c824e8149c574c08216fef7909082e0dbd8fcf3973d1746ed3
+
+test:
+  secret_key_base: 367e5a2da146fb0c1d51d9820b2f866688e7694209667dfdef3eb569ed98a3219ecb528a4c61920de021de9740a42784f8655e355c0850f109a8f855793de785

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/test/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/test/dummy/db/migrate/20170719143227_create_orders.rb

@@ -0,0 +1,10 @@
+class CreateOrders < ActiveRecord::Migration[5.1]
+  def change
+    create_table :orders do |t|
+      t.string :customer_name
+      t.date :date
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/test/errors/active_model_error_serializer_test.rb

@@ -0,0 +1,47 @@
+require_relative '../test_helper'
+
+class ActiveModelErrorSerializerTest < Minitest::Spec
+  let(:attribute_error) do
+    SimpleJsonapi::Errors::ActiveModelError.new("the_attribute", "the_message", "the_pointer")
+  end
+  let(:generic_error) do
+    SimpleJsonapi::Errors::ActiveModelError.new(nil, "the_message", nil)
+  end
+
+  let(:serialized_attribute_error) do
+    SimpleJsonapi.render_errors(attribute_error).dig(:errors, 0)
+  end
+  let(:serialized_generic_error) do
+    SimpleJsonapi.render_errors(generic_error).dig(:errors, 0)
+  end
+
+  describe SimpleJsonapi::Errors::ActiveModelErrorSerializer do
+    it "has a status of 422" do
+      assert_equal "422", serialized_attribute_error[:status]
+    end
+
+    it "has a code of unprocessable_entity" do
+      assert_equal "unprocessable_entity", serialized_attribute_error[:code]
+    end
+
+    it "has the attribute name in the title" do
+      assert_equal "Invalid the_attribute", serialized_attribute_error[:title]
+    end
+
+    it "has a generic title if the attribute is blank" do
+      assert_equal "Invalid record", serialized_generic_error[:title]
+    end
+
+    it "has the full message as the detail" do
+      assert_equal "the_message", serialized_attribute_error[:detail]
+    end
+
+    it "includes the source pointer" do
+      assert_equal "the_pointer", serialized_attribute_error.dig(:source, :pointer)
+    end
+
+    it "ignores a missing source pointer" do
+      assert_nil serialized_generic_error.dig(:source, :pointer)
+    end
+  end
+end

data/test/errors/active_model_error_test.rb

@@ -0,0 +1,46 @@
+require_relative '../test_helper'
+
+class ActiveModelErrorTest < Minitest::Spec
+  class Order
+    include ActiveModel::Model
+    attr_accessor :customer_name, :description
+    validates :customer_name, presence: true
+    validates :description, presence: true
+  end
+
+  let(:invalid_order) { Order.new.tap(&:valid?) }
+
+  describe SimpleJsonapi::Errors::ActiveModelError do
+    describe "#initialize" do
+      let(:error) { SimpleJsonapi::Errors::ActiveModelError.new("the_attribute", "the_message", "the_pointer") }
+
+      it "takes an attribute, a message, and a pointer" do
+        assert_equal "the_attribute", error.attribute
+        assert_equal "the_message", error.message
+        assert_equal "the_pointer", error.pointer
+      end
+    end
+
+    describe ".from_errors" do
+      let(:pointer_mapping) do
+        {
+          customer_name: "/data/attributes/customer_name",
+          description: "/data/attributes/description",
+        }
+      end
+
+      let(:errors) do
+        SimpleJsonapi::Errors::ActiveModelError.from_errors(invalid_order.errors, pointer_mapping)
+      end
+
+      it "converts an ActiveModel::Errors object" do
+        assert_equal ["customer_name", "description"], errors.map(&:attribute).sort
+        assert_equal ["Customer name can't be blank", "Description can't be blank"], errors.map(&:message).sort
+      end
+
+      it "incorporates a pointer mapping" do
+        assert_equal ["/data/attributes/customer_name", "/data/attributes/description"], errors.map(&:pointer).sort
+      end
+    end
+  end
+end

data/test/errors/active_record/record_not_found_serializer_test.rb

@@ -0,0 +1,33 @@
+require_relative '../../test_helper'
+
+class ActiveRecord::RecordNotFoundSerializerTest < Minitest::Spec
+  let(:error) do
+    ActiveRecord::RecordNotFound.new("a message", "Thing", "id", 1)
+  end
+
+  let(:serialized_error) do
+    SimpleJsonapi.render_errors(error).dig(:errors, 0)
+  end
+
+  describe SimpleJsonapi::Errors::ActiveRecord::RecordNotFoundSerializer do
+    it "has a status of 404" do
+      assert_equal "404", serialized_error[:status]
+    end
+
+    it "has a code of not_found" do
+      assert_equal "not_found", serialized_error[:code]
+    end
+
+    it "has a title of Not found" do
+      assert_equal "Not found", serialized_error[:title]
+    end
+
+    it "has the full message as the detail" do
+      assert_equal "a message", serialized_error[:detail]
+    end
+
+    it "has the primary key as the source parameter" do
+      assert_equal "id", serialized_error[:source][:parameter]
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# Set up the dummy app
+ENV['RAILS_ENV'] = 'test'
+require_relative 'dummy/config/environment'
+ActiveRecord::Migrator.migrate File.expand_path("dummy/db/migrate/", __dir__)
+
+require 'active_support'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/reporters'
+require 'pry'
+require 'pp'
+
+require 'simple_jsonapi/rails'
+require 'simple_jsonapi/rails/test_helpers'
+
+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 ActiveSupport::TestCase
+  extend Minitest::Spec::DSL
+  self.test_order = :random
+
+  include ActiveRecord::TestFixtures
+  self.use_transactional_tests = true
+end