jbr 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 074fba6db0300fd967935b1996f1791016e216aa49ef829e771f56340400af1f
-  data.tar.gz: c8433c006174ab91d76db6a331268c325a90ff4f049f179c5adf46acd9716487
+  metadata.gz: 0f0002106d5864e3b0224d1a454f67813be100c2fca6abd411417f81ac913e53
+  data.tar.gz: 1e7998f2402eea55768b060ddc4057a7d513c29741b419fa5ade852caaf71a7a
 SHA512:
-  metadata.gz: 1d3e116c317b973a9600af44e3fd02466e360321f08b4e1c696c2e214854b91b8318c45a8ffdb7c50f6f880bf07e6388bf060d33f54ad58b60b2ead27aab535d
-  data.tar.gz: 28ee328df69a90a166cfaa4ed6ee0b22fad572c7bca8defb501afba0b3054c652b17741df883f4be32b0bd33ca7253a4a7e5872564b2f636f02d459323a7693c
+  metadata.gz: 6b7ce3628d2828f50173f6e41bccf9e6cb3dd2c9197dc7bcf0b30e814f49e5e27db25641835e0b8c174cd9c6e6e96daae74b16c3f532e67cf7fb6b45f466035c
+  data.tar.gz: 1cf960b5042097b943e62dd9ced8ab0e4adf0a084f8ca6143ea48b38c9e2510fae13b21d0576c9165916af7a85d587726d6ed34875c34a32bbe019c83632f662

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+## [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
+  somebody called it. Each is a `Jbr::LineItem` answering `quantity`, `name` and
+  `description`, and reading as `3 Bathroom Faucet Installation (Professional installation
+  of a new bathroom faucet)` — without the parenthesis where nobody described it, and as the
+  name alone where Jobber holds no quantity either. `quantified` is the first half of that on
+  its own, how many of what. A quantity reads whole where Jobber's own Float has nothing
+  after the point and keeps its fraction where it has, so a line is `3 Faucets` or `3.5
+  Hours` as billed. Every line Jobber holds is answered, in the order it holds them
+- [New] `includes(:line_items)`, which is how they are asked for. Nothing nested arrives
+  unasked, so the import walks that never read a line item pay nothing for them
+- [New] `summary` on a job: its lines as a sentence of how many of what, `3 Bathroom Faucet
+  Installation and 2 Change Toilet Valve`. What the work was, where `title` is only what
+  somebody called it — and `name` again where the job has no lines, or where the query never
+  asked for them, so it is never nil and never empty
+
 ## [3.3.0] - 2026-08-13
 
 - [Fix] Credentials are given up only when Jobber says the grant itself is no good. Any

data/README.md

@@ -104,6 +104,33 @@ job.quote_total # => 240.0
 job.created_at # => 2026-05-10 09:15:00
 ```
 
+### Line items
+
+What the work actually was, where the title is only what somebody called it. Asked for the
+same way as anything nested, since a page costs what it carries:
+
+```ruby
+job = oauth.jobs.includes(:line_items).find 'Njc5MTk5'
+
+job.summary # => '3 Bathroom Faucet Installation and 2 Change Toilet Valve', the lines as a
+            #    sentence of how many of what. Falls back to #name where there are none
+
+job.line_items # => an Array of the lines the job is made of
+line = job.line_items.first
+line.quantity # => 3, whole where Jobber's own Float has nothing after the point, and 3.5
+              #    where it has: `3 Faucets`, or `3.5 Hours` for what was really billed
+line.quantified # => '3 Bathroom Faucet Installation', how many of what
+line.name # => 'Bathroom Faucet Installation'
+line.description # => 'Professional installation of a new bathroom faucet'
+line.to_s # => '3 Bathroom Faucet Installation (Professional installation of a new bathroom
+          #     faucet)', and without the parenthesis where nobody described it
+```
+
+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
 
 Fetch a non-draft invoice from Jobber:
@@ -179,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:
@@ -249,6 +282,18 @@ Jbr.mock.jobs = [ { id: 'job-01', title: 'Furnace tune-up', status: 'archived',
     client: { id: 'client-01', company_name: 'Acme Property Management' } } } ]
 ```
 
