jbr 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 815b57ea81f9bda41efb8b7d09a0767224763b895126a3ee56acabab6266b3fc
-  data.tar.gz: 127a174761ddb6bc0cc00cb34ffd9e49044152d575f3f5e4f42a030f222023a5
+  metadata.gz: 5a315b6ba52c573f0d7fa1a0adec8145578550bd67a136071e7b8a02ea328ea1
+  data.tar.gz: 8c338c2f5a13ce4e98c99c2b5c11377274c71908a2b93fc6c114d8fb109ae540
 SHA512:
-  metadata.gz: 3be4d269a045c6d9e0629a27922697f93c102259eee21762fcef02b0e5257f1b4ebd05e56812faa47e41b68a94ea440624c02621eaa95a4449db42dda94d62f4
-  data.tar.gz: d34a6393d787cb20628cf4a18e0c63ffe63bdecaa3cf00e7e84016f8423fca125567549cda5ced525770b07d6354103be476c00d54b21b936e6769a728efe8b8
+  metadata.gz: e82a0f7dac54170d4f791a752f7497d0b783dce98f4057c606c3ee1f5fe73c85ef32032eb297e2406b95d82bf531d6ba1cf2f4db8a9de5be1fbef38ac1c1c69b
+  data.tar.gz: 82a90ec3316204bb8ccf87c4d4011e249cd7b5d4484697fc30477f553bd4146baa9402bff10f4c6c2f893ce93bc7d06509831ecaf4a7d8a16a60dfad5b0ae67d

data/README.md

