model_driven_api 3.7.4 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1053d8f7e666ab9eb65f47714e9a02881028b261b10e4667b24ca8a4883eb45
-  data.tar.gz: d106be5cfe8eaff72ef75a9dfe910014af157f1726540197f97bc7d37b07993a
+  metadata.gz: d0955834f57dc25b51a326caf3a64d2da728c635eacb2b01cf1e9f656e559ea5
+  data.tar.gz: 677af97d19ed54c6cba486f0d99bce4736e4e06e3f916c4d0c896a13eef8c865
 SHA512:
-  metadata.gz: d970bb7e8bb28e5c04e03e35d2528b916d121741ee570c3fdd838f86b365f9a584147f5da9f7240e8e9444fe755632a09c452c1e3e25163746647f4d0d9c0f8b
-  data.tar.gz: 49d4d7cf759bc034dd48d43e006e277f356c0512e876843329bbf67856f82fbd19e26aa5b50633585c2548523123a007451fcd36364d379709350a314988356c
+  metadata.gz: 07f3a5338e772e90baf5687dc38b6b038b55b97da94bae909d544408767b67927da667507f3e84e52a80f4cc7ff26c275757d9700f1bbfb0ce8914784da206fd
+  data.tar.gz: ec926ebae3447ad6ba9f8231dd60b2992f75b2838b2b49be14378390fe63f99b0af3085f9759ea0e2d580477463fa10d092b651dc29452597f0801c420b4eb18

data/README.md

@@ -449,6 +449,22 @@ When composing `json_attrs` across multiple concerns, use `ModelDrivenApi.smart_
 self.json_attrs = ModelDrivenApi.smart_merge((json_attrs || {}), { only: [:id, :name] })
 ```
 
