open-graph-scraper - npm Package Compare versions

Comparing version 0.9.9 to 1.0.1

app.js

 var request = require('request'),
-	cheerio = require('cheerio');
+	cheerio = require('cheerio'),
+	_ = require('lodash');
 
@@ -10,2 +11,98 @@ module.exports = function(options, callback){
 
+var fieldsArray = [{
+    multiple: false,
+    property: 'og:title',
+    fieldName: 'ogTitle'
+}, {
+    multiple: false,
+    property: 'og:type',
+    fieldName: 'ogType'
+}, {
+    multiple: true,
+    property: 'og:image',
+    fieldName: 'ogImage'
+}, {
+    multiple: true,
+    property: 'og:image:width',
+    fieldName: 'ogImageWidth'
+}, {
+    multiple: true,
+    property: 'og:image:height',
+    fieldName: 'ogImageHeight'
+}, {
+    multiple: true,
+    property: 'og:image:type',
+    fieldName: 'ogImageType'
+}, {
+    multiple: false,
+    property: 'og:url',
+    fieldName: 'ogUrl'
+}, {
+    multiple: false,
+    property: 'og:audio',
+    fieldName: 'ogAudio'
+}, {
+    multiple: false,
+    property: 'og:description',
+    fieldName: 'ogDescription'
+}, {
+    multiple: false,
+    property: 'og:determiner',
+    fieldName: 'ogDeterminer'
+}, {
+    multiple: false,
+    property: 'og:locale',
+    fieldName: 'ogLocale'
+}, {
+    multiple: false,
+    property: 'og:locale:alternate',
+    fieldName: 'ogLocaleAlternate'
+}, {
+    multiple: false,
+    property: 'og:site_name',
+    fieldName: 'ogSiteName'
+}, {
+    multiple: true,
+    property: 'og:video',
+    fieldName: 'ogVideo'
+}, {
+    multiple: true,
+    property: 'og:video:width',
+    fieldName: 'ogVideoWidth'
+}, {
+    multiple: true,
+    property: 'og:video:height',
+    fieldName: 'ogVideoHeight'
+}, {
+    multiple: true,
+    property: 'og:video:type',
+    fieldName: 'ogVideoType'
+}];
+
+var mediaMapper = function(item) {
+    return {
+        url: item[0],
+        width: item[1],
+        height: item[2],
+        type: item[3]
+    }
+};
+
+var mediaSorter = function(a, b) {
+    if (!(a.url && b.url))
+        return 0;
+
+    var aRes = a.url.match(/\.(\w{2,5})$/),
+        aExt = (aRes && aRes[1].toLowerCase()) || null;
+    var bRes = b.url.match(/\.(\w{2,5})$/),
+        bExt = (bRes && bRes[1].toLowerCase()) || null;
+
+    if (aExt == 'gif' && bExt != 'gif')
+        return -1;
+    else if (aExt != 'gif' && bExt == 'gif')
+        return 1;
+    else
+        return Math.max(b.width, b.height) - Math.max(a.width, a.height);
+};
+
 /*
@@ -133,37 +230,52 @@ * get info
 			keys.forEach(function(key){
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:title'){
-					ogObject.ogTitle = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:type'){
-					ogObject.ogType = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:image'){
-					ogObject.ogImage = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:url'){
-					ogObject.ogUrl = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:audio'){
-					ogObject.ogAudio = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:description'){
-					ogObject.ogDescription = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:determiner'){
-					ogObject.ogDeterminer = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:locale'){
-					ogObject.ogLocale = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:locale:alternate'){
-					ogObject.ogLocaleAlternate = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:site_name'){
-					ogObject.ogSiteName = meta[key].attribs.content;
-				};
-				if(meta[key].attribs && meta[key].attribs.property && meta[key].attribs.property === 'og:video'){
-					ogObject.ogVideo = meta[key].attribs.content;
-				};
+				if(!(meta[key].attribs && meta[key].attribs.property))
+					return;
+
+				var property = meta[key].attribs.property,
+				content = meta[key].attribs.content;
+
+				fieldsArray.forEach(function(item){
+					if (property === item.property){
+						if(!item.multiple)
+							ogObject[item.fieldName] = content;
+						else if(!ogObject[item.fieldName])
+							ogObject[item.fieldName] = [content];
+						else if(Array.isArray(ogObject[item.fieldName]))
+							ogObject[item.fieldName].push(content);
+					};
+				});
 			});
-			//example of how to get the title tag 
+
+			/* Combine image/width/height/type
+				and sort for priority */
+			var ogImages = _.zip(ogObject.ogImage,
+					ogObject.ogImageWidth,
+					ogObject.ogImageHeight,
+					ogObject.ogImageType)
+				.map(mediaMapper).sort(mediaSorter);
+
+			/* Combine video/width/height/type
+				and sort for priority */
+			var ogVideos = _.zip(ogObject.ogVideo,
+					ogObject.ogVideoWidth,
+					ogObject.ogVideoHeight,
+					ogObject.ogVideoType)
+				.map(mediaMapper).sort(mediaSorter);
+
+			// Delete temporary fields
+			fieldsArray.filter(function(item){
+				return item.multiple;
+			}).forEach(function(item) {
+				delete ogObject[item.fieldName];
+			});
+
+			// Select the best image
+			if (ogImages.length)
+				ogObject.ogImage = ogImages[0];
+
+			// Select the best video
+			if (ogVideos.length)
+				ogObject.ogVideo = ogVideos[0];
+
+			//example of how to get the title tag
 			// $('title').map(function(i, info) {
@@ -176,2 +288,2 @@ // 	console.log('title:',info.children[0].data);
 	});
