@localnerve/get-attribute 1.0.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2024 Alex Grant, LocalNerve LLC, https://www.localnerve.com
+
+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.

package/README.md

@@ -0,0 +1,20 @@
+# get-attribute
+
+> A command to get a single attribute or property from a webpage, echo to stdout
+
+[![npm version](https://badge.fury.io/js/@localnerve%2Fget-attribute.svg)](https://badge.fury.io/js/@localnerve%2Fget-attribute)
+![Verify](https://github.com/localnerve/get-attribute/workflows/Verify/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/localnerve/get-attribute/badge.svg?branch=main)](https://coveralls.io/github/localnerve/get-attribute?branch=main)
+
+## Example
+
+Grab the full url from a specific anchor tag of interest:
+
+```shell
+get-attribute --url=https://host.com/path --selector='a[href^="/videos"]' --attribute=href --useprop=true --timeout=5000
+
+# echoes the first matching href with full url from property: 'https://host.com/path/videos/123456789'
+```
+
+## License
+[MIT](LICENSE.md)

package/bin/get-attribute

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../lib');

package/eslint.config.js

@@ -0,0 +1,39 @@
+const js = require('@eslint/js');
+const globals = require('globals');
+const jest = require('eslint-plugin-jest');
+
+const ignores = {
+  name: 'ignores',
+  ignores: [
+    'bin/**',
+    'node_modules/**',
+    'tmp/**'
+  ]
+};
+
+const tests = {
+  name: 'tests',
+  files: ['__tests__/**'],
+  ...jest.configs['flat/recommended']
+};
+
+const lib = {
+  name: 'lib',
+  files: ['lib/**'],
+  languageOptions: {
+    globals: {
+      ...globals.node
+    }
+  },
+  rules: {
+    ...js.configs.recommended.rules,
+    indent: [2, 2, {
+      SwitchCase: 1,
+      MemberExpression: 1
+    }],
+    quotes: [2, 'single'],
+    'dot-notation': [2, {allowKeywords: true}]
+  }
+}
+
+module.exports = [ignores, tests, lib];

package/jest.config.js

@@ -0,0 +1,17 @@
+module.exports = {
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coveragePathIgnorePatterns: [
+    '/__tests__/globals/'
+  ],
+  globalSetup: './__tests__/globals/setup',
+  globalTeardown: './__tests__/globals/teardown',
+  verbose: true,
+  testEnvironment: 'node',
+  testPathIgnorePatterns: [
+    '/node_modules/',
+    '/tmp/',
+    '__tests__/fixtures',
+    '__tests__/globals'
+  ]
+};

package/lib/cli.js

@@ -0,0 +1,18 @@
+/**
+ * Get the command line args.
+ * 
+ * Args are url, selector, attribute, and [useprop].
+ */
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+
+function getCommandLineArgs (argv) {
+  const args = yargs(hideBin(argv)).argv;
+  const prerequisite = args.url && args.selector && args.attribute;
+  if (!prerequisite) {
+    return null;
+  }
+  return args;
+}
+
+module.exports = getCommandLineArgs;

package/lib/get-attribute.js

@@ -0,0 +1,39 @@
+/**
+ * Get an attribute from a web page given url, selector, and attributeName.
+ */
+const {default: puppeteer, TimeoutError} = require('puppeteer');
+
+async function getAttribute (url, selector, attribute, {
+  useProp = false,
+  timeout = 10000
+} = {}) {
+  const browser = await puppeteer.launch();
+  let attributeValue = null;
+
+  try {
+    const page = await browser.newPage();
+    await page.goto(url, {
+      timeout
+    });
+    const sel = await page.waitForSelector(selector, {
+      timeout
+    });
+    /* istanbul ignore next */
+    attributeValue = await sel?.evaluate((el, attrName, useProp) => {
+      if (useProp) {
+        return el[attrName];
+      }
+      return el.getAttribute(attrName);
+    }, attribute, useProp);
+  } catch (e) {
+    if (!(e instanceof TimeoutError)) {
+      throw e;
+    }
+  } finally {
+    await browser.close();
+  }
+
+  return attributeValue;
+}
+
+module.exports = getAttribute;

package/lib/index.js

@@ -0,0 +1,29 @@
+/**
+ * Scrape a webpage for an attribute, write to standard out.
+ * 
+ * get-attribute --url=<url> --selector=<selector> --attribute=<attribute-name> [--useprop=false] [--timeout=10000]
+ */
+const getArgs = require('./cli');
+const getAttr = require('./get-attribute');
+
+const syntax = 'get-attribute --url=https://host.dom --selector=a[href^="/videos"] --attribute=href [--useprop=false] [--timeout=10000]';
+const args = getArgs(process.argv);
+
+if (args) {
+  (async () => {
+    const attributeValue = 
+      await getAttr(args.url, args.selector, args.attribute, {
+        useProp: args.useprop,
+        timeout: args.timeout
+      });
+    if (!attributeValue) {
+      console.error('Failed to retrieve attribute');
+      process.exit(2);
+    } else {
+      console.log(attributeValue);
+    }
+  })();
+} else {
+  console.error(`Argument error:\n\t${syntax}`);
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@localnerve/get-attribute",
+  "version": "1.0.0",
+  "description": "Get an attribute from a webpage, echo to stdout",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --testTimeout=300000",
+    "test": "jest . --runInBand"
+  },
+  "bin": {
+    "get-attribute": "./bin/get-attribute"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/localnerve/get-attribute.git"
+  },
+  "keywords": [
+    "puppeteer",
+    "web",
+    "attribute"
+  ],
+  "author": "Alex Grant <alex@localnerve.com> (https://www.localnerve.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/localnerve/get-attribute/issues"
+  },
+  "homepage": "https://github.com/localnerve/get-attribute#readme",
+  "dependencies": {
+    "puppeteer": "^22.6.5",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "eslint": "^9.1.0",
+    "@eslint/js": "^9.1.1",
+    "eslint-plugin-jest": "^28.2.0",
+    "express": "^4.19.2",
+    "globals": "^15.0.0",
+    "jest": "^29.7.0",
+    "server-destroy": "^1.0.1"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}