Normalize symbols in request payloads

Author: mconnell

lib/preflight_qa/client.rb

@@ -53,7 +53,7 @@ def build_request(http_class, uri, body)
       request["Authorization"] = "Bearer #{config.api_key}"
       request["Content-Type"] = "application/json"
       request["Accept"] = "application/json"
-      request.body = JSON.generate(body) unless body.nil?
+      request.body = JSON.generate(normalize_payload(body)) unless body.nil?
       request
     end
 
@@ -100,5 +100,24 @@ def error_class_for(status)
       else RequestError
       end
     end
+
+    def normalize_payload(value)
+      case value
+      when Array
+        value.map { |item| normalize_payload(item) }
+      when Hash
+        normalize_payload_hash(value)
+      when Symbol
+        value.to_s
+      else
+        value
+      end
+    end
+
+    def normalize_payload_hash(value)
+      value.each_with_object({}) do |(key, nested_value), normalized|
+        normalized[key.to_s] = normalize_payload(nested_value)
+      end
+    end
   end
 end

spec/preflight_qa/client_spec.rb

@@ -27,6 +27,24 @@
     end
   end
 
+  it "converts symbols to strings throughout the JSON payload" do
+    client.post(
+      "/screenshots",
+      body: {
+        apps: {
+          apple_mail_mac: { modes: [:light, :dark] }
+        },
+        locale: :"en-GB"
+      }
+    )
+
+    expect(http).to have_received(:request) do |request|
+      expect(request.body).to eq(
+        '{"apps":{"apple_mail_mac":{"modes":["light","dark"]}},"locale":"en-GB"}'
+      )
+    end
+  end
+
   it "raises a configuration error without an api key" do
     config.api_key = nil