ecoportal-api 0.10.15 → 0.10.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f1140595821ac9fa4c456761eead0dcfa575c2fe638ed54c0d42cd3b24c7c7
-  data.tar.gz: 62c241b84ab6552812a8e6b386aff188fd126201dbe6f5243f58882ccaa9572f
+  metadata.gz: f6998cdda6bc8a40de4a368ab81d522cd9828cd8dbbb559a59948976e3f57dcb
+  data.tar.gz: ba86db2250fad20b429d1f5afa26a08b064e0eeb14ea90f096dceaf4973d362e
 SHA512:
-  metadata.gz: e82ade621496ffefce230aae2b95c5a0a5a54808b5c604ffdc7b3329c5221051f1780e0084c8ab4a7f8179c17b7fd4f5afba5da10510d9fa2b6eb985984ed529
-  data.tar.gz: bc52feca422916fc79dcd4b5424c4fa6c04af03dea5496db8c9c1869926646ad0bbaffa3397ff7a560c51de47eee1d21853ca30b9e0692a73c7f1b801cbb18a1
+  metadata.gz: fb91f3d928853691c913efbd17f0db1bda9343c44b1449275864fc16e053ef0d3cd1f14fd64e90625fc3ea991a81494c2a7315d318666184c14dd3acd51344f4
+  data.tar.gz: 57f8fc55f1d55f1733fe98720477739d72b063bae1f4a16665132e20a5560192275b5815e25d99097400fd2f5de4c7914a35823a8e5168ea34187e4e5d9ae98c

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.10.16] - 2026-01-xx
+## [0.10.17] - 2026-06-xx
 
 ### Added
 
@@ -10,6 +10,16 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [0.10.16] - 2026-06-05
+
+### Added
+
+### Changed
+
+### Fixed
+
+- Non-applicable _Missing API key!_ message.
+
 ## [0.10.15] - 2026-05-26
 
 ### Changed

data/CLAUDE.md

