Add support for tracking reading

scripts/posts.json

@@ -396,6 +396,92 @@
           "note"
         ]
       }
+    },
+    {
+      "url": "2021/11/ghatp",
+      "type": [
+        "h-entry"
+      ],
+      "properties": {
+        "entry-type": [
+          "read"
+        ],
+        "published": [
+          "2021-11-13T07:51:00+0000"
+        ],
+        "read-status": [
+          "finished"
+        ],
+        "read-of": [
+          {
+            "type": [
+              "h-cite"
+            ],
+            "properties": {
+              "url": [
+                "https://openlibrary.org/books/OL26318312M"
+              ],
+              "uid": [
+                "isbn:9780316217651"
+              ],
+              "name": [
+                "Gods of risk"
+              ],
+              "author": [
+                "James S. A. Corey"
+              ],
+              "photo": {
+                "value": "https://covers.openlibrary.org/b/id/7992542.jpg",
+                "alt": "Cover picture of Gods of risk"
+              }
+            }
+          }
+        ]
+      }
+    },
+    {
+      "url": "2021/11/ghatp-url",
+      "type": [
+        "h-entry"
+      ],
+      "properties": {
+        "entry-type": [
+          "read"
+        ],
+        "published": [
+          "2021-11-13T07:51:00+0000"
+        ],
+        "read-status": [
+          "finished"
+        ],
+        "read-of": [
+          "https://books-mf2.herokuapp.com/isbn/9780316332897"
+        ]
+      }
+    },
+    {
+      "url": "2021/11/99ib8",
+      "type": [
+        "h-entry"
+      ],
+      "properties" : {
+        "entry-type": [
+          "read"
+        ],
+        "summary" : [ "Finished reading: Cibola Burn by James S. A. Corey, ISBN: 9780316217620" ],
+        "read-status" : [ "finished" ],
+        "read-of" : [
+          {
+            "type" : [ "h-cite" ],
+            "properties" : {
+              "name" : [ "Cibola Burn" ],
+              "author" : [ "James S. A. Corey" ],
+              "uid" : [ "isbn:9780316217620" ]
+            }
+          }
+        ],
+        "published" : [ "2020-10-09T23:08:24.411Z" ]
+      }
     }
   ]
 }

src/events/fetch-context/books-mf2.js

@@ -0,0 +1,31 @@
+const fetch = require('node-fetch')
+const logger = require('@architect/shared/logger')
+
+function name () {
+  return 'Books-MF2'
+}
+
+function isBooksMf2Url (url) {
+  return (url.indexOf('https://books-mf2.herokuapp.com/') > -1)
+}
+
+async function fetchContext (url) {
+  if (!isBooksMf2Url(url)) {
+    return
+  }
+  const response = await fetch(url)
+  if (!response.ok) {
+    const text = await response.text()
+    logger.warn('Failed to fetch context from Books-MF2', `${url}\n${text}`)
+    return
+  }
+  const mf2 = await response.json()
+  if (!('items' in mf2) || !mf2.items.length) return
+  return mf2.items[0].properties
+}
+
+module.exports = {
+  name,
+  isBooksMf2Url,
+  fetchContext
+}

src/events/fetch-context/config.arc

@@ -0,0 +1,2 @@
+@aws
+timeout 15

src/events/fetch-context/eventbrite.js

@@ -1,6 +1,10 @@
 const fetch = require('node-fetch')
 const logger = require('@architect/shared/logger')
 
