bitfab 0.65.6 → 0.65.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614f7adf31df970f2961c5ce1bd647d0e875e7e0324e3cad4279846b6a0a2393
-  data.tar.gz: 9dff87903a5c97d9cf0ea9cc705840b6015c21ee0a03d2f89943a76e694d4226
+  metadata.gz: 84d81613e344f01a011f28ac437476d22e73867eb7ab2df04579075730b1c73b
+  data.tar.gz: d3bb4d9f79d587dca9ee2ef2e1ee36a41fbeb59da7cb69960bf9fdbe75e8d663
 SHA512:
-  metadata.gz: a49875ee7ef5769bd78e1a6faf8095fc25c67aa2edb54dfc945c33dc26788881182204ccc21f9799c060fbba3c6f582293863f459beb3a0eab476fde47ee7979
-  data.tar.gz: f78dc742e2b597b173a7270d9c49486bbccff14f1439e54f6d9406b67c78fcf88838125ce8d480065f54ccf9d5783381455204ef96b50ab1bc5ffdaf38d39580
+  metadata.gz: 18ceec3ef05433309efff835c6bcf050789439e9d0424f9919972a70dd5d5b358eb07641fbed220d36b52e92f503d719dee044ba18003fb1371d77d0dba2e8e3
+  data.tar.gz: a6743709c41b9b69597e43e5c1336af5038bf9e5c56d5e3b247051e12fb4527d9732d79bb98e3587f90aedfbc59f7e23ebeae6c0d02e1bfad712f37d6789dd00

data/lib/bitfab/assertions.rb

@@ -13,7 +13,11 @@ module Bitfab
     end
 
     # Each returned assertion carries "category_id" and, with the same value,
-    # the deprecated "category_assertion_id".
+    # the deprecated "category_assertion_id". It also carries "rewrite", the
+    # latest check of its text (the same hash a save returns), or nil when no
+    # check ever ran on it. Read a "pending" check from a save back here once
+    # it finishes, and save each of its "separateAssertions" as its own
+    # assertion.
     def get_assertions(trace_id)
       response = @http_client.get(assertions_path(trace_id))
       return response unless response.is_a?(Hash) && response["assertions"].is_a?(Array)
@@ -24,17 +28,41 @@ module Bitfab
     # Assertion hashes take "category_id": omit it to keep the assignment, or
     # pass nil to clear it. The deprecated "category_assertion_id" is still
     # accepted and sent as "category_id"; "category_id" wins when both are set.
-    def save_assertions(trace_id, assertions, source: "agent")
-      save_assertions_all([{"traceId" => trace_id, "assertions" => assertions}], source:)
+    #
+    # By default, after the save, Bitfab checks each assertion's text against its
+    # trace. When the text bundles two claims, adds a condition, points at a
+    # value instead of stating it, names an id from the recorded run, or cannot
+    # be measured, Bitfab rewrites it and saves the rewritten text in place of
+    # the text you sent. This method returns as soon as the text is saved: each
+    # checked assertion comes back with "status" "pending", and Bitfab rewrites
+    # it in place in the background, usually within a minute. Read the result
+    # later with {#get_assertions}, whose assertions carry the same "rewrite"
+    # hash. Pass skip_guided_rewrite: true to save the text exactly as sent,
+    # with no check.
+    #
+    # Each returned assertion carries a "rewrite" hash: "status" ("pending",
+    # "rewritten", "unchanged", "not_checked", or "check_failed"),
+    # "sentAssertion", "changes", "separateAssertions", "unresolved", and
+    # "error". A check not finished 15 minutes after the save reads as
+    # "check_failed", with the text as sent. Save each of
+    # "separateAssertions" as its own assertion, since the saved one keeps
+    # only one claim.
+    def save_assertions(trace_id, assertions, source: "agent", skip_guided_rewrite: false)
+      save_assertions_all([{"traceId" => trace_id, "assertions" => assertions}], source:, skip_guided_rewrite:)
     end
 
-    # Same assertion hash keys as {#save_assertions}, for several traces at once.
-    def save_assertions_all(updates, source: "agent")
+    # Same assertion hash keys, rewrite, and returned "rewrite" hash as
+    # {#save_assertions}, for several traces at once.
+    def save_assertions_all(updates, source: "agent", skip_guided_rewrite: false)
       return [] if updates.empty?
 
       saved = @http_client.request(
         "/api/sdk/traces/assertions",
-        {"updates" => updates.map { |update| with_new_category_key(update) }, "source" => source}
+        {
+          "updates" => updates.map { |update| with_new_category_key(update) },
+          "source" => source,
+          "guidedRewrite" => !skip_guided_rewrite
+        }
       )["assertions"]
       saved.is_a?(Array) ? saved.map { |assertion| with_both_category_keys(assertion) } : saved
     end

data/lib/bitfab/version.rb

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

metadata

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