ecoportal-api 0.10.15 → 0.10.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9f1140595821ac9fa4c456761eead0dcfa575c2fe638ed54c0d42cd3b24c7c7
-  data.tar.gz: 62c241b84ab6552812a8e6b386aff188fd126201dbe6f5243f58882ccaa9572f
+  metadata.gz: fc93a32fe44f4a745aa6142c5963c3f6f80bd740bc2439728161f3287ea068b5
+  data.tar.gz: bd9a21e9631556d9eb0213d1460c6c3b088b4423568b9405c4a357e75b350d6c
 SHA512:
-  metadata.gz: e82ade621496ffefce230aae2b95c5a0a5a54808b5c604ffdc7b3329c5221051f1780e0084c8ab4a7f8179c17b7fd4f5afba5da10510d9fa2b6eb985984ed529
-  data.tar.gz: bc52feca422916fc79dcd4b5424c4fa6c04af03dea5496db8c9c1869926646ad0bbaffa3397ff7a560c51de47eee1d21853ca30b9e0692a73c7f1b801cbb18a1
+  metadata.gz: 881aa1ca8bb2dd35236f8da1f1b5a9a9a7b398c1e49eff09b3271d4ae89e72ea585177c1e03334adfc82b52b297b03f2f40cceb6c68085988448ecdd7e9146e3
+  data.tar.gz: 7b0cc3dd4730fe3b9177271a364b704c3b5b940e7a1202e8b89b94bcd24f6b9b8aa5662a83f31a40d173b9f1d1d048ffc57b38829727cd7582829090c0bd6e92

data/CHANGELOG.md

@@ -2,7 +2,34 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.10.16] - 2026-01-xx
+## [Unreleased]
+
+## [0.10.19] - 2026-09-30
+
+Security republish of 0.10.18 -- backwards-compatible, no code change: removes customer and
+internal identifiers from shipped comments and this changelog; includes the full-path
+packaging allowlist.
+
+### Fixed
+
+- **`spec.files` is now allowlisted by full path, not by root directory.** The `0.10.18`
+  fix replaced the old denylist with `f.start_with?('lib/', 'exe/')`, which still ships
+  anything dropped into `lib/` regardless of what it is -- a directory prefix asserts
+  nothing about extension. This repo has not leaked under that rule, but a sibling gem's
+  identically-shaped root allowlist shipped five `CLAUDE.md` files out of its `lib/` in a
+  later release. `spec.files` now also requires `.rb` for anything under `lib/`, closing
+  the same hole here pre-emptively, with `spec/packaging_spec.rb` added to pin the rule.
+
+## [0.10.18] - 2026-08-13
+
+### Fixed
+
+- Packaging-only republish with the allowlisted gemspec. `0.10.17` shipped internal repository
+  content (the repo's internal docs, `docs/self-docs/`, `docs/worklog.md`, `CLAUDE.md`,
+  `.claude/settings.json`) to rubygems.org via the old denylist `spec.files`. `0.10.18` is the
+  identical `lib/` code packaged clean; `0.10.17` will be yanked.
+
+## [0.10.17] - 2026-08-08
 
 ### Added
 
@@ -10,6 +37,19 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+- `WithRetry` never retried timeouts: `HTTP::TimeoutError` (and so `HTTP::ConnectTimeoutError`)
+  is a sibling of `HTTP::ConnectionError` in the `http` gem hierarchy, not a subclass — a
+  transient connect/read/write timeout propagated immediately and killed whole batches mid-loop
+  (live-confirmed on a customer integration, 2026-07-30). Added `HTTP::TimeoutError` to
+  `HANDLED_CONNECTION_ERRORS`; applies to all downstream gems that inherit this retry layer
+  (`ecoportal-api-v2`, `ecoportal-api-graphql`, `eco-helpers`).
+
+## [0.10.16] - 2026-06-05
+
+### Fixed
+
+- Non-applicable _Missing API key!_ message.
+
 ## [0.10.15] - 2026-05-26
 
 ### Changed

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

@@ -5,8 +5,14 @@ module Ecoportal
         module WithRetry
           DELAY_REQUEST_RETRY       = 5
           RETRY_ATTEMPTS            = 5
+          # HTTP::TimeoutError is a SIBLING of HTTP::ConnectionError in the http gem's
+          # hierarchy (ConnectTimeoutError < TimeoutError < Error), so it must be listed
+          # explicitly: without it a transient connect/read/write timeout is never retried
+          # and kills a whole batch mid-loop (live-confirmed on a customer integration,
+          # 2026-07-30 — see internal script repos' migration notes).
           HANDLED_CONNECTION_ERRORS = [
             HTTP::ConnectionError,
+            HTTP::TimeoutError,
             IOError
           ].freeze
 

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.19'.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.19
 platform: ruby
 authors:
 - Tapio Saarinen
@@ -200,20 +200,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".markdownlint.json"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- ecoportal-api.gemspec
 - lib/ecoportal/api.rb
 - lib/ecoportal/api/common.rb
 - lib/ecoportal/api/common/base_class.rb

data/.gitignore

@@ -1,25 +0,0 @@
-# it's a gem, ignore the lockfile
-Gemfile.lock
-
-# build artifacts
-*.gem
-/.bundle/
-/vendor/bundle
-/spec/reports/
-/tmp/
-/pkg/
-
-# docs
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-
-# rspec failure tracking
-.rspec_status
-scratch.rb
-
-#byebug
-.byebug_history
-
-.solargraph.yml

data/.markdownlint.json

