Repository navigation

Modernise the gem for 2.0 (Ruby 3.4, typed, retrying transport) - #53

Draft

mantas wants to merge 143 commits into

masterfrom

modernise-2.0

Commits on Aug 27, 2026
- build: start the 2.0 line on Ruby 3.4
  
  mantas
  and
  claude
  committed
  284696e
- refactor!: rewrite the client internals
  
  mantas
  and
  claude
  committed
  bb0b771
- feat: add RBS signatures and Steep type checking
  
  mantas
  and
  claude
  committed
  b4125cd
- ci: check types and specs on a Ruby matrix, release via trusted publishing
  
  mantas
  and
  claude
  committed
  0d8c059
- docs: document the 2.0 API and the upgrade path
  
  mantas
  and
  claude
  committed
  db0083b
- feat: pattern matching, derived clients and pattern-matched shape checks
  
  mantas
  and
  claude
  committed
  d776673
- ci: boot Zammad and drive it with this gem end to end
  
  mantas
  and
  claude
  committed
  9b116f1
- ci: fix the Zammad boot and unblock the Ruby head job
  
  mantas
  and
  claude
  committed
  fb6c683
- fix: detect an already-configured Zammad by authenticating
  
  mantas
  and
  claude
  committed
  229948b
- ci: drop Ruby head from the matrix
  
  mantas
  and
  claude
  committed
  9a6adc5
- ci: test only released Rubies
  
  mantas
  and
  claude
  committed
  d8466bf
- ci: test on Ruby 4.0 as well
  
  mantas
  and
  claude
  committed
  8401f89
- build: add Mantas Masalskis as a gem author
  
  mantas
  and
  claude
  committed
  907e94e
- docs: add runnable examples for the 2.0 API
  
  mantas
  and
  claude
  committed
  e01212e
- docs: add a pagination example
  
  mantas
  and
  claude
  committed
  b42c11a
- docs: add an example of driving pagination in batches by hand
  
  mantas
  and
  claude
  committed
  204b7e3
Commits on Sep 10, 2026
- fix: decode the reload response before replacing attributes
  
  mantas
  and
  claude
  committed
  2d60cb1
- fix: close two gaps in the credential-redaction contract
  
  mantas
  and
  claude
  committed
  48e3a8e
- fix: keep the original value as the baseline in changes
  
  mantas
  and
  claude
  committed
  8ce5029
- test: make two vacuous examples able to fail
  
  mantas
  and
  claude
  committed
  4ee31b2
- docs: harden the examples against hostile data
  
  mantas
  and
  claude
  committed
  dedfdd2
- feat!: chain collection pagination instead of passing keywords
  
  mantas
  and
  claude
  committed
  8a2e421
- docs: correct the documented type of ResponseError#response
  
  mantas
  and
  claude
  committed
  aa58220
- feat: reach any endpoint with client.get/post/put/delete
  
  mantas
  and
  claude
  committed
  ef4c354
- feat!: return false from save on a validation failure
  
  mantas
  and
  claude
  committed
  4f0e41c
- fix!: stop handing out the mutable attribute hash
  
  mantas
  and
  claude
  committed
  2cd4509
- feat: open the Faraday stack with adapter and middleware
  
  mantas
  and
  claude
  committed
  65a780d
- feat: assign and save a hash of attributes in one call
  
  mantas
  and
  claude
  committed
  8ed7ac4
- feat: add find_by, exists? and pluck
  
  mantas
  and
  claude
  committed
  7e3e3f0
- feat: add Client.from_env, #me and #version
  
  mantas
  and
  claude
  committed
  1c282a6
- feat: reach related records through record.related
  
  mantas
  and
  claude
  committed
  d0c2d12
- feat: enumerate a resource proxy without naming all
  
  mantas
  and
  claude
  committed
  cfc9ffd
- feat: ship a test kit for code that calls this client
  
  mantas
  and
  claude
  committed
  ce08783
- test: assert the raising save in the integration specs
  
  mantas
  and
  claude
  committed
  755a285
