ecoportal-api-v2 3.3.5 → 3.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9ea2abc82177f2b292bab333e466526dc633c8b849a4af90ce66c7ed8e127f7
-  data.tar.gz: 655492d67fe745a2025dbb3b3fc4c928af901a985d40daf80a2fad687c5502d3
+  metadata.gz: 8804921ca6b6893fba5d2f775b2718bcbd8c7e23e840224ea792f8a11265951d
+  data.tar.gz: e0c1c47bd24c02bce9c729b3a5ac67bf246e07e726d9f218ae093ff4d5dfb1a7
 SHA512:
-  metadata.gz: c822d0f45c889887c6b65b76ed410b141b814a490cabdeb8144e6135066fa2dd54153fb747dc95213b6038563750f40fbc58fb10d1341b51c239471e4cdba9ff
-  data.tar.gz: 1d780d683ba889a1ec606a36877a36e35d2aa4a4fea74c060c75c2b03d052af0529aa8d538d250f1f48cae6546c94bcf2dc79c3007ca9bb123c90595a72328a6
+  metadata.gz: 186d61f92d3d47212eb80bc16dc59b83d3fa2bd9c030c353e8098b837759a33464b6edb59d15842f69e797ae5d46a0a193d251ff5b28fd6bc9ff54aa64b9f418
+  data.tar.gz: b5741a4223c50560cff05dfa95f87e718b540016fb10faf5190998af91bac4ddbb0f12dea2a63c7fe35305e95976480f086da0beff52435d4f89237c6affa25f

