Skip to content

Latest commit

 

History

History
224 lines (147 loc) · 4.31 KB

README.md

File metadata and controls

224 lines (147 loc) · 4.31 KB
Raw

Polarpod

Polarpod is a set of useful APIs for data extraction and processing, with a little enfocus to be an alternative to paid services but for use in smaller projects. Is based on Node.js public avaliable modules.

(caution, the next part may contain THE100 spoilers!)
The name came from "Polaris", "Escape-pod" and a a bit of 'south/north pole signs', Polaris is a space station from THE100 series.

this API uses

  • open-graph-crapper
  • word filter [only english support up to now]
  • atob and btoa base64
  • express
  • js-video-url-parser
  • qrcode-svg
  • object-hash
  • js-sha256

Inside but not in use

  • metafetch [unused, secondary]
  • nano-memoize [unused]
  • mysql

General usage

Og tag getter

https://polarpod.herokuapp.com/apis/ogtags?u=[URL]

parameters:

  • u: url

response:

  • json

SHA1/MD5/SHA256/SHA224 hashes

https://polarpod.herokuapp.com/apis/hash/[sha1|md5|sha256|sha224]?d=[data]

parameters

  • d: data
  • ...apis/hash/[algorithm]: hash algorithm

responses

  • json
  • text (if algorithm is missing)

example

https://polarpod.herokuapp.com/apis/hash/sha256?d=test

Warning(known issue that will not be corrected soon): MD5 and SHA1 - do not expect the same hash from given text to be equal to other hash generators

SVG QR Code generator

https://polarpod.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]

parameters:

  • u: data
  • d: dark/light [true/false] (if true generates a lighet qr)
  • w: width
  • c: HEX color (without the #) default colors: for dark themes=#CCCCCC and light=#222222
  • bg: background color in HEX (without the #) default is transparent if any param was send, a message will be showed

response:

  • SVG document

SVG file return

same as above just add /file, the code will be saved and avaliable at ... .com/code.svg

this is for a specific use case that i needed

https://polarpod.herokuapp.com/apis/qr/file?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]

Video URL parser

http://polarpod.herokuapp.com/apis/video/meta?u=[URL]

params:

  • u: video url

response:

  • json

Video thumbnail

same as video url parser, but with different response and url

http://polarpod.herokuapp.com/apis/video/thumb?u=[URL]

supported platforms

  • youtube
  • vimeo

params:

  • u: video url

response:

  • json

Bad-word message filter

https://polarpod.herokuapp.com/apis/filter?msg=[message_to_filter]

params:

  • msg: message

response:

  • json

responses

og tags response sample

  {
    "name": "GitHub",
    "title": "Build software better, together",
    "desc": "description...",
    "type": "",
    "url": "https://github.com",
    "img": "https://github.githubassets.com/images/modules/open_graph/github-logo.png"
  }

video url parser

thumbnails is currently avaliable for youtube and vimeo only for youtube, maxresdefault will be retuned if avaliable, else will return '0.jpg', the same as hqdefault.jpg _for vimeo thumbails the image size '_640' is replaced by '1920'

  {
    "id": "jYCGSuNDy4M",
    "mediaType": "video",
    "provider": "youtube",
    "thumb":"https://img.youtube.com/vi/jYCGSuNDy4M/maxresdefault.jpg"
  },

 {
    "id": "76979871",
    "mediaType": "video",
    "provider": "vimeo",
    "thumb":"https://i.vimeocdn.com/video/452001751_1920.jpg",
    "thumbOriginal":"https://i.vimeocdn.com/video/452001751_640.jpg"
  },

bad-word filter

  {
    "msg":"****"
  }

hasher

  {
    "status":200,
    "success":true,
    "algorithm":"sha256",
    "original":"test",
    "date":"Fri, 25 Oct 2019 03:30:52 GMT",
    "hash":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
  }

Modules credits

qrcode-svg by papnkukn

bad-words by web-mech

jsVideoUrlParser by Zod-

openGraphScraper by jshemas

metafetch by brahma-dev

object-hash by puleos

js-sha256 by emn178

LICENSE

  • MIT