model_driven_api 3.5.5 → 3.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61a965405c27cbeed7e06d994c4cd97cd69ec81ba21e9eb1cd1f6feef3b32741
-  data.tar.gz: 414b957e13b3ccff5a2a3b999242ad3ae3a310f5c635f2edeab21264a2633cf2
+  metadata.gz: df0f02193f91b162df1248961aabf8c4281440c49dc7f3147cb400db371f68d0
+  data.tar.gz: d0c42164dbde60bbb752110daa5e8b757ac8a7e0bfcc5e9b6a67898a02555ec8
 SHA512:
-  metadata.gz: 269993f8be409f5f3fdea9509df7037cdbf6927d21efb28152c0a65e8e6c10dc549ed784490c39d0b758caa3140052e89499675aa3f55e391982d5887c5f97ad
-  data.tar.gz: d05fef4b0562fc228a3c5ff12ecb82f7a283fd5a5cbefe16a5482f8783fb9d03edac64689452f5b53c253b0432b02febcc233bf777faab4445fafae06863c1ee
+  metadata.gz: e4e3c99b867169e19e966832ef085d5d8ffd67399a6a4047fa504a950c75a63b1a96719502d8c9d01dca6efd5d32ae7d9b07d69c8c7ad361a561cde24b957d65
+  data.tar.gz: 6bcff8f0e6c408ead804305dd386e827edf582b0e950774bcf9c79cdb9c24fe7577dab86d813e0c1a9cb8ff7e3355079f451d23eb1a8327df658824cd876b167

data/app/controllers/api/v2/application_controller.rb

@@ -40,7 +40,7 @@ class Api::V2::ApplicationController < ActionController::API
     response.set_header("Content-Range", "#{@model.table_name} #{range_start}-#{range_end}/#{@records.total_count}")
 
     # puts "ALL RECORDS FOUND: #{@records_all.inspect}"
-    status = @records_count.zero? ? 404 : 200
+    status = @records_count.zero? && params[:always_ok].blank? ? 404 : 200
     # puts "If it's asked for page number, then paginate"
     return render json: @records.as_json(json_attrs), status: status if !page.blank? # (@json_attrs || {})
     #puts "if you ask for count, then return a json object with just the number of objects"
@@ -140,18 +140,17 @@ class Api::V2::ApplicationController < ActionController::API
   # or
   # [GET|PUT|POST|DELETE] :controller/custom_action/:custom_action/:id
   def check_for_custom_action
-
     custom_action, token = if !params[:do].blank?
-      # This also responds to custom actions which have the bearer token in the custom action name. A workaround to remove for some IoT devices
-      # Which don't support token in header or in querystring
-      # This is for backward compatibility and in future it can ben removed
-      params[:do].split("-")
-    elsif request.url.include? "/custom_action/"
-      [params[:action_name], nil]
-    else
-      # Not a custom action call
-      false
-    end
+        # This also responds to custom actions which have the bearer token in the custom action name. A workaround to remove for some IoT devices
+        # Which don't support token in header or in querystring
+        # This is for backward compatibility and in future it can ben removed
+        params[:do].split("-")
+      elsif request.url.include? "/custom_action/"
+        [params[:action_name], nil]
+      else
+        # Not a custom action call
+        false
+      end
     return false unless custom_action
     # Poor man's solution to avoid the possibility to
     # call an unwanted method in the AR Model.
@@ -176,7 +175,7 @@ class Api::V2::ApplicationController < ActionController::API
       # Custom endpoint does not exist or cannot be called
       raise NoMethodError
     end
-    
+
     return true, body.to_json(json_attrs), status
   end
 

data/app/controllers/api/v2/info_controller.rb

@@ -1135,6 +1135,174 @@ Content-Type: application/json
   "count": 156
 }
 
