Merge pull request #2 from roast-cms/feature/vendors-docs

update docs, and add ability to fetch all vendors for a link

Author: dmitrizzle

README.md

@@ -32,11 +32,16 @@ Complete example can be found in `./example-server.ts` and can be run with `yarn
 
 ## API:
 
-#### GET `/recommends/widget?locale=us`
+#### GET `/recommends/widget`
 
 ```json
 {
-  "link": "https://shop.com/us/widget?referral=you"
+  "link": "widget",
+  "status": 200,
+  "vendor": {
+    "name": "eBay",
+    "url": "https://ebay.com/us/widget?referral=you"
+  }
 }
 ```
 
@@ -56,6 +61,15 @@ For this example to work, MongoDB collection `links` should have the following d
 }
 ```
 
+##### Parameters:
+
+- `locale` - Not implemented but planned. Would prioritize local vendors.
+- `vendors` - Select vendor groups. Currently implemented: `"ALL"`, which lists all vendors for the link.
+
+#### GET `/recommends/group?tag=cameras`
+
+Returns all links for a given `tag` param.
+
 ## Usage (with React):
 
 This an example using React framework, however, the idea would be the same in any kind of project (both on server and on the browser):

src/index.ts

@@ -44,14 +44,17 @@ const tool = ({ pathName }: { pathName: string | undefined }) => {
       // query
       const linkID = req.params.link;
       const linkTag = req.query.tag;
+      const linkVendors = req.query.vendors;
+
+      /**
+        Group/list of links with a particular tag.
+      */
       const isGroupRequest = linkTag && linkID === "group";
       const dbDocument = isGroupRequest
         ? await Links.find({ tags: { $in: [linkTag] } })
         : await Links.findOne({ link: linkID })
             .cache(60 * 10) // cache links for 10 min
             .exec();
-
-      // group/list of links with a particular tag
       if (isGroupRequest && dbDocument.length) {
         return res.json({
           status: 200,
@@ -73,6 +76,22 @@ const tool = ({ pathName }: { pathName: string | undefined }) => {
       // unwraps the response
       const doc = Object.assign({}, dbDocument._doc);
 
+      /**
+        Shows all vendors.
+      */
+      if (linkVendors === "all")
+        return res.json({
+          status: 200,
+          link: doc.link,
+          tags: doc.tags,
+          vendors: doc.vendors?.map(({ name, url, value, locale }) => ({
+            name,
+            url,
+            value,
+            locale,
+          })),
+        });
+
       /**
         Sorts vendors based on value you assign to them & pics top-valued one.
       */
@@ -84,6 +103,13 @@ const tool = ({ pathName }: { pathName: string | undefined }) => {
         }
       )[0];
 
+      /**
+        TODO:
+        Add a condition where if the locale is specified, and it exists
+        in the list of vendors, matching results get bumped above other vendors
+        in the list.
+      */
+
       // successful API response
       return res.json({
         status: 200,
@@ -92,6 +118,7 @@ const tool = ({ pathName }: { pathName: string | undefined }) => {
           url: topValuedVendor.url,
           locale: topValuedVendor.locale,
           name: topValuedVendor.name,
+          tags: topValuedVendor.tags,
           // you may not want to share the vale you place on various vendors
         },
       });

src/utils/mongoose.ts

@@ -3,8 +3,12 @@ import * as mongoose from "mongoose";
 require("dotenv").config();
 const databaseURI = process.env.DATABASE_URI || "";
 const cachegoose = require("recachegoose");
+
+console.log("databaseURI", databaseURI);
+
 try {
   const client = require("./redis").default;
+  console.log("client.options", client.options);
   cachegoose(mongoose, {
     engine: "redis",
     port: client.options.port,

src/utils/redis.ts

@@ -3,6 +3,7 @@ import * as bluebird from "bluebird";
 
 require("dotenv").config();
 const redisURL = process.env.REDIS_URL || "";
+console.log("redisURL", redisURL);
 const client = redis.createClient({ url: redisURL });
 bluebird.promisifyAll(redis.RedisClient.prototype);
 bluebird.promisifyAll(redis.Multi.prototype);