jpie 0.4.5 → 1.0.0

data/lib/json_api/support/responders.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "rack/utils"
+
+module JSONAPI
+  module Responders
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :ensure_jsonapi_content_type, if: -> { request.post? || request.patch? || request.put? }
+      before_action :ensure_jsonapi_accept_header
+    end
+
+    private
+
+    def ensure_jsonapi_content_type
+      return if request.content_type&.include?("application/vnd.api+json")
+
+      render json: {
+        errors: [
+          {
+            status: "415",
+            title: "Unsupported Media Type",
+            detail: "Content-Type must be application/vnd.api+json"
+          }
+        ]
+      }, status: :unsupported_media_type
+    end
+
+    def ensure_jsonapi_accept_header
+      # Allow requests without Accept header or with */* (browser defaults)
+      # Only validate when Accept header is explicitly set to non-JSON:API media types
+      accept_header = request.headers["Accept"]
+
+      # Allow blank Accept header (browser default)
+      return if accept_header.blank?
+
+      # Allow */* Accept header (browser default)
+      return if accept_header == "*/*"
+
+      # Check if request accepts */* (wildcard)
+      return if request.accepts.any? { |mime| mime.to_s == "*/*" }
+
+      # Check if JSON:API media type is explicitly requested
+      return if jsonapi_requested?
+
+      # If Accept header is present and doesn't include JSON:API, return 406
+      # This ensures we honor explicit Accept preferences while allowing defaults
+      render_not_acceptable_error
+    end
+
+    def jsonapi_requested?
+      request.accepts.any? { |mime| mime.to_s.include?("application/vnd.api+json") }
+    end
+
+    def render_not_acceptable_error
+      render_parameter_errors(
+        [nil],
+        title: "Not Acceptable",
+        detail_proc: ->(_) { "Accept header must include application/vnd.api+json or be omitted" },
+        status: :not_acceptable
+      )
+    end
+
+    def render_jsonapi_error(status:, title:, detail: nil, source: nil)
+      render_jsonapi_errors([{ status:, title:, detail:, source: }], status:)
+    end
+
+    def render_jsonapi_errors(errors, status:)
+      normalized_errors = Array(errors).map do |error|
+        normalized = error.compact
+        normalized_status = normalized[:status] || status
+        normalized[:status] = status_code_for(normalized_status)
+        normalized
+      end
+
+      render json: { errors: normalized_errors }, status:
+    end
+
+    def render_parameter_errors(values, title:, detail_proc:, source_proc: nil, status: :bad_request)
+      errors = Array(values).map do |value|
+        error = {
+          title:,
+          detail: detail_proc.call(value)
+        }
+        error[:source] = source_proc.call(value) if source_proc
+        error
+      end
+
+      render_jsonapi_errors(errors, status:)
+    end
+
+    def status_code_for(status)
+      return status if status.is_a?(String) && status.match?(/\A\d+\z/)
+
+      Rack::Utils::SYMBOL_TO_STATUS_CODE.fetch(status, status).to_s
+    end
+  end
+end

data/lib/json_api/support/response_helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module ResponseHelpers
+    # Delegates to Serializer.jsonapi_object for backward compatibility
+    def self.jsonapi_object
+      JSONAPI::Serializer.jsonapi_object
+    end
+  end
+end

data/lib/json_api/support/sort_parsing.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module SortParsing
+    module_function
+
+    def parse_sort_field(sort_field)
+      descending = sort_field.start_with?("-")
+      field = descending ? sort_field[1..] : sort_field
+      { field:, direction: descending ? :desc : :asc }
+    end
+
+    def extract_sort_field_name(sort_field)
+      parse_sort_field(sort_field)[:field]
+    end
+
+    def extract_sort_direction(sort_field)
+      parse_sort_field(sort_field)[:direction]
+    end
+  end
+end

data/lib/json_api/support/type_conversion.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module TypeConversion
+    module_function
+
+    def type_to_class_name(type)
+      type.to_s.singularize.classify
+    end
+
+    def model_type_name(model_class)
+      model_class.name.underscore.pluralize
+    end
+
+    def resource_type_name(definition_class)
+      type_name = definition_class.name.sub(/Resource$/, "").underscore.pluralize
+      # Remove namespace prefix if present (e.g., "json_api/active_storage_blobs" -> "active_storage_blobs")
+      type_name.split("/").last
+    end
+  end
+end

