moloni 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd2b46790ffa005a63b070cd61e841afb66f72ecacb6d0616d2ed95af2a19e4
-  data.tar.gz: 6461230850e14c022010e9021948b20789958c2f3ee74cb3ba834713240e480c
+  metadata.gz: f30248a3261946fc4dd7b032d350e7200ccd0aacedb2716b081c6558555a3c4c
+  data.tar.gz: 77f95dd212fe05082c51f175480232a62a7b6cc2fa1389be2de9bb3844d46844
 SHA512:
-  metadata.gz: be6798d96a26ebde2d5f714d8216cea066797af66e4e10d23519200bf26fa2af0c99ca005abaf6241ccddbbfea0065edb767e86f80fc6cede7a33e7dde51db78
-  data.tar.gz: f6d873d8bfb6045d3dccbdda1873761fa3c955b1ed35ef8684f90f152adc970039008f74ee7e0cfa0bb5f05e44872a1d5d05010fbcda05f904e84193f9b984ab
+  metadata.gz: 50f8d1aa864564bcfb6ed0fc6d73605be3f016b1a2cacb13c0b6089ffeaa9e55ee87d901c07a2c1396d7ac11426b90fec99110dd3efb25982d317c342b562444
+  data.tar.gz: cd10ee2f20c76c784bec31ebb3f5b17a4a3699a3855677f3d7889309caf1ee04ca8a48830c74c2d5c5f27e0f8278e468f532673c1b730417dc9fdc9e3145ca2a

data/AGENTS.md

@@ -39,3 +39,9 @@ bundle exec rubocop  # lint
 - `Tax#iva_normal`, `#iva_intermedio`, `#iva_reduzido` still exist with hardcoded IDs.
 - `Company.all` (the broken GET version) was removed; use `Company.getAll` via dynamic dispatch.
 - `User.me` and `Printer.all` remain as explicit custom methods.
+
+## Pagination (Product, 0.5)
+- `Product.each_page(method, args, qty: 50) { |page| ... }` — yields full page arrays, stops when `page.length < qty`. Returns `Enumerator` without a block.
+- `Product.paginate(method, args, qty: 50) { |item| ... }` — yields individual items across all pages. Returns `Enumerator` without a block.
+- Works with any method that supports `offset`/`qty` params (getAll, getByEAN, getByReference, getByName, getBySearch, getModifiedSince).
+- Detection of last page: result array is shorter than requested `qty`.

data/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [0.5.1] — 2026-05-20
+
+### Added
+- `Product.each_page(method, args, qty: 50)` — yields full page arrays, stops when `page.length < qty`. Returns `Enumerator` without a block.
+- `Product.paginate(method, args, qty: 50)` — yields individual items across all pages. Returns `Enumerator` without a block.
+- Works with any method supporting `offset`/`qty` params: `getAll`, `getByEAN`, `getByReference`, `getByName`, `getBySearch`, `getModifiedSince`.
+
+## [0.5.0] — 2026-05-11
+
+### Changed
+- **Ruby requirement:** Now requires Ruby 3.2 or later.
+- **HTTP method:** All API calls now use `POST` (previously some reads used `GET`).
+- **Auth URL fix:** `Moloni::Auth.auth_url` now correctly points to `https://www.moloni.pt/ac/root/oauth/`.
+- **Multi-json removed:** Replaced `multi_json` with standard library `JSON`.
+- Updated dependencies (Faraday 2.x, Addressable 2.x, Sinatra 4.x).
+- Token auto-refresh with 5-minute safety margin before expiry.
+
+### Added
+- Backward-compatible `all`, `find`, `count`, `create`, `delete` aliases on `BaseModel`.
+- `Product.searchByName` and `Product.search_by_name` aliases.
+
+### Removed
+- `Company.all` (broken GET version). Use `Company.getAll` via dynamic dispatch.
+
+## [0.4.0] — 2024-01-29
+
+### Fixed
+- Fixed args input in all methods.
+
+## [0.3.x] — 2021
+
+### Added
+- Simplified invoice model.
+- Invoice receipts model.
+- Customer update support.
+- Product search (`getByName`, `getByReference`).
+- Customer `getByNumber`, `getByEmail`.
+- Language shortcuts (`pt`, `en`, `es`).
+- Payment method and maturity date helpers.
+
+### Changed
+- Updated Faraday dependency versions.
+
+## [0.2.x] — 2020-12
+
+### Added
+- Initial model support: Company, User, Subscription, Printer, Tax, Country.
+- Customer model with `find_by_vat`, `create` (with default params).
+- Product, Document, DocumentSet, ProductCategory, ProductStock models.
+- Invoice creation with products, taxes, document sets.
+- OAuth 2.0 client token retrieval flow.
+
+## [0.1.0] — 2020-12-11
+
+### Added
+- Initial release.
+- Faraday HTTP client pointing to `https://api.moloni.pt/v1/`.
+- Basic OAuth configuration support.
+- `base_model.rb` with POST-only requests and `human_errors=true`.

