bitfab 0.72.1 → 0.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 750acbbb2c4ff46221148021fd6cfe9d159dbfc0d4c1c7020c705b6f703a09c1
-  data.tar.gz: 7d6d64ec6afc5e8d78df539fa1f25cf4633d07469d59e75a33f2aa0118f4f3ea
+  metadata.gz: 1a30e89baf273769afece482948a0ff108d9a1a2481fad9b2edbcbf8169a344f
+  data.tar.gz: c6807a2ba664c08f1626b879242fab202a37859f0c8c3af2c833e6fc5df74b0d
 SHA512:
-  metadata.gz: 68bed12848716050b8a5a9229af72f7c946e126adae28588207069731750cdeab6850ce15f6a0e5e77fa0a29c7df7321b96465fd5f31c6fac879eaaed03e28d2
-  data.tar.gz: 8d436252fb328617a0b40e4e26e6d6a3641baf9b64faf1884cf806d0554d313bd3f720210cb4e9567e7b1c0e33827335593e52291946ca56e2690de712c67796
+  metadata.gz: fffcdc93382999f0f4e087f8cdeab967768afebfc14ef98d9235257102604d5a9e2203d4953f5fa2f04e77c4656fdd14d08113276c5ccbb34162663bdd9a2180
+  data.tar.gz: 123101bb86a8eafa4fb4f89e86f1856a29e9d262adfc134b0fbad9ca505e9bf51b46532df51658509d1d7c54b7d7362c0faa8ebb71cd15b3cc880660eb4707a4

data/lib/bitfab/scenarios.rb

@@ -9,14 +9,22 @@ module Bitfab
     RECORDS_KEYS_IN_DATA = %w[records sources].freeze
     private_constant :RECORDS_KEYS_IN_DATA
 
+    # Reads the scenario built from trace_id, in any creation state, and returns its hash. "creationStatus" is
+    # "empty" when nothing has started building it, "generating" while Bitfab builds it or waits for the scenario
+    # callback to save it, "created" once it is built, and "error" when building failed, with "creationError" saying
+    # why. "trigger", "data", "triggerSummary", and "dataSummary" are nil until the scenario is built. After
+    # generate_scenario, poll this until "creationStatus" is "created" or "error". A trace with no scenario at all
+    # raises an error.
     def get_scenario(trace_id)
       @http_client.get(scenario_path(trace_id))["scenario"]
     end
 
-    # Starts building the scenario for trace_id and returns at once, without waiting for it. Read it later with
-    # get_scenario. Returns {"status", "traceId", "scenarioId"}: "status" is "started" while Bitfab builds it in the
-    # background, or "already_generated" when the trace already has a scenario, which is left as it is and named by
-    # "scenarioId". "scenarioId" is nil while the trace has no scenario yet.
+    # Starts building the scenario for trace_id and returns at once, without waiting for it. Poll get_scenario until
+    # its "creationStatus" is "created" or "error". Returns {"status", "traceId", "scenarioId", "creationStatus"}:
+    # "status" is "started" while Bitfab builds it in the background, or "already_generated" when the trace already
+    # has a scenario, which is left as it is and named by "scenarioId". A scenario whose build failed is started
+    # again. "scenarioId" is nil while the trace has no scenario yet, and "creationStatus" is the scenario's creation
+    # status right after the call.
     #
     # A replay, a trace outside the organization, or a trace Bitfab cannot build a scenario for (not
     # noah-agent-turn and no scenario callback) raises an error. Adding a trace to a dataset starts the same build

data/lib/bitfab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bitfab
-  VERSION = "0.72.1"
+  VERSION = "0.73.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitfab
 version: !ruby/object:Gem::Version
-  version: 0.72.1
+  version: 0.73.0
 platform: ruby
 authors:
 - Harvest Team