data/lib/json_api/testing/test_helper.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Testing
+    # Test helper for Rails integration/request tests that provides consistent
+    # `as: :jsonapi` behavior across all HTTP methods.
+    #
+    # Usage in RSpec:
+    #   RSpec.configure do |config|
+    #     config.include JSONAPI::Testing::TestHelper, type: :request
+    #   end
+    #
+    # Then use `as: :jsonapi` in your tests:
+    #   get users_path, params: { filter: { active: true } }, headers:, as: :jsonapi
+    #   post users_path, params: payload, headers:, as: :jsonapi
+    #
+    # Behavior:
+    # - GET: Sets Accept header, params go to query string (no body encoding)
+    # - POST/PATCH/PUT/DELETE: Sets Content-Type and Accept headers, JSON-encodes body
+    #
+    module TestHelper
+      JSONAPI_MIME = "application/vnd.api+json"
+
+      def get(path, **options)
+        if options[:as] == :jsonapi
+          options = apply_jsonapi_headers(options, include_content_type: false)
+          options.delete(:as)
+        end
+        super
+      end
+
+      def post(path, **options)
+        options = apply_jsonapi_options_for_body(options) if options[:as] == :jsonapi
+        super
+      end
+
+      def patch(path, **options)
+        options = apply_jsonapi_options_for_body(options) if options[:as] == :jsonapi
+        super
+      end
+
+      def put(path, **options)
+        options = apply_jsonapi_options_for_body(options) if options[:as] == :jsonapi
+        super
+      end
+
+      def delete(path, **options)
+        options = apply_jsonapi_options_for_body(options) if options[:as] == :jsonapi
+        super
+      end
+
+      private
+
+      def apply_jsonapi_headers(options, include_content_type: true)
+        options = options.dup
+        headers = (options[:headers] || {}).dup
+
+        headers["Accept"] = JSONAPI_MIME
+        headers["Content-Type"] = JSONAPI_MIME if include_content_type
+
+        options[:headers] = headers
+        options
+      end
+
+      def apply_jsonapi_options_for_body(options)
+        options = apply_jsonapi_headers(options, include_content_type: true)
+        options.delete(:as)
+
+        # JSON-encode params for request body
+        options[:params] = options[:params].to_json if options[:params].is_a?(Hash)
+
+        options
+      end
+    end
+  end
+end

data/lib/json_api/testing.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "testing/test_helper"

data/lib/{jpie → json_api}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module JPie
-  VERSION = '0.4.5'
+module JSONAPI
+  VERSION = "1.0.0"
 end

data/lib/json_api.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json_api/version"
+require "json_api/configuration"
+
+module JSONAPI
+  class Error < StandardError; end
+  class AuthorizationError < Error; end
+end
+
+require "json_api/errors/parameter_not_allowed"
+
+module JSONAPI
+  # Rebuild BaseController and RelationshipsController to reflect the current
+  # base_controller_class configuration. Safe to call repeatedly.
+  def self.rebuild_base_controllers!
+    remove_const(:BaseController) if const_defined?(:BaseController)
+    load "json_api/controllers/base_controller.rb"
+
+    remove_const(:RelationshipsController) if const_defined?(:RelationshipsController)
+    load "json_api/controllers/relationships_controller.rb"
+  end
+end
+
+require "json_api/resources/resource"
+require "json_api/resources/resource_loader"
+require "json_api/support/type_conversion"
+require "json_api/support/sort_parsing"
+require "json_api/support/resource_identifier"
+require "json_api/support/relationship_helpers"
+require "json_api/support/param_helpers"
+require "json_api/active_storage/detection"
+require "json_api/active_storage/serialization"
+require "json_api/active_storage/deserialization"
+require "json_api/support/active_storage_support"
+require "json_api/support/collection_query"
+require "json_api/routing"
+require "json_api/support/responders"
+require "json_api/support/instrumentation"
+require "json_api/serialization/serializer"
+require "json_api/serialization/deserializer"
+require "json_api/support/response_helpers"
+require "json_api/controllers/concerns/controller_helpers"
+require "json_api/controllers/concerns/resource_actions"
+require "json_api/controllers/base_controller"
+require "json_api/controllers/resources_controller"
+require "json_api/controllers/relationships_controller"
+require "json_api/resources/active_storage_blob_resource" if defined?(ActiveStorage)
+
+require "json_api/railtie" if defined?(Rails)