@@ -0,0 +1,71 @@
+# CLAUDE.md — ecoportal-api
+
+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` is the **foundational REST API gem** in the EcoPortal Ruby stack. It provides authentication, HTTP client infrastructure, org context, and the `Ecoportal::API::Common` namespace that all downstream gems build on.
+
+**Position in chain:**
+```
+ecoportal-api          ← THIS REPO
+      ↓
+ecoportal-api-v2
+      ↓
+ecoportal-api-graphql
+      ↓
+eco-helpers
+```
+
+**Remote:** https://gitlab.ecoportal.co.nz/ecoportal/ecoportal-api.git
+
+---
+
+## Key Folder Layout
+
+```
+lib/ecoportal/api/
+  common/              Shared infrastructure (client, logging, response, batch, hash_diff)
+    client/            HTTP client — rate throttling, retries, timeouts, APM, error handling
+  errors/              Shared error classes
+  internal/            Internal API resources (people, permissions, schema, login providers)
+  v1/                  REST API v1 resources (people, schema, jobs)
+  logger.rb            Shared logger
+  version.rb           Gem version
+```
+
+---
+
+## Namespace
+
+`Ecoportal::API` — specifically:
+- `Ecoportal::API::Common` — shared base classes (consumed by `ecoportal-api-v2` and `ecoportal-api-graphql`)
+- `Ecoportal::API::Internal` — internal API endpoints
+- `Ecoportal::API::V1` — v1 REST endpoints
+
+---
+
+## Key Concerns
+
+- `Common::Client` — base HTTP client with rate throttling, retry logic, timeouts, and APM integration. All downstream clients inherit or wrap this.
+- `Common::BaseModel` / `Common::BaseClass` — base model classes. `ecoportal-api-v2` extends these heavily.
+- Changes to `Common::` affect **all downstream gems** — treat as a public API.
+
+---
+
+## Backwards Compatibility
+
+Changes to `Ecoportal::API::Common::*` propagate to `ecoportal-api-v2`, `ecoportal-api-graphql`, and `eco-helpers`. Any breaking change must be coordinated across the chain.
+
+---
+
+## Running Tests
+
+```bash
+bundle install
+bundle exec rspec
+```

data/lib/ecoportal/api/common/client.rb

@@ -62,6 +62,8 @@ module Ecoportal
 
           return unless api_key.nil? || api_key.match(/\A\W*\z/)
           return unless self.version
+          return if self.version == 'graphql'
+          return if self.version == 'http'
 
           log(:error) { 'Api-key missing!' }
         end
@@ -69,11 +71,11 @@ module Ecoportal
         # Sends an http `GET` request against the api version using `path` to complete the base url,
         # and adding the key_value pairs of `params` in the http _header_.
         # @param path [String] the tail that completes the url of the request.
-        # @param params [Hash] the header paramters of the http request (not including the api key).
+        # @param params [Hash] the header parameters of the http request (not including the api key).
         # @option params [String] :page the current page we are requesting with given the `:per_page` offset.
         # @option params [String] :per_page the offset or the number of entries you get per request.
         # @option params [String] :q some text to search. Omit this parameter to target all the entries.
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def get(path, params: {})
           instrument('GET', path, params) do
             request do |http|
@@ -87,9 +89,9 @@ module Ecoportal
         # @note it automatically adds the http header param `Content-Type` as `application/json`
         # @param path [String] the tail that completes the url of the request.
         # @param data [String] the body of the query in json format.
-        # @param params [Hash] the header paramters of the http request (not including the api key).
+        # @param params [Hash] the header parameters of the http request (not including the api key).
         # @option params [String] URL params; will depend on he API being used.
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def post(path, data:, params: {})
           instrument('POST', path, params) do
             request do |http|
@@ -107,7 +109,7 @@ module Ecoportal
         # @note it automatically adds the http header param `Content-Type` as `application/json`
         # @param path [String] the tail that completes the url of the request.
         # @param data [String] the body of the query in json format.
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def patch(path, data:)
           instrument('PATCH', path, data) do
             request do |http|
@@ -118,7 +120,7 @@ module Ecoportal
 
         # Sends an http `DELETE` request against the api version using `path` to complete the base url.
         # @param path [String] the tail that completes the url of the request.
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def delete(path)
           instrument('DELETE', path) do
             request do |http|
@@ -132,14 +134,14 @@ module Ecoportal
         # @yield [http] launch specific http request.
         # @yieldparam http [HTTP] the http connection.
         # @yieldreturn [Common::Response] the basic custom response object.
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def request
           wrap_response yield(base_request)
         end
 
         # Wrap with basic custom object of the gem for responses.
         # @param response [HTTP::Response]
-        # @return [Common::Reponse] the basic custom response object.
+        # @return [Common::Response] the basic custom response object.
         def wrap_response(response)
           Ecoportal::API::Common::Response.new(response)
         end
@@ -151,7 +153,7 @@ module Ecoportal
         def base_request
           @base_request ||=
             case @version
-            when 'v2'
+            when 'v2', 'v3'
               HTTP.headers('X-ECOPORTAL-API-KEY' => api_key).accept(:json)
             else
               HTTP.headers('X-ApiKey' => api_key).accept(:json)
@@ -205,7 +207,7 @@ module Ecoportal
         #   log(:info) {'General information on what's going on'}
         #   log(:warn) {'This is a warning that something is likely to have gone amiss'}
         #   log(:error) {'Something went wrong'}
-        #   log(:fatal) {'An unrecoverable error has happend'}
+        #   log(:fatal) {'An unrecoverable error has happened'}
         # @param level [Symbol] the level that the message should be logged.
         # @yield [] generates the message.
         # @yieldreturn [String] the generated message.

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = '0.10.15'.freeze
+    VERSION = '0.10.16'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.15
+  version: 0.10.16
 platform: ruby
 authors:
 - Tapio Saarinen
@@ -207,6 +207,7 @@ files:
 - ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE
 - README.md