jbr 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc29abcfab78a836ad4c098926a10986bf90ec1d53a62ddcce2c6e1da47e9772
-  data.tar.gz: 4a807c61b3173205f6e53c47f71bbee28fceaa21930c7f2cb0797663c1e53920
+  metadata.gz: 0f0002106d5864e3b0224d1a454f67813be100c2fca6abd411417f81ac913e53
+  data.tar.gz: 1e7998f2402eea55768b060ddc4057a7d513c29741b419fa5ade852caaf71a7a
 SHA512:
-  metadata.gz: 5cabf6ed4fe94c9d71205788acf0fc0464d87fcea88e316c02acf99d509b891df9e24b912ce525053741388591e704106911ec19c3504d30121b01b22a9bcc5e
-  data.tar.gz: 23b0588c84c8042d2b40d396ca34a7c1c34f77d20b566685cdc4ca5f1333d9482ae6779eb310de25f370449b6826b6e1331bc458e58e57e5d4a652dc03442696
+  metadata.gz: 6b7ce3628d2828f50173f6e41bccf9e6cb3dd2c9197dc7bcf0b30e814f49e5e27db25641835e0b8c174cd9c6e6e96daae74b16c3f532e67cf7fb6b45f466035c
+  data.tar.gz: 1cf960b5042097b943e62dd9ced8ab0e4adf0a084f8ca6143ea48b38c9e2510fae13b21d0576c9165916af7a85d587726d6ed34875c34a32bbe019c83632f662

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [3.5.0] - 2026-08-17
+
+- [Fix] A walk of jobs carrying their line items was refused outright: `Throttled`. Jobber
+  prices a query by the page it asks for and prices an *unbounded* connection at its own
+  maximum, so `lineItems` on a page of 40 jobs was charged as though every job carried the
+  largest job's worth of lines. The connection is bounded at 20 now, and a page of jobs is 20
+  rather than 40 — half the page is half the query, and a walk loses nothing by reading twice
+  as many. A job with more than 20 lines is summarized by its first 20
+- [Fix] Jobber's own failures reach a caller as `Jbr::Error`, which is what this gem has
+  always said they would. `GraphQL::Error` was escaping instead, so an app that rescued
+  `Jbr::Error` — as the README tells it to — was not catching a throttle, a 500 or an
+  unreadable answer, and had its own job blow up rather than hearing that Jobber said no
+- [Fix] A refusal for cost says what the cost was: `Throttled (cost 12400, 9500 of 10000
+  available, restoring 500/s)` rather than `Throttled`. Without the numbers there is no
+  telling a query too big to ever run from a bucket that needed another second
+- [Change] A refused query prices the next one. Jobber reports the bucket when it says no as
+  readily as when it answers, and the throttle was only reading it on the way through — so a
+  walk that hit the ceiling then asked again immediately, at the same size, and was refused
+  again
+
 ## [3.4.0] - 2026-08-17
 
 - [New] `line_items` on a job: what the work actually was, where the title is only what

data/README.md

