ecoportal-api-v2 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bec4b516ab8e7355727c70598185b370f0165e944bae0cde0e852d94d80be95
-  data.tar.gz: eb74199d7ea533a76b03b0db49f2260d6627c2c123538b5198ab504c2eec5a29
+  metadata.gz: fcf0d1bcb9682c389d37e23c34f5e8b358fec8867dcc42da783279e9d7b3de85
+  data.tar.gz: 62f6710a5f91ad24960ccd6cd03b83703de067e6cbcd7f49f2814ed792e5b287
 SHA512:
-  metadata.gz: d787c2dab1e01fa783f1612193e1ae4c07a6c2fb131208de512cd48f8f30080c1c9c9816eba0738a14627d5af6b7c592e8dc606af5a809df2318f398fef37238
-  data.tar.gz: aaa1fa2d08bde158aae7142673c497f7c0347fac765cc0cf397a209a8b7d6492cfdb1312767228f1b4ca83fb5c0db024099a1e2ba69b8b68ec92764e7e470c55
+  metadata.gz: f398d701389d9a3f705385a86ed7f14bf055b77e244fef3f735fe5d63d85974d305520a77bb142506c8ede0d7ab2436fe520098c859fba950f7c18ed65594c8e
+  data.tar.gz: b01280b46c5168ab31d510680ee8d46b650c0c25dc4540784fff591a2160fe848f7e6d7a365259ddaea53199f4e1381eca6aa8d0a391d89e134bddf2206bb9d0

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.2.2
+  TargetRubyVersion: 3.2
   Exclude:
     - 'config/routes.rb'
   NewCops: enable

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.3.2] - 2025-06-xx
+## [3.3.3] - 2026-06-xx
 
 ### Added
 
@@ -10,6 +10,16 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [3.3.2] - 2026-06-05
+
+### Added
+
+- **AI**: instructions
+
+### Changed
+
+- upgraded `ecoportal-api` gem.
+
 ## [3.3.1] - 2025-06-11
 
 ### Changed

data/CLAUDE.md

@@ -0,0 +1,82 @@
+# CLAUDE.md — ecoportal-api-v2
+
+AI agent instructions for this repository.
+
+**Cross-cutting architecture context lives in `ecoportal-api-graphql` — see its `CLAUDE.md` and `.claude/` folder for the full dependency map, project history, and shared skills.**
+
+---
+
+## Repository Role
+
+`ecoportal-api-v2` is the **REST API v2 gem**, extending `ecoportal-api` with a rich content model layer (pages, registers, people, S3 file handling). It provides the `Ecoportal::API::V2` and `Ecoportal::API::Common::Content` namespaces.
+
+**Position in chain:**
+```
+ecoportal-api
+      ↓
+ecoportal-api-v2       ← THIS REPO
+      ↓
+ecoportal-api-graphql
+      ↓
+eco-helpers
+```
+
+**Remote:** https://gitlab.ecoportal.co.nz/oscar/ecoportal-api-v2.git
+
+---
+
+## Key Folder Layout
+
+```
+lib/ecoportal/api/
+  common/
+    concerns/          Benchmarkable, Threadable mixins
+    content/           Core model infrastructure (see below)
+  v2/
+    page/              Page model — sections, stages, components, forces, permissions
+    page/component/    All field types (text, number, date, selection, files, geo, etc.)
+    pages/             Pages collection, stage results, tasks
+    registers/         Register models — search results, stage/page results
+    people/            V2 people endpoint
+    s3/                S3 file upload/download infrastructure
+```
+
+### `Common::Content` — the model engine
+
+The most complex part of this gem. Key classes:
+
+- `DoubleModel` — two-layer model (a "live" doc and a "patch" doc) with attribute DSL, diffing, nesting, and change tracking. Almost all V2 models inherit from this.
+- `CollectionModel` — ordered collection with upsert/delete/mutation support.
+- `ClassHelpers` — `class_resolver` macro for injectable class references (pattern shared with `ecoportal-api-graphql`).
+- `DocHelpers`, `ModelHelpers`, `IncluderHelpers` — utility mixins for model construction.
+
+---
+
+## Namespace
+
+- `Ecoportal::API::V2` — v2 REST resources
+- `Ecoportal::API::Common::Content` — shared model infrastructure (consumed downstream)
+- `Ecoportal::API::Common::Concerns` — threading and benchmarking mixins
+
+---
+
+## Key Concerns
+
+- `DoubleModel` is the foundational abstraction — understand it before modifying any V2 model.
+- `Common::Content::ClassHelpers` mirrors the `ClassHelpers` in `ecoportal-api-graphql` — changes to one may need mirroring in the other.
+- S3 upload is async with polling (`s3/files/poll.rb`) — timing-sensitive code.
+
+---
+
+## Backwards Compatibility
+
+`eco-helpers` and `ecoportal-api-graphql` both depend on this gem. Changes to `Common::Content::*` or `V2::Page::*` interfaces must be checked against usage in both downstream gems before committing.
+
+---
+
+## Running Tests
+
+```bash
+bundle install
+bundle exec rspec
+```

data/ecoportal-api-v2.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0'
   spec.add_development_dependency 'yard',         '~> 0.9'
 
-  spec.add_dependency 'ecoportal-api', '~> 0.10', '>= 0.10.12'
+  spec.add_dependency 'ecoportal-api', '~> 0.10', '>= 0.10.16'
   spec.add_dependency 'mime-types',    '~> 3.5',  '>= 3.5.2'
 end
 

data/lib/ecoportal/api/common/concerns/benchmarkable.rb

@@ -16,6 +16,7 @@ module Ecoportal
 
           def benchmarking(ref = nil, units: 1, print: false, &block)
             return yield unless benchmark_enabled?
+
             benchmark_mem(ref, units: units, print: false) do
               benchmark_time(ref, units: units, print: false, &block)
             end.tap do

data/lib/ecoportal/api/common/content/double_model/double_doc/linkable_doc.rb

@@ -35,6 +35,7 @@ module Ecoportal
               def as_json
                 doc
               end
+              alias_method :to_h, :as_json
 
               def print_pretty
                 puts JSON.pretty_generate(as_json)

data/lib/ecoportal/api/v2/s3/files/batch_upload.rb

@@ -3,7 +3,9 @@ module Ecoportal
     class V2
       class S3
         class Files
-          # Class service to upload multiple files in one go
+          # Class service to upload multiple files in one go.
+          # Full cycle: from local files to the org file manager.
+          # @note it uploads to S3, and converts it into a file container as well.
           class BatchUpload
             include Ecoportal::API::Common::Concerns::Benchmarkable
             include Ecoportal::API::Common::Concerns::Threadable

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = '3.3.1'.freeze
+    GEM2_VERSION = '3.3.2'.freeze
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Oscar Segura
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -135,7 +134,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.12
+        version: 0.10.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -145,7 +144,7 @@ dependencies:
         version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.12
+        version: 0.10.16
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +165,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.2
-description:
 email:
 - oscar@ecoportal.co.nz
 executables: []
@@ -180,6 +178,7 @@ files:
 - ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE
 - README.md
@@ -334,7 +333,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -349,8 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 4.0.8
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's V2 API
 test_files: []