data/MOLONI_API_DOC.md

@@ -254,6 +254,35 @@ Manage products, categories, stock, and pricing.
 
 Typical methods: `getAll`, `getOne`, `insert`, `update`, `delete`.
 
+#### Pagination
+
+The following product methods support `offset` and `qty` parameters for server-side pagination:
+
+| Method | Parameters |
+|--------|-----------|
+| `getAll` | `offset`, `qty` |
+| `getByName` | `name`, `offset`, `qty` |
+| `getBySearch` | `search`, `offset`, `qty` |
+| `getByEAN` | `ean`, `offset`, `qty` |
+| `getByReference` | `reference`, `offset`, `qty` |
+| `getModifiedSince` | `lastmodified`, `offset`, `qty` |
+
+- **`offset`** — integer, default `0`. Number of records to skip.
+- **`qty`** — integer, default `50`, maximum `50`. Number of records per page.
+
+The gem provides two helper methods for iterating paginated results:
+
+```ruby
+# each_page — yields full page arrays, stops when page < qty
+Moloni::Product.each_page(:get_all, qty: 50) { |page| ... }
+
+# paginate — yields individual items across all pages
+Moloni::Product.paginate(:get_all, qty: 50) { |item| ... }
+
+# Both return Enumerator when called without a block
+Moloni::Product.paginate(:get_all).each { |item| ... }
+```
+
 ---
 
 ### 6.3 Documents

data/README.md

@@ -89,6 +89,31 @@ Moloni::Product.get_by_reference(reference: 'ABC-123')
 Moloni::Invoice.getByNumber(number: 'FT 2025/001')
 ```
 
+### Pagination (Product)
+
+Methods that support the Moloni `offset`/`qty` parameters (getAll, getByEAN, getByReference, getByName, getBySearch, getModifiedSince) have built-in helpers for iterating through all results:
+
+```ruby
+# Layer 1 — yields full page arrays
+Moloni::Product.each_page(:get_all, qty: 50) do |page|
+  page.each { |product| puts product[:name] }
+end
+
+# Layer 2 — yields individual items across all pages
+Moloni::Product.paginate(:get_all, qty: 50) do |product|
+  puts product[:name]
+end
+
+# Both return an Enumerator when called without a block
+products = Moloni::Product.paginate(:get_all).to_a
+pages = Moloni::Product.each_page(:get_all).to_a
+
+# Snake_case methods and extra args are supported
+Moloni::Product.paginate(:get_by_name, { name: 'Widget' }, qty: 25) { |p| ... }
+```
+
+Pagination stops automatically when a page has fewer items than the requested `qty`.
+
 ### Customers
 
 ```ruby

data/lib/moloni/models/product.rb

@@ -6,6 +6,30 @@ module Moloni
   class Product < BaseModel
     @intermediate_path = 'products/'
 
+    def self.each_page(method, args = nil, qty: 50, &block)
+      return enum_for(:each_page, method, args, qty:) unless block
+
+      args ||= {}
+      offset = 0
+
+      loop do
+        page = send(method, args.merge(offset:, qty:))
+        break unless page.is_a?(Array)
+        break if page.empty?
+
+        yield page
+        break if page.length < qty
+
+        offset += qty
+      end
+    end
+
+    def self.paginate(method, args = nil, qty: 50, &block)
+      return enum_for(:paginate, method, args, qty:) unless block
+
+      each_page(method, args, qty:) { |page| page.each(&block) }
+    end
+
     # Backward-compatible alias (v0.4 API name)
     # rubocop:disable Naming/MethodName
     def self.searchByName(args)

data/lib/moloni/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Moloni
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moloni
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tiago Pinto
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-11 00:00:00.000000000 Z
+date: 2026-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -207,6 +207,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - AGENTS.md
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt