infinum_json_api_setup 0.0.3

data/lib/infinum_json_api_setup/rspec/matchers/include_related_resource.rb

@@ -0,0 +1,42 @@
+module InfinumJsonApiSetup
+  module RSpec
+    module Matchers
+      # @param [String] type
+      # @param [Integer] id
+      # @return [InfinumJsonApiSetup::Rspec::Matchers::IncludeRelatedResource]
+      def include_related_resource(type, id)
+        IncludeRelatedResource.new(type, id)
+      end
+
+      class IncludeRelatedResource < JsonBodyMatcher
+        # @param [String] type
+        # @param [Integer] id
+        def initialize(type, id)
+          super(Matchers::Util::BodyParser.new('included'))
+
+          @type = type
+          @id = id
+        end
+
+        private
+
+        attr_reader :id
+        attr_reader :included
+        attr_reader :pointer
+        attr_reader :type
+
+        def body_matches?
+          included.one? { |item| item['type'] == type && item['id'].to_i == id }
+        end
+
+        def match_failure_message
+          "Expected included items to include (type = #{type}, id = #{id}), but didn't"
+        end
+
+        def process_parsing_result(result)
+          @included = result
+        end
+      end
+    end
+  end
+end

data/lib/infinum_json_api_setup/rspec/matchers/json_body_matcher.rb

@@ -0,0 +1,42 @@
+module InfinumJsonApiSetup
+  module RSpec
+    module Matchers
+      class JsonBodyMatcher
+        def initialize(parser)
+          @parser = parser
+        end
+
+        # @param [ActionDispatch::TestResponse] response
+        # @return [Boolean]
+        def matches?(response)
+          @response = response
+          success, result = parser.process(response)
+
+          if success
+            process_parsing_result(result)
+            body_matches?
+          else
+            @error_message = result
+            false
+          end
+        end
+
+        # @return [String]
+        def failure_message
+          @error_message || match_failure_message
+        end
+
+        private
+
+        attr_reader :parser
+        attr_reader :response
+
+        def body_matches?; end
+
+        def match_failure_message; end
+
+        def process_parsing_result(_result); end
+      end
+    end
+  end
+end

data/lib/infinum_json_api_setup/rspec/matchers/schema_matchers.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :match_response_schema do |schema|
+  match do |response|
+    schema_path = RSpec.configuration.schema_response_root.join("#{schema}.json")
+    schemer = JSONSchemer.schema(schema_path)
+
+    @errors = schemer.validate(JSON.parse(response.body))
+
+    @errors.none?
+  end
+
+  failure_message do |_|
+    @errors.map { |error| JSONSchemer::Errors.pretty error }
+  end
+end
+
+RSpec::Matchers.define :match_request_schema do |schema|
+  match do |request|
+    schema_path = RSpec.configuration.schema_request_root.join("#{schema}.json")
+    schemer = JSONSchemer.schema(schema_path)
+
+    @errors = schemer.validate(JSON.parse(request.body.readpartial))
+
+    @errors.none?
+  end
+
+  failure_message do |_|
+    @errors.map { |error| JSONSchemer::Errors.pretty error }
+  end
+end

data/lib/infinum_json_api_setup/rspec.rb

@@ -0,0 +1,21 @@
+require 'infinum_json_api_setup/rspec/matchers/schema_matchers'
+require 'infinum_json_api_setup/rspec/matchers/util/body_parser'
+require 'infinum_json_api_setup/rspec/matchers/json_body_matcher'
+require 'infinum_json_api_setup/rspec/matchers/include_all_resource_ids'
+require 'infinum_json_api_setup/rspec/matchers/include_all_resource_string_ids'
+require 'infinum_json_api_setup/rspec/matchers/include_all_resource_ids_sorted'
+require 'infinum_json_api_setup/rspec/matchers/have_empty_data'
+require 'infinum_json_api_setup/rspec/matchers/have_resource_count_of'
+require 'infinum_json_api_setup/rspec/matchers/include_error_detail'
+require 'infinum_json_api_setup/rspec/matchers/have_error_pointer'
+require 'infinum_json_api_setup/rspec/matchers/include_related_resource'
+
+require 'infinum_json_api_setup/rspec/helpers/request_helper'
+require 'infinum_json_api_setup/rspec/helpers/response_helper'
+
+RSpec.configure do |config|
+  config.include InfinumJsonApiSetup::RSpec::Matchers
+
+  config.add_setting :schema_response_root
+  config.add_setting :schema_request_root
+end

