initial commits

2024-02-14 16:27:07 -08:00 · 2024-02-14 16:27:07 -08:00 · 2b24feddab
parent 4ae1dccf55
commit 2b24feddab
2 changed files with 117 additions and 0 deletions
--- a/appendframeimage.go
+++ b/appendframeimage.go
@ -0,0 +1,21 @@
+package frameproto
+
+// AppendFrameImage will append 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 p []byte
+//	
+//	// ...
+//	
+//	var url string = "https://example.com/images/screen.png"
+//	
+//	p = frameproto.AppendFrameImage(p, url)
+//
+// Would append this HTML <meta/> element:
+//
+//	<meta property="fc:frame:image" content="https://example.com/images/screen.png" />
+func AppendFrameImage(p []byte, url string) []byte {
+	const property string = MetaPropertyFrameImage
+	return appendMetaPropertyContent(p, property, url)
+}
--- a/appendframeimage_test.go
+++ b/appendframeimage_test.go
@ -0,0 +1,96 @@
+package frameproto
+
+import (
+	"testing"
+)
+
+func TestAppendFrameImage(t *testing.T) {
+
+	tests := []struct{
+		Version string
+		Expected string
+	}{
+		{
+			Version:                                           "",
+			Expected: `<meta property="fc:frame:image" content="" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                           "something",
+			Expected: `<meta property="fc:frame:image" content="something" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                           "Hello world! 🙂",
+			Expected: `<meta property="fc:frame:image" content="Hello world! 🙂" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                           "https://example.com/path/to/post/to.png",
+			Expected: `<meta property="fc:frame:image" content="https://example.com/path/to/post/to.png" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                           "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 [256]byte
+			var p []byte = buffer[0:0]
+
+			p = AppendFrameImage(p, test.Version)
+
+			expected := test.Expected
+			actual   := string(p)
+
+			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("LABEL: %q", test.Version)
+				continue
+			}
+		}
+
+		{
+			const top    string = "<html>\n<head>\n"
+			const bottom string = "</head>\n<body>\n</body>\n</html>\n"
+
+			var buffer [256]byte
+			var p []byte = buffer[0:0]
+
+			p = append(p, top...)
+
+			p = AppendFrameImage(p, test.Version)
+
+			p = append(p, bottom...)
+
+			expected := top + test.Expected + bottom
+			actual   := string(p)
+
+			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("LABEL: %q", test.Version)
+				continue
+			}
+		}
+	}
+}