+```
+
+## ActiveStorage Integration: React Frontend & Rails Backend
+
+### Overview
+
+This guide explains how to handle file uploads (via Camera or Gallery) and attachment deletions using a **React** frontend and a **Ruby on Rails** backend.
+
+The Rails model uses a virtual attribute strategy for deletion:
+
+* **Upload:** handled via `has_many_attached :assets`
+* **Deletion:** handled via `attr_accessor :remove_assets`
+
+---
+
+### 1. Handling File Objects (No "Paths" needed)
+
+In a web/mobile context (React Web or PWA), you do not need a file system path. When a user takes a photo or selects a file, the browser creates a native **`File`** object (a type of `Blob`).
+
+You must send this binary object to the backend using **`FormData`**.
+
+#### React Component Example
+
+This component handles:
+
+1. **File Input:** Supports both gallery selection and direct camera capture on mobile.
+2. **FormData:** Constructs the payload correctly for Rails.
+3. **API Call:** Sends the data via `fetch`.
+
+```jsx
+import React, { useState } from 'react';
+
+const ProductForm = () => {
+  const [title, setTitle] = useState('');
+  const [selectedFiles, setSelectedFiles] = useState([]);
+
+  // Handle file selection
+  const handleFileChange = (event) => {
+    // event.target.files is a FileList; convert to Array for convenience
+    const filesArray = Array.from(event.target.files);
+    setSelectedFiles(filesArray);
+  };
+
+  // Handle form submission
+  const handleSubmit = async (event) => {
+    event.preventDefault();
+
+    // 1. Create the FormData object
+    const formData = new FormData();
+
+    // 2. Append text fields
+    formData.append('product[title]', title);
+
+    // 3. Append FILES
+    // It is crucial to use 'product[assets][]' with brackets.
+    // This tells Rails to treat it as an array of attachments.
+    selectedFiles.forEach((file) => {
+      formData.append('product[assets][]', file);
+    });
+
+    try {
+      const response = await fetch('http://localhost:3000/api/products', {
+        method: 'POST',
+        // IMPORTANT NOTE:
+        // When using FormData, do NOT set 'Content-Type': 'application/json'
+        // and do NOT manually set 'multipart/form-data'.
+        // The browser will automatically set the header with the correct 'boundary'.
+        body: formData,
+      });
+
+      if (response.ok) {
+        console.log("Upload successful!");
+        // Reset form or redirect...
+      } else {
+        console.error("Upload error");
+      }
+    } catch (error) {
+      console.error("Network error:", error);
+    }
+  };
+
+  return (
+    <form onSubmit={handleSubmit} style={{ padding: '20px' }}>
+      <div>
+        <label>Product Title:</label>
+        <input 
+          type="text" 
+          value={title} 
+          onChange={(e) => setTitle(e.target.value)} 
+        />
+      </div>
+
+      <div style={{ marginTop: '20px' }}>
+        <label>Photos (Camera or Gallery):</label>
+        {/* accept="image/*": Accepts only images.
+           capture="environment": On mobile, opens the rear camera directly.
+           Remove 'capture' if you want the user to choose between Gallery and Camera.
+           multiple: Allows selecting multiple photos.
+        */}
+        <input 
+          type="file" 
+          accept="image/*" 
+          multiple
+          onChange={handleFileChange} 
+        />
+      </div>
+
+      <button type="submit" style={{ marginTop: '20px' }}>
+        Save Product
+      </button>
+    </form>
+  );
+};
+
+export default ProductForm;
+
+```
+
+---
+
+### 2. Key Implementation Details
+
+#### A. The `capture` Attribute
+
+* `<input type="file" capture="environment" />`: Opens the **rear camera** directly on iOS/Android.
+* `<input type="file" capture="user" />`: Opens the **front camera** (selfie mode).
+* **No `capture` attribute** (but with `accept="image/*"`): The device will prompt the user: *"Take Photo or Photo Library?"*. This is often the best UX.
+
+#### B. The `forEach` Loop
+
+You cannot pass an array directly into `FormData` (e.g., `formData.append('key', myArray)` will not work).
+Rails expects multiple values for the same key. You must append each file individually:
+
+```javascript
+// Correct
+files.forEach(file => formData.append('product[assets][]', file));
+
+```
+
+#### C. The Content-Type Header
+
+This is a common pitfall. When using `fetch` or `axios` with a `FormData` body, **do not set the Content-Type header manually**.
+The browser must generate it automatically to include the boundary:
+`Content-Type: multipart/form-data; boundary=----WebKitFormBoundary...`
+
+---
+
+## 3. Handling Deletion (PATCH Request)
+
+To remove specific attachments using the `remove_assets` virtual attribute defined in your Rails model, send the **Attachment IDs** (not the file objects).
+
+```javascript
+const handleUpdate = async () => {
+  const formData = new FormData();
+  
+  // 1. Add new files (if any)
+  newFiles.forEach(file => formData.append('product[assets][]', file));
+
+  // 2. Add IDs to remove 
+  // (e.g., idsToRemove is an array like [12, 45])
+  idsToRemove.forEach(id => formData.append('product[remove_assets][]', id));
+
+  await fetch(`http://localhost:3000/api/products/${productId}`, {
+    method: 'PATCH',
+    body: formData
+  });
+};
+
 ```
     MARKDOWN
     info

data/lib/model_driven_api/version.rb

@@ -1,3 +1,3 @@
 module ModelDrivenApi
-  VERSION = "3.5.5".freeze
+  VERSION = "3.5.7".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_driven_api
 version: !ruby/object:Gem::Version
-  version: 3.5.5
+  version: 3.5.7
 platform: ruby
 authors:
 - Gabriele Tassoni