data/lib/infinum_json_api_setup/version.rb

@@ -0,0 +1,3 @@
+module InfinumJsonApiSetup
+  VERSION = '0.0.3'.freeze
+end

data/lib/infinum_json_api_setup.rb

@@ -0,0 +1,16 @@
+require 'jsonapi_parameters'
+require 'rails'
+require 'responders'
+require 'pagy'
+require 'json_schemer'
+
+require 'infinum_json_api_setup/error'
+require 'infinum_json_api_setup/json_api/error_handling'
+require 'infinum_json_api_setup/json_api/error_serializer'
+
+require 'infinum_json_api_setup/json_api/content_negotiation'
+require 'infinum_json_api_setup/json_api/request_parsing'
+require 'infinum_json_api_setup/json_api/serializer_options'
+require 'infinum_json_api_setup/json_api/responder'
+
+require 'infinum_json_api_setup/rails'

data/spec/controllers/api/v1/base_controller_spec.rb

@@ -0,0 +1,9 @@
+describe Api::V1::BaseController do
+  it 'sets responder' do
+    expect(described_class.responder).to eq(InfinumJsonApiSetup::JsonApi::Responder)
+  end
+
+  it 'sets respond_to' do
+    expect(described_class.respond_to).to have_key(:json_api)
+  end
+end

data/spec/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/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets .css

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/api/v1/base_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  module V1
+    class BaseController < ApplicationController
+      include InfinumJsonApiSetup::JsonApi::ErrorHandling
+      include InfinumJsonApiSetup::JsonApi::ContentNegotiation
+
+      self.responder = InfinumJsonApiSetup::JsonApi::Responder
+      respond_to :json_api
+    end
+  end
+end

data/spec/dummy/app/controllers/api/v1/locations_controller.rb

@@ -0,0 +1,64 @@
+module Api
+  module V1
+    class LocationsController < BaseController
+      include Pundit
+
+      around_action :with_locale
+
+      # GET /api/v1/locations
+      def index
+        q = Api::V1::Locations::Query.new(Location.all, params.to_unsafe_hash)
+
+        respond_with q.results, pagination_details: q.pagination_details
+      end
+
+      # GET /api/v1/locations
+      def create
+        location = Location.create(permitted_params)
+
+        respond_with location
+      end
+
+      # GET /api/v1/locations/:id
+      def show
+        location = authorize(Location.find(params[:id]))
+
+        respond_with location
+      end
+
+      # PUT/PATCH /api/v1/locations/:id
+      def update
+        location = authorize(Location.find(params[:id]))
+        location.update(permitted_params)
+
+        respond_with location
+      end
+
+      # DELETE /api/v1/locations/:id
+      def destroy
+        location = authorize(Location.find(params[:id]))
+        location.destroy
+
+        respond_with location
+      end
+
+      private
+
+      def with_locale(&block)
+        I18n.with_locale(params.fetch(:locale, :en), &block)
+      end
+
+      def permitted_params
+        params.require(:location).permit(:latitude, :longitude)
+      end
+
+      def authorize(record)
+        super(record, policy_class: Api::V1::Locations::Policy)
+      end
+
+      def pundit_user
+        nil
+      end
+    end
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/models/location.rb

