bitfab 0.64.19 → 0.64.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4949c6f7ebe457c48b386ae3243b7b5f4735f9fb0e8c2248db559328ca2d532
-  data.tar.gz: cd72bfba1753c4c2a4baee978f2fd401fe9cecfccdf56b90dd01a70a49aea85d
+  metadata.gz: 74c6c0ac432a8fb315a5ee0fe520a115f0eb49a69a0dc2fdb3fcc26fa82fb163
+  data.tar.gz: 7b7e66e3be766f46b22699a03896d09e25a3201decefeea40010706fb4f66e13
 SHA512:
-  metadata.gz: 525e777fd4ae7517aa2bec6efabb08afd0d944efb17a270952ec8bd762e04c5f78dba6070fe0e2b33f7174ec0c198c5c55bf3c20a2e55511f7b0c9ae2232745e
-  data.tar.gz: d68cbd2fd4dbc0c84e50c773f3e99b3e7edc5bf7e7cd481734db313e62c63169fe2332c1dbbcaedf5172760aa840dd7db8aa100cdb6fe6c46b8034569e4b35eb
+  metadata.gz: 284fc64fd1f74394e6bbcdcd3403fa0936a2b24769eac35975c29bc1f46dade520a142d4b32ef6ec0a205c9f67b4984b7d17fd318dceeae9a7e0cf5ae14ddc37
+  data.tar.gz: 8f977a4b90730b6bdf376d287d057ba7b8624988d8763769db829fdd6b5b15cdd889a684241da842905fc2db855c8710939442bdcbfca4e28cbc1db8da073dd8

data/lib/bitfab/scenarios.rb

@@ -4,11 +4,25 @@ require "uri"
 
 module Bitfab
   class Traces
+    UNSET = Object.new.freeze
+    private_constant :UNSET
+
     def get_scenario(trace_id)
       @http_client.get(scenario_path(trace_id))["scenario"]
     end
 
-    def save_scenario(trace_id, name: nil, description: nil, trigger: nil, data: nil, append_data: nil)
+    # Updates the scenario built from trace_id and returns the saved hash.
+    #
+    # name:, description:, trigger:, and data: each replace the saved value whole. Keywords left out are kept.
+    # append_data: adds history and missing entries after the saved ones. Pass data: or append_data:, not both.
+    #
+    # actual_outcome: is what the run actually did in this one example, never what it should have done.
+    # Bitfab never fills it in, so only the caller sets it. It takes
+    # {"summary" => String, "actions" => [{"name", "details", "result", "failed", "at"}], "source" => Hash or nil}
+    # and replaces the saved value whole. Passing nil clears it. Leaving it out keeps it.
+    #
+    # Raises ArgumentError before any request when nothing is passed, or when data: and append_data: are both passed.
+    def save_scenario(trace_id, name: nil, description: nil, trigger: nil, data: nil, append_data: nil, actual_outcome: UNSET)
       if !data.nil? && !append_data.nil?
         raise ArgumentError, "Pass data or append_data, not both: data replaces the saved data whole."
       end
@@ -19,8 +33,9 @@ module Bitfab
       payload["trigger"] = trigger unless trigger.nil?
       payload["data"] = data unless data.nil?
       payload["appendData"] = append_data unless append_data.nil?
+      payload["actualOutcome"] = actual_outcome unless actual_outcome.equal?(UNSET)
       if payload.empty?
-        raise ArgumentError, "Pass at least one of name, description, trigger, data, or append_data: there is nothing to save otherwise."
+        raise ArgumentError, "Pass at least one of name, description, trigger, data, append_data, or actual_outcome: there is nothing to save otherwise."
       end
 
       @http_client.request(scenario_path(trace_id), payload)["scenario"]

data/lib/bitfab/version.rb

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

metadata

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