infinum_json_api_setup 0.0.8 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29be6fb7cd837fda6ba353b4f22fcadbf8139328b8a74c73f373954310abb4f
-  data.tar.gz: 4a3272b935f333a35c2b671287d02395ce5140e300a60ff9d7cf51cc7109ef7d
+  metadata.gz: 02c01a6edfee1465e478a630629fd38b0cd35f08a84a32a2eac73c353440bebc
+  data.tar.gz: f94a539f053417cfc9e0a4c938eaa594a02e422930fee2f46b80aebffeaa17e0
 SHA512:
-  metadata.gz: 50ab89b7384a97fd64a450cc10921b1ed2b6b9535603568af7c5e09110dcdb048be752b351e4343db9e30c2fc85fe938caa53d3769904d771570d1c8bd244517
-  data.tar.gz: 99ada6a80d54574f9cce79e702ba166a98bf07a6363529d3138afcd6d87a0332fc4118d155de6d4e72ae07996c951fc1e73e35f31f21a442215ea375133ba003
+  metadata.gz: eadacbfe9298f7345e3f8a639b5dee0d39515b030a9519fa9c020667d2dfe65f52a7326971853dbb52a5a25b5aea407e049da466ea6e7bcf86fe49765568fc0d
+  data.tar.gz: 6d811bc78b9f2e999a40c5e08d250277cf5f70bc0307b6f61fba1f336907a36b6f813dd57fb6bcdeebb5d26fc789711521bbae0c17f103bee5ac27449a5973b0

data/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      database:
+        image: postgres:14
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2.9', '3.3.9', '3.4.5']
+        gemfile: ['rails.7.1.gemfile', 'rails.8.0.gemfile']
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+    - name: Install dependencies
+      run: bundle install
+    - name: Setup database
+      env:
+        BUNDLE_GEMFILE: "../../${{ matrix.gemfile }}"
+      run: |
+        cd spec/dummy
+        bundle exec rake db:test:prepare
+    - name: Run rubocop
+      run: bundle exec rubocop
+    - name: Run specs
+      run: bundle exec rspec

data/.gitignore

@@ -4,3 +4,5 @@
 /spec/dummy/tmp/
 
 coverage
+
+/pkg

data/.rubocop.yml

@@ -22,7 +22,7 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   Exclude:
     - 'spec/dummy/db/schema.rb'
     - 'spec/dummy/db/migrate/*.rb'

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.4.5

data/CHANGELOG.md

@@ -1,22 +1,60 @@
-## 0.0.8 (Oct 25th, 2021)
-- update and upgrade pagy
+# Change Log for infinum/infinum-json-api-setup
 
