Using Imgur API rate limit feedback to prevent exceeding it.

src/methods/imgurAlbum.js

@@ -4,14 +4,25 @@ const config = require('config');
 const fetch = require('node-fetch');
 
 const logger = require('../logger')(__filename);
+const { fetchPredata } = require('./imgurImage');
+
+async function imgurAlbumApi(host, post, { predata }) {
+    if (predata.remaining === 10) { // keep a buffer
+        throw new Error(`Reached Imgur API rate limit with source '${host.url}'`);
+    }
 
-async function imgurAlbumApi(host, post) {
     const res = await fetch(`https://api.imgur.com/3/album/${host.id}`, {
         headers: {
             Authorization: `Client-ID ${config.methods.imgur.clientId}`,
         },
     });
 
+    const rateRemaining = Number(res.headers.get('x-ratelimit-userremaining'));
+
+    if (rateRemaining) {
+        predata.setRemaining(rateRemaining);
+    }
+
     const { data } = await res.json();
 
     if (res.status !== 200) {
@@ -33,7 +44,7 @@ async function imgurAlbumApi(host, post) {
             datetime: new Date(data.datetime * 1000),
             original: data,
         },
-        items: data.images.map(item => ({
+        items: data.images.map((item) => ({
             extracted: extract,
             id: item.id,
             url: item.animated ? item.mp4 : item.link,
@@ -46,4 +57,7 @@ async function imgurAlbumApi(host, post) {
     };
 }
 
-module.exports = imgurAlbumApi;
+module.exports = {
+    fetchInfo: imgurAlbumApi,
+    fetchPredata,
+};

src/methods/imgurImage.js

@@ -3,16 +3,52 @@
 const config = require('config');
 const fetch = require('node-fetch');
 
-async function imgurImageApi(host) {
+async function fetchPredata() {
+    const data = {
+        limit: 0,
+        remaining: 0,
+    };
+
+    data.setRemaining = (remaining) => {
+        data.remaining = remaining;
+    };
+
+    const res = await fetch('https://api.imgur.com/3/credits', {
+        headers: {
+            Authorization: `Client-ID ${config.methods.imgur.clientId}`,
+        },
+    });
+
+    if (res.ok) {
+        const body = await res.json();
+
+        if (body.success) {
+            data.limit = body.data.UserLimit;
+            data.remaining = body.data.UserRemaining;
+        }
+    }
+
+    return data;
+}
+
+async function imgurImageApi(host, post, { predata } = {}) {
+    if (predata.remaining === 10) { // keep a buffer
+        throw new Error(`Reached Imgur API rate limit with source '${host.url}'`);
+    }
+
     const res = await fetch(`https://api.imgur.com/3/image/${host.id}`, {
         headers: {
             Authorization: `Client-ID ${config.methods.imgur.clientId}`,
         },
     });
 
-    console.log('imgur headers', res.headers);
+    const rateRemaining = Number(res.headers.get('x-ratelimit-userremaining'));
 
-    if (res.status !== 200) {
+    if (rateRemaining) {
+        predata.setRemaining(rateRemaining);
+    }
+
+    if (!res.ok) {
         throw new Error(`Imgur API returned HTTP ${res.status} for source '${host.url}'`);
     }
 
@@ -36,8 +72,11 @@ async function imgurImageApi(host) {
     };
 }
 
-async function imgurImage(host, post) {
-    return imgurImageApi(host, post);
+async function imgurImage(host, post, context) {
+    return imgurImageApi(host, post, context);
 }
 
-module.exports = imgurImage;
+module.exports = {
+    fetchInfo: imgurImage,
+    fetchPredata,
+};

src/methods/redgifs.js

@@ -6,6 +6,28 @@ const mime = require('mime');
 
 const { version } = require('../../package.json');
 
+async function fetchPredata() {
+    const userAgent = `ripunzel/${version}`;
+    const res = await fetch('https://api.redgifs.com/v2/auth/temporary', {
+        headers: {
+            'user-agent': userAgent,
+        },
+    });
+
+    const data = await res.json();
+
+    if (res.ok) {
+        return {
+            address: data.addr,
+            agent: data.agent,
+            token: data.token,
+            userAgent,
+        };
+    }
+
+    return null;
+}
+
 function scrapeGallery(data) {
     const oldestDate = Math.min(...data.gifs.map((gif) => gif.createDate));
 
@@ -125,28 +147,6 @@ async function redgifs(host, post, { predata }) {
     */
 }
 
-async function fetchPredata() {
-    const userAgent = `ripunzel/${version}`;
-    const res = await fetch('https://api.redgifs.com/v2/auth/temporary', {
-        headers: {
-            'user-agent': userAgent,
-        },
-    });
-
-    const data = await res.json();
-
-    if (res.ok) {
-        return {
-            address: data.addr,
-            agent: data.agent,
-            token: data.token,
-            userAgent,
-        };
-    }
-
-    return null;
-}
-
 module.exports = {
     fetchInfo: redgifs,
     fetchPredata,