bitfab 0.64.19 → 0.64.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4949c6f7ebe457c48b386ae3243b7b5f4735f9fb0e8c2248db559328ca2d532
-  data.tar.gz: cd72bfba1753c4c2a4baee978f2fd401fe9cecfccdf56b90dd01a70a49aea85d
+  metadata.gz: 01e0c3dff10bb4315c2d7501e397c6e466679dd8a26ae99c98f682f7f91d0584
+  data.tar.gz: 9135b87f009d87e024b567bbf795fb78f3ca2da88560eca0c8f4a81ca9054223
 SHA512:
-  metadata.gz: 525e777fd4ae7517aa2bec6efabb08afd0d944efb17a270952ec8bd762e04c5f78dba6070fe0e2b33f7174ec0c198c5c55bf3c20a2e55511f7b0c9ae2232745e
-  data.tar.gz: d68cbd2fd4dbc0c84e50c773f3e99b3e7edc5bf7e7cd481734db313e62c63169fe2332c1dbbcaedf5172760aa840dd7db8aa100cdb6fe6c46b8034569e4b35eb
+  metadata.gz: 8cf6468e184bcc18a6de04a739f55fcc4f35e31c8e95664ab5f054e6a260933ceaf6f3f8aea3478b0ac91756b16e84d69b6971b76549ce1152403ff3f37b6f5c
+  data.tar.gz: 4fa5a6541e6f234ae28637aba7371c40a1dd80a1800e2d4113d4fda5a507d0652fe12650458a02557661d67d1161225f66ce483daee4d6ce988d068d5494429b

data/lib/bitfab/datasets.rb

@@ -58,6 +58,21 @@ module Bitfab
       @http_client.get(dataset_path(dataset_id))["dataset"]
     end
 
+    # Rename the dataset or change its description, and return the updated
+    # dataset. It keeps its id, traces, and graders. A nil argument leaves that
+    # field untouched, and an empty description clears it. Raises ArgumentError
+    # when both are nil. A blank name, or one another dataset under the same
+    # trace function already uses, raises Net::HTTPError with a 400. A dataset
+    # outside this organization raises Net::HTTPError with a 404.
+    def update(dataset_id, name: nil, description: nil)
+      raise ArgumentError, "Provide name and/or description to update." if name.nil? && description.nil?
+
+      payload = {}
+      payload["name"] = name unless name.nil?
+      payload["description"] = description unless description.nil?
+      @http_client.request(dataset_path(dataset_id), payload, method: "PATCH")["dataset"]
+    end
+
     # The ids of every trace in the dataset, the same membership a replay with
     # dataset_id: selects. Fetches all pages automatically.
     def list_traces(dataset_id)

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.21"
 end

metadata

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