setting up the repo

Author: jshemas

.eslintignore

@@ -0,0 +1,3 @@
+coverage/
+node_modules/
+example.js

.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "settings": {
+    "react": {
+      "version": "latest"
+    }
+  },
+  "extends": [
+    "airbnb",
+    "plugin:promise/recommended"
+  ],
+  "plugins": [
+    "mocha",
+    "promise"
+  ],
+  "env": {
+    "commonjs": true,
+    "node": true
+  },
+  "rules": {
+    "max-len": ["error", {
+      "code": 120,
+      "ignoreStrings": true,
+      "ignoreTrailingComments": true
+    }],
+    "no-param-reassign": "off"
+  }
+}

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  buildAndTest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install Dependencies
+      run: npm ci
+    - name: Linting
+      run: npm run eslint
+    - name: Unit Testing
+      run: npm run mocha:unit
+    - name: Integration Testing
+      run: npm run mocha:int

.gitignore

@@ -0,0 +1,20 @@
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+*.DS_Store
+
+pids
+logs
+results
+node_modules
+
+.nyc_output/
+coverage/
+
+npm-debug.log
+.idea/

.snyk

@@ -0,0 +1,10 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.14.1
+ignore: {}
+# patches apply the minimum changes required to fix a vulnerability
+patch:
+  SNYK-JS-LODASH-567746:
+    - lodash:
+        patched: '2020-05-30T23:04:33.532Z'
+    - cheerio > lodash:
+        patched: '2020-05-30T23:04:33.532Z'

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## 1.1.0
+- Setting up the openGraphScraperLite repo
+
+## 1.0.0
+- First version of openGraphScraperLite!

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,101 @@
-# openGraphScraperLite
+# openGraphScraperLite
+
+[![Node.js CI](https://github.com/jshemas/openGraphScraperLite/workflows/Node.js%20CI/badge.svg?branch=master)](https://github.com/jshemas/openGraphScraperLite/actions?query=branch%3Amaster)
+[![Known Vulnerabilities](https://snyk.io/test/github/jshemas/openGraphScraperLite/badge.svg)](https://snyk.io/test/github/jshemas/openGraphScraperLite)
+
+A simple javascript module for scraping Open Graph and Twitter Card info off a site. For Node.js usage, we recommend `open-graph-scraper` by the same people.
+
+## Installation
+
+```bash
+npm install open-graph-scraper-lite
+```
+
+## Usage
+
+Callback Example:
+```javascript
+const ogs = require('open-graph-scraper-lite');
+const options = { url: 'http://ogp.me/' };
+ogs(options, (error, results, response) => {
+  console.log('error:', error); // This is returns true or false. True if there was a error. The error it self is inside the results object.
+  console.log('results:', results); // This contains all of the Open Graph results
+  console.log('response:', response); // This contains the HTML of page
+});
+```
+
+Promise Example:
+```javascript
+const ogs = require('open-graph-scraper-lite');
+const options = { url: 'http://ogp.me/' };
+ogs(options)
+  .then((data) => {
+    const { error, result, response } = data;
+    console.log('error:', error);  // This is returns true or false. True if there was a error. The error it self is inside the results object.
+    console.log('result:', result); // This contains all of the Open Graph results
+    console.log('response:', response); // This contains the HTML of page
+  })
+```
+
+## Results JSON
+
+Check the return for a ```success``` flag. If success is set to true, then the url input was valid. Otherwise it will be set to false. The above example will return something like...
+```javascript
+{
+  ogTitle: 'Open Graph protocol',
+  ogType: 'website',
+  ogUrl: 'http://ogp.me/',
+  ogDescription: 'The Open Graph protocol enables any web page to become a rich object in a social graph.',
+  ogImage: {
+    url: 'http://ogp.me/logo.png',
+    width: '300',
+    height: '300',
+    type: 'image/png'
+  },
+  requestUrl: 'http://ogp.me/',
+  success: true
+}
+```
+
+## Options
+| Name                 | Info                                                                       | Default Value | Required |
+|----------------------|----------------------------------------------------------------------------|---------------|----------|
+| url                  | URL of the site.                                                           |               | x        |
+| timeout              | Timeout of the request                                                     | 2000 ms       |          |
+| html                 | You can pass in an HTML string to run ogs on it. (use without options.url) |               |          |
+| blacklist            | Pass in an array of sites you don't want ogs to run on.                    | []            |          |
+| onlyGetOpenGraphInfo | Only fetch open graph info and don't fall back on anything else.           | false         |          |
+| ogImageFallback      | Fetch other images if no open graph ones are found.                        | true          |          |
+| customMetaTags       | Here you can define custom meta tags you want to scrape.                   | []            |          |
+| allMedia             | By default, OGS will only send back the first image/video it finds         | false         |          |
+| retry                | Number of times ogs will retry the request.                                | 2             |          |
+| headers              | An object containing request headers. Useful for setting the user-agent    | {}            |          |
+| peekSize             | Sets the peekSize for the request                                          | 1024          |          |
+| urlValidatorSettings | Sets the options used by validator.js for testing the URL                  | [Here](https://github.com/jshemas/openGraphScraper/blob/master/lib/openGraphScraper.js#L21-L36)          |          |
+
+Note: `open-graph-scraper-lite` uses [ky](https://github.com/sindresorhus/ky) for requests and most of [ky's options](https://github.com/sindresorhus/ky#api) should work as `open-graph-scraper-lite` options.
+
+Custom Meta Tag Example:
+```javascript
+const ogs = require('open-graph-scraper-lite');
+const options = {
+  url: 'https://github.com/jshemas/openGraphScraper',
+  customMetaTags: [{
+    multiple: false, // is there more then one of these tags on a page (normally this is false)
+    property: 'hostname', // meta tag name/property attribute
+    fieldName: 'hostnameMetaTag', // name of the result variable
+  }],
+};
+ogs(options)
+  .then((data) => {
+    const { error, result, response } = data;
+    console.log('hostnameMetaTag:', result.hostnameMetaTag); // hostnameMetaTag: github.com
+  })
+```
+
+## Tests
+
+Then you can run the tests by running...
+```bash
+npm run test
+```

example.js

@@ -0,0 +1,13 @@
+const ogs = require('open-graph-scraper-lite');
+
+const options = {
+  url: 'http://ogp.me/'
+};
+
+ogs(options)
+  .then((data) => {
+    const { error, result, response } = data;
+    console.log('error:', error); // This is returns true or false. True if there was a error. The error it self is inside the results object.
+    console.log('result:', result); // This contains all of the Open Graph results
+    console.log('response:', response); // This contains the HTML of page
+  });

index.js

@@ -0,0 +1,51 @@
+const openGraphScraperLite = require('./lib/openGraphScraperLite');
+
+/*
+ * run
+ * @param string options - options the user has set
+ * @param function callback and promise
+ */
+exports.run = async (options, callback) => {
+  const hasCallback = typeof callback === 'function';
+  if (hasCallback) {
+    let results;
+    try {
+      results = await openGraphScraperLite(options);
+    } catch (exception) {
+      const returnError = {
+        success: false,
+        requestUrl: options.url,
+        error: exception.message,
+        errorDetails: exception,
+      };
+      return callback(true, returnError);
+    }
+    return callback(false, results.ogObject, results.response);
+  }
+  // eslint-disable-next-line no-async-promise-executor
+  return new Promise(async (resolve, reject) => {
+    let results;
+    try {
+      results = await openGraphScraperLite(options);
+    } catch (exception) {
+      const returnError = {
+        error: true,
+        result: {
+          success: false,
+          requestUrl: options.url,
+          error: exception.message,
+          errorDetails: exception,
+        },
+      };
+      return reject(returnError);
+    }
+    const returnValues = {
+      error: false,
+      result: results.ogObject,
+      response: results.response,
+    };
+    return resolve(returnValues);
+  });
+};
+
+module.exports = (options, callback) => exports.run(options, callback);