-[Compare v0.0.7...v0.0.8](https://github.com/infinum/infinum-json-api-setup/compare/v0.0.7...v0.0.8)
+All notable changes to this project will be documented in this file.
 
-## 0.0.7 (Oct 25th, 2021)
-- fix runtime depenency loading
+This projects adheres to [Semantic Versioning](https://semver.org/) and [Keep a CHANGELOG](https://keepachangelog.com/).
 
-[Compare v0.0.6...v0.0.7](https://github.com/infinum/infinum-json-api-setup/compare/v0.0.6...v0.0.7)
+## [Unreleased]
 
-## 0.0.6 (Oct 25th, 2021)
-- update installation instructions in README
-- promote jsonapi-query-builder and jsonapi-serializer to runtime dependencies
-- start CHANGELOG
+### Changes
 
-[Compare v0.0.5...v0.0.6](https://github.com/infinum/infinum-json-api-setup/compare/v0.0.5...v0.0.6)
+## [0.1.1] - 2026-08-13
 
-## 0.0.5 (Oct 6th, 2021)
-- bump jsonapi-query_builder dependency
-- bump Nokogiri dependency (due to CVE)
+### Fixed
+- Merge controller-provided `meta` into pagination meta instead of replacing it when rendering paginated JSON:API collections
 
-[Compare v0.0.4...v0.0.4](https://github.com/infinum/infinum-json-api-setup/compare/v0.0.4...v0.0.5)
+## [0.1.0] - 2025-11-03
+
+### Added
+- Rails 8 support
+- Locale negotiation
+
+### Changes
+- Reformat CHANGELOG according to infinum/open-source-project-template
+- Drop support for Rails 6.1
+- Relax json_schemer dependency
+
+### Fixed
+- Ruby 3.4 ostruct deprecation warning
+
+## [0.0.8] - 2021-10-25
+
+### Updated
+- Bump pagy dependency
+
+## [0.0.7] - 2021-10-25
+
+### Fixed
+- Runtime depenency loading
+
+## [0.0.6] - 2021-10-25
+
+### Added
+- CHANGELOG
+
+### Changed
+- Update installation instructions in README
+- Promote jsonapi-query-builder and jsonapi-serializer to runtime dependencies
+
+## [0.0.5] - 2021-10-06
+
+### Updated
+- Bump jsonapi-query_builder dependency
+- Bump Nokogiri dependency (due to CVE)
+
+[Unreleased]: https://github.com/infinum/infinum-json-api-setup/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/infinum/infinum-json-api-setup/compare/v0.0.8...v0.1.0
+[0.0.8]: https://github.com/infinum/infinum-json-api-setup/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/infinum/infinum-json-api-setup/compare/v0.0.6...v0.0.7
+[0.0.6]: https://github.com/infinum/infinum-json-api-setup/compare/v0.0.5...v0.0.6
+[0.0.5]: https://github.com/infinum/infinum-json-api-setup/compare/v0.0.4...v0.0.5

data/Gemfile

@@ -0,0 +1 @@
+rails.7.1.gemfile

data/Gemfile.lock

@@ -0,0 +1 @@
+rails.7.1.gemfile.lock

data/README.md

@@ -24,6 +24,7 @@ module Api
   class BaseController < ActionController::API
     include InfinumJsonApiSetup::JsonApi::ErrorHandling
     include InfinumJsonApiSetup::JsonApi::ContentNegotiation
+    include InfinumJsonApiSetup::JsonApi::LocaleNegotiation
 
     self.responder = InfinumJsonApiSetup::JsonApi::Responder
     respond_to :json_api
@@ -65,12 +66,30 @@ def destroy
 end
 ```
 
+For paginated collections, pass `pagination_details` from your query object. You can add extra collection-level fields to `meta`; they are merged with pagination meta instead of replacing it.
+```ruby
+def index
+  q = Users::Query.new(User.all, params.to_unsafe_hash)
+
+  respond_with q.results,
+               pagination_details: q.pagination_details,
+               meta: { total_unread: current_user.unread_notifications_count }
+end
+```
+
 ## Internals
 This section explains the under-the-hood behavior of the library.
 
 ### Content negotiation
 `InfinumJsonApiSetup::JsonApi::ContentNegotiation` module is designed to integrate [server responsibilities](https://jsonapi.org/format/#content-negotiation-servers) of content negotiation protocol described by the JSON:API specification.
 
+### Locale negotiation
+`InfinumJsonApiSetup::JsonApi::LocaleNegotiation` module ensures that request handling happens within the locale best matching the `Accept-Language` header.
+
+- **Default behavior:** locale falls back to the application's default when the header is missing.
+- **Invalid locales:** enable graceful fallback by setting `self.fallback_to_default_locale_if_invalid = true` in your controller when you want to disregard unrecognized locales instead of raising `json_api.errors.bad_request.invalid_locale`.
+- **Error handling:** when fallback is disabled (default), requests with invalid locales trigger a JSON:API formatted bad request response.
+
 ### Error handling
 `InfinumJsonApiSetup::JsonApi::ErrorHandling` module is designed to catch and handle common exceptions that might bubble up when processing a request.
 

data/Rakefile

@@ -1 +1,4 @@
 require 'bundler/gem_tasks'
+require 'gemika/tasks'
+
+task default: 'matrix:spec'

data/base.gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'bundler-audit', require: false
+gem 'factory_bot', '~> 6.2'
+gem 'faker', '~> 2.18'
+gem 'overcommit', '~> 0.58', require: false
+gem 'pg'
+gem 'pry-rails'
+gem 'pundit'
+gem 'rake', require: false
+gem 'rubocop', '~> 1.0', require: false
+gem 'rubocop-infinum', require: false
+gem 'rubocop-rake', require: false
+gem 'simplecov', require: false

data/infinum_json_api_setup.gemspec

@@ -10,21 +10,16 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'https://github.com/infinum/infinum-json-api-setup'
   s.license     = 'MIT'
-  s.required_ruby_version = '> 2.7'
+  s.required_ruby_version = '>= 3.2'
+  s.metadata = { 'rubygems_mfa_required' => 'true' }
 
-  s.add_runtime_dependency 'jsonapi_parameters'
-  s.add_runtime_dependency 'jsonapi-query_builder'
-  s.add_runtime_dependency 'jsonapi-serializer'
-  s.add_runtime_dependency 'json_schemer', '~> 0.2'
-  s.add_runtime_dependency 'pagy'
-  s.add_runtime_dependency 'rails'
-  s.add_runtime_dependency 'responders'
-
-  s.add_development_dependency 'overcommit', '~> 0.58'
-  s.add_development_dependency 'pg'
-  s.add_development_dependency 'pry-rails'
-  s.add_development_dependency 'pundit'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec-rails', '~> 5.0'
-  s.add_development_dependency 'simplecov'
+  s.add_dependency 'accept_language', '~> 2.0'
+  s.add_dependency 'jsonapi_parameters'
+  s.add_dependency 'jsonapi-query_builder'
+  s.add_dependency 'jsonapi-serializer'
+  s.add_dependency 'json_schemer', '>= 0.2', '< 3'
+  s.add_dependency 'ostruct'
+  s.add_dependency 'pagy', '~> 8.0'
+  s.add_dependency 'rails'
+  s.add_dependency 'responders'
 end

data/lib/generators/infinum_json_api_setup/templates/config/locales/json_api.en.yml

@@ -4,6 +4,7 @@ en:
       bad_request:
         title: Bad Request
         detail: Bad request
+        invalid_locale: Invalid locale
       not_found:
         title: Not found
         detail: Resource not found

data/lib/infinum_json_api_setup/json_api/content_negotiation.rb

@@ -16,9 +16,9 @@ module InfinumJsonApiSetup
       end
 
       def valid_content_type?
-        return true if request.body.size.zero?
+        return true if request.body.nil? || request.body.size.zero? # rubocop:disable Style/ZeroLengthPredicate
 
-        request.content_type == Mime.fetch(:json_api)
+        request.content_mime_type == Mime.fetch(:json_api)
       end
 
       def acceptable?

data/lib/infinum_json_api_setup/json_api/locale_negotiation.rb

@@ -0,0 +1,45 @@
+module InfinumJsonApiSetup
+  module JsonApi
+    module LocaleNegotiation
+      extend ActiveSupport::Concern
+
+      included do
+        around_action :setup_locale
+        class_attribute :fallback_to_default_locale_if_invalid, default: false
+      end
+
+      def rescue_with_handler(*)
+        I18n.with_locale(locale) { super }
+      end
+
+      private
+
+      def setup_locale(&)
+        return render_invalid_locale_error if locale.blank?
+
+        I18n.with_locale(locale, &)
+      end
+
+      def locale
+        return I18n.default_locale if locale_from_request.blank?
+
+        parsed_locale = AcceptLanguage.parse(locale_from_request).match(*I18n.available_locales)
+
+        if parsed_locale.present?
+          parsed_locale
+        elsif fallback_to_default_locale_if_invalid
+          I18n.default_locale
+        end
+      end
+
+      def locale_from_request
+        request.env['HTTP_ACCEPT_LANGUAGE']
+      end
+
+      def render_invalid_locale_error
+        message = I18n.t('json_api.errors.bad_request.invalid_locale')
+        render_error(InfinumJsonApiSetup::Error::BadRequest.new(message:))
+      end
+    end
+  end
+end

data/lib/infinum_json_api_setup/json_api/serializer_options.rb

@@ -4,9 +4,11 @@ module InfinumJsonApiSetup
       # @param [Hash] opts
       # @option opts [Hash] :params
       # @option opts [Object] :pagination_details
-      def initialize(params:, pagination_details:)
+      # @option opts [Hash] :extra_meta additional collection meta merged into pagination meta
+      def initialize(params:, pagination_details:, extra_meta: nil)
         @params = params
         @pagination_details = pagination_details
+        @extra_meta = extra_meta || {}
       end
 
       # @return [Hash]
@@ -23,8 +25,13 @@ module InfinumJsonApiSetup
 
       attr_reader :params
       attr_reader :pagination_details
+      attr_reader :extra_meta
 
       def meta
+        pagination_meta.merge(extra_meta)
+      end
+
+      def pagination_meta
         return {} unless pagination_details
 
         {

data/lib/infinum_json_api_setup/rails.rb

@@ -19,10 +19,12 @@ ActiveSupport.on_load(:action_controller) do
         "#{controller_path.classify.pluralize}::Serializer".constantize
       end
       options = InfinumJsonApiSetup::JsonApi::SerializerOptions.new(
-        params: params.to_unsafe_h, pagination_details: opts[:pagination_details]
+        params: params.to_unsafe_h,
+        pagination_details: opts[:pagination_details],
+        extra_meta: opts[:meta]
       ).build
 
-      serializer.new(resources, options.merge(opts)).serializable_hash.to_json
+      serializer.new(resources, options.merge(opts.except(:meta))).serializable_hash.to_json
     end
   end
 end

data/lib/infinum_json_api_setup/rspec/helpers/response_helper.rb

@@ -9,14 +9,14 @@ module InfinumJsonApiSetup
         def response_item
           raise 'json response is not an item' if json_response[:data].is_a?(Array)
 
-          OpenStruct.new(json_response[:data][:attributes])
+          OpenStruct.new(json_response[:data][:attributes]) # rubocop:disable Style/OpenStructUse
         end
 
         def response_collection
           raise 'json response is not a collection' unless json_response[:data].is_a?(Array)
 
           json_response[:data].map do |item|
-            OpenStruct.new(id: item[:id], type: item[:type], **item[:attributes])
+            OpenStruct.new(id: item[:id], type: item[:type], **item[:attributes]) # rubocop:disable Style/OpenStructUse
           end
         end
 
@@ -24,7 +24,7 @@ module InfinumJsonApiSetup
           case response_type
           when :item then json_response.dig(:data, :relationships)
           when :collection then json_response[:data].pluck(:relationships)
-          else raise ArgumentError ':response_type must be one of [:item, :collection]'
+          else raise ArgumentError, ':response_type must be one of [:item, :collection]'
           end
         end
 
@@ -34,7 +34,7 @@ module InfinumJsonApiSetup
 
         def response_included
           json_response[:included].map do |item|
-            OpenStruct.new(id: item[:id], type: item[:type], **item[:attributes])
+            OpenStruct.new(id: item[:id], type: item[:type], **item[:attributes]) # rubocop:disable Style/OpenStructUse
           end
         end
 

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

@@ -2,7 +2,7 @@ module InfinumJsonApiSetup
   module RSpec
     module Matchers
       # @return [InfinumJsonApiSetup::Rspec::Matchers::HaveEmptyData]
-      def have_empty_data # rubocop:disable Naming/PredicateName
+      def have_empty_data # rubocop:disable Naming/PredicatePrefix
         HaveEmptyData.new
       end
 

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

@@ -3,7 +3,7 @@ module InfinumJsonApiSetup
     module Matchers
       # @param [String] pointer
       # @return [InfinumJsonApiSetup::Rspec::Matchers::HaveErrorPointer]
-      def have_error_pointer(pointer) # rubocop:disable Naming/PredicateName
+      def have_error_pointer(pointer) # rubocop:disable Naming/PredicatePrefix
         HaveErrorPointer.new(pointer)
       end
 

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

@@ -3,7 +3,7 @@ module InfinumJsonApiSetup
     module Matchers
       # @param [Integer] expected_count
       # @return [InfinumJsonApiSetup::Rspec::Matchers::HaveResourceCountOf]
-      def have_resource_count_of(expected_count) # rubocop:disable Naming/PredicateName
+      def have_resource_count_of(expected_count) # rubocop:disable Naming/PredicatePrefix
         HaveResourceCountOf.new(expected_count)
       end
 

data/lib/infinum_json_api_setup/version.rb

@@ -1,3 +1,3 @@
 module InfinumJsonApiSetup
-  VERSION = '0.0.8'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/infinum_json_api_setup.rb

@@ -1,9 +1,11 @@
 require 'rails'
 
+require 'accept_language'
 require 'json'
 require 'jsonapi_parameters'
 require 'jsonapi/serializer'
 require 'json_schemer'
+require 'ostruct'
 require 'responders'
 
 require 'pagy'
@@ -14,6 +16,7 @@ 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/locale_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'

data/rails.7.1.gemfile

@@ -0,0 +1,8 @@
+eval(File.read(File.expand_path('base.gemfile', __dir__))) # rubocop:disable Security/Eval
+
+gem 'gemika'
+gem 'observer'
+gem 'rails', '~> 7.1.0'
+gem 'rspec-rails', '~> 7.0', require: false
+
+gemspec