feat: add spotify integration

Kikobeats · Kikobeats · commit 34c850a5300a · 2019-11-08T21:03:44.000+01:00
diff --git a/README.md b/README.md
@@ -205,6 +205,7 @@ const metascraper = require('metascraper')([
 | [`metascraper-title`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-title) | [![npm](https://img.shields.io/npm/v/metascraper-title.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-title) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-title&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-title) |
 | [`metascraper-uol`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-uol) | [![npm](https://img.shields.io/npm/v/metascraper-uol.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-uol) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-uol&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-uol) |
 | [`metascraper-url`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-url) | [![npm](https://img.shields.io/npm/v/metascraper-url.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-url) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-url&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-url) |
+| [`metascraper-spotify`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-spotify) | [![npm](https://img.shields.io/npm/v/metascraper-spotify.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-spotify) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-spotify&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-spotify) |
 | [`metascraper-video`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-video) | [![npm](https://img.shields.io/npm/v/metascraper-video.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-video) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-video&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-video) |
 | [`metascraper-youtube`](https://github.com/microlinkhq/metascraper/tree/master/packages/metascraper-youtube) | [![npm](https://img.shields.io/npm/v/metascraper-youtube.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-youtube) | [![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-youtube&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-youtube) |
 
diff --git a/packages/metascraper-helpers/index.js b/packages/metascraper-helpers/index.js
@@ -130,11 +130,11 @@ const protocol = url => {
   return protocol.replace(':', '')
 }
 
-const isMediaTypeUrl = (url, type, opts) =>
-  isUrl(url, opts) && isMediaTypeExtension(url, type)
+const isMediaTypeUrl = (url, type, { ext, ...opts } = {}) =>
+  isUrl(url, opts) && isMediaTypeExtension(url, type, ext)
 
-const isMediaTypeExtension = (url, type) =>
-  eq(type, get(EXTENSIONS, extension(url)))
+const isMediaTypeExtension = (url, type, ext) =>
+  eq(type, get(EXTENSIONS, ext || extension(url)))
 
 const isMediaUrl = (url, opts) =>
   isImageUrl(url, opts) || isVideoUrl(url, opts) || isAudioUrl(url, opts)
@@ -252,12 +252,12 @@ const logo = url
 
 const video = (value, opts) => {
   const urlValue = url(value, opts)
-  return isVideoUrl(urlValue) && urlValue
+  return isVideoUrl(urlValue, opts) && urlValue
 }
 
 const audio = (value, opts) => {
   const urlValue = url(value, opts)
-  return isAudioUrl(urlValue) && urlValue
+  return isAudioUrl(urlValue, opts) && urlValue
 }
 
 const validator = {
@@ -279,7 +279,7 @@ const toRule = (fn, opts) => rule => ({ htmlDom, url }) => {
   return fn(value, { url, ...opts })
 }
 
-const composeRule = (fn, opts) => ({ from, to = from }) => async ({
+const composeRule = fn => ({ from, to = from, ...opts }) => async ({
   htmlDom,
   url
 }) => {
diff --git a/packages/metascraper-spotify/.npmrc b/packages/metascraper-spotify/.npmrc
@@ -0,0 +1,4 @@
+unsafe-perm=true
+save-prefix=~
+shrinkwrap=false
+save=false
diff --git a/packages/metascraper-spotify/README.md b/packages/metascraper-spotify/README.md
@@ -0,0 +1,19 @@
+# metascraper-spotify
+
+[![npm](https://img.shields.io/npm/v/metascraper-spotify.svg?style=flat-square)](https://www.npmjs.com/package/metascraper-spotify)
+[![Dependency Status](https://david-dm.org/microlinkhq/metascraper.svg?path=packages/metascraper-spotify&style=flat-square)](https://david-dm.org/microlinkhq/metascraper?path=packages/metascraper-spotify)
+
+> metascraper integration with Spotify.
+
+## Install
+
+```bash
+$ npm install metascraper-spotify --save
+```
+
+## License
+
+**metascraper-spotify** © [microlink.io](https://microlink.io), Released under the [MIT](https://github.com/microlinkhq/metascraper-spotify/blob/master/LICENSE.md) License.<br>
+Authored and maintained by microlink.io with help from [contributors](https://github.com/microlinkhq/metascraper-spotify/contributors).
+
+> [microlink.io](https://microlink.io) · GitHub [@microlink.io](https://github.com/microlinkhq) · Twitter [@microlinkhq](https://twitter.com/microlinkhq)
diff --git a/packages/metascraper-spotify/__snapshots__/index.js.snap-shot b/packages/metascraper-spotify/__snapshots__/index.js.snap-shot
@@ -0,0 +1,52 @@
+exports['ad5bbc912b5260028b5775ba6d03a0697592ead84acc359f25f38a214815d660 1'] = {
+  "title": "Immaterial",
+  "image": "https://i.scdn.co/image/d6f496a6708d22a2f867e5acb84afb0eb0b07bc1",
+  "audio": "https://p.scdn.co/mp3-preview/6be8eb12ff18ae09b7a6d38ff1e5327fd128a74e?cid=a46f5c5745a14fbf826186da8da5ecc3",
+  "url": "https://open.spotify.com/track/5nTtCOCds6I0PHMNtqelas",
+  "author": "SOPHIE",
+  "date": null,
+  "description": null,
+  "lang": null,
+  "logo": "https://embed.spotify.com/favicon.ico",
+  "publisher": null
+}
+
+exports['ad5bbc912b5260028b5775ba6d03a0697592ead84acc359f25f38a214815d660 2'] = {
+  "title": "Immaterial",
+  "image": "https://i.scdn.co/image/d6f496a6708d22a2f867e5acb84afb0eb0b07bc1",
+  "audio": "https://p.scdn.co/mp3-preview/6be8eb12ff18ae09b7a6d38ff1e5327fd128a74e?cid=a46f5c5745a14fbf826186da8da5ecc3",
+  "url": "https://open.spotify.com/track/5nTtCOCds6I0PHMNtqelas",
+  "author": "SOPHIE",
+  "date": null,
+  "description": null,
+  "lang": null,
+  "logo": "https://open.spotify.com/favicon.ico",
+  "publisher": null
+}
+
+exports['ad5bbc912b5260028b5775ba6d03a0697592ead84acc359f25f38a214815d660 3'] = {
+  "title": "Thrones",
+  "image": "https://i.scdn.co/image/ab67616d0000b273b2e2e8384aa498c6579ecba4",
+  "audio": "https://p.scdn.co/mp3-preview/610d2f2de94a751446d9fea3e8b7485693edf72e?cid=a46f5c5745a14fbf826186da8da5ecc3",
+  "url": "https://open.spotify.com/track/6YqroNoDYeQAOUMpdmim9M",
+  "author": "Chuki Beats",
+  "date": null,
+  "description": null,
+  "lang": null,
+  "logo": "https://open.spotify.com/favicon.ico",
+  "publisher": null
+}
+
+exports['ad5bbc912b5260028b5775ba6d03a0697592ead84acc359f25f38a214815d660 4'] = {
+  "title": "The Days",
+  "image": "https://i.scdn.co/image/ab67616d0000b273b9591cb18806aabd30d78aa8",
+  "audio": "https://p.scdn.co/mp3-preview/48a8445c3d6ad4b895fe04ab92acac0cbe6b9c69?cid=a46f5c5745a14fbf826186da8da5ecc3",
+  "url": "https://open.spotify.com/track/5Iy2Jj87Ha0C0IBlNE1I4y",
+  "author": "Avicii",
+  "date": null,
+  "description": null,
+  "lang": null,
+  "logo": "https://play.spotify.com/favicon.ico",
+  "publisher": null
+}
+
diff --git a/packages/metascraper-spotify/index.js b/packages/metascraper-spotify/index.js
@@ -0,0 +1,30 @@
+'use strict'
+
+const { composeRule } = require('@metascraper/helpers')
+const { getPreview } = require('spotify-url-info')
+const spotifyUri = require('spotify-uri')
+const memoizeOne = require('memoize-one')
+
+const memoFn = (newArgs, oldArgs) => newArgs[1] === oldArgs[1]
+
+const spotify = memoizeOne(($, url) => getPreview(url), memoFn)
+
+const getSpotify = composeRule(spotify)
+
+const isValidUrl = url => !!spotifyUri(url).id
+
+module.exports = () => {
+  const rules = {
+    title: getSpotify({ from: 'title' }),
+    image: getSpotify({ from: 'image' }),
+    audio: getSpotify({ from: 'audio', ext: 'mp3' }),
+    url: getSpotify({ from: 'link', to: 'url' }),
+    author: getSpotify({ from: 'artist', to: 'author' })
+  }
+
+  rules.test = ({ url }) => isValidUrl(url)
+
+  return rules
+}
+
+module.exports.isValidUrl = isValidUrl
diff --git a/packages/metascraper-spotify/package.json b/packages/metascraper-spotify/package.json
@@ -0,0 +1,46 @@
+{
+  "name": "metascraper-spotify",
+  "description": "metascraper integration with Spotify",
+  "homepage": "https://nicedoc.io/microlinkhq/metascraper/packages/metascraper-spotify",
+  "version": "0.0.0",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microlinkhq/metascraper-spotify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/microlinkhq/metascraper-spotify/issues"
+  },
+  "keywords": [
+    "audio",
+    "metascraper",
+    "spotify"
+  ],
+  "dependencies": {
+    "@metascraper/helpers": "^5.7.21",
+    "memoize-one": "~5.1.1",
+    "spotify-uri": "~1.0.0",
+    "spotify-url-info": "~1.3.0"
+  },
+  "devDependencies": {
+    "mocha": "latest",
+    "should": "latest",
+    "snap-shot": "latest",
+    "standard": "latest"
+  },
+  "engines": {
+    "node": ">= 8"
+  },
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "test": "NODE_PATH=.. TZ=UTC NODE_ENV=test mocha test"
+  },
+  "license": "MIT",
+  "standard": {
+    "env": [
+      "mocha"
+    ]
+  }
+}
diff --git a/packages/metascraper-spotify/test/index.js b/packages/metascraper-spotify/test/index.js
@@ -0,0 +1,48 @@
+'use strict'
+
+const snapshot = require('snap-shot')
+const should = require('should')
+
+const metascraperSpotify = require('metascraper-spotify')
+
+const { isValidUrl } = metascraperSpotify
+
+const metascraper = require('metascraper')([
+  metascraperSpotify(),
+  require('metascraper-author')(),
+  require('metascraper-date')(),
+  require('metascraper-description')(),
+  require('metascraper-image')(),
+  require('metascraper-lang')(),
+  require('metascraper-logo')(),
+  require('metascraper-logo-favicon')(),
+  require('metascraper-publisher')(),
+  require('metascraper-title')(),
+  require('metascraper-url')()
+])
+
+const spotifyUrls = [
+  'https://embed.spotify.com/?uri=spotify:track:5nTtCOCds6I0PHMNtqelas',
+  'https://open.spotify.com/track/5nTtCOCds6I0PHMNtqelas',
+  'https://open.spotify.com/track/6YqroNoDYeQAOUMpdmim9M?si=_-aA_80kSligZ0SN6VsboA',
+  'https://play.spotify.com/track/4th1RQAelzqgY7wL53UGQt'
+]
+
+describe('metascraper-spotify', () => {
+  describe('.isvalidUrl', () => {
+    spotifyUrls.forEach(url => {
+      it(url, () => {
+        should(isValidUrl(url)).be.true()
+      })
+    })
+  })
+
+  describe('extract metadata', () => {
+    spotifyUrls.forEach(url => {
+      it(url, async () => {
+        const meta = await metascraper({ url })
+        snapshot(meta)
+      })
+    })
+  })
+})
diff --git a/packages/metascraper-spotify/test/mocha.opts b/packages/metascraper-spotify/test/mocha.opts
@@ -0,0 +1,6 @@
+--require should
+--reporter spec
+--timeout 120000
+--slow 300
+--bail
+--recursive
