jpie 0.4.1 → 0.4.3

data/lib/jpie/controller/rendering.rb

@@ -23,9 +23,15 @@ module JPie
       end
 
       # More concise method names following Rails conventions
-      def render_jsonapi(resource_or_resources, status: :ok, meta: nil)
+      def render_jsonapi(resource_or_resources, status: :ok, meta: nil, pagination: nil, original_scope: nil)
         includes = parse_include_params
         json_data = serializer.serialize(resource_or_resources, context, includes: includes)
+
+        # Add pagination metadata and links if pagination is provided and valid
+        if pagination && pagination[:per_page]
+          add_pagination_metadata(json_data, resource_or_resources, pagination, original_scope)
+        end
+
         json_data[:meta] = meta if meta
 
         render json: json_data, status:, content_type: 'application/vnd.api+json'
@@ -37,6 +43,94 @@ module JPie
 
       private
 
+      def add_pagination_metadata(json_data, resources, pagination, original_scope)
+        page = pagination[:page] || 1
+        per_page = pagination[:per_page]
+
+        # Get total count from the original scope before pagination
+        total_count = get_total_count(resources, original_scope)
+        total_pages = (total_count.to_f / per_page).ceil
+
+        # Add pagination metadata
+        json_data[:meta] ||= {}
+        json_data[:meta][:pagination] = {
+          page: page,
+          per_page: per_page,
+          total_pages: total_pages,
+          total_count: total_count
+        }
+
+        # Add pagination links
+        json_data[:links] = build_pagination_links(page, per_page, total_pages)
+      end
+
+      def get_total_count(resources, original_scope)
+        # Use original scope if provided, otherwise fall back to resources
+        scope_to_count = original_scope || resources
+
+        # If scope is an ActiveRecord relation, get the count
+        # Otherwise, if it's an array, get the length
+        if scope_to_count.respond_to?(:count) && !scope_to_count.loaded?
+          scope_to_count.count
+        elsif scope_to_count.respond_to?(:size)
+          scope_to_count.size
+        else
+          0
+        end
+      end
+
+      def build_pagination_links(page, per_page, total_pages)
+        url_components = extract_url_components
+        pagination_data = { page: page, per_page: per_page, total_pages: total_pages }
+
+        links = build_base_pagination_links(url_components, pagination_data)
+        add_conditional_pagination_links(links, url_components, pagination_data)
+
+        links
+      end
+
+      def extract_url_components
+        base_url = request.respond_to?(:base_url) ? request.base_url : 'http://example.com'
+        path = request.respond_to?(:path) ? request.path : '/resources'
+        query_params = request.respond_to?(:query_parameters) ? request.query_parameters.except('page') : {}
+
+        { base_url: base_url, path: path, query_params: query_params }
+      end
+
+      def build_base_pagination_links(url_components, pagination_data)
+        full_url = url_components[:base_url] + url_components[:path]
+        query_params = url_components[:query_params]
+        page = pagination_data[:page]
+        per_page = pagination_data[:per_page]
+        total_pages = pagination_data[:total_pages]
+
+        {
+          self: build_page_url(full_url, query_params, page, per_page),
+          first: build_page_url(full_url, query_params, 1, per_page),
+          last: build_page_url(full_url, query_params, total_pages, per_page)
+        }
+      end
+
+      def add_conditional_pagination_links(links, url_components, pagination_data)
+        full_url = url_components[:base_url] + url_components[:path]
+        query_params = url_components[:query_params]
+        page = pagination_data[:page]
+        per_page = pagination_data[:per_page]
+        total_pages = pagination_data[:total_pages]
+
+        links[:prev] = build_page_url(full_url, query_params, page - 1, per_page) if page > 1
+        links[:next] = build_page_url(full_url, query_params, page + 1, per_page) if page < total_pages
+      end
+
+      def build_page_url(base_url, query_params, page_num, per_page)
+        params = query_params.merge(
+          'page' => page_num.to_s,
+          'per_page' => per_page.to_s
+        )
+        query_string = params.respond_to?(:to_query) ? params.to_query : params.map { |k, v| "#{k}=#{v}" }.join('&')
+        "#{base_url}?#{query_string}"
+      end
+
       def infer_resource_class
         # Convert controller name to resource class name
         # e.g., "UsersController" -> "UserResource"

data/lib/jpie/controller.rb

@@ -6,6 +6,8 @@ require_relative 'controller/parameter_parsing'
 require_relative 'controller/rendering'
 require_relative 'controller/crud_actions'
 require_relative 'controller/json_api_validation'
+require_relative 'controller/relationship_actions'
+require_relative 'controller/related_actions'
 
 module JPie
   module Controller
@@ -16,5 +18,28 @@ module JPie
     include Rendering
     include CrudActions
     include JsonApiValidation
+    include RelationshipActions
+    include RelatedActions
+
+    # Relationship route actions
+    def show_relationship
+      relationship_show
+    end
+
+    def update_relationship
+      relationship_update
+    end
+
+    def create_relationship
+      relationship_create
+    end
+
+    def destroy_relationship
+      relationship_destroy
+    end
+
+    def show_related
+      related_show
+    end
   end
 end

data/lib/jpie/errors.rb

@@ -55,6 +55,12 @@ module JPie
       end
     end
 
+    class UnsupportedMediaTypeError < Error
+      def initialize(detail: 'Unsupported Media Type')
+        super(status: 415, title: 'Unsupported Media Type', detail:)
+      end
+    end
+
     class InternalServerError < Error
       def initialize(detail: 'Internal Server Error')
         super(status: 500, title: 'Internal Server Error', detail:)

data/lib/jpie/railtie.rb

