fortnox-api 0.9.2 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0605a1ea41ed7a7322a560e9e27255b60df149c486f875bd968354adbf1b826
-  data.tar.gz: b66ce8b6a31fa9ef28b5ae0a99e8531df1027253bde63338291c875bfaa15367
+  metadata.gz: 355563e337538c18df2917f19aee3e0d91a1f7763fbb3a01bad441bd3956f496
+  data.tar.gz: 4898bf90e631edd152c4c44b1fda68c2284cc2f24e38cd712a8a0057e27a6c40
 SHA512:
-  metadata.gz: 347bab9a453b33bd19d396d2b142fb8e133ee9615529f307fbe2ecc47f79e37d907731940267da551481c62ae8a17bd0df8b83de8c955c5cdbed8ba2e0517130
-  data.tar.gz: d5ea5952ecc427a24ba0264197ed5cfa364119f37921a742304a9aec41d55b13d24ff379001af4087ce5d3235456413ade7b2a5d51ad733040de13710a3b5d6e
+  metadata.gz: 5acaea5d925b3c8f60f817ff39d167f0e078e5ec32f7f86568cf853935ac4955431dd037c81b561ec2be081e09d46b1dbae9b3c3d204bbfbcfd2615bc4d19d50
+  data.tar.gz: 14ddc8dbdc2da42f8c09d6bb5ee11c47ceb6fa8faba6cd51da7c97d1fc4bbf4c3adcba67e2bbc831c2783a2841d4f292b3f358d608e31d84cae8e25222fa711b

data/CHANGELOG.md

@@ -6,113 +6,138 @@ 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).
 
-## [0.9.2]
-
-### Fixed
-
-- Email validation now accepts internationalized domain names (IDN),
-  e.g. `user@teståäö.se` (RFC 6530)
-
-## [0.9.1]
-
-### Fixed
-- Restored undocumented support for string keys in model attributes,
-  which was inadvertently removed in `v0.9.0`.
-- Set correct lower limit for `Article#quantity_in_stock`
-
-## [0.9.0]
+## [1.0.0.rc2] - 2026-05-05
 
 ### Added
 
-- Script in `bin/get_tokens` to issue access and refresh tokens
-- Script in `bin/renew_tokens` (convenience feature for developers)
-- `Fortnox::API::Repository::Authentication.renew_token`, used for token renewal
+- Per-resource OAuth scope declarations via the `scope` setting in
+  `Fortnox::Resource`, plus `Fortnox.scopes` returning a
+  `{ scope_string => [resource_classes] }` mapping derived from the
+  registered resources.
 
 ### Changed
 
