1.0.3 • Published 8 years ago

crawl-client v1.0.3

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
8 years ago
This application requires:
  • Node v6.2.0
  • NPM v3.8.9
  1. Add crawl-client to package.json
       npm install crawl-client --save
  2. Set required ENV vars
      export NODE_ENV=<development, acceptance, production>
      export CRAWL_API_USERNAME=<crawl api username>
      export CRAWL_API_PASSWORD=<crawl api password>
      export CRAWL_API_URL=http://localhost:3000
  3. Require in JS file:

       const crawlClient = require("crawl-client");
  4. Authenticate (returns a Promise)

       crawlClient.authenticate()
         .then(function() {
           crawlClient.<api-resource>.<api-action>
         });
  5. Make API calls (returns a Promise)
     crawlClient.extractors.list()
       .then(function(results) {
         console.log(JSON.stringify(results));
       })

##Resources

  • crawlers.create | update | list | find | findOrCreate
  • extractors.create | update | list | find | findOrCreate
  • traversers.create | update | list | find | findOrCreate
  • crawlRequests.create | update | list | find | findOrCreate
  • crawlRequestPoller.addCallbackUrl | start

*Note: start local rails server by: rails s -b0.0.0.0