jbr 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e03e9b80223954e92497d75f84d2f6be78f23fadcbcfd7d82ba95e83ebacec
-  data.tar.gz: aac7754bb691e5b45ec8284a289eceacfc9afc961cbb71e6ffedc2f92a5fd2a9
+  metadata.gz: 131ece92fb051e64674afcd8e0066a126c83cd4502b7ea570795e2f6a456aaf6
+  data.tar.gz: d56615c6a47fab3de06ecebf672ade7f355e2338e263ff23577faea1b3dd744d
 SHA512:
-  metadata.gz: 1a962bbdc7d20e9549fb10d55a5c52ddb1de7ce7c92a9da20e61162f040a8b2da35c2c6daa545c4ef67e36b04eec0085fa03faddf10db6435674390c20ddacde
-  data.tar.gz: e565f59d6f14284fd3919a048f770e060588be06850d225947b4552d88b1201ea7149afec5fe733f57d78afaa1809ea762f62377a7596729917381ecd7d65e7f
+  metadata.gz: 12e0d034ad5a76d89bf9d8ded9b84bd5790197e34a709404c551f9b75d9d697dcaec066db7f9bd05283bb17fabbee9a5b1239f29b5ed90bb025141f47b9db88a
+  data.tar.gz: 1c3b8eff188c1a4ade48f273c6ec575bfe57a9906da717b8fba10237e3722317f04fc1bacbb333b06b2df4753e3dcf3c5e5d203a2d970908136d55098f3009d9

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [2.4.0] - 2026-08-08
+
+- [Breaking change] A visit answers `property` -- the ID Jobber files the place under, beside
+  the address fields -- rather than `property_id` and `address` apart. It reads the way
+  `client` already did, so a caller unpacks both the same way
+
+## [2.3.0] - 2026-08-07
+
+- [Breaking change] A client's phone is the number Jobber holds as reachable rather than
+  the string on the record: the primary before the rest, one that takes texts before one
+  that does not, and the first of those the North American plan recognizes, ten digits
+  without the country code. A client with no such number now answers nil
+
 ## [2.2.0] - 2026-08-07
 
 - [New] Carry the client a visit is for -- id, first name, last name, phone and email --

data/README.md

@@ -98,11 +98,11 @@ visit = visits.first
 visit.id # => 'Z2lkOi8vS'
 visit.title # => 'Furnace tune-up'
 visit.job_id # => 'Z2lkOi8vS'
-visit.property_id # => 'Z2lkOi8vS'
+visit.property # => { id: 'Z2lkOi8vS', street: '1 Main St', city: 'Raleigh',
+               #      state: 'NC', zip: '27601', latitude: 35.77, longitude: -78.63 }
 visit.client # => { id: 'Z2lkOi8vS', first_name: 'Jane', last_name: 'Doe',
              #      phone: '5553335555', email: 'jane@example.com' }
-visit.address # => { street: '1 Main St', city: 'Raleigh', state: 'NC', zip: '27601',
-              #      latitude: 35.77, longitude: -78.63 }
+             # phone is the reachable North American number, ten digits, or nil
 visit.starts_at # => 2026-08-09 14:00:00
 visit.ends_at # => 2026-08-09 16:00:00
 visit.all_day? # => false