data/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.3.6] - 2026-09-30
+
+### Fixed
+
+- **`Benchmarkable#memory_usage` crashed with `NoMethodError: undefined method 'chop' for nil`
+  on modern Windows.** The Windows branch shelled out to `wmic`, which has been deprecated and
+  removed from current Windows (Win 11 24H2 / Server 2025). A backtick to a missing command
+  returns an EMPTY string, not `nil`, so the `return 0 unless wmem` guard never fired;
+  `"".lines.first` is `nil`, and `nil.chop` raised. Because benchmarking wraps ordinary
+  operations (e.g. every `graphql.pages.get` in downstream `ecoportal-api-graphql`/`eco-helpers`
+  flows), the crash surfaced as a bogus "page not found" on EVERY page fetch on such a host,
+  with no real relation to the page or its permissions. `memory_usage` now guards nil AND empty,
+  falls back to `Get-CimInstance` (`wmic`'s PowerShell successor), and returns 0 when no reading
+  is available -- benchmarking never crashes the operation it wraps. Adds
+  `spec/ecoportal/api/common/concerns/benchmarkable_spec.rb` pinning the never-raise invariant
+  and the empty-`wmic`-output case.
+
+- **`spec.files` allowlisted by root directory, not by full path.** The `3.3.4` fix replaced a
+  denylist with `f.start_with?('lib/', 'exe/')`, which stops a new top-level directory from
+  shipping but says nothing about what a file under `lib/` actually IS. `ecoportal-api-graphql`
+  hit exactly that blind spot in its `2.2.0` build, shipping five `CLAUDE.md` files that lived
+  inside its `lib/` tree under the equivalent rule. This gem was never caught leaking that way --
+  `git ls-files lib/ | grep -v '\.rb$'` is empty today -- but the same root-keyed rule sat here
+  too, so it is hardened pre-emptively rather than waiting for its own incident: `spec.files` now
+  requires both the `lib/` prefix and a `.rb` extension, still intersected with `git ls-files`.
+  Adds `spec/packaging_spec.rb` to pin the allowlist against regression.
+
+### Security
+
+- Removes customer and internal identifiers from this changelog (shipped code comments re-scanned: clean). The
+  published `3.3.4` and `3.3.5` changelogs named a customer, and `3.3.2` shipped an internal
+  notes file; `3.3.6` is the clean replacement so those versions can be yanked. No code or
+  dependency change beyond the fixes above -- drop-in for `~> 3.3, >= 3.3.5`.
+
 ## [3.3.5] - 2026-08-20
 
 ### Fixed
@@ -31,7 +65,7 @@ All notable changes to this project will be documented in this file.
 ### Fixed
 
 - Packaging-only republish with the allowlisted gemspec. `3.3.3` shipped internal repository
-  content (`.ai-assistance/` tooling and notes, `.claude/settings.json`) to rubygems.org via the
+  content (internal AI-tooling notes and editor settings) to rubygems.org via the
   old denylist `spec.files`. `3.3.4` is the identical `lib/` code packaged clean; `3.3.3` will
   be yanked.
 
@@ -45,7 +79,7 @@ All notable changes to this project will be documented in this file.
   `(attribute, obj_k)` destructured the **accumulator hash** and `attribute` became the trace `Hash` →
   `send(<hash>)` raised `"… is not a symbol nor a string" (TypeError)` on **any** cascaded operation
   (e.g. `Diffable#as_update` / `DiffService`) over a model with nested attributes. Latent because
-  Ruby 2.x tolerated the arg order; fatal under Ruby 3.x (crashed the live act-gov TOOCS integration
+  Ruby 2.x tolerated the arg order; fatal under Ruby 3.x (crashed a live customer integration
   via the `ecoportal-api-graphql` consumer). Swapped to `|(attribute, obj_k), out|` (commit `6a2b1b5`).
   **Regression spec added** (`spec/…/double_model_spec.rb`).
 

data/README.md

@@ -1,7 +1,57 @@
 # Ecoportal::API::V2
 
-This is a basic collection of helpers that can be used to interact with the
-[ecoPortal](https://www.ecoportal.com) `APIv2`
+## Why this repo exists
+
+This gem holds the **base models for GraphQL** -- the `DoubleModel` / `CollectionModel`
+class-holder layer under `lib/ecoportal/api/common/content/` -- and it is
+`ecoportal-api-graphql`'s pinned runtime dependency: its `Common::GraphQL::Model`
+subclasses `Ecoportal::API::Common::Content::DoubleModel` directly.
+
+In the owner's words (2026-09-24):
+
+> "contains base models for GraphQL and must be documented, but excluding the api_v2
+> part... as that is deprecated... this gem will become a DoubleModel class holder gem
+> once we removed all the APIv2 stuff... and we will repurpose the repo :)"
+
+### What stays and matters
+
+The `Ecoportal::API::Common::Content` base-model infrastructure, under
+`lib/ecoportal/api/common/content/`:
+
+- `DoubleModel` -- the foundational two-layer (live doc + patch doc) model abstraction;
+  almost all V2 models, and `ecoportal-api-graphql`'s `Common::GraphQL::Model`, inherit
+  from it.
+- `CollectionModel` / `ArrayModel` -- ordered collections with upsert/delete/mutation
+  support.
+- `ClassHelpers`, `DocHelpers`, `ModelHelpers`, `IncluderHelpers` -- supporting mixins
+  for model construction.
+
+### Deprecated -- do not build on
+
+The `Ecoportal::API::V2` REST client namespace (`lib/ecoportal/api/v2/`: `page`,
+`pages`, `people`, `registers`, `s3`) is the APIv2 REST client. It is **deprecated** and
+being removed. Once it is gone, this gem becomes a pure `DoubleModel` class-holder gem
+and the repo will be repurposed (name/scope not yet decided by the owner). The owner
+flagged the same likely fate, tentatively, for `ecoportal-api` (its v0/v1 APIs are
+deprecated and due to retire soon) -- not yet ruled, and out of scope here.
+
+### Who uses it
+
+`ecoportal-api-graphql` depends on this gem for its base-model layer; `eco-helpers`
+(the team's central integrations library) sits downstream of both.
+
+```mermaid
+flowchart LR
+    A["ecoportal-api-v2<br/>Common::Content::DoubleModel"] --> B[ecoportal-api-graphql]
+    B --> C[eco-helpers]
+```
+*Source: `CLAUDE.md` dependency chain + owner ruling, 2026-09-24.*
+
+### Current state
+
+The APIv2 client removal and repo repurposing have not started; this section records
+intent so the owner does not need to re-explain it. See `TODO.md` (`DOC-ROADMAP-1`,
+`DOC-WHY-1`) for the tracked work.
 
 ## Installation
 

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

@@ -156,17 +156,42 @@ module Ecoportal
             [parts[..-2].join(", "), parts.last].join(" and ")
           end
 
-          # @return [Integer] total memory used by this process in KB
+          # @note Benchmarking must never crash the operation it wraps. When a memory
+          #   reading cannot be obtained -- most notably on modern Windows, where `wmic`
+          #   has been deprecated and removed (Win 11 24H2 / Server 2025) -- this returns
+          #   0 rather than raising. A failed backtick spawn yields an EMPTY string (not
+          #   nil), so a bare `unless wmem` never guarded it and `"".lines.first` was nil,
+          #   raising `NoMethodError: undefined method 'chop' for nil` on every wrapped call.
+          # @return [Float, Integer] total memory used by this process in KB, or 0 when unavailable
           def memory_usage
             if Gem.win_platform?
-              wmem = `wmic process where processid=#{Process.pid} get WorkingSetSize | findstr "[0-9]"`
-              return 0 unless wmem
-
-              wmem.lines.first.chop.strip.to_i / 1024.0
+              windows_memory_usage
             else
               `ps -o rss= -p #{Process.pid}`.to_i
             end
           end
+
+          # Windows working-set in KB. Tries `wmic` (legacy) then `Get-CimInstance`
+          # (its PowerShell successor); returns 0 if neither is available. Never raises.
+          # @return [Float, Integer]
+          def windows_memory_usage
+            bytes = windows_working_set_bytes
+            bytes.positive? ? bytes / 1024.0 : 0
+          end
+
+          # @return [Integer] process working-set size in bytes, or 0 when unavailable
+          def windows_working_set_bytes
+            wmem = `wmic process where processid=#{Process.pid} get WorkingSetSize 2>NUL | findstr "[0-9]"`
+            line = wmem.to_s.lines.first
+            return line.strip.to_i if line && !line.strip.empty?
+
+            filter = "ProcessId=#{Process.pid}"
+            cmd = "(Get-CimInstance Win32_Process -Filter '#{filter}').WorkingSetSize"
+            ps = `powershell -NoProfile -Command "#{cmd}" 2>NUL`
+            ps.to_s.strip.to_i
+          rescue StandardError
+            0
+          end
         end
       end
     end

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = '3.3.5'.freeze
+    GEM2_VERSION = '3.3.6'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 3.3.5
+  version: 3.3.6
 platform: ruby
 authors:
 - Oscar Segura