feat(plugins/community/poopmap): add poopmap plugin support (#675)

source/plugins/poopmap/README.md

@@ -0,0 +1,53 @@
+### 💩 PoopMap plugin
+
+The *poopmap* plugin displays statistics from your [PoopMap](https://poopmap.net) account
+
+<table>
+  <td align="center">
+    <img src="https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg">
+    <img width="900" height="1" alt="">
+  </td>
+</table>
+
+<details>
+  <summary>💬 Obtaining a PoopMap token</summary>
+
+First, install the PoopMap app ([iOS](https://itunes.apple.com/us/app/poop-map/id1303269455?mt=8)/[Android](https://play.google.com/store/apps/details?id=net.poopmap)) and create an account.
+
+Navigate to your profile in the app
+
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/45036977/143533812-c2776bcc-1fda-441e-bc96-cf21d4c69ca1.jpg" width="150" />
+</div>
+
+Tap "Share Profile" in the top right
+
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/45036977/143533849-b7e03b4d-2903-4339-bbb7-e1fc0ea9724e.jpg" width="150" />
+</div>
+
+Tap "Copy to Clipboard" the copy the link to your clipboard
+
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/45036977/143533856-f4a9fc0d-7bde-48c2-b579-e8ee91804d78.jpg" width="150" />
+</div>
+
+You should have something like `Haha, check out the places I've pooped on Poop Map https://api.poopmap.net/map?token=xxxxxxxxxx` copied.
+
+Extract the `token` query paramater from the link
+
+You now have your PoopMap token! This token will not expire and it can only access public details.
+</details>
+
+#### ℹ️ Examples workflows
+
+[➡️ Available options for this plugin](metadata.yml)
+
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    # ... other options
+    plugin_poopmap: yes
+    plugin_poopmap_token: ${{ secrets.POOPMAP_TOKEN }}      # Required
+    plugin_poopmap_days: 7                                  # Display last week stats
+```

source/plugins/poopmap/index.mjs

@@ -0,0 +1,36 @@
+//Setup
+export default async function({q, imports, data, account}, {enabled = false, token = ""} = {}) {
+  //Plugin execution
+  try {
+    //Check if plugin is enabled and requirements are met
+    if ((!enabled)||(!q.poopmap))
+      return null
+
+    if (!token) return {poops:[], days:7}
+
+    const {days} = imports.metadata.plugins.poopmap.inputs({data, account, q})
+    const {data:{poops}} = await imports.axios.get(`https://api.poopmap.net/api/v1/public_links/${token}`)
+
+    const filteredPoops = poops.filter(poop => {
+      const createdAt = new Date(poop.created_at)
+      poop.created_at = createdAt.toString()
+      return createdAt > new Date().getTime() - days * 24 * 60 * 60 * 1000
+    })
+
+    const hours = {max:0}
+    for (let i = 0; i < filteredPoops.length; i++) {
+      const poop = filteredPoops[i]
+      const hour = new Date(poop.created_at).getHours()
+      hours[hour] = (hours[hour] ?? 0) + 1
+
+      hours.max = Math.max(hours[hour], hours.max)
+    }
+
+    //Results
+    return {poops:hours, days}
+  }
+  //Handle errors
+  catch (error) {
+    throw {error:{message:"An error occured", instance:error}}
+  }
+}

source/plugins/poopmap/metadata.yml

@@ -0,0 +1,29 @@
+name: "💩 PoopMap plugin"
+category: social
+index: ~
+supports:
+  - user
+inputs:
+
+  # Enable or disable plugin
+  plugin_poopmap:
+    description: Display PoopMap stats
+    type: boolean
+    default: no
+
+  # PoopMap API token
+  plugin_poopmap_token:
+    description: PoopMap API token
+    type: token
+    default: ""
+
+  # Time range to use for displayed stats
+  plugin_poopmap_days:
+    description: PoopMap time range
+    type: string
+    values:
+      - 7     # Last week
+      - 30    # Last month
+      - 180   # Last 6 months
+      - 365   # Last year
+    default: 7

source/plugins/poopmap/tests.yml

@@ -0,0 +1,5 @@
+- name: Poopmap plugin (default)
+  uses: lowlighter/metrics@latest
+  with:
+    token: MOCKED_TOKEN
+    plugin_poopmap: yes