@@ -111,8 +111,10 @@ job.scheduled_at # => 2026-05-14 23:02:52
 job.completed_at # => 2026-05-18 11:36:13
 ```
 
-Or walk the account's jobs, oldest first. Jobber is asked for a page at a time, and only
-once the page before it runs out, so `first` costs one request where `to_a` costs as many
+Or walk the account's jobs, oldest first. Either half of the schedule takes how much of it
+you meant — a duration, measured from the same now the half is split at — and a walk that
+stops at a boundary reads only the pages up to it. Jobber is asked for a page at a time, and
+only once the page before it runs out, so `first` costs one request where `to_a` costs as many
 as the account has pages. A walk is priced by what its pages carry, and a long one can be
 refused for it: see [Rate limits](#rate-limits).
 
@@ -120,6 +122,7 @@ refused for it: see [Rate limits](#rate-limits).
 jobs = oauth.jobs # => an Enumerable of every job, nothing fetched yet
 oauth.jobs.past # => the ones dated before now, nothing fetched yet
 oauth.jobs.upcoming # => the ones dated from now on, nothing fetched yet
+oauth.jobs.past(1.year) # => only as far back as a year, which is fewer pages to read
 oauth.jobs.past.ids # => %w[Z2lkOi8vS ...], every page of them, and nothing else about them
 
 job = jobs.first
@@ -178,6 +181,7 @@ Walk the account's visits, oldest first, the same way as its jobs:
 visits = oauth.visits # => an Enumerable of every visit, nothing fetched yet
 oauth.visits.upcoming # => the ones dated from now on, nothing fetched yet
 oauth.visits.past # => the ones dated before now, nothing fetched yet
+oauth.visits.upcoming(3.months) # => only as far ahead as three months
 oauth.visits.upcoming.ids # => %w[Z2lkOi8vS ...], every page of them, and nothing else
 
 visit = visits.first

data/lib/jbr/listable.rb

@@ -19,11 +19,21 @@ module Jbr
     # starts, and a page is read only once the one before it runs out.
     def each(&) = walk(page).each(&)
 
+    # @param within [ActiveSupport::Duration, Numeric, nil] how far ahead to look, or nil for
+    #   as far ahead as the account is scheduled.
     # @return [Listable] the same list, narrowed to what is scheduled from now on.
-    def upcoming = narrowed from_now
+    def upcoming(within = nil)
+      now = Time.now
+      narrowed after: now, before: (now + within if within)
+    end
 
+    # @param within [ActiveSupport::Duration, Numeric, nil] how far back to look, or nil for
+    #   as far back as the account goes.
     # @return [Listable] the same list, narrowed to what started before now.
-    def past = narrowed until_now
+    def past(within = nil)
+      now = Time.now
+      narrowed before: now, after: (now - within if within)
+    end
 
     # The ID Jobber files each record under, and nothing else about it: the cheapest question
     # an account can be walked with, and the one to ask where every record is then read on its
@@ -33,13 +43,26 @@ module Jbr
 
   private
 
-    def narrowed(filter) = self.class.new(oauth: @oauth, includes: @includes, filter: filter)
-
     # The two halves of a schedule, split at the moment they are asked for rather than per
     # page: read page by page the boundary would slide, and something could cross it unseen.
-    def from_now = { startAt: { after: Time.now.iso8601 } }
+    # The same moment is the near end of a window, so the far end is measured from it too.
+    def narrowed(after: nil, before: nil)
+      bounds = { after: after&.iso8601, before: before&.iso8601 }.compact
+      self.class.new oauth: @oauth, includes: @includes, filter: { startAt: bounds }
+    end
 
-    def until_now = { startAt: { before: Time.now.iso8601 } }
+    # Whether a moment falls in the stretch of the schedule the list was narrowed to, for
+    # anything answering one without asking Jobber. A record with no moment at all is in an
+    # open-ended upcoming list, since nothing has started it, and in no window, since a window
+    # is a stretch it would have to have fallen in.
+    def scheduled?(at)
+      return true unless @filter
+
+      after, before = @filter[:startAt].values_at :after, :before
+      return before.nil? unless at
+
+      (after.nil? || at >= Time.iso8601(after)) && (before.nil? || at <= Time.iso8601(before))
+    end
 
     # Every record a paged query answers, one at a time, a page read only once the one before
     # it runs out. The filter is data: narrowed to nothing, the query narrows nothing.

data/lib/jbr/mock/jobs.rb

@@ -13,16 +13,7 @@ module Jbr
       Enumerator.new { |yielder| selected.each { |job| yielder << Mock::Job.new(node: job) } }
     end
 
-    # The half of the schedule the list was narrowed to, from what the app dated each job.
-    # One it left undated is one nothing has started, so it counts as upcoming.
-    def selected
-      return Jbr.mock.jobs unless @filter
-
-      started = @filter.dig(:startAt, :before).present?
-      Jbr.mock.jobs.select { |job| started?(job) == started }
-    end
-
-    def started?(job) = job[:scheduled_at] ? job[:scheduled_at] <= Time.now : false
+    def selected = Jbr.mock.jobs.select { |job| scheduled? job[:scheduled_at] }
 
     # Only a real list is looked through: an app that mocked the list as something raising
     # was mocking the walk failing, and a lookup is a question of its own.

data/lib/jbr/mock/visits.rb

@@ -11,16 +11,7 @@ module Jbr
       Enumerator.new { |yielder| selected.each { |it| yielder << Mock::Visit.new(node: it) } }
     end
 
-    # The half of the schedule the list was narrowed to, from what the app dated each visit.
-    # One it left undated is one nothing has started, so it counts as upcoming.
-    def selected
-      return Jbr.mock.visits unless @filter
-
-      started = @filter.dig(:startAt, :before).present?
-      Jbr.mock.visits.select { |visit| started?(visit) == started }
-    end
-
-    def started?(visit) = visit[:starts_at] ? visit[:starts_at] <= Time.now : false
+    def selected = Jbr.mock.visits.select { |visit| scheduled? visit[:starts_at] }
 
     def listed(id) = Jbr.mock.visits.to_a.find { |visit| visit[:id] == id }.to_h
   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.9.0'
+  VERSION = '3.10.0'
 end

metadata

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