fortnox-api 1.0.0.rc5 → 1.0.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d9ec48a070723310f19f5c87fa23c64e3c92c0e3a04d9e000a6390f0d6e2f65
-  data.tar.gz: 7b95b905d0d908bee63b1130cede763d7a0697de0ef8d008e92b710580457674
+  metadata.gz: 1572886bdede9cde4d2de4970160e66e53b83f2dbd19f7cd5ab6165fe28a3c6b
+  data.tar.gz: f76deefb58d635d1fc1a0583fa96a398d47131fbdb9eb5b9e5454281eeac4686
 SHA512:
-  metadata.gz: fc85ca3a86615ab6d329091fcdf1ec565d03325bf2b98776602e32fa74e9c440081f9e8f37c4ee4baf759cdcdd29e339c0abe0eeaae777abe52ef162e382eced
-  data.tar.gz: 5b01d27ef5d0d7d61961378ada0ed97356c8e2f17412bc191b711c902cda18c754058bafd86ec3409bec895da890fdda425ca6274a097c51061835eb2ede4889
+  metadata.gz: a99b87e8f1d3ef0370b3258000c4a6fe65561305338a9c1d52590faacd0ecd851e6423973c8043857a3b9aadeb750c703e51cdda3362303dda628e953ecfd521
+  data.tar.gz: baa027a8995db227621be745ca00856c84d60f93f6772e21ca0f3c5666c94a96d0b85c992a3682b6688054eab68c4aca383936fc866e3d71057851a338617990

data/CHANGELOG.md

@@ -6,6 +6,42 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.0.0.rc7] - 2026-05-19
+
+### Changed
+
+- **Breaking** Minimum Ruby version raised to 3.2. Ruby 3.1 reached
+  end-of-life in March 2025 and is no longer supported or tested.
+- Upgraded `rest-easy` dependency to `~> 1.3.0`.
+
+### Fixed
+
+- Declare `base64` as a runtime dependency. It is `require`d by the gem
+  and used for OAuth credential encoding, but `base64` was removed from
+  Ruby's default gems in 3.4, so the gem failed to load on Ruby 3.4 with
+  `LoadError: cannot load such file -- base64`.
+- Saving a persisted record with no changes is again a no-op, matching
+  0.9. In that version `save` returned early for an unchanged persisted record
+  without issuing a request. The 1.0.0.rc1 rest-easy rewrite regressed
+  this: `save` on a record fetched via `find` re-sent every attribute
+  via a full-record `PUT`, which could clobber fields changed elsewhere
+  since it was loaded.
+
+## [1.0.0.rc6] - 2026-05-18
+
+### Added
+
+- HTTP wire logging via `Fortnox.configure { logger ... }`, with an
+  optional `log_bodies` toggle for request/response bodies. Standard
+  auth headers are redacted automatically. Inherited from `rest-easy`
+  1.2.
+
+### Changed
+
+- Upgraded `rest-easy` dependency to `~> 1.2.0`.
+
 ## [1.0.0.rc5] - 2026-05-15
 
 ### Changed