+Mock the lines a job is made of, under the job that is made of them:
+
+```ruby
+Jbr.mock.jobs = [ { id: 'job-01', line_items: [
+  { quantity: 3.0, name: 'Bathroom Faucet Installation',
+    description: 'Professional installation of a new bathroom faucet' },
+  { quantity: 2.0, name: 'Change Toilet Valve' } ] } ]
+
+oauth.jobs.past.first.summary
+# => '3 Bathroom Faucet Installation and 2 Change Toilet Valve'
+```
+
 ### Visits
 
 Mock the visits the account has:

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/includable.rb

@@ -2,8 +2,8 @@ module Jbr
   # Extends a list of records with the chaining that says what to bring back beside them.
   # Nothing extra comes back unasked: a page costs what it carries.
   module Includable
-    # @param names [Array<Symbol, Hash>] :client, :property, or property: :client for the
-    #   client whose file the place sits on.
+    # @param names [Array<Symbol, Hash>] :client, :line_items, :property, or
+    #   property: :client for the client whose file the place sits on.
     # @return [Resource] the same list, asking Jobber for those too.
     def includes(*names)
       named = names.each_with_object({}) do |name, all|
@@ -20,6 +20,7 @@ module Jbr
     def selection_of(name, nested)
       case name
         when :client then Cliental::SELECTION
+        when :line_items then LineItem::SELECTION
         when :property then Properted.selection client: nested == :client
       end
     end

data/lib/jbr/itemized.rb

@@ -0,0 +1,9 @@
+module Jbr
+  # Extends a record Jobber itemizes: a job, whose lines say what the work actually was
+  # where the title only says what somebody called it.
+  module Itemized
+    # @return [Array<LineItem>] the lines the record is made of, empty where the query never
+    #   asked for them — a page costs what it carries, so nothing nested arrives unasked.
+    def line_items = LineItem.from @node.dig('lineItems', 'nodes')
+  end
+end

data/lib/jbr/job.rb

@@ -1,7 +1,7 @@
 module Jbr
   # Work a Jobber user accepted and scheduled.
   class Job < Resource
-    include Cliental, Named, Properted
+    include Cliental, Itemized, Named, Properted
 
     # @return [String, nil] what the job is called, where whoever opened it named it.
     def title = @node['title']
@@ -9,6 +9,13 @@ module Jbr
     # @return [String, nil] what the work is, in the words whoever opened the job wrote.
     def instructions = @node['instructions']
 
+    # What the job's lines add up to, each as how many of what: `3 Faucet install and 2 Valve
+    # change`. The lines say what the work was where a title only says what it was called, so
+    # this reads better than one — and falls back to {#name} where the job has no lines, or
+    # where the query never asked for them. Never nil and never empty.
+    # @return [String] the lines as a sentence, or the title, or the ID.
+    def summary = line_items.map(&:quantified).to_sentence.presence || name
+
     # @return [String, nil] where Jobber files the job in its own workflow.
     def status = @node['jobStatus']
 

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