- docs: record this round's changes in the upgrade path
  
  mantas
  and
  claude
  committed
  91e60a6
- feat: compare records by the Zammad record they came from
  
  mantas
  and
  claude
  committed
  359574a
- feat: serialize a record as its attributes
  
  mantas
  and
  claude
  committed
  a389969
- feat: ask a collection for its size and whether it is empty
  
  mantas
  and
  claude
  committed
  db45a04
- docs: document how records compare and serialize
  
  mantas
  and
  claude
  committed
  205a941
- docs: document the collection size and empty? readers
  
  mantas
  and
  claude
  committed
  e1cf29d
- feat!: size the call that reads instead of chaining per
  
  mantas
  and
  claude
  committed
  70db1f0
Commits on Sep 11, 2026
- docs: rewrite the examples around the client's defaults
  
  mantas
  and
  claude
  committed
  63e00eb
- docs: ask for feedback on 2.0 while it can still change
  
  mantas
  and
  claude
  committed
  bd0a532
- fix: reject a logger that cannot log
  
  mantas
  and
  claude
  committed
  33400fb
- docs: sort the migration guide by what it costs to miss
  
  mantas
  and
  claude
  committed
  b66f5ea
- fix: stop reporting a working paginator as stuck
  
  mantas
  and
  claude
  committed
  d7eabdb
- fix: raise on a nil query value instead of dropping it
  
  mantas
  and
  claude
  committed
  bdc4ce5
- fix: record test-kit queries the way the transport sends them
  
  mantas
  and
  claude
  committed
  f30116b
- refactor: replace a record's state in one place
  
  mantas
  and
  claude
  committed
  c3a84a4
- fix: clear the previous error before a save attempt
  
  mantas
  and
  claude
  committed
  de960a4
- feat: tell a destroyed record apart from a live one
  
  mantas
  and
  claude
  committed
  a22a373
- fix: stop claiming a writer that read-only records refuse
  
  mantas
  and
  claude
  committed
  5fbd704
- refactor: record whether a response was JSON
  
  mantas
  and
  claude
  committed
  c635e9f
- perf: build the test kit's client once
  
  mantas
  and
  claude
  committed
  dbb9136
- perf: download the smoke attachment once
  
  mantas
  and
  claude
  committed
  fc6fddf
Commits on Sep 14, 2026
- fix: escape a record id instead of pasting it into the path
  
  mantas
  and
  claude
  committed
  ca4a7e3
- fix: redact credentials carried in the instance URL
  
  mantas
  and
  claude
  committed
  e34f300
- fix: send the From header as a string
  
  mantas
  and
  claude
  committed
  0e574e5
- fix: keep url credentials out of transport error messages
  
  mantas
  and
  claude
  committed
  5b0467b
- fix: map bare socket errors to the gem's transport errors
  
  mantas
  and
  claude
  committed
  8ed8a1e
- fix: keep a derived client on the transport it was built with
  
  mantas
  and
  claude
  committed
  cd0e245
- fix: drop the association memo when its foreign key changes
  
  mantas
  and
  claude
  committed
  3574567
- fix: check for a repeated page before yielding it
  
  mantas
  and
  claude
  committed
  7ebb30b
- fix: keep a query-scoped stub answering after the first request
  
  mantas
  and
  claude
  committed
  1836a1c
- fix: reject a search term passed to where
  
  mantas
  and
  claude
  committed
  937f7c0
- fix!: reject filters an index endpoint cannot honour
  
  mantas
  and
  claude
  committed
  d0a58a7
- fix: escape every record id that reaches a path
  
  mantas
  and
  claude
  committed
  203e644
- fix: redact a credential that carries an unencoded @
  
  mantas
  and
  claude
  committed
  a4a0a6a
- fix: keep a derived transport on the class it was built from
  
  mantas
  and
  claude
  committed
  0b6367e
- fix: report the status a locally raised error is the name for
  
  mantas
  and
  claude
  committed
  6c849fd
- fix: send nothing when a save has nothing to send
  
  mantas
  and
  claude
  committed
  1a793f6