data/lib/rubocop/cop/custom/hash_value_omission.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Custom
+      # Enforces hash value omission syntax introduced in Ruby 3.1
+      # When a hash key and value have the same name, use the shorthand syntax.
+      #
+      # @example
+      #   # bad
+      #   { controller: controller }
+      #   { foo: foo, bar: bar }
+      #
+      #   # good
+      #   { controller: }
+      #   { foo:, bar: }
+      class HashValueOmission < Base
+        extend AutoCorrector
+
+        MSG = "Use hash value omission (`%<key>s:`) when the value is the same-named local variable."
+
+        def on_pair(node)
+          return unless valid_pair_for_omission?(node)
+
+          key_name = node.key.value.to_s
+          return if already_omitted?(node, key_name)
+          return unless same_name?(node, key_name)
+
+          add_offense(node, message: format(MSG, key: key_name)) do |corrector|
+            corrector.replace(node.source_range, "#{key_name}:")
+          end
+        end
+
+        def valid_pair_for_omission?(node)
+          key = node.key
+          value = node.value
+
+          key.sym_type? && value&.lvar_type?
+        end
+
+        def already_omitted?(node, key_name)
+          source = node.source.strip
+          source == "#{key_name}:"
+        end
+
+        def same_name?(node, key_name)
+          value_name = node.value.source
+          key_name == value_name
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Emil Kampp
 bindir: exe
 cert_chain: []
-date: 2025-05-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -49,183 +49,64 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 8.0.0
-- !ruby/object:Gem::Dependency
-  name: brakeman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.50'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.18'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.20'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.20'
-description: JPie provides a framework for developing JSON:API compliant servers with
-  Rails 8+. It focuses on clean architecture with strong separation of concerns.
+description: A Rails 8+ gem that provides jsonapi_resources routing DSL and generic
+  JSON:API controllers
 email:
-- emil@example.com
+- emil@kampp.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".cursor/rules/dependencies.mdc"
-- ".cursor/rules/examples.mdc"
-- ".cursor/rules/git.mdc"
-- ".cursor/rules/project_structure.mdc"
-- ".cursor/rules/publish_gem.mdc"
-- ".cursor/rules/security.mdc"
-- ".cursor/rules/style.mdc"
-- ".cursor/rules/testing.mdc"
-- ".overcommit.yml"
+- ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
-- LICENSE.txt
-- PUBLISHING.md
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
-- examples/basic_example.md
-- examples/including_related_resources.md
-- examples/pagination.md
-- examples/relationships.md
-- examples/resource_attribute_configuration.md
-- examples/resource_meta_configuration.md
-- examples/rspec_testing.md
-- examples/single_table_inheritance.md
+- bin/console
+- bin/setup
 - jpie.gemspec
+- kiln/app/resources/user_message_resource.rb
 - lib/jpie.rb