@@ -174,7 +174,8 @@ Mock successfully fetching upcoming visits:
 
 ```ruby
 Jbr.mock.visits = [ { id: 'visit-01', title: 'Furnace tune-up', job_id: 'job-01',
-  property_id: 'property-01', client: { id: 'client-01', first_name: 'Jane' },
+  property: { id: 'property-01', street: '1 Main St' },
+  client: { id: 'client-01', first_name: 'Jane' },
   address: { street: '1 Main St', city: 'Raleigh', state: 'NC', zip: '27601' },
   starts_at: Date.tomorrow.noon, ends_at: Date.tomorrow.end_of_day,
   all_day: false, client_confirmed: true } ]

data/lib/jbr/mock/visit.rb

@@ -15,11 +15,9 @@ module Jbr
 
     def job_id = @node[:job_id]
 
-    def property_id = @node[:property_id]
-
     def client = @node.fetch :client, {}
 
-    def address = @node.fetch :address, {}
+    def property = @node.fetch :property, {}
 
     def all_day? = @node[:all_day]
 

data/lib/jbr/phone.rb

@@ -0,0 +1,23 @@
+module Jbr
+  # The numbers on a client's file, and which of them the client is reached on.
+  class Phone
+    # What Jobber is asked for wherever a client is read: the number, and what ranks it.
+    SELECTION = 'phones { normalizedPhoneNumber smsAllowed primary }'
+
+    # Ten digits whose area code and exchange open with 2 through 9, behind the E.164 +1.
+    NORTH_AMERICAN = /\A\+1([2-9]\d{2}[2-9]\d{6})\z/
+
+    # The number to reach a client on, without its country code.
+    # @param phones [Array<Hash>, nil] the numbers as Jobber answered them.
+    # @return [String, nil] the ten digits to call, or nil where none can be dialed.
+    def self.from(phones)
+      # The index breaks a tie because sort_by does not: two equally ranked numbers would
+      # otherwise swap between runs, and the client would answer a different phone each time.
+      ranked = Array(phones).each_with_index.sort_by do |phone, index|
+        [ phone['primary'] ? 0 : 1, phone['smsAllowed'] ? 0 : 1, index ]
+      end
+      numbers = ranked.lazy.map { |phone, _| phone['normalizedPhoneNumber'].to_s }
+      numbers.filter_map { |number| number[NORTH_AMERICAN, 1] }.first
+    end
+  end
+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 = '2.2.0'
+  VERSION = '2.4.0'
 end

data/lib/jbr/visit.rb

@@ -2,9 +2,7 @@ module Jbr
   # One stop at a property: when the work on a job is scheduled to happen.
   class Visit < Resource
     # What Jobber calls each field of the client the work is for, against what a caller reads.
-    CLIENT_FIELDS = { id: :id, firstName: :first_name, lastName: :last_name,
-      phone: :phone, email: :email,
-    }
+    CLIENT_FIELDS = { id: :id, firstName: :first_name, lastName: :last_name, email: :email }
 
     # The query that reads a page of visits starting after a moment, oldest first. Forty a
     # page, not a hundred: Jobber prices a query by its page size and refuses the wider one.
@@ -14,7 +12,7 @@ module Jbr
           nodes {
             id title startAt endAt allDay clientConfirmed
             job { id }
-            client { #{CLIENT_FIELDS.keys.join ' '} }
+            client { #{CLIENT_FIELDS.keys.join ' '} #{Phone::SELECTION} }
             property { id address { #{Property::SELECTION} } }
           }
           pageInfo { hasNextPage endCursor }
@@ -53,18 +51,20 @@ module Jbr
     # @return [Boolean, nil] whether the client has confirmed the visit.
     def client_confirmed? = @node['clientConfirmed']
 
-    # @return [String, nil] the ID of the property the work happens at.
-    def property_id = @node.dig 'property', 'id'
-
     # Who the work is for, in the fields a client is created with.
     # @return [Hash] any of :id, :first_name, :last_name, :phone and :email.
     def client
-      CLIENT_FIELDS.to_h { |jobber, ours| [ ours, @node.dig('client', jobber.to_s) ] }.compact
+      fields = CLIENT_FIELDS.to_h { |jobber, ours| [ ours, @node.dig('client', jobber.to_s) ] }
+      fields.merge(phone: Phone.from(@node.dig('client', 'phones'))).compact
     end
 
-    # Where the work happens, in the fields {Property} carries.
-    # @return [Hash] any of :street, :city, :state, :zip, :latitude and :longitude.
-    def address = Property.fields_from @node.dig('property', 'address')
+    # Where the work happens, in the fields {Property} carries, under the ID Jobber files
+    # it by -- the shape {#client} answers in, so both read the same way.
+    # @return [Hash] any of :id, :street, :city, :state, :zip, :latitude and :longitude.
+    def property
+      fields = Property.fields_from @node.dig('property', 'address')
+      { id: @node.dig('property', 'id') }.merge fields
+    end
 
     # @return [Time, nil] the visit start time
     def starts_at

data/lib/jbr.rb

@@ -14,7 +14,8 @@ require 'jbr/request'
 require 'jbr/oauth'
 
 require 'jbr/account'
-# Property comes before Client and Visit: their queries read its fields as they load.
+# Phone and Property come before Client and Visit: their queries read these as they load.
+require 'jbr/phone'
 require 'jbr/property'
 require 'jbr/client'
 require 'jbr/invoice'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbr
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Claudio Baccigalupo
@@ -111,6 +111,7 @@ files:
 - lib/jbr/mock/visit.rb
 - lib/jbr/mocking.rb
 - lib/jbr/oauth.rb
+- lib/jbr/phone.rb
 - lib/jbr/property.rb
 - lib/jbr/quote.rb
 - lib/jbr/request.rb