@@ -126,9 +126,10 @@ line.to_s # => '3 Bathroom Faucet Installation (Professional installation of a n
           #     faucet)', and without the parenthesis where nobody described it
 ```
 
-Every line Jobber holds is in the list, in the order it holds them and whatever each is
-quantified at. One it holds no quantity for reads as its name alone. Ask for nothing and
-nothing arrives, so `oauth.jobs.first.line_items` is empty where the query never named them.
+Every line Jobber holds is in the list, up to twenty of them, in the order it holds them and
+whatever each is quantified at. One it holds no quantity for reads as its name alone. Ask for
+nothing and nothing arrives, so `oauth.jobs.first.line_items` is empty where the query never
+named them.
 
 ### Invoices
 
@@ -205,6 +206,12 @@ done about either — every request waits for itself:
 A request that follows no other waits for nothing, so a single `find` is as quick as it ever
 was. Only a walk long enough to be a problem is slowed, and only by as much as it must be.
 
+Where Jobber refuses for cost anyway, the `Jbr::Error` raised says what the query would have
+cost against what was available — `Throttled (cost 12400, 9500 of 10000 available, restoring
+500/s)` — so a query too big to ever run reads apart from a bucket that needed a moment. Every
+connection this gem asks for is bounded, because Jobber prices an unbounded one at its own
+maximum: twenty lines to a job, and twenty jobs or visits to a page.
+
 ### Events
 
 Parse the payload of a Jobber event webhook:

data/lib/graphql/client.rb

@@ -23,13 +23,27 @@ module GraphQL
       raise Unauthorized, response.body if response.code == '401'
       raise Error, response.body unless response.is_a? Net::HTTPSuccess
       body = JSON.parse(response.body)
-      errors = body['errors']
-      raise Error, errors.map { |error| error['message'] }.join('; ') if errors.present?
+      # Before the refusal, not after it: an endpoint that reports what it will still answer
+      # reports it when it says no, which is when a caller most needs to know.
       yield body['extensions'] if block_given?
+      raise Error, refusal(body) if body['errors'].present?
       body.fetch('data')
     end
 
   private
+
+    # What the endpoint refused, and — where it priced the refusal — what the query would have
+    # cost against what was available. `Throttled` on its own leaves a caller unable to tell a
+    # query too big to ever run from a bucket that only needed a moment.
+    def refusal(body)
+      message = body['errors'].map { |error| error['message'] }.join '; '
+      cost = body['extensions'].to_h['cost'].to_h
+      status = cost['throttleStatus'].to_h
+      return message if status.empty?
+
+      "#{message} (cost #{cost['requestedQueryCost']}, #{status['currentlyAvailable']} of " \
+        "#{status['maximumAvailable']} available, restoring #{status['restoreRate']}/s)"
+    end
     def request_headers
       { 'Authorization' => "Bearer #{@token}", 'Content-Type' => 'application/json' }.merge @headers
     end

data/lib/jbr/jobs.rb

@@ -29,12 +29,14 @@ module Jbr
 
   private
 
-    # Forty a page, not a hundred: Jobber prices a query by its page size and refuses the
-    # wider one, and what an includes brings back is charged for on top.
+    # Twenty a page, not forty and not a hundred: Jobber prices a query by its page size, and
+    # what an includes brings back is charged for on top of every row of it — so a page of jobs
+    # carrying their lines, their property and its client priced past what a bucket holds. Half
+    # the page costs half the query and loses nothing, since a walk simply reads more pages.
     def page
       <<~GRAPHQL
         query($after: String, $filter: JobFilterAttributes) {
-          jobs(first: 40, after: $after, filter: $filter) {
+          jobs(first: 20, after: $after, filter: $filter) {
             nodes { #{FIELDS} #{selections} }
             pageInfo { hasNextPage endCursor }
           }

data/lib/jbr/line_item.rb

@@ -5,8 +5,13 @@ module Jbr
     # What Jobber calls each field of a line.
     FIELDS = %w[quantity name description]
 
+    # The most lines to read off one record. Bounded because Jobber prices a connection by the
+    # page it is asked for and prices an unbounded one at its own maximum, so the lines of a
+    # page of jobs were charged for as though every job had the largest job's worth of them.
+    PAGE = 20
+
     # What to ask for wherever a record lists the lines it is made of.
-    SELECTION = "lineItems { nodes { #{FIELDS.join ' '} } }"
+    SELECTION = "lineItems(first: #{PAGE}) { nodes { #{FIELDS.join ' '} } }"
 
     # @param nodes [Array<Hash>, nil] the lines as Jobber answered them, if it answered any.
     # @return [Array<LineItem>] one per line, in the order Jobber holds them.

data/lib/jbr/oauth.rb

@@ -41,6 +41,11 @@ module Jbr
       client.query(statement, variables: variables) { |extensions| throttle.read extensions }
     rescue GraphQL::Unauthorized
       refresh ? retry : {}
+    rescue GraphQL::Error => error
+      # The transport's own class never leaves the gem: a caller told to rescue `Jbr::Error`
+      # was not catching a throttle, a 500 or an unreadable answer, and had its own job blow
+      # up instead of hearing that Jobber would not answer.
+      raise Error, error.message
     end
 
     # Delete a token. If the token is invalid, do nothing.

data/lib/jbr/throttle.rb

@@ -21,7 +21,9 @@ module Jbr
     def read(extensions)
       cost = extensions.to_h['cost'].to_h
       status = cost['throttleStatus'].to_h
-      @cost = cost['actualQueryCost'].to_f
+      # What a refused query would have cost is what it costs: Jobber prices it either way,
+      # and only an answered one reports an actual.
+      @cost = (cost['actualQueryCost'] || cost['requestedQueryCost']).to_f
       @available = status['currentlyAvailable'].to_f
       @restore_rate = status['restoreRate'].to_f
     end

data/lib/jbr/version.rb

@@ -1,5 +1,5 @@
 # A Ruby client for the Jobber API.
 module Jbr
   # The version of this gem.
-  VERSION = '3.4.0'
+  VERSION = '3.5.0'
 end

data/lib/jbr/visits.rb

@@ -18,12 +18,12 @@ module Jbr
 
   private
 
-    # Forty a page, not a hundred: Jobber prices a query by its page size and refuses the
-    # wider one, and what an includes brings back is charged for on top.
+    # Twenty a page, the same as jobs: Jobber prices a query by its page size, and what an
+    # includes brings back is charged for on top of every row of it.
     def page
       <<~GRAPHQL
         query($after: String, $filter: VisitFilterAttributes) {
-          visits(first: 40, after: $after, filter: $filter) {
+          visits(first: 20, after: $after, filter: $filter) {
             nodes { #{FIELDS} #{selections} }
             pageInfo { hasNextPage endCursor }
           }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbr
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Claudio Baccigalupo