-- lib/jpie/configuration.rb
-- lib/jpie/controller.rb
-- lib/jpie/controller/crud_actions.rb
-- lib/jpie/controller/error_handling.rb
-- lib/jpie/controller/error_handling/handler_setup.rb
-- lib/jpie/controller/error_handling/handlers.rb
-- lib/jpie/controller/json_api_validation.rb
-- lib/jpie/controller/parameter_parsing.rb
-- lib/jpie/controller/related_actions.rb
-- lib/jpie/controller/relationship_actions.rb
-- lib/jpie/controller/relationship_validation.rb
-- lib/jpie/controller/rendering.rb
-- lib/jpie/deserializer.rb
-- lib/jpie/errors.rb
-- lib/jpie/generators/resource_generator.rb
-- lib/jpie/generators/templates/resource.rb.erb
-- lib/jpie/railtie.rb
-- lib/jpie/resource.rb
-- lib/jpie/resource/attributable.rb
-- lib/jpie/resource/inferrable.rb
-- lib/jpie/resource/sortable.rb
-- lib/jpie/routing.rb
-- lib/jpie/serializer.rb
-- lib/jpie/version.rb
-homepage: https://github.com/emk-klaay/jpie
+- lib/json_api.rb
+- lib/json_api/active_storage/deserialization.rb
+- lib/json_api/active_storage/detection.rb
+- lib/json_api/active_storage/serialization.rb
+- lib/json_api/configuration.rb
+- lib/json_api/controllers/base_controller.rb
+- lib/json_api/controllers/concerns/controller_helpers.rb
+- lib/json_api/controllers/concerns/resource_actions.rb
+- lib/json_api/controllers/relationships_controller.rb
+- lib/json_api/controllers/resources_controller.rb
+- lib/json_api/errors/parameter_not_allowed.rb
+- lib/json_api/railtie.rb
+- lib/json_api/resources/active_storage_blob_resource.rb
+- lib/json_api/resources/resource.rb
+- lib/json_api/resources/resource_loader.rb
+- lib/json_api/routing.rb
+- lib/json_api/serialization/deserializer.rb
+- lib/json_api/serialization/serializer.rb
+- lib/json_api/support/active_storage_support.rb
+- lib/json_api/support/collection_query.rb
+- lib/json_api/support/instrumentation.rb
+- lib/json_api/support/param_helpers.rb
+- lib/json_api/support/relationship_guard.rb
+- lib/json_api/support/relationship_helpers.rb
+- lib/json_api/support/resource_identifier.rb
+- lib/json_api/support/responders.rb
+- lib/json_api/support/response_helpers.rb
+- lib/json_api/support/sort_parsing.rb
+- lib/json_api/support/type_conversion.rb
+- lib/json_api/testing.rb
+- lib/json_api/testing/test_helper.rb
+- lib/json_api/version.rb
+- lib/rubocop/cop/custom/hash_value_omission.rb
+homepage: https://github.com/klaay/json_api
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/emk-klaay/jpie
-  source_code_uri: https://github.com/emk-klaay/jpie.git
-  changelog_uri: https://github.com/emk-klaay/jpie/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -241,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
-summary: A resource-focused Rails library for developing JSON:API compliant servers
+summary: JSON:API compliant Rails gem for producing and consuming JSON:API resources
 test_files: []

data/.cursor/rules/dependencies.mdc

@@ -1,19 +0,0 @@
----
-description: 
-globs: 
-alwaysApply: false
----
-# Dependency Management
-
-## Requirements
-- Keep dependencies minimal and justified
-- Document new dependencies in README.md
-- Keep development dependencies in Gemfile
-- Ensure compatibility with Ruby 3.4+
-- Only support Rails 8+ features
-- Use modern gem versions
-
-## Compatibility Requirements
-- Maintain Ruby 3.4+ compatibility
-- Support Rails 8+ integration
-- Follow JSON:API specification strictly

data/.cursor/rules/examples.mdc

@@ -1,16 +0,0 @@
----
-description: 
-globs: 
-alwaysApply: false
----
-# Example Guidelines
-
-- Examples must only include required code
-- Examples must not include any unrelated or superfluous code
-- Examples must be a single markdown file
-- Examples must use the `http` code blocks for examples
-- Examples must only include the minimum number of examples
-- Examples must never include migrations
-- Examples must not include a features section or similar
-- Examples must include an introduction to the example
-- Examples live in /examples/*.md

data/.cursor/rules/git.mdc

@@ -1,14 +0,0 @@
----
-description: 
-globs: 
-alwaysApply: false
----
-# Git Commit Guidelines
-
-- Write clear, descriptive commit messages
-- Keep commits focused and atomic
-- Run and pass tests before committing
-- Update documentation in the same commit as code changes
-- Ignore spec/examples.txt and other files listed in .gitignore
-- Include Ruby/Rails version requirements in relevant commits
-- Update tests in the same commit as code changes