-};
+};

package.json

 {
 	"name": "open-graph-scraper",
 	"description": "Node.js scraper service for Open Graph info",
-	"version": "0.9.9",
+	"version": "1.0.1",
 	"license": "MIT",
@@ -13,8 +13,9 @@ "main": "app.js",
 	"dependencies": {
-		"request": "2.34.0",
-		"cheerio": "0.15.0"
+		"request": "2.55.0",
+		"lodash": "3.6.0",
+		"cheerio": "0.19.0"
 	},
 	"devDependencies": {
 		"expect.js": "0.3.1",
-		"mocha": "1.18.2"
+		"mocha": "2.2.4"
 	},
@@ -21,0 +22,0 @@ "repository": {

README.md

@@ -39,3 +39,8 @@ openGraphScraper
     ogUrl: "http://ogp.me/"
-    ogImage: "http://ogp.me/logo.png"
+    ogImage: {
+      url: "http://ogp.me/logo.png"
+      width: 100
+      height: 100
+      type: 'image/jpeg'
+    }
     ogDescription: "The Open Graph protocol enables any web page to become a rich object in a social graph."
@@ -42,0 +47,0 @@ }

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15177

13.78%

Lines of code

434

29.94%

Number of low quality alerts

1

-50%

Number of lines in readme file

69

7.81%

Worsened metrics

Dependency count

3

50%

Dependency changes

• + Added

  lodash@3.6.0

• + Added

  ansi-regex@2.1.1
  (transitive)

• + Added

  ansi-styles@2.2.1
  (transitive)

• + Added

  bl@0.9.5
  (transitive)

• + Added

  bluebird@2.11.0
  (transitive)

• + Added

  boolbase@1.0.0
  (transitive)

• + Added

  boom@2.10.1
  (transitive)

• + Added

  caseless@0.9.0
  (transitive)

• + Added

  chalk@1.1.3
  (transitive)

• + Added

  cheerio@0.19.0
  (transitive)

• + Added

  commander@2.20.3
  (transitive)

• + Added

  cryptiles@2.0.5
  (transitive)

• + Added

  css-select@1.0.0
  (transitive)

• + Added

  css-what@1.0.0
  (transitive)

• + Added

  dom-serializer@0.1.1
  (transitive)

• + Added

  domhandler@2.3.0
  (transitive)

• + Added

  entities@1.1.2
  (transitive)

• + Added

  escape-string-regexp@1.0.5
  (transitive)

• + Added

  forever-agent@0.6.1
  (transitive)

• + Added

  form-data@0.2.0
  (transitive)

• + Added

  generate-function@2.3.1
  (transitive)

• + Added

  generate-object-property@1.2.0
  (transitive)

• + Added

  har-validator@1.8.0
  (transitive)

• + Added

  has-ansi@2.0.0
  (transitive)

• + Added

  hawk@2.3.1
  (transitive)

• + Added

  hoek@2.16.3
  (transitive)

• + Added

  htmlparser2@3.8.3
  (transitive)

• + Added

  is-my-ip-valid@1.0.1
  (transitive)

• + Added

  is-my-json-valid@2.20.6
  (transitive)

• + Added

  is-property@1.0.2
  (transitive)

• + Added

  isstream@0.1.2
  (transitive)

• + Added

  jsonpointer@5.0.1
  (transitive)

• + Added

  lodash@3.6.0
  (transitive)

• + Added

  mime-db@1.12.0
  (transitive)

• + Added

  mime-types@2.0.14
  (transitive)

• + Added

  nth-check@1.0.2
  (transitive)

• + Added

  oauth-sign@0.6.0
  (transitive)

• + Added

  qs@2.4.2
  (transitive)

• + Added

  readable-stream@1.0.34
  (transitive)

• + Added

  request@2.55.0
  (transitive)

• + Added

  sntp@1.0.9
  (transitive)

• + Added

  stringstream@0.0.6
  (transitive)

• + Added

  strip-ansi@3.0.1
  (transitive)

• + Added

  supports-color@2.0.0
  (transitive)

• + Added

  tunnel-agent@0.4.3
  (transitive)

• + Added

  xtend@4.0.2
  (transitive)

• - Removed

  CSSselect@0.4.1
  (transitive)

• - Removed

  CSSwhat@0.4.7
  (transitive)

• - Removed

  boom@0.4.2
  (transitive)

• - Removed

  cheerio@0.15.0
  (transitive)

• - Removed

  cryptiles@0.2.2
  (transitive)

• - Removed

  dom-serializer@0.2.2
  (transitive)

• - Removed

  domelementtype@2.3.0
  (transitive)

• - Removed

  domhandler@2.2.1
  (transitive)

• - Removed

  entities@2.2.0
  (transitive)

• - Removed

  forever-agent@0.5.2
  (transitive)

• - Removed

  form-data@0.1.4
  (transitive)

• - Removed

  hawk@1.0.0
  (transitive)

• - Removed

  hoek@0.9.1
  (transitive)

• - Removed

  htmlparser2@3.7.3
  (transitive)

• - Removed

  lodash@2.4.2
  (transitive)

• - Removed

  mime@1.2.11
  (transitive)

• - Removed

  oauth-sign@0.3.0
  (transitive)

• - Removed

  qs@0.6.6
  (transitive)

• - Removed

  request@2.34.0
  (transitive)

• - Removed

  sntp@0.2.4
  (transitive)

• - Removed

  tunnel-agent@0.3.0
  (transitive)

• Updated

  cheerio@0.19.0

• Updated

  request@2.55.0