Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | 1x 1x 1x 1x 1x 1x 3x 3x 1x 4x 4x 1x 3x 3x 4x 4x 1x 3x 3x 1x 1x 1x 1x 1x 1x 1x 11x 1x 1x 10x 10x 3x 3x 3x 4x 3x 1x 3x 3x 1x 1x 1x 1x | /**
* # web2os
*
*   
*
* Scrap the web asynchronously in live, reusing Node.js, all in one file, with a few lines! From the web to your operative system (web2os), easily!
*
* *Based on [Electron](https://github.com/electron/electron).*
*
* ## 1. Installation
*
* ~$ `npm install -s web2os`
*
* ## 2. Usage
*
* #### 2.1. How to run `web2os` scripts
*
* If you installed [Electron](https://github.com/electron/electron) globally, you can:
*
* ~$ `electron myScript.js`
*
* *Note: if you have problems installing **Electron** globally, use the flag `--unsafe-perm=true`.*
*
* If you did not install [Electron](https://github.com/electron/electron) globally, you can, instead:
*
* ~$ `./node_modules/.bin/electron myScript.js`
*
* ## 3. Examples
*
* As all the API of `web2os` module is chainable (all the methods can be called one after the other), these are some examples:
*
* #### Example 1: scrap Google's main page title and put it into a file:
*
* ```js
* require("web2os")
* .create()
* .open("https://www.google.com")
* .onWeb((done, error) => {done(document.title);})
* .onOs((done, error, data) => {
* require("fs").writeFileSync("Google title.txt", data, "utf8");
* done();
* })
* .run(() => {
* console.log("DONE!");
* });
* ```
*
* ##### Example 2: scrap Github's main page title (this time headlessly, so without seeing the browser) and put it into a file:
*
* ```js
* require("web2os")
* .create({
* browser: {show: false}
* })
* .open("https://www.github.com")
* .onWeb((done, error) => {done(document.title);})
* .onOs((done, error, data) => {
* require("fs").writeFileSync("Google title.txt", data, "utf8");
* done();
* })
* .run(() => {
* console.log("DONE!");
* });
* ```
* ##### Example 3: scrap multiple URLs the same way:
*
* ```js
* const web2osInstance = require("web2os").create({});
* const links = [
* "https://www.google.com",
* "https://www.github.com",
* "https://stackoverflow.com/"
* ];
* const file = __dirname + "/titles.txt";
* const fs = require("fs");
* const data = {titles: []};
* links.forEach((link) => {
* web2osInstance
* .open(link)
* .onWeb((done, error) => {
* done(document.title);
* }).onOs((done, error, title) => {
* fs.appendFileSync(file, title+"\n", "utf8");
* done();
* });
* });
* web2osInstance.run(() => {
* fs.readFileSync(file).toString()
* });
* ```
*
* ## 4. API Reference
*
*/
/**
*
* ----
*
* ### `require("web2os").create(optionsParam)`
* @type `{Function}`
* @param `{Object} optionsParam`. Object with the options we want to provide for the current web2os instance.
*
* Accepted parameters are:
*
* - **abortOnRejectedPromise**: `{Boolean}`. Defaults to `true`. This means that `{web2os}` will stop the execution when a promise (from `onWeb` or `onOs` callbacks) is rejected.
*
* - **browser**: `{Object}`. Parameters for the {BrowserWindow} Electron object. For more info, go to: https://github.com/electron/electron/blob/master/docs/api/browser-window.md#class-browserwindow
*
* - **openDevTools**: `{Boolean}`. Specifies if the openDevTools should be opened or not. Default: false.
*
* @returns `{Object} chainable`. Object that has all the methods available for `{web2os}` scraps.
* @description Creates an instance of `{web2os}`, and returns its chainable methods as an `{Object}` that we will call the `chainable`.
*/
function create(optionsParam = {}) {
var deepExtend = require("deep-extend");
/**
*
* ----
*
* ### `web2os`
* @type `{Object}` Object returned by `require("web2os").create(...);`. It represents a `{web2os}` instance.
* @description Object that is going to be returned by the methods it has, in order
* to make them chainable. It also holds the `internals` property, which has some
* useful data for the `{web2os}` instance.
*/
var chainables = {};
/**
*
* ----
*
* ### `web2os#internals`
* @type `{Object}`
* @description Contains some useful data for the `{web2os}` instance.
*/
chainables.internals = {};
/**
*
* ----
*
* ### `web2os#internals.tasks`
* @type `{Array}`
* @description Holds all the tasks (asynchronous functions) that have been requested
* to this `{web2os}` instance. The tasks that are dispatched (or being dispatched) will
* not appear in this array.
*/
chainables.internals.tasks = [];
/**
*
* ----
*
* ### `web2os#internals.options`
* @type `{Object}`
* @description Contains all the parameters of the current `{web2os}` instance.
* This object is deeply extended by the parameter passed to the
* `{web2os}.create(~)` method.
*
* By default, its value is:
*
* ```js
* {
* openDevTools: false,
* browser: {
* // show: false,
* width: 800,
* height: 600,
* webPreferences: {
* nodeIntegration: false
* }
* },
* abortOnRejectedPromise: true
* }
* ```
* Also, you can pass a `onError` function, to handle the errors by default.
*
*
*/
chainables.internals.options = deepExtend({
abortOnRejectedPromise: true,
openDevTools: false,
browser: {
// show: false,
width: 800,
height: 600,
webPreferences: {
nodeIntegration: false
}
}
}, optionsParam.browser || {});
/**
*
* ----
*
* ### `web2os#open`
* @type `{Function}`
* @parameter `{String}` `url`. URL to be opened by the current `{web2os}` instance.
* @returns `{Object}` chainables.
* @description Adds a task that opens the provided URL (it can be a `"file://"` URI too)
*/
chainables.open = function(url) {
chainables.internals.tasks.push({
op: "open",
url
});
return chainables;
};
/**
*
* ----
*
* ### `web2os#onWeb`
* @type `{Function}`
* @param {Function:async || String} fnParam. Asynchronous function (this means that it will
* receive as parameters: {1:Function:resolve}, {2:Function:reject}) that will be applied
* to the Web Environment of the current `{web2os}` instance. Must be resolved or rejected.
* The parameter can also be a string, which should contain the code of an asynchronous
* function.
* @param {Boolean} isSync. Default: false. Set to true to pass simple code, and it will not
* be wrapped in a {Promise}. By default, the fnParam is wrapped in a Promise.
* @returns `{Object}` chainables
* @description Adds a task that executes an asynchronous function in the Web Environment.
* In this environment, you are working with the JavaScript of the browser, and so, you can
* manipulate the DOM, do AJAX calls, or whatever. This function can return, through the
* `resolve` ({1:Function:resolve}) parameter some data, and if the next chained call is an
* `onOs(func)`, the callback it handles will receive this data, appended as a new parameter.
* This way, you can pass data from the Web Environemnt to the OS Environment, and manage it
* locally.
*/
chainables.onWeb = function(fnParam, isSync=false) {
var fn = undefined;
if (typeof fnParam === "string") {
fn = fnParam;
} else Eif (typeof fnParam === "function") {
fn = fnParam.toString();
}
chainables.internals.tasks.push({
op: "onWeb",
isSync,
fn
});
return chainables;
};
/**
*
* ----
*
* ### `web2os#onOs(fn:Function:async)`
* @type `{Function}`
* @param {Function:async} fn. Asynchronous function (this means that it will
* receive as parameters:
* - **param 1:** `{Function:resolve}`
* - **param 2:** `{2:Function:reject}`
* both of which work as a typical JavaScript `Promise`) that will be applied
* to the OS Environment.
* Moreover, if the previous chained call was an `onWeb` call, and
* it was resolved with some data as parameter, a 3rd parameter will be passed to this
* asynchronous function that is going to be executed in our OS Environment.
* That parameter
* will contain the data returned by the previous `onWeb` asynchronous call. Otherwise,
* only the `resolve` and `reject` functions will be passed as parameters.
* @returns `{Object}` `chainables`.
* @description Adds a task that executes an asynchronous function in the OS Environment.
* In this environment, you are working with the JavaScript of Node.js, and so, you can
* access to any npm or node modules available in your current context (to read and write files,
* start processes, manage databases, etc.).
*/
chainables.onOs = function(fn) {
chainables.internals.tasks.push({
op: "onOs",
fn
});
return chainables;
};
/**
*
* ----
*
* ### `web2os#run(doneRun:Function)`
* @type `{Function}`
* @param `{Function}` `doneRun` (Optional). Function that will be executed once the `run`
* function ended.
* @returns `{Object}` `chainables`
* @description This function starts running all the tasks acumulated until it is called.
*/
chainables.run = function(doneRun) {
// Retrieve the necessary objects for Electron to run:
const {
app,
BrowserWindow
} = require("electron");
// Add a 'ready' event listener:
app.on("ready", function() {
// Instantiate the browser:
var win = new BrowserWindow(chainables.internals.options.browser);
chainables.internals.app = app;
chainables.internals.BrowserWindow = BrowserWindow;
chainables.internals.win = win;
// Define abort-task:
function abortTask(error) {
console.log("[web2os] Error arised:", error);
if(typeof chainables.internals.options.onError === "function") {
chainables.internals.options.onError(error);
}
if (chainables.internals.options.abortOnRejectedPromise) {
chainables.internals.tasks = [];
} else {
nextTask.apply(null, Array.prototype.slice.call(arguments));
}
};
// Define next-task function:
function nextTask(data) {
// If there are no more tasks...
if (chainables.internals.tasks.length === 0) {
// Close the window
win.close();
// Finish the task calling the callback passed to `run` method, if any.
return doneRun ? doneRun(data) : undefined;
}
// Retrieve the current task (the first one in the `tasks` FIFO stack)
var curTask = chainables.internals.tasks.shift();
// Do the proper thing for the current task:
switch (curTask.op) {
// When we are opening it:
case "open":
win.loadURL(curTask.url);
Iif (chainables.internals.options.openDevTools) {
win.openDevTools();
}
return nextTask();
// When we are on the web environment
case "onWeb":
if(!curTask.isSync) {
return win.webContents.executeJavaScript("new Promise(" + curTask.fn + ")").then(nextTask).catch(abortTask);
} else {
return win.webContents.executeJavaScript(curTask.fn).then(nextTask).catch(abortTask);
}
// When we are on the os environment:
case "onOs":
return new Promise(function(done, error) {
curTask.fn.call(chainables, done, error, data ? data : undefined);
}).then(nextTask).catch(abortTask);
}
};
// Start dispatching the tasks
nextTask();
});
return chainables;
};
return chainables;
};
module.exports = {
create
};
/**
*
*
*
* ## 5. Tests, coverage and documentation generation
*
* #### 5.1. Tests and coverage
*
* You can make the tests pass and generate automatically the coverage by typing:
*
* ~$ `npm run test`
*
* You can clean the generated coverage reports by typing:
*
* ~$ `npm run clean`
*
* #### 5.2. Documentation
*
* You can regenerate the documentation typing:
*
* ~$ `npm run docs`
*
* The generated docs will be dumped directly from `src/web2os.js` to `README.md` file, in Markdown format, and from javadoc comments.
*
* ## 6. Conclusion
*
* This has turned into a promising clean API to do web-scraping comfortably, and in a fast, reliable way, because you can attack to applications that are loaded by client-side frameworks like Angular or React, which require a DOM processing by the browser previously to proceed to the scrap.
*
* Consider the fact that you can:
*
* 1. Use database NPM modules to insert the data that you collect from the web directly to your database, you can even use ORMs to do it effortlessly.
*
* 2. See the current progression of the scraps.
*
* 3. Do multiple simultaneous scraps in the same script even.
*
* 4. Automate tests or demonstration of products.
*
* 5. Take profit of all the Node.js modules to do your scraps, tests or whatever.
*
* 6. Scrap the web asynchronously, with a browser environment executing all the JavaScript needed to reach the data you want.
*
* But also, you can see how a Chromium browser does all of this in live, interact with it by hand in the moment, and it is very simple to use because you only have to use the technologies you already know, the JavaScript of the browser and Node.js!
*
* Happy scraping!
*
* *Take into account that I am the developer of the NaturalScript programming language, and I have been working on Open Source projects since I know that Microsoft is not available to give 5.000 dollars to programming languages that come nearer to natural language, and they do not even want to give explanations about their reasons... Well, Microsoft, Google, Intel and Oracle, neither of them are capable to answer a request by a simple novice developer who is giving big part of its time to the Open Source community.*
*
*
*
*
*/ |