json-web-crawler

Json Web Crawler

Use JSON to list all elements (with css 3 and jquery selector) that you want to crawl. Only run in node >= 4.0

Demo

run the two scripts (kickstarter & steam) in terminal to see what happen.

Usage

npm i json-web-crawler --save

var Crawl = require('json-web-crawl');

Crawl('HTML content', your json setting)
  .then(console.log)
  .catch(console.log);

Different from 0.0.6

You can compare it in demo

• limit, range, focus and ignore combine to listOption
• keys rename to crawl
• no name key in crawl
• no use key, only process

Variables

It's messy, I know.

var setting = {
  // If match one of this checklist, it will return page not found error.
  pageNotFound: [{
    elem: '.error-msg',
    get:  'text',
    check: ['equal', '404']  // No `process` here
  }],

  // 'content' or 'list', default is content if not set
  // Content: crawl page to a single json.
  type: 'content',
  // DOM element that will focus on.
  container: '.container',

  // or
  // List: crawl a list like Google search result into multi data.
  type: 'list',
  // DOM element that will loop to crawl
  container: 'li.search-result',

  // If type is 'list', you may need to set these values below.
  // =================================================================

  // Optional, use if you don't want to crawl the whole list. ** ALL STRAT FROM 0 **
  listOption: ['limit', 10],           // eq(0) ~ eq(9)
  // listOption: ['range', 6, 12],     // eq(6) ~ eq(11)*, if without end, it will continue to the last one
  // listOption: ['focus', 0, 3, 7],   // [eq(0), eq(3), eq(7)]
  // listOption: ['ignore', 1, 2, 5],  // Elements you want to ignore it. You can use -1, -2 to count from backward.
  // =================================================================

  crawl: {
    keyName: {
      elem: '.element1:eq(0)', // Must have, If empty or undefined, it will use container or listElems instead
      noChild: true,           // Optional, remove all children elem under $(elem)
      outOfContainer: true,    // Optional, If exist, It will use $('html').find()
      get: 'text',
      // get: 'num'
      // get: 'html'
      // get: 'length'            // => $element.length
      // get: 'attrName'          // => $elem.attr('attrName')
      // get: 'data-dataName'     // => $elem.data('dataNAme')
      // get: 'data-dataName:X'
      // X is optional, if data is an array, set 'data-dataName:0' will return $elem.data('dataAttribute')[0]
      // If data is an object, set 'data-dataName:id' will return $elem.data('dataAttribute')['id']
      // If X not exist, it will return the whole data

      // Optional, if you want to do something else after 'get'
      // You can use functions that exist in (lodash)[https://lodash.com/docs].
      process: [
        ['match', /regex here/, number],  // => str.match(/regex here/)[number], return array if no number, but will cause other process won't work
        ['split', ',', number],           // => str.split(',')[number], return array if no number, but will cause other process won't work
        ['replace', 'one', 'two'],
        ['substring', 0, 3],
        ['prepend', 'text'],              // => 'text' + get
        ['append', 'text'],               // => get + 'text'
        ['indexOf', 'text']               // => return number
        ['independent function'],         // like encodeURI, encodeURIComponent, unescape, etc...
        // Due to lodash has the same name `escape` & `unescape` functions with different behavior,
        // so both in pure js renamed to `encode` & `decode` here.
      ]
    },
    keyName2: {
      elem: 'table tbody thead',

      // If the value you want is sperated to several elements, use collect to get all elems
      collect: {
        elems: [{
          elem: 'tr:nth-child(1)',
          get:  'text',
        }, {
          elem: 'tr:nth-child(2)',
          get:  'num',
        }, {
          get:  'href'  // If no elem, the default is parent elem (table tbody)
        }],

        // without this, collect will return array
        combineWith: ', '
      }
    },
    keyName3: {
      elem: 'table tbody tr',
      // It will run all tr elems you set
      collect: {
        loop: true,
        get:  'text',
        combineWith: ', '
      }
    }
  }
};

The MIT License (MIT)

Copyright (c) 2015 Knovour Zheng

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.