-- **Breaking** The auth process is rewritten to support
-  [the new auth flow](https://developer.fortnox.se/general/authentication/) that
-  Fortnox has implemented. You also need to set the access token explicitly with
-  `Fortnox::API.access_token ' your token'`. See [README](README.md) for more
-  instructions.
-
-### Fixed
-
-- Missing runtime dependencies `dry-configurable` and `dry-container` is added.
-  Those were indirect dependencies before via other dry libs, but we use them
-  explicitly in the gem, so they should be included as real dependencies. Also,
-  newer versions of these gems did actually break the gem.
-- Not trying to update resource if diff against parent is an empty object
-  (#238).
-
-### Removed
-
-- **Breaking** Drops support for Ruby 2.6 since it's reached end of life
-- Token rotation is removed since Fortnox counts rate limit on tenant and client
-  id. Before, you could get around this by using multiple access tokens. That's
-  not possible anymore, so token rotation is simply removed.
-- **Breaking** Removes `client_id` and `client_secret` from configuration. These
-  value are only used for token renewal, so they are now arguments to the
-  `Authentication` repository. This means there are no longer any required
-  configuration to set in `Fortnox::API.configuration`.
-
-## [0.8.0]
+- `fortnox-setup` lists the OAuth scopes covered by the gem's resources
+  and accepts a space-separated selection or `all`, replacing the
+  prescriptive default that didn't reflect the actual resource set. Other
+  Fortnox scopes (`salary`, `bookkeeping`, etc.) can still be entered
+  manually.
+- `TermsOfPayment.code` is now `Sized::String[25]` and required, matching
+  Fortnox API documentation. The rest-easy rewrite for rc1 briefly lost
+  the required flag.
+- `Unit.code` is now `Sized::String[20]` and required, matching Fortnox
+  API documentation. The rest-easy rewrite for rc1 briefly lost the
+  required flag.
+- `Unit.description` is now `Sized::String[100]` and required, matching
+  Fortnox API documentation. In 0.x and rc1 this was nullable client-side,
+  but the Fortnox API rejected unset descriptions anyway.
+
+## [1.0.0.rc1] - 2026-05-04
+
+Version 1.0 is a complete rewrite of the gem and is **not** a drop-in
+replacement for the 0.x series. Almost every public entry point has changed.
+See [MIGRATING_TO_1.0.md](MIGRATING_TO_1.0.md) for a guided upgrade and the sections below
+for the full list of breaking changes.
 
 ### Changed
 
-- `Fortnox::API::CURRENT_HOUSEWORK_TYPES` is now renamed to `HOUSEWORK_TYPES`
-  and is instead a Hash with keys for the different categories of types. It also
-  includes legacy types, which means `Fortnox::API::LEGACY_HOUSEWORK_TYPES` is
-  removed.
-
-### Removed
-
-- Drops support for Ruby < `2.5.0` since they are deprecated
-
-## [0.7.2]
-
-### Fixed
-
-- Invalid validation for Customer's account number attribute
-
-## [0.7.1]
-
-### Fixed
-
-- Invalid validation for Customer's country attributes
-
-## [0.7.0]
+- **Breaking** Complete rewrite based on [rest-easy](https://github.com/accodeing/rest-easy),
+  replacing the HTTParty + Data Mapper architecture with a single resource
+  class per entity. The top-level namespace moves from `Fortnox::API` to
+  `Fortnox` (e.g. `Fortnox::API::Repository::Customer` →
+  `Fortnox::Customer`).
+- **Breaking** Minimum Ruby version raised to 3.1.
+- **Breaking** Authorization now uses the new Fortnox client credentials flow.
+  Refresh tokens are no longer needed, nor supported. A tenant ID is now required;
+  obtain one with the new `fortnox-setup` executable.
+- **Breaking** Environment variables lose the `_API_` infix:
+  `FORTNOX_API_CLIENT_ID` → `FORTNOX_CLIENT_ID`, `FORTNOX_API_CLIENT_SECRET`
+  → `FORTNOX_CLIENT_SECRET`, `FORTNOX_API_ACCESS_TOKEN` →
+  `FORTNOX_ACCESS_TOKEN`. `FORTNOX_API_REFRESH_TOKEN`,
+  `FORTNOX_API_REDIRECT_URI`, and `FORTNOX_API_SCOPES` are removed —
+  refresh tokens are no longer supported, and the redirect URI and scopes
+  are now selected interactively in `fortnox-setup`. The new
+  `FORTNOX_TENANT_ID` is required for the client credentials flow.
+- **Breaking** `Fortnox.request_access_token` replaces
+  `Fortnox::API::Repository::Authentication` for token management.
+- **Breaking** Configuration moves from `Fortnox::API.configuration` to
+  module-level setters such as `Fortnox.access_token=`.
+- **Breaking** Country attributes on documents (`country_code`,
+  `delivery_country`) now only accept ISO alpha-2 codes (e.g. `'NO'`,
+  `'SE'`). The old gem also accepted country names like `'Norge'` or
+  `'Norway'`.
+- **Breaking** Exception classes are renamed and consolidated.
+  0.x → 1.0 mapping:
+  - `Fortnox::API::Exception` → `Fortnox::Error`. Still the base class
+    for everything below; rescue it to catch any gem-raised error.
+  - `Fortnox::API::AttributeError` → `Fortnox::AttributeError`.
+  - `Fortnox::API::RemoteServerError` → `Fortnox::RequestError`, now
+    carries the response object as `.response`.
+  - `Fortnox::API::MissingAttributeError` → `Fortnox::MissingAttributeError`,
+    now carries `.attribute_name`.
+  - `Fortnox::API::MissingAccessToken` → `Fortnox::MissingAccessToken`.
+    In 0.x this was raised eagerly when constructing a repository; in 1.0
+    it is raised lazily, on the first API call from a thread that has not
+    set a token.
+  - `Fortnox::API::MissingConfiguration` is removed — the configurable
+    surface is much smaller in 1.0 and the previous misconfigurations
+    are no longer expressible.
+  - *new* `Fortnox::ConstraintError < Fortnox::AttributeError` — raised
+    when an attribute value violates a type constraint. Carries
+    `.attribute_name` and `.value`.
+- Nested structs (EDIInformation, EmailInformation, InvoiceRow, etc.) are
+  now plain `Dry::Struct` subclasses; key-mapping and serialisation logic
+  lives in dedicated classes under `Fortnox::Mappers`.
+- **Breaking** Collection-returning methods (`.all`, `.search`, `.only`,
+  and `.find(hash)`) now return a `Fortnox::Collection` instead of a plain
+  `Array`. Collection is `Enumerable` and delegates `each`, `first`, `last`,
+  `size`, `length`, `empty?`, `[]`, and `to_a`, so most existing Array
+  usage works unchanged. Code that explicitly checks `is_a?(Array)` or
+  compares with `==` against an Array literal needs updating.
+- **Breaking** `Invoice.accounting_method` is now an enum accepting only
+  `''`, `'ACCRUAL'`, or `'CASH'`. In 0.x this was a free-form
+  `Nullable::String` so any value passed client-side.
+- **Breaking** `Invoice.invoice_type` is now an enum accepting only `''`,
+  `'INVOICE'`, `'AGREEMENTINVOICE'`, `'INTRESTINVOICE'`, `'SUMMARYINVOICE'`,
+  or `'CASHINVOICE'`. In 0.x this was a free-form `Nullable::String`.
+- `your_order_number` on Invoice and Order (inherited from Document) max
+  length raised from 30 to 75 characters to match the current Fortnox API.
+- Article dimension fields (`depth`, `height`, `weight`, `width`) max raised
+  from 99,999,999 to 999,999,999 to match the documented Fortnox range.
 
 ### Added
 
-- Adds build test for Ruby `2.6.0`, `2.6.3` and `2.7.0-preview`.
-
-### Removed
-
-- Drops support for Ruby < `2.4.0` since they are deprecated
+- `Fortnox.request_access_token` for client credentials token requests
+- `fortnox-setup` executable for initial OAuth authorization and tenant ID
+  discovery
+- `fortnox-update-env` executable for refreshing access tokens in env files
+- `Fortnox::Struct` base class for nested models, extending `Dry::Struct`
+  with a `:read_only` attribute flag for computed/server-side fields
+- `Fortnox::Collection` class wrapping the result of multi-record API calls
+  and exposing pagination metadata via `.total`, `.pages`, and `.current_page`
+- `instance.meta.partial?` flag — true for instances parsed from a
+  collection response (which Fortnox returns with fewer attributes than
+  single-resource fetches), false for instances from `find(id)`
+- Label resource
 
 ### Fixed
 
-- Country attribute for `Invoice` and `Order` is now validated correctly.
-- Fixes deprecation warnings
-- Unlocks pinned `HTTParty` version
-- Invalid email validation
-
-## [0.6.3]
-
-### Changed
-
-- Pins `dry-types` to `< 0.13.0` due to breaking changes
-
-### Fixed
-
-- Model attribute `url` is no longer null
-
-[0.9.2]: https://github.com/accodeing/fortnox-api/compare/v0.9.1...v0.9.2
-[0.9.1]: https://github.com/accodeing/fortnox-api/compare/v0.9.0...v0.9.1
-[0.9.0]: https://github.com/accodeing/fortnox-api/compare/v0.8.0...v0.9.0
-[0.8.0]: https://github.com/accodeing/fortnox-api/compare/v0.7.2...v0.8.0
-[0.7.2]: https://github.com/accodeing/fortnox-api/compare/v0.7.1...v0.7.2
-[0.7.1]: https://github.com/accodeing/fortnox-api/compare/v0.7.0...v0.7.1
-[0.7.0]: https://github.com/accodeing/fortnox-api/compare/v0.6.3...v0.7.0
-[0.6.3]: https://github.com/accodeing/fortnox-api/compare/v0.6.2...v0.6.3
+- Setting an attribute to `nil` on update now correctly sends `null` to
+  Fortnox, clearing the field. In 0.x this silently re-sent the original
+  value due to a bug in the mapper diff. (#172)
+- Read-only attributes like `total`, `balance`, and `booked` now load
+  correctly from Fortnox API responses. In 0.x these returned `nil` due
+  to missing writers for private attributes. (#50)
+- API base URL updated from `apps.fortnox.se/3` to `api.fortnox.se/3`,
+  avoiding the redirect introduced by Fortnox in February 2026. (#249)
+- All current housework types are now supported, including types added
+  after the 0.x release. (#196)
+- The `Currencies` enum no longer accepts `KUR`. It is not an ISO-4217
+  currency code and the Fortnox API would have rejected it; 0.x accepted
+  it client-side.
+
+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).
+
+[1.0.0.rc2]: https://github.com/accodeing/fortnox-api/compare/v1.0.0.rc1...v1.0.0.rc2
+[1.0.0.rc1]: https://github.com/accodeing/fortnox-api/releases/tag/v1.0.0.rc1