@@ -29,6 +29,12 @@ module JPie
       end
     end
 
+    initializer 'jpie.routing' do
+      ActiveSupport.on_load(:action_dispatch) do
+        ActionDispatch::Routing::Mapper.include JPie::Routing
+      end
+    end
+
     generators do
       require 'jpie/generators/resource_generator'
     end

data/lib/jpie/resource/attributable.rb

@@ -59,13 +59,13 @@ module JPie
         def has_many(name, options = {})
           name = name.to_sym
           resource_class_name = options[:resource] || infer_resource_class_name(name)
-          relationship(name, { resource: resource_class_name }.merge(options))
+          relationship(name, { type: :has_many, resource: resource_class_name }.merge(options))
         end
 
         def has_one(name, options = {})
           name = name.to_sym
           resource_class_name = options[:resource] || infer_resource_class_name(name)
-          relationship(name, { resource: resource_class_name }.merge(options))
+          relationship(name, { type: :has_one, resource: resource_class_name }.merge(options))
         end
 
         private
@@ -104,13 +104,8 @@ module JPie
 
       # Handle through associations by calling the appropriate association method
       def handle_through_association(name, options)
-        if options[:attr]
-          # Custom attribute name was provided - use it
-          @object.public_send(options[:attr])
-        else
-          # Use the relationship name directly - Rails will handle the through association
-          @object.public_send(name)
-        end
+        attr_name = options[:attr] || name
+        @object.public_send(attr_name)
       end
     end
   end

data/lib/jpie/resource.rb

@@ -51,17 +51,31 @@ module JPie
       # Return supported sort fields for validation
       # Override this method to customize supported sort fields
       def supported_sort_fields
-        # Return all attributes and sortable fields as supported sort fields by default
-        fields = (_attributes + _sortable_fields.keys).uniq.map(&:to_s)
+        base_fields = extract_base_sort_fields
+        timestamp_fields = extract_timestamp_fields
+        (base_fields + timestamp_fields).uniq
+      end
 
-        # Add common model timestamp fields if the model supports them
-        if model.respond_to?(:column_names)
-          fields << 'created_at' if model.column_names.include?('created_at') && fields.exclude?('created_at')
+      private
 
-          fields << 'updated_at' if model.column_names.include?('updated_at') && fields.exclude?('updated_at')
-        end
+      def extract_base_sort_fields
+        (_attributes + _sortable_fields.keys).uniq.map(&:to_s)
+      end
+
+      def extract_timestamp_fields
+        return [] unless model.respond_to?(:column_names)
+
+        timestamp_fields = []
+        add_timestamp_field(timestamp_fields, 'created_at')
+        add_timestamp_field(timestamp_fields, 'updated_at')
+        timestamp_fields
+      end
+
+      def add_timestamp_field(fields, field_name)
+        return unless model.column_names.include?(field_name)
+        return if fields.include?(field_name)
 
-        fields
+        fields << field_name
       end
     end
 

data/lib/jpie/routing.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module JPie
+  module Routing
+    # Add jpie_resources method to Rails routing DSL that creates JSON:API compliant routes
+    def jpie_resources(*resources)
+      options = resources.extract_options!
+      merged_options = build_merged_options(options)
+
+      # Create standard RESTful routes for the resource
+      resources(*resources, merged_options) do
+        yield if block_given?
+        add_jsonapi_relationship_routes(merged_options) if relationship_routes_allowed?(merged_options)
+      end
+    end
+
+    private
+
+    def build_merged_options(options)
+      default_options = {
+        defaults: { format: :json },
+        constraints: { format: :json }
+      }
+      default_options.merge(options)
+    end
+
+    def relationship_routes_allowed?(merged_options)
+      only_actions = merged_options[:only]
+      except_actions = merged_options[:except]
+
+      if only_actions
+        # If only specific actions are allowed, don't add relationship routes
+        # unless multiple member actions (show, update, destroy) are included
+        (only_actions & %i[show update destroy]).size >= 2
+      elsif except_actions
+        # If actions are excluded, only add if member actions aren't excluded
+        !except_actions.intersect?(%i[show update destroy])
+      else
+        true
+      end
+    end
+
+    def add_jsonapi_relationship_routes(_merged_options)
+      # These routes handle relationship management as per JSON:API spec
+      member do
+        # Routes for fetching and updating relationships
+        # Pattern: /resources/:id/relationships/:relationship_name
+        get 'relationships/*relationship_name', action: :show_relationship, as: :relationship
+        patch 'relationships/*relationship_name', action: :update_relationship
+        post 'relationships/*relationship_name', action: :create_relationship
+        delete 'relationships/*relationship_name', action: :destroy_relationship
+
+        # Routes for fetching related resources
+        # Pattern: /resources/:id/:relationship_name
+        get '*relationship_name', action: :show_related, as: :related
+      end
+    end
+  end
+end

data/lib/jpie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JPie
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
 end

data/lib/jpie.rb

@@ -11,6 +11,7 @@ module JPie
   autoload :Controller, 'jpie/controller'
   autoload :Configuration, 'jpie/configuration'
   autoload :Errors, 'jpie/errors'
+  autoload :Routing, 'jpie/routing'
 
   class << self
     def configuration

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jpie
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Emil Kampp
 bindir: exe
 cert_chain: []
-date: 2025-05-25 00:00:00.000000000 Z
+date: 2025-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".cursorrules"
+- ".overcommit.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
@@ -177,6 +178,8 @@ files:
 - 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/single_table_inheritance.md
@@ -186,8 +189,13 @@ files:
 - 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
@@ -198,6 +206,7 @@ files:
 - 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