+### Default `json_attrs` — no `Api::ModelName` concern required
+
+A model doesn't need an explicit `Api::ModelName` concern just to get a working API shape.
+`ModelDrivenApiDefaultJsonAttrs` is registered into
+[`ThecoreBackendCommons::DefaultModuleRegistry`](../thecore_backend_commons/README.md#defaultmoduleregistry--shared-applicationrecordinherited-hook)
+and automatically `include`d into every `ApplicationRecord` subclass as it's defined, setting
+`self.json_attrs = { except: [] }` (every column, no `methods`, no sideloaded `include`) — the
+simplest safe default. A model with its own `Api::ModelName` concern (or `ModelDrivenApiUser`/
+`ModelDrivenApiRole`) is unaffected: that concern's `include` always runs after the default and
+freely overrides or merges on top of it via `ModelDrivenApi.smart_merge`. Only a model with no
+concern at all keeps the bare default.
+
+**Temporary dependency note**: this currently requires `thecore_backend_commons` from a Gemfile
+`git:` pin to its `release/3` branch, since the RubyGems release hasn't caught up with the
+registry yet — see this repo's `CLAUDE.md` for the exact commit/removal condition.
+
 ---
 
 ## Raw SQL endpoint

data/app/models/endpoints/push_subscriber.rb

@@ -57,30 +57,45 @@ class Endpoints::PushSubscriber < NonCrudEndpoints
 
   self.desc 'PushSubscriber', :send_push, {
     post: {
-      summary: 'Send a Web Push notification to a specific subscriber',
+      summary: 'Send Web Push to one subscriber (push_subscriber_id) or many (push_subscriber_ids array, async).',
       parameters: [],
       responses: {
-        '201' => { description: 'Message created and dispatched' },
+        '201' => { description: 'Single: message JSON. Bulk: { created: [...], failed: [...] }' },
         '422' => { description: 'Validation error' },
-        '404' => { description: 'Subscriber not found' }
+        '404' => { description: 'Subscriber not found (single mode only)' }
       }
     }
   }
 
   def send_push(params)
-    subscriber = PushSubscriber.active.find_by(id: params[:push_subscriber_id])
-    return [{ error: 'Subscriber not found' }, 404] unless subscriber
-    message = subscriber.push_messages.build(
-      title: params[:title],
-      body: params[:body],
-      url: params[:url],
-      icon: params[:icon]
-    )
-    unless message.save
-      return [{ error: message.errors.full_messages.join(', ') }, 422]
+    return [{ error: 'title is required' }, 422] if params[:title].blank?
+    return [{ error: 'body is required' }, 422] if params[:body].blank?
+
+    if params[:push_subscriber_ids].present?
+      send_push_bulk(params)
+    else
+      send_push_single(params)
     end
-    ThecoreBackendCommons::PushNotificationService.dispatch(subscriber, message)
-    [message, 201]
+  rescue => e
+    [{ error: e.message }, 500]
+  end
+
+  self.desc 'PushSubscriber', :broadcast_push, {
+    post: {
+      summary: 'Send Web Push to all active subscribers.',
+      parameters: [],
+      responses: {
+        '201' => { description: '{ enqueued: N } — number of jobs enqueued' },
+        '422' => { description: 'Validation error (title or body missing)' }
+      }
+    }
+  }
+
+  def broadcast_push(params)
+    return [{ error: 'title is required' }, 422] if params[:title].blank?
+    return [{ error: 'body is required' }, 422] if params[:body].blank?
+
+    broadcast_push_all(params)
   rescue => e
     [{ error: e.message }, 500]
   end
@@ -103,8 +118,89 @@ class Endpoints::PushSubscriber < NonCrudEndpoints
     now = Time.current
     message.update!(received_at: now) if params[:received] && message.received_at.nil?
     message.update!(read_at: now) if params[:read] && message.read_at.nil?
-    [message, 200]
+    [message.as_json(PushMessage.json_attrs), 200]
   rescue ActiveRecord::RecordInvalid => e
     [{ error: e.message }, 422]
   end
+
+  private
+
+  def send_push_single(params) # rubocop:disable Metrics/MethodLength
+    subscriber = PushSubscriber.active.find_by(id: params[:push_subscriber_id])
+    return [{ error: 'Subscriber not found' }, 404] unless subscriber
+
+    message = subscriber.push_messages.build(
+      title: params[:title],
+      body: params[:body],
+      url: params[:url],
+      icon: params[:icon]
+    )
+    return [{ error: message.errors.full_messages.join(', ') }, 422] unless message.save
+
+    ThecoreBackendCommons::PushNotificationService.dispatch(subscriber, message)
+    [message.as_json(PushMessage.json_attrs), 201]
+  end
+
+  def broadcast_push_all(params) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    active_ids = PushSubscriber.active.pluck(:id)
+    return [{ enqueued: 0 }, 201] if active_ids.empty?
+
+    now = Time.current
+    records = active_ids.map do |sub_id|
+      {
+        push_subscriber_id: sub_id,
+        title: params[:title],
+        body: params[:body],
+        url: params[:url].presence,
+        icon: params[:icon].presence,
+        message_type: params[:message_type].presence || 'communication',
+        sender_user_id: params[:current_user_id].presence,
+        created_at: now,
+        updated_at: now
+      }
+    end
+
+    returning_cols = %w[id push_subscriber_id title body url icon
+                        message_type sent_at received_at read_at
+                        created_at updated_at sender_user_id]
+    result = PushMessage.insert_all(records, returning: returning_cols)
+
+    created = result.to_a
+    created.each { |r| PushDispatchJob.perform_later(r['id']) }
+
+    [{ enqueued: created.length }, 201]
+  end
+
+  def send_push_bulk(params) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    ids = Array(params[:push_subscriber_ids]).map(&:to_i).uniq
+    valid_ids = PushSubscriber.active.where(id: ids).pluck(:id)
+    failed = ids - valid_ids
+
+    return [{ created: [], failed: failed }, 201] if valid_ids.empty?
+
+    now = Time.current
+    records = valid_ids.map do |sub_id|
+      {
+        push_subscriber_id: sub_id,
+        title: params[:title],
+        body: params[:body],
+        url: params[:url].presence,
+        icon: params[:icon].presence,
+        message_type: params[:message_type].presence || 'communication',
+        sender_user_id: params[:sender_user_id].presence,
+        created_at: now,
+        updated_at: now
+      }
+    end
+
+    returning_cols = %w[id push_subscriber_id title body url icon
+                        message_type sent_at received_at read_at
+                        created_at updated_at sender_user_id]
+    result = PushMessage.insert_all(records, returning: returning_cols)
+
+    created = result.to_a
+    created.each { |r| PushDispatchJob.perform_later(r['id']) }
+
+    [{ created: created, failed: failed }, 201]
+  end
 end

data/config/initializers/default_json_attrs_registration.rb

@@ -0,0 +1,18 @@
+require "concerns/model_driven_api_default_json_attrs"
+
+# Registers the generic default `json_attrs` module (ADR 0001) into
+# ThecoreBackendCommons's shared DefaultModuleRegistry so it is `include`d
+# into every `ApplicationRecord` subclass as it is defined.
+#
+# Installed from `config.to_prepare` -- not `config.after_initialize` -- for
+# the same reason `ThecoreBackendCommons::DefaultModuleRegistry.install!` is:
+# Rails runs `to_prepare` callbacks *before* `eager_load!`, so the module must
+# already be registered before eager loading defines every model class in
+# production. `to_prepare` also re-runs on every class reload in development;
+# `DefaultModuleRegistry.register` is idempotent for the same module object,
+# so re-running this block on reload is safe.
+Rails.application.configure do
+  config.to_prepare do
+    ThecoreBackendCommons::DefaultModuleRegistry.register(ModelDrivenApiDefaultJsonAttrs)
+  end
+end

data/lib/concerns/model_driven_api_default_json_attrs.rb

@@ -0,0 +1,51 @@
+# Registered into ThecoreBackendCommons::DefaultModuleRegistry (see
+# config/initializers/default_json_attrs_registration.rb) so it is
+# automatically `include`d into *every* `ApplicationRecord` subclass at
+# class-definition time -- not just the handful of named classes
+# (ModelDrivenApiUser, ModelDrivenApiRole, ...) that get a bespoke concern.
+#
+# See vendor/external/thecore/docs/adr/0001-application-record-defaults-over-generated-concerns.md
+# in the host app for the design rationale: default model behavior should
+# not require a generated per-model `Api::ModelName` concern file for the
+# no-customization case.
+#
+# A model that *does* need custom serialization still gets (or keeps) an
+# explicit `Api::ModelName` concern, `include`d directly in the model file
+# exactly as today -- because `ApplicationRecord.inherited` (which applies
+# this default) fires *before* the subclass's own body executes, that later
+# explicit `include` always runs after this default has already set
+# `json_attrs`, so it freely overrides (or, via `ModelDrivenApi.smart_merge`,
+# merges on top of) the default's value. See `ModelDrivenApiUser`/
+# `ModelDrivenApiRole` for that pattern.
+module ModelDrivenApiDefaultJsonAttrs
+  extend ActiveSupport::Concern
+
+  included do
+    ## DSL (AKA what to show in the returned JSON)
+    # Use self.json_attrs to drive json rendering for
+    # API model responses (index, show and update ones).
+    # For reference:
+    # https://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html
+    # The object passed accepts only these keys:
+    # - only: list [] of model field names in symbol notation to be shown in JSON
+    #       serialization.
+    # - except: exclude these fields from the JSON serialization, is a list []
+    #        of model field names in symbol notation.
+    # - methods: include the result of some methods defined in the model (virtual
+    #       fields).
+    # - include: include associated models, it's a list [] of hashes {} which also
+    #       accepts the [:only, :except, :methods, :include] keys.
+    #
+    # Default shape: no `only`/`except` restriction beyond the empty array
+    # below (so every column is serialized), no `methods`, no `include` (no
+    # associations sideloaded) -- the simplest safe default for a model that
+    # has no customization needs. `cattr_accessor` (not a plain method
+    # definition) is required so `json_attrs` lands as an *own* method on
+    # each concrete model class -- `Api::V2::InfoController#schema`/`#dsl`
+    # check `instance_methods(false).include?(:json_attrs)` while walking
+    # `ApplicationRecord.subclasses`, and a merely-inherited method would
+    # silently fail that check and drop the model from introspection output.
+    cattr_accessor :json_attrs
+    self.json_attrs = { except: [] }
+  end
+end

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.7.4".freeze
+  VERSION = "3.9.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.7.4
+  version: 3.9.0
 platform: ruby
 authors:
 - Gabriele Tassoni
@@ -195,6 +195,7 @@ files:
 - config/initializers/after_initialize_for_model_driven_api.rb
 - config/initializers/auto_include_json.rb
 - config/initializers/cors_api_thecore.rb
+- config/initializers/default_json_attrs_registration.rb
 - config/initializers/knock.rb
 - config/initializers/time_with_zone.rb
 - config/initializers/wrap_parameters.rb
@@ -210,6 +211,7 @@ files:
 - lib/api/v3/serializer_factory.rb
 - lib/concerns/api_exception_management.rb
 - lib/concerns/model_driven_api_application_record.rb
+- lib/concerns/model_driven_api_default_json_attrs.rb
 - lib/concerns/model_driven_api_push_message.rb
 - lib/concerns/model_driven_api_push_subscriber.rb
 - lib/concerns/model_driven_api_role.rb