ecoportal-api 0.10.14 → 0.10.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c60da1fe6f9c6176e85d65b5283b75b54af11f5e977788eddd7fde57bba953
-  data.tar.gz: d5bf03e2eaec6dad5778f8a0ce693b9a29d9786331e5517facab0e28941abccd
+  metadata.gz: f6998cdda6bc8a40de4a368ab81d522cd9828cd8dbbb559a59948976e3f57dcb
+  data.tar.gz: ba86db2250fad20b429d1f5afa26a08b064e0eeb14ea90f096dceaf4973d362e
 SHA512:
-  metadata.gz: b5d0dfc99e97e97b857a1f424b80e4211811ed7ef6250300a9cd8614a39d5281fef6661519d915a29980a8347368b50bcf7961cfb5a676b6b6d196f16a48cafb
-  data.tar.gz: 1ca5a7a3ffc81adc74679524ad715d4833e665867041e7c2c25eace44e98d9612a330dad433e0db4c9e85d95e5fbc5209fc5c46705c1510e91280a011a122c11
+  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.15] - 2025-08-xx
+## [0.10.17] - 2026-06-xx
 
 ### Added
 
@@ -10,6 +10,22 @@ 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
+
+- `Client.new` keep `@version` var when parameter not specified.
+
 ## [0.10.14] - 2025-08-15
 
 ### Added

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

@@ -31,7 +31,7 @@ module Ecoportal
         MAIN_END_POINT = 'api'.freeze
 
         attr_accessor :logger
-        attr_reader :host
+        attr_reader :host, :version
 
         # @note the `api_key` will be automatically added as parameter `X-ApiKey` in the header of the http requests.
         # @param api_key [String] the key version to stablish the api connection.
@@ -40,8 +40,9 @@ module Ecoportal
         # @param logger [Logger] an object with `Logger` interface to generate logs.
         # @param deep_logging [Boolean] whether or not batch responses should be logged
         # @return [Client] an object that holds the configuration of the api connection.
-        def initialize(api_key:, version: nil, host: DEFAULT_HOST, logger: nil, deep_logging: false)
-          @version      = version
+        def initialize(api_key:, version: :unused, host: DEFAULT_HOST, logger: nil, deep_logging: false)
+          version       = nil     if version == :unused
+          @version      = version unless version.nil?
           @api_key      = api_key
           @logger       = logger
           @host         = host
@@ -55,12 +56,14 @@ module Ecoportal
 
           if deep_logging?
             log(:debug) {
-              "#{version} client initialized pointing at #{host}"
+              "#{self.version} client initialized pointing at #{host}"
             }
           end
 
           return unless api_key.nil? || api_key.match(/\A\W*\z/)
-          return unless version
+          return unless self.version
+          return if self.version == 'graphql'
+          return if self.version == 'http'
 
           log(:error) { 'Api-key missing!' }
         end
@@ -68,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|
@@ -86,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|
@@ -106,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|
@@ -117,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|
@@ -131,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
@@ -150,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)
@@ -204,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.14'.freeze
+    VERSION = '0.10.16'.freeze
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.10.14
+  version: 0.10.16
 platform: ruby
 authors:
 - Tapio Saarinen
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -194,7 +193,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description:
 email:
 - tapio@ecoportal.co.nz
 - oscar@ecoportal.co.nz
@@ -209,6 +207,7 @@ files:
 - ".ruby-version"
 - ".yardopts"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - LICENSE
 - README.md
@@ -274,7 +273,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -289,8 +287,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 various APIs
 test_files: []