@@ -181,6 +217,10 @@ for the full list of breaking changes.
 For changes prior to the 1.0 rewrite, see the
 [0.x changelog](https://github.com/accodeing/fortnox-api/blob/v0.9.2/CHANGELOG.md).
 
+[Unreleased]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc7...HEAD
+[1.0.0.rc7]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc6...v1.0.0.rc7
+[1.0.0.rc6]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc5...v1.0.0.rc6
+[1.0.0.rc5]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc4...v1.0.0.rc5
 [1.0.0.rc4]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc3...v1.0.0.rc4
 [1.0.0.rc3]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc2...v1.0.0.rc3
 [1.0.0.rc2]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc1...v1.0.0.rc2

data/README.md

@@ -1,5 +1,7 @@
 # fortnox-api
 
+[![CI](https://github.com/accodeing/fortnox-api/actions/workflows/ci.yml/badge.svg)](https://github.com/accodeing/fortnox-api/actions/workflows/ci.yml)
+
 Ruby gem for Fortnox's version 3 REST API, built on
 [rest-easy](https://github.com/accodeing/rest-easy). If you need to integrate an existing or new Ruby
 or Rails app against Fortnox this gem will save you a lot of time.
@@ -10,13 +12,13 @@ Feel free to repay the community with some nice PRs of your own.
 
 Article, Customer, Invoice, Label, Order, Project, TermsOfPayment, Unit
 
-Adding more resources is quick and easy, see the
-[Contributing](#contributing) section.
+Adding more resources is quick and easy — see the
+[Developer readme](DEVELOPER_README.md).
 
 ## Status
 
 Version 1.0 is a complete rewrite, currently in release candidate
-(`1.0.0.rc5`). It is built on
+(`1.0.0.rc7`). It is built on
 [rest-easy](https://github.com/accodeing/rest-easy), replacing the old
 HTTParty + Data Mapper architecture with a single resource class per entity.
 Authorization uses the Fortnox client credentials flow.
@@ -71,7 +73,17 @@ The gem raises the following exceptions:
 - `Fortnox::RequestError` — 4xx/5xx responses from the Fortnox API. The
   exception message includes the API's `ErrorInformation.Message` and code
   when present (Fortnox is inconsistent about the key casing — the gem
-  normalises both). The full response is on `.response`.
+  normalises both). The full response is on `.response`, which exposes
+  the HTTP status code and body — match on `.status` rather than the
+  message text:
+
+  ```ruby
+  Fortnox::Customer.find(id)
+  rescue Fortnox::RequestError => e
+    return nil if e.response&.status == 404
+
+    raise
+  ```
 - `Fortnox::AttributeError` — base for attribute validation failures.
   - `Fortnox::ConstraintError` — an attribute value violates a type
     constraint (max size, format, etc.). Carries `.attribute_name` and
@@ -83,7 +95,7 @@ The gem raises the following exceptions:
 
 ## Requirements
 
-Ruby 3.1 or higher.
+Ruby 3.2 or higher.
 
 ### Installation
 
@@ -308,6 +320,19 @@ updated = customer.update(name: 'Acme Inc')
 Fortnox::Customer.save(updated)
 ```
 
+Updates are partial: only the attributes you pass to `.update` are sent to
+Fortnox. Attributes you don't touch are left as-is on the record (so a
+field changed elsewhere in the meantime is not clobbered). Note this is
+based on *which* attributes you pass, not a value comparison — passing an
+attribute equal to its stored value still sends it. Setting an attribute
+to `nil` is sent as an explicit clear:
+
+```ruby
+customer = Fortnox::Customer.find(1)
+updated = customer.update(phone1: nil)
+Fortnox::Customer.save(updated) # phone1 is now cleared in Fortnox
+```
+
 ### Searching
 
 ```ruby
@@ -322,6 +347,43 @@ Some resources support server-side filters:
 Fortnox::Invoice.only('unpaid')
 ```
 
+### Logging
+
+Set a `Logger`-compatible instance on the gem-level config to log every
+HTTP request and response. Faraday's built-in logger middleware is attached
+only when this setting is non-nil — no overhead when unset:
+
+```ruby
+require 'logger'
+
+Fortnox.configure do
+  logger Logger.new($stdout)
+end
+```
+
+By default only request/response lines and headers are logged, with the
+standard auth headers (`Authorization`, `Proxy-Authorization`, `Cookie`,
+`Set-Cookie`) filtered to `[FILTERED]`. To also log bodies, opt in:
+
+```ruby
+Fortnox.configure do
+  logger     Logger.new($stdout)
+  log_bodies true
+end
+```
+
+The Faraday connection is built once on the first request and cached for
+the life of the process, so changes to `logger` or `log_bodies` after that
+take effect only on restart.
+
+The `fortnox-setup` and `fortnox-update-env` executables talk directly to
+the OAuth token endpoint and are not routed through this logger.
+
+If you suspect the gem is silently dropping a field Fortnox added — or
+hitting some other schema-drift issue — please open an issue. There's a
+maintainer-only knob to surface those warnings; see the
+[Developer readme](DEVELOPER_README.md) for details.
+
 ### Gotchas
 
 See [docs/gotchas.md](docs/gotchas.md) for known quirks and edge cases in the

data/fortnox.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = ['fortnox-setup', 'fortnox-update-env']
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
+  spec.add_dependency 'base64'
   spec.add_dependency 'countries', '~> 7.1'
   spec.add_dependency 'dry-struct', '~> 1.5'
-  spec.add_dependency 'rest-easy', '~> 1.1.2'
+  spec.add_dependency 'rest-easy', '~> 1.3.0'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/fortnox/resource.rb

@@ -29,7 +29,9 @@ module Fortnox
         # Strip nils for new records — rely on Fortnox defaults
         data = data.compact
       elsif __changes__.any?
-        # Only send changed attributes on update, preserving explicit nils
+        # Send only the attributes passed to .update — field-level dirty
+        # tracking, not a value diff, so an attribute equal to its stored
+        # value is still sent, and an explicit nil reaches Fortnox as a clear.
         changed_api_names = __changes__.keys.filter_map do |model_name|
           self.class.all_attribute_definitions[model_name]&.api_name
         end
@@ -61,6 +63,12 @@ module Fortnox
       end
 
       def save(instance)
+        # A persisted record with no recorded changes has nothing to write.
+        # Without this short-circuit rest-easy would PUT the entire record
+        # back, re-sending every untouched attribute and risking clobbering
+        # changes made elsewhere since it was loaded.
+        return instance if !instance.meta.new? && instance.__changes__.empty?
+
         with_translated_errors { super }
       end
 

data/lib/fortnox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fortnox
-  VERSION = '1.0.0.rc5'
+  VERSION = '1.0.0.rc7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fortnox-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc5
+  version: 1.0.0.rc7
 platform: ruby
 authors:
 - Jonas Schubert Erlandsson
@@ -11,8 +11,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-15 00:00:00.000000000 Z
+date: 2026-05-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: countries
   requirement: !ruby/object:Gem::Requirement
@@ -47,14 +61,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
 description: Fortnox F3 REST API library, based on rest-easy.
 email:
 - info@accodeing.com
@@ -116,14 +130,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Fortnox F3 REST API library, based on rest-easy.