@@ -0,0 +1,38 @@
+class Location < ApplicationRecord
+  MIN_LATITUDE = -90
+  MAX_LATITUDE = 90
+  MIN_LONGITUDE = -180
+  MAX_LONGITUDE = 180
+  FIRST_QUADRANT = :first
+  SECOND_QUADRANT = :second
+  THIRD_QUADRANT = :third
+  FOURTH_QUADRANT = :fourth
+  ORIGIN = :origin
+  X_AXIS = :x_axis
+  Y_AXIS = :y_axis
+
+  has_many :labels, class_name: 'LocationLabel'
+  validates :latitude, numericality: { greater_than_or_equal_to: MIN_LATITUDE,
+                                       less_than_or_equal_to: MAX_LATITUDE }
+  validates :longitude, numericality: { greater_than_or_equal_to: MIN_LONGITUDE,
+                                        less_than_or_equal_to: MAX_LONGITUDE }
+
+  # @return [Integer]
+  def quadrant # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    if latitude.positive? && longitude.positive?
+      FIRST_QUADRANT
+    elsif latitude.positive? && longitude.negative?
+      SECOND_QUADRANT
+    elsif latitude.negative? && longitude.negative?
+      THIRD_QUADRANT
+    elsif latitude.negative? && longitude.positive?
+      FOURTH_QUADRANT
+    elsif latitude.zero? && longitude.zero?
+      ORIGIN
+    elsif latitude.zero?
+      X_AXIS
+    else
+      Y_AXIS
+    end
+  end
+end

data/spec/dummy/app/models/location_label.rb

@@ -0,0 +1,3 @@
+class LocationLabel < ApplicationRecord
+  belongs_to :location
+end

data/spec/dummy/app/policies/application_policy.rb

@@ -0,0 +1,51 @@
+class ApplicationPolicy
+  attr_reader :user
+  attr_reader :record
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  def index?
+    false
+  end
+
+  def show?
+    false
+  end
+
+  def create?
+    false
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    false
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    false
+  end
+
+  class Scope
+    attr_reader :user
+    attr_reader :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+
+    def resolve
+      scope.all
+    end
+  end
+end

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/app/web/api/v1/locations/label_serializer.rb

@@ -0,0 +1,13 @@
+module Api
+  module V1
+    module Locations
+      class LabelSerializer
+        include JSONAPI::Serializer
+
+        attribute :title
+        attribute :created_at
+        attribute :updated_at
+      end
+    end
+  end
+end

data/spec/dummy/app/web/api/v1/locations/policy.rb

@@ -0,0 +1,28 @@
+module Api
+  module V1
+    module Locations
+      class Policy < ApplicationPolicy
+        # @return [Boolean]
+        def show?
+          first_quadrant?
+        end
+
+        # @return [Boolean]
+        def update?
+          first_quadrant?
+        end
+
+        # @return [Boolean]
+        def destroy?
+          first_quadrant?
+        end
+
+        private
+
+        def first_quadrant?
+          record.quadrant == Location::FIRST_QUADRANT
+        end
+      end
+    end
+  end
+end

data/spec/dummy/app/web/api/v1/locations/query.rb

@@ -0,0 +1,12 @@
+module Api
+  module V1
+    module Locations
+      class Query < Jsonapi::QueryBuilder::BaseQuery
+        default_sort created_at: :asc
+
+        sorts_by :latitude
+        sorts_by :longitude
+      end
+    end
+  end
+end

data/spec/dummy/app/web/api/v1/locations/serializer.rb

@@ -0,0 +1,15 @@
+module Api
+  module V1
+    module Locations
+      class Serializer
+        include JSONAPI::Serializer
+
+        has_many :labels, serializer: LabelSerializer
+        attribute :latitude
+        attribute :longitude
+        attribute :created_at
+        attribute :updated_at
+      end
+    end
+  end
+end

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,39 @@
+require_relative 'boot'
+
+require 'rails'
+# Pick the frameworks you want:
+require 'active_model/railtie'
+require 'active_job/railtie'
+require 'active_record/railtie'
+require 'active_storage/engine'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_mailbox/engine'
+require 'action_text/engine'
+require 'action_view/railtie'
+require 'action_cable/engine'
+# require "sprockets/railtie"
+require 'rails/test_unit/railtie'
+
+# 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 Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+
+    # Only loads a smaller set of middleware suitable for API only apps.
+    # Middleware like session, flash, cookies can be added back manually.
+    # Skip views, helpers and assets when generating a new resource.
+    config.api_only = true
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/spec/dummy/config/database.yml

@@ -0,0 +1,15 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  database: infinum-json-api-setup-dev
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: infinum-json-api-setup-test

data/spec/dummy/config/environment.rb

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