+function name () {
+  return 'Eventbrite'
+}
+
 function isEventbriteUrl (url) {
   return ((url.indexOf('https://eventbrite.com') > -1) ||
     (url.indexOf('https://www.eventbrite.com') > -1) ||
@@ -29,6 +33,7 @@ async function fetchContext (url) {
 }
 
 module.exports = {
+  name,
   isEventbriteUrl,
   fetchContext
 }

src/events/fetch-context/granary.js

@@ -1,6 +1,10 @@
 const fetch = require('node-fetch')
 const logger = require('@architect/shared/logger')
 
+function name () {
+  return 'Granary'
+}
+
 function getGranaryUrl (url) {
   const granaryBaseUrl = 'https://granary.io/'
   const safeUrl = encodeURIComponent(url)
@@ -26,4 +30,4 @@ async function fetchContext (url) {
   return mf2.items[0].properties
 }
 
-module.exports = { fetchContext }
+module.exports = { name, fetchContext }

src/events/fetch-context/index.js

@@ -1,39 +1,42 @@
 const arc = require('@architect/functions')
 const logger = require('@architect/shared/logger')
+const booksMf2 = require('./books-mf2')
 const eventbrite = require('./eventbrite')
 const granary = require('./granary')
 const meetup = require('./meetup')
 const openGraph = require('./open-graph')
 
-async function getContext (url) {
-  // for specific sites, use custom parsing
+async function getHandler (url) {
   if (meetup.isMeetupUrl(url)) {
-    const properties = await meetup.fetchContext(url)
-    if (properties) {
-      return properties
-    }
+    return meetup
   } else if (eventbrite.isEventbriteUrl(url)) {
-    const properties = await eventbrite.fetchContext(url)
-    if (properties) {
-      return properties
-    }
+    return eventbrite
+  } else if (booksMf2.isBooksMf2Url(url)) {
+    return booksMf2
+  } else {
+    return granary
   }
-  // otherwise fallback to Granary, and then OpenGraph
-  const properties = await granary.fetchContext(url)
+}
+
+async function getContext (handler, url) {
+  // if our fetching fails, fallback to OpenGraph
+  const properties = await handler.fetchContext(url)
   if (properties) {
+    logger.info(`Context fetched ${url} using ${handler.name()}`, JSON.stringify(properties))
     return properties
   }
 
+  logger.info(`Context fetching ${url} using fallback ${openGraph.name()}`, JSON.stringify(properties))
   return await openGraph.fetchContext(url)
 }
 
 exports.handler = async function subscribe (event) {
   const data = await arc.tables()
   const { url } = JSON.parse(event.Records[0].Sns.Message)
-  const properties = await getContext(url)
+  const handler = await getHandler(url)
+  const properties = await getContext(handler, url)
   await data.contexts.put({
     url,
     properties
   })
-  logger.info(`Context fetched ${url}`, JSON.stringify(properties))
 }

src/events/fetch-context/meetup.js

@@ -1,6 +1,10 @@
 const fetch = require('node-fetch')
 const logger = require('@architect/shared/logger')
 
+function name () {
+  return 'Meetup'
+}
+
 function isMeetupUrl (url) {
   return ((url.indexOf('https://meetup.com') > -1) ||
     (url.indexOf('https://www.meetup.com') > -1))
@@ -27,6 +31,7 @@ async function fetchContext (url) {
 }
 
 module.exports = {
+  name,
   isMeetupUrl,
   fetchContext
 }

src/events/fetch-context/open-graph.js

@@ -1,6 +1,10 @@
 const ogs = require('open-graph-scraper')
 const logger = require('@architect/shared/logger')
 
+function name () {
+  return 'OpenGraph'
+}
+
 function setName (result, properties) {
   if (result.ogTitle) {
     properties.name = [result.ogTitle]
@@ -61,4 +65,4 @@ async function fetchContext (url) {
   return properties
 }
 
-module.exports = { fetchContext }
+module.exports = { name, fetchContext }

src/http/get-micropub/config/post-types.js

@@ -60,5 +60,18 @@ module.exports = [
   {
     type: 'listen',
     name: 'Listen'
+  },
+  {
+    type: 'read',
+    name: 'Read',
+    properties: [
+      'content',
+      'read-of',
+      'read-status'
+    ],
+    'required-properties': [
+      'read-of',
+      'read-status'
+    ]
   }
 ]

src/http/get-micropub/contexts.js

@@ -3,7 +3,7 @@ const { isValidURL } = require('@architect/shared/utils')
 
 async function setContexts (post) {
   const data = await arc.tables()
-  const urlProps = ['in-reply-to', 'repost-of', 'like-of', 'bookmark-of', 'listen-of']
+  const urlProps = ['in-reply-to', 'repost-of', 'like-of', 'bookmark-of', 'listen-of', 'read-of']
 
   for (const prop of urlProps) {
     if ((prop in post.properties) && Array.isArray(post.properties[prop])) {

src/shared/utils.js

@@ -5,6 +5,7 @@ const reservedUrls = `
   bookmarks
   photos
   checkins
+  reads
   reposts
   likes
   replies
@@ -51,6 +52,9 @@ function derivePostType (post) {
   } else if (('listen-of' in post.properties) &&
     isValidURL(post.properties['listen-of'][0])) {
     return 'listen'
+  } else if (('read-of' in post.properties) && post.properties['read-status'] &&
+    ['to-read', 'reading', 'finished'].includes(post.properties['read-status'][0])) {
+    return 'read'
   } else {
     return 'note'
   }
@@ -67,7 +71,7 @@ function isValidURL (string) {
 
 function findContexts (post) {
   const urls = []
-  for (const prop of ['in-reply-to', 'repost-of', 'like-of', 'bookmark-of', 'listen-of']) {
+  for (const prop of ['in-reply-to', 'repost-of', 'like-of', 'bookmark-of', 'listen-of', 'read-of']) {
     if ((prop in post.properties) && Array.isArray(post.properties[prop])) {
       for (const i in post.properties[prop]) {
         const url = post.properties[prop][i]