- fix!: raise an unstubbed request outside the gem's error hierarchy
  
  mantas
  and
  claude
  committed
  998e13c
- fix: answer an array-valued query stub
  
  mantas
  and
  claude
  committed
  7a9ea39
- perf: bound the search find_by scans
  
  mantas
  and
  claude
  committed
  f3b1045
- perf: hold one page at a time while walking
  
  mantas
  and
  claude
  committed
  1125896
- fix: walk to the end of an endpoint that pages smaller than the cap
  
  mantas
  and
  claude
  committed
  6098714
- fix!: refuse to re-size a collection already limited to a page
  
  mantas
  and
  claude
  committed
  c9be490
- test: say what is missing when a lifecycle spec runs alone
  
  mantas
  and
  claude
  committed
  80da816
- docs: record this round's fixes
  
  mantas
  and
  claude
  committed
  1dbcb5e
- fix!: refuse a record id that is a dot segment
  
  mantas
  and
  claude
  committed
  1c6d40e
- fix!: refuse a page larger than the endpoint serves
  
  mantas
  and
  claude
  committed
  809f826
- fix: search find_by on the values Zammad can actually match
  
  mantas
  and
  claude
  committed
  b83393b
- fix: refuse a search Zammad routes no endpoint for
  
  mantas
  and
  claude
  committed
  18b660c
- fix: send a nested query parameter as a structure
  
  mantas
  and
  claude
  committed
  89e8ee6
- fix: keep Faraday out of the signatures the gem publishes
  
  mantas
  and
  claude
  committed
  2c8d24c
- fix: retry the socket failures it says it retries
  
  mantas
  and
  claude
  committed
  df85ef8
- fix: read a string key in where as the parameter it names
  
  mantas
  and
  claude
  committed
  f37ac76
- fix: raise ParseError for a list that is not made of records
  
  mantas
  and
  claude
  committed
  cfe48da
- fix: drop the state a destroyed record can no longer act on
  
  mantas
  and
  claude
  committed
  b651449
- fix: redact only an @ that actually marks a credential
  
  mantas
  and
  claude
  committed
  bde5122
- refactor: hold the member-path rule in one place
  
  mantas
  and
  claude
  committed
  5911a8e
- perf: build the test kit's client without a Faraday stack
  
  mantas
  and
  claude
  committed
  c41df79
- test: register the integration metadata in one block
  
  mantas
  and
  claude
  committed
  264af9f
- docs: record this round's fixes
  
  mantas
  and
  claude
  committed
  a351a42
Commits on Sep 15, 2026
- refactor: derive the me path from the user resource
  
  mantas
  and
  claude
  committed
  2053ba2
- refactor: drop the transport seam nothing uses
  
  mantas
  and
  claude
  committed
  c8bdbce
- fix: tighten what Config validates and what it redacts
  
  mantas
  and
  claude
  committed
  0f71247
- fix: report every failed connection build as a config error
  
  mantas
  and
  claude
  committed
  7d99d94
- fix: redact the credential key spellings the log let through
  
  mantas
  and
  claude
  committed
  2eb07d4
- fix: keep a destroyed record destroyed
  
  mantas
  and
  claude
  committed
  8d2bd28
- fix: refuse a fetch arity that Hash#fetch refuses
  
  mantas
  and
  claude
  committed
  e4f46fd
- fix: quote a find_by value that carries search syntax
  
  mantas
  and
  claude
  committed
  26a0c57
- perf: stop a walk on the total the endpoint reports
  
  mantas
  and
  claude
  committed
  aabe7b3
- fix: record a request body by value in the test kit
  
  mantas
  and
  claude
  committed
  54521f3
- fix: read the test kit's request count under its monitor
  
  mantas
  and
  claude
  committed
  82f864a
- docs: record this review round's fixes
  
  mantas
  and
  claude
  committed
  9ec5ff9
- fix: stop a walk only on a total the page corroborates
  
  mantas
  and
  claude
  committed
  ae1d56f
- fix: mark a record created before decoding its body
  
  mantas
  and
  claude
  committed
  3075df0