@@ -0,0 +1,46 @@
+module Jbr
+  # One line of the work a job is made of: how many of a thing, what it is called, and what
+  # doing it involves.
+  class LineItem < Resource
+    # 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(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.
+    def self.from(nodes) = nodes.to_a.map { |node| new node: node }
+
+    # @return [Integer, Float, nil] how many of it the job is for.
+    def quantity = whole @node['quantity']
+
+    # @return [String, nil] what the line is called.
+    def name = @node['name']
+
+    # @return [String, nil] what doing it involves, in whoever wrote the line's own words.
+    def description = @node['description']
+
+    # @return [String] how many of what: `3 Bathroom Faucet Installation`, and the name alone
+    #   where Jobber holds no quantity for the line.
+    def quantified = [ quantity, name ].compact.join ' '
+
+    # @return [String] how a line reads: `3 Faucet install (Fits a new faucet)`, and without
+    #   the parenthesis where nobody described it.
+    def to_s = [ quantified, described ].compact.join ' '
+
+  private
+
+    # Jobber answers every quantity as a Float, and a whole one reads as an Integer:
+    # `3 Faucets` rather than `3.0 Faucets`. A fraction keeps its point — `3.5 Faucets` —
+    # since rounding it would lie about what was billed.
+    def whole(number) = number && ((number % 1).zero? ? number.to_i : number)
+
+    def described = ("(#{description})" if description.present?)
+  end
+end

data/lib/jbr/mock/job.rb

@@ -22,6 +22,8 @@ module Jbr
 
     def property = Mock::Property.new(node: @node.fetch(:property, {}))
 
+    def line_items = Mock::LineItem.from(@node.fetch(:line_items, []))
+
     def scheduled_at = @node[:scheduled_at]
 
     def completed_at = @node[:completed_at]

data/lib/jbr/mock/line_item.rb

@@ -0,0 +1,12 @@
+module Jbr
+  # A line of a job that reads from {Jbr.mock} instead of Jobber.
+  class Mock::LineItem < LineItem
+    # @return [Object, nil] the values the app asked for. The quantity is still read whole,
+    #   so an app that mocks `3.0` of a thing sees the `3` a page would show.
+    def quantity = whole @node[:quantity]
+
+    def name = @node[:name]
+
+    def description = @node[:description]
+  end
+end

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.3.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 }
           }

data/lib/jbr.rb

@@ -1,11 +1,13 @@
 require 'json'
 require 'net/http'
 
-# Only the two Active Support files whose methods are used, rather than the whole of it:
+# Only the three Active Support files whose methods are used, rather than the whole of it:
 # Jobber answers a field it holds nothing for with an empty string as readily as with null,
-# and a caller who validates presence needs those to arrive as the same nothing.
+# and a caller who validates presence needs those to arrive as the same nothing. The third is
+# for the sentence a job's lines read as.
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/array/conversions'
 
 require 'graphql/error'
 require 'graphql/unauthorized'
@@ -32,6 +34,10 @@ require 'jbr/account'
 require 'jbr/property'
 require 'jbr/properted'
 require 'jbr/includable'
+# LineItem before Itemized, and both before Job: the lines a job is made of are asked for
+# by a constant the include reads as it loads.
+require 'jbr/line_item'
+require 'jbr/itemized'
 require 'jbr/client'
 require 'jbr/invoice'
 require 'jbr/job'
@@ -44,6 +50,7 @@ require 'jbr/mock/oauth'
 require 'jbr/mock/client'
 require 'jbr/mock/property'
 require 'jbr/mock/quote'
+require 'jbr/mock/line_item'
 require 'jbr/mock/job'
 require 'jbr/mock/jobs'
 require 'jbr/mock/invoice'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbr
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -115,14 +115,17 @@ files:
 - lib/jbr/event.rb
 - lib/jbr/includable.rb
 - lib/jbr/invoice.rb
+- lib/jbr/itemized.rb
 - lib/jbr/job.rb
 - lib/jbr/jobs.rb
+- lib/jbr/line_item.rb
 - lib/jbr/mock.rb
 - lib/jbr/mock/account.rb
 - lib/jbr/mock/client.rb
 - lib/jbr/mock/invoice.rb
 - lib/jbr/mock/job.rb
 - lib/jbr/mock/jobs.rb
+- lib/jbr/mock/line_item.rb
 - lib/jbr/mock/oauth.rb
 - lib/jbr/mock/property.rb
 - lib/jbr/mock/quote.rb