Use uuid for screenshot resources

Author: mconnell

README.md

@@ -53,14 +53,14 @@ submission = PreflightQA::Screenshots.create(
   mode: "dark"
 )
 
-submission.guid
+submission.uuid
 submission.status
 ```
 
 Find screenshots for a submission:
 
 ```ruby
-screenshots = PreflightQA::Screenshots.find(submission.guid)
+screenshots = PreflightQA::Screenshots.find(submission.uuid)
 
 screenshots.each do |screenshot|
   puts "#{screenshot.app}: #{screenshot.status} -> #{screenshot.url}"

lib/preflight_qa/screenshot.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module PreflightQA
-  Screenshot = Data.define(:guid, :app, :mode, :status, :url, :raw) do
-    def self.from_payload(payload, guid: nil)
+  Screenshot = Data.define(:uuid, :app, :mode, :status, :url, :raw) do
+    def self.from_payload(payload, uuid: nil)
       new(
-        guid: payload["guid"] || guid,
+        uuid: payload["uuid"] || uuid,
         app: payload["app"],
         mode: payload["mode"],
         status: payload["status"],

lib/preflight_qa/screenshots.rb

@@ -11,10 +11,10 @@ def create(subject:, html:, **options)
       )
     end
 
-    def find(guid)
-      payload = PreflightQA.client.get("/screenshots/#{guid}")
+    def find(uuid)
+      payload = PreflightQA.client.get("/screenshots/#{uuid}")
       screenshots = extract_screenshots(payload)
-      screenshots.map { |screenshot| Screenshot.from_payload(screenshot, guid: extract_guid(payload, guid)) }
+      screenshots.map { |screenshot| Screenshot.from_payload(screenshot, uuid: extract_uuid(payload, uuid)) }
     end
 
     def extract_screenshots(payload)
@@ -26,13 +26,13 @@ def extract_screenshots(payload)
     end
     private_class_method :extract_screenshots
 
-    def extract_guid(payload, fallback)
-      payload.dig("meta", "guid") ||
-        payload.dig("data", "guid") ||
-        payload.dig("data", "submission", "guid") ||
+    def extract_uuid(payload, fallback)
+      payload.dig("meta", "uuid") ||
+        payload.dig("data", "uuid") ||
+        payload.dig("data", "submission", "uuid") ||
         fallback
     end
-    private_class_method :extract_guid
+    private_class_method :extract_uuid
 
     def build_create_payload(subject:, html:, options:)
       payload = { subject: subject, html: html }

lib/preflight_qa/submission.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 module PreflightQA
-  Submission = Data.define(:guid, :status, :subject, :raw) do
+  Submission = Data.define(:uuid, :status, :subject, :raw) do
     def self.from_payload(payload)
       data = payload["data"] || payload
       source = data["submission"] || data["request"] || data["screenshot_request"] || data
 
       new(
-        guid: source["guid"] || payload.dig("meta", "guid"),
+        uuid: source["uuid"] || payload.dig("meta", "uuid"),
         status: source["status"],
         subject: source["subject"] || payload.dig("meta", "subject"),
         raw: payload

spec/preflight_qa/screenshots_spec.rb

@@ -6,7 +6,7 @@
     {
       "data" => {
         "submission" => {
-          "guid" => "abc123",
+          "uuid" => "1b153496-f702-4f89-85b4-cd1a9516cbbe",
           "status" => "pending",
           "subject" => "My Test Email"
         }
@@ -19,13 +19,19 @@
         "screenshots" => [
           {
             "app" => "outlook_mac",
-            "mode" => "dark",
+            "mode" => "light",
             "status" => "complete",
             "url" => "https://preflight.qa/screenshot.png"
+          },
+          {
+            "app" => "outlook_mac",
+            "mode" => "dark",
+            "status" => "pending",
+            "url" => nil
           }
         ]
       },
-      "meta" => { "guid" => "abc123" }
+      "meta" => { "uuid" => "1b153496-f702-4f89-85b4-cd1a9516cbbe" }
     }
   end
 
@@ -57,28 +63,38 @@
 
     expect(result).to eq(
       PreflightQA::Submission.new(
-        guid: "abc123",
+        uuid: "1b153496-f702-4f89-85b4-cd1a9516cbbe",
         status: "pending",
         subject: "My Test Email",
         raw: submission_payload
       )
     )
   end
 
-  it "finds screenshots by guid" do
-    allow(client).to receive(:get).with("/screenshots/abc123").and_return(screenshot_payload)
+  it "finds screenshots by uuid" do
+    allow(client).to receive(:get)
+      .with("/screenshots/1b153496-f702-4f89-85b4-cd1a9516cbbe")
+      .and_return(screenshot_payload)
 
-    result = described_class.find("abc123")
+    result = described_class.find("1b153496-f702-4f89-85b4-cd1a9516cbbe")
 
     expect(result).to eq(
       [
         PreflightQA::Screenshot.new(
-          guid: "abc123",
+          uuid: "1b153496-f702-4f89-85b4-cd1a9516cbbe",
           app: "outlook_mac",
-          mode: "dark",
+          mode: "light",
           status: "complete",
           url: "https://preflight.qa/screenshot.png",
           raw: screenshot_payload.fetch("data").fetch("screenshots").first
+        ),
+        PreflightQA::Screenshot.new(
+          uuid: "1b153496-f702-4f89-85b4-cd1a9516cbbe",
+          app: "outlook_mac",
+          mode: "dark",
+          status: "pending",
+          url: nil,
+          raw: screenshot_payload.fetch("data").fetch("screenshots").last
         )
       ]
     )