initial commits

writeframeimage.go

@@ -0,0 +1,22 @@
+package frameproto
+
+import (
+	"io"
+)
+
+// WriteFrameImage will write the HTML <meta/> element for the Frame-Protocol's (i.e., Farcaster Frame's) "fc:frame:image" name-value pair.
+//
+// For example, this call:
+//
+//	var url string = "https://example.com/images/screen.png"
+//	
+//	frameproto.WriteFrameImage(writer, url)
+//
+// Would write this HTML <meta/> element:
+//
+//	<meta property="fc:frame:image" content="https://example.com/images/screen.png" />
+func WriteFrameImage(writer io.Writer, url string) {
+	const property string = MetaPropertyFrameImage
+	writeMetaPropertyContent(writer, property, url)
+}
+

writeframeimage_test.go

@@ -0,0 +1,68 @@
+package frameproto
+
+import (
+	"testing"
+
+	"strings"
+)
+
+func TestWriteFrameImage(t *testing.T) {
+
+	tests := []struct{
+		URL string
+		Expected string
+	}{
+		{
+			URL: "",
+			Expected: `<meta property="fc:frame:image" content="" />`+"\n",
+		},
+
+
+
+		{
+			URL: "something",
+			Expected: `<meta property="fc:frame:image" content="something" />`+"\n",
+		},
+
+
+
+		{
+			URL: "Hello world! 🙂",
+			Expected: `<meta property="fc:frame:image" content="Hello world! 🙂" />`+"\n",
+		},
+
+
+
+		{
+			URL: "https://example.com/path/to/post/to.png",
+			Expected: `<meta property="fc:frame:image" content="https://example.com/path/to/post/to.png" />`+"\n",
+		},
+
+
+
+		{
+			URL: "x-proto:apple/banana/cherry",
+			Expected: `<meta property="fc:frame:image" content="x-proto:apple/banana/cherry" />`+"\n",
+		},
+	}
+
+	for testNumber, test := range tests {
+
+		var buffer strings.Builder
+
+		WriteFrameImage(&buffer, test.URL)
+
+		expected := test.Expected
+		actual   := buffer.String()
+
+		if expected != actual {
+			t.Errorf("For test #%d, the actual written meta-tag is not what was expected." ,testNumber)
+			t.Logf("EXPECTED: %s", expected)
+			t.Logf("ACTUAL:   %s", actual)
+			t.Logf("EXPECTED: %q", expected)
+			t.Logf("ACTUAL:   %q", actual)
+			t.Logf("URL: %q", test.URL)
+			continue
+		}
+	}
+}