- fix: declare what a resource's endpoint does, and inherit it
  
  mantas
  and
  claude
  committed
  1782c23
- fix: check the options that escaped the config contract
  
  mantas
  and
  claude
  committed
  b312ce5
- fix: keep a TLS error and a proxy password in contract
  
  mantas
  and
  claude
  committed
  fa50d70
- refactor: hold the deep-copy walk in one place
  
  mantas
  and
  claude
  committed
  e2638ec
- fix: page and scope the test kit like a real endpoint
  
  mantas
  and
  claude
  committed
  8bcbd93
- perf: hand out one resource proxy per resource
  
  mantas
  and
  claude
  committed
  7f29d1a
- docs: record this review round's fixes
  
  mantas
  and
  claude
  committed
  3d36ea8
- fix: refuse a record the create response left without an id
  
  mantas
  and
  claude
  committed
  f0e0c18
- fix: send a write of an attribute the record does not carry
  
  mantas
  and
  claude
  committed
  ac9516a
- fix: refuse an update on a destroyed record before it stages
  
  mantas
  and
  claude
  committed
  a25feb4
- fix: refuse an article on a ticket that has no id
  
  mantas
  and
  claude
  committed
  03ea768
- fix: refuse a has_many list the endpoint served part of
  
  mantas
  and
  claude
  committed
  09ce522
- fix: keep a client immutable once it is built
  
  mantas
  and
  claude
  committed
  423d9a5
- test: report an unreachable Zammad as a setup failure
  
  mantas
  and
  claude
  committed
  5d23543
- refactor: drop a header spelling a response cannot carry
  
  mantas
  and
  claude
  committed
  53cca0d
- refactor: forward the collection shorthands by name
  
  mantas
  and
  claude
  committed
  e23c647
- docs: size the paging examples the way the endpoints do
  
  mantas
  and
  claude
  committed
  21a882a
- docs: record this review round's fixes
  
  mantas
  and
  claude
  committed
  590a1ba
- fix: search a find_by value the way both backends read it
  
  mantas
  and
  claude
  committed
  b1195a5
- fix: search find_by on one value, not all of them joined
  
  mantas
  and
  claude
  committed
  62d45aa
- fix: corroborate a total against the page an endpoint serves
  
  mantas
  and
  claude
  committed
  2047154
- fix: refuse a destroyed record's readers instead of dropping a memo
  
  mantas
  and
  claude
  committed
  bccb626
- docs: say why the deep-copy walk is one walk
  
  mantas
  and
  claude
  committed
  4edeb4c
- fix: give each stubbed response its own frozen headers
  
  mantas
  and
  claude
  committed
  703e4df
- fix: redact a config value the error quoted rather than interpolated
  
  mantas
  and
  claude
  committed
  7b9fb52
- ci: check the published signatures before publishing the gem
  
  mantas
  and
  claude
  committed
  0d7dce9
- fix: refuse a Numeric that cannot be compared
  
  mantas
  and
  claude
  committed
  61d30b4
- fix: say when a block supersedes the fetch default
  
  mantas
  and
  claude
  committed
  c71cf38
- refactor: drop the string-key branches no decode path reaches
  
  mantas
  and
  claude
  committed
  8702d57
- fix: populate the class-level memos before a caller can race for them
  
  mantas
  and
  claude
  committed
  1b75eb1
Commits on Sep 16, 2026
- fix: close what five rounds of review turned up
  
  mantas
  and
  claude
  committed
  fa258aa
Commits on Sep 17, 2026
- fix: close what three more rounds of review turned up
  
  mantas
  and
  claude
  committed
  3178b67
Commits on Sep 25, 2026
- refactor: call the page size of page per_page, not of
  
  mantas
  and
  claude
  committed
  3261cbd
- bump ruby-version
  mantas
  committed
  ed8ab3f
- fixes ci
  mantas
  committed
  520683d

Commits

Commits on Aug 27, 2026

Commits on Sep 10, 2026

Commits on Sep 11, 2026

Commits on Sep 14, 2026

Commits on Sep 15, 2026

Commits on Sep 16, 2026