@natlibfi/ekirjasto-opds-feed-parser 0.0.0-post.147

package/test/feed_parser_test.ts

@@ -0,0 +1,244 @@
+import PrefixMap from "../src/prefix_map";
+import FeedParser from "../src/feed_parser";
+import AcquisitionFeed from "../src/acquisition_feed";
+import NavigationFeed from "../src/navigation_feed";
+import NamespaceParser from "../src/namespace_parser";
+import OPDSAcquisitionLink from "../src/opds_acquisition_link";
+import chai = require("chai");
+let expect = chai.expect;
+
+describe("FeedParser", () => {
+  let parser: FeedParser;
+
+  beforeEach(() => {
+    let prefixes: PrefixMap = {};
+    prefixes[NamespaceParser.ATOM_URI] = "atom:";
+    prefixes[NamespaceParser.OPEN_SEARCH_URI] = "opensearch:";
+    prefixes[NamespaceParser.FH_URI] = "fh:";
+    parser = new FeedParser(prefixes);
+  });
+
+  describe("#parse", () => {
+    it("extracts entries", () => {
+      let entries = [{
+        "atom:id": [{"_": "test id"}],
+        "atom:title": [{"_": "test title"}]
+      }];
+
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:entry": entries
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.entries.length).to.equals(1);
+      let parsedEntry = parsedFeed.entries[0];
+      expect(parsedEntry.title).to.equals("test title");
+      expect(parsedEntry.id).to.equals("test id");
+    });
+
+    it("extracts links", () => {
+      let links = [{
+        "$": {
+          "href": {"value": "test href"},
+          "rel":  {"value": "test rel"}
+        }
+      }];
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:link": links
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.links.length).to.equals(1);
+      let parsedLink = parsedFeed.links[0];
+      expect(parsedLink.href).to.equals("test href");
+      expect(parsedLink.rel).to.equals("test rel");
+    });
+
+    it("extracts id", () => {
+      let id = {
+        "_": "test id"
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:id": [id]
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.id).to.equals("test id");
+    });
+
+    it("extracts title", () => {
+      let title = {
+        "_": "test title"
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:title": [title]
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.title).to.equals("test title");
+    });
+
+    it("extracts updated date", () => {
+      let updated = {
+        "_": "2016-02-01T18:30:59Z"
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:updated": [updated]
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.updated).to.equals(updated["_"]);
+    });
+
+    it("extracts fh:complete if present", () => {
+      let complete = {};
+      let feed = {
+        "$": {
+          "xmlns:fh": {
+            "value": NamespaceParser.FH_URI,
+            "local": "fh"
+          }
+        },
+        "fh:complete": [complete]
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.complete).to.be.true;
+    });
+
+    it("does not extract fh:complete if not present", () => {
+      let feed = {
+        "$": {
+          "xmlns:fh": {
+            "value": NamespaceParser.FH_URI,
+            "local": "fh"
+          }
+        }
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.complete).to.be.false;
+    });
+
+    it("extracts search info", () => {
+      let totalResults = {
+        "_": "22"
+      };
+      let startIndex = {
+        "_": "5"
+      };
+      let itemsPerPage = {
+        "_": "12"
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "opensearch:totalResults": [totalResults],
+        "opensearch:startIndex": [startIndex],
+        "opensearch:itemsPerPage": [itemsPerPage]
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.search.totalResults).to.equals(22);
+      expect(parsedFeed.search.startIndex).to.equals(5);
+      expect(parsedFeed.search.itemsPerPage).to.equals(12);
+    });
+
+    it("recognizes navigation feed", () => {
+      let links = [{
+        "$": {
+          "href": {"value": "test href"},
+          "rel":  {"value": "test rel"}
+        }
+      }];
+      let entry = {
+        "atom:link": links
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:entry": [entry],
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed).to.be.an.instanceof(NavigationFeed);
+      expect(parsedFeed).not.to.be.an.instanceof(AcquisitionFeed);
+    });
+
+    it("recognizes acquisition feed", () => {
+      let links = [{
+        "$": {
+          "href": {"value": "test href"},
+          "rel":  {"value": OPDSAcquisitionLink.GENERIC_REL}
+        }
+      }];
+      let entry = {
+        "atom:link": links
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:entry": [entry],
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed).to.be.an.instanceof(AcquisitionFeed);
+      expect(parsedFeed).not.to.be.an.instanceof(NavigationFeed);
+    });
+
+    it("keeps unparsed data", () => {
+      let links = [{
+        "$": {
+          "href": {"value": "test href"},
+          "rel":  {"value": OPDSAcquisitionLink.GENERIC_REL}
+        }
+      }];
+      let entry = {
+        "atom:link": links
+      };
+      let feed = {
+        "$": {
+          "xmlns:atom": {
+            "value": NamespaceParser.ATOM_URI,
+            "local": "atom"
+          }
+        },
+        "atom:entry": [entry],
+      };
+      let parsedFeed = parser.parse(feed);
+      expect(parsedFeed.unparsed).to.eql(feed);
+    });
+  });
+});