@@ -1,4 +0,0 @@
-{
-  "MD013": false,
-  "MD024": false
-}

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,102 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.2
-  Exclude:
-    - 'config/routes.rb'
-  NewCops: enable
-
-Metrics/ClassLength:
-  Max: 500
-Metrics/ModuleLength:
-  Max: 300
-Metrics/MethodLength:
-  Max: 50
-Metrics/AbcSize:
-  Max: 30
-Metrics/ParameterLists:
-  Max: 5
-  CountKeywordArgs: false
-Metrics/BlockLength:
-  CountAsOne: ['array', 'heredoc', 'method_call']
-  Max: 50
-Metrics/CyclomaticComplexity:
-  Max: 30
-Metrics/PerceivedComplexity:
-  Max: 30
-
-Style/AccessorGrouping:
-  Enabled: false
-Style/ConditionalAssignment:
-  Enabled: false
-Style/BlockDelimiters:
-  BracesRequiredMethods: ['log']
-  AllowedPatterns: ['proc', 'new']
-Style/HashSyntax:
-  EnforcedShorthandSyntax: either
-  EnforcedStyle: no_mixed_keys
-Style/ArgumentsForwarding:
-  UseAnonymousForwarding: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
-Style/StringLiterals:
-  Enabled: false
-Style/StringLiteralsInInterpolation:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/CommentedKeyword:
-  Enabled: false
-Style/MultilineBlockChain:
-  Enabled: false
-Style/AndOr:
-  Enabled: false
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-Style/FetchEnvVar:
-  Enabled: false
-Style/RegexpLiteral:
-  EnforcedStyle: mixed
-  AllowInnerSlashes: true
-
-Layout/HashAlignment:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
-Layout/LeadingCommentSpace:
-  Enabled: false
-  AllowGemfileRubyComment: true
-Layout/ParameterAlignment:
-  Enabled: false
-Layout/MultilineMethodDefinitionBraceLayout:
-  EnforcedStyle: symmetrical
-Layout/LineLength:
-  Enabled: true
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: false
-Layout/SpaceInsideBlockBraces:
-  Enabled: false
-Layout/SpaceAroundOperators:
-  Enabled: false
-Layout/ExtraSpacing:
-  AllowForAlignment: true
-  AllowBeforeTrailingComments: true
-Layout/AccessModifierIndentation:
-  EnforcedStyle: indent
-Layout/DotPosition:
-  EnforcedStyle: trailing
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Layout/FirstHashElementIndentation:
-  Enabled: false
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-  CheckSymbols: false
-Naming/MethodParameterName:
-  AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io', 'to']
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-Naming/BlockForwarding:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-3.2.2

data/.yardopts

@@ -1,10 +0,0 @@
---readme README.md
---charset utf-8
---markup-provider=redcarpet
---markup=markdown
---no-private
---output-dir ./doc
-'lib/**/*.rb'
--
-CHANGELOG.md
-LICENSE

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in ecoportal-api.gemspec
-gemspec

data/Rakefile

@@ -1,38 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'yard'
-require 'redcarpet'
-
-desc "run the specs"
-RSpec::Core::RakeTask.new(:spec)
-
-desc "run rspec showing backtrace"
-RSpec::Core::RakeTask.new(:spec_trace) do |task|
-  task.rspec_opts = ['--backtrace']
-end
-task(rspec_trace: :spec_trace)
-
-desc "run rspec stopping on first fail, and show backtrace"
-RSpec::Core::RakeTask.new(:spec_fast) do |task|
-  task.rspec_opts = ['--fail-fast', '--backtrace']
-end
-task(rspec_fast: :spec_fast)
-
-desc "run rubocop diaplying cop names"
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--display-cop-names']
-end
-
-# default task name is yard
-desc "Yard: generate all the documentation"
-YARD::Rake::YardocTask.new(:doc) do |t|
-  #t.files = ['lib/**/*.rb']
-end
-
-desc "default task: runs rubocop and rspec"
-task :default do
-  Rake::Task[:rubocop].invoke
-ensure
-  Rake::Task[:spec].invoke
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "ecoportal/api"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "pry"
-Pry.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/ecoportal-api.gemspec

@@ -1,45 +0,0 @@
-# rubocop:disable Gemspec/DevelopmentDependencies
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'ecoportal/api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "ecoportal-api"
-  spec.version       = Ecoportal::API::VERSION
-  spec.authors       = ['Tapio Saarinen']
-  spec.email         = [
-    'tapio@ecoportal.co.nz',
-    'oscar@ecoportal.co.nz'
-  ]
-
-  spec.summary       = "A collection of helpers for interacting with the ecoPortal MS's various APIs"
-  spec.homepage      = "https://www.ecoportal.com"
-  spec.licenses      = %w[MIT]
-
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  spec.required_ruby_version = '>= 3.2.2'
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'pry',       '~> 0.14'
-  spec.add_development_dependency 'rake',      '>= 13.0.3', '< 14'
-  spec.add_development_dependency 'redcarpet', '>= 3.6.0',  '< 4'
-  spec.add_development_dependency 'rspec',     '>= 3.12.0', '< 4'
-  spec.add_development_dependency 'rubocop',   '~> 1'
-  spec.add_development_dependency 'rubocop-rake', '~> 0'
-  spec.add_development_dependency 'yard',         '~> 0.9'
-
-  spec.add_dependency 'dotenv',        '~> 3'
-  spec.add_dependency 'elastic-apm',   '>= 4.7',   "< 5"
-  spec.add_dependency 'http',          '~> 5.1',   "< 6"
-  spec.add_dependency 'rate_throttle_client', '~> 0.1'
-end
-
-# rubocop:enable Gemspec/DevelopmentDependencies