forked from casperjs/casperjs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
2971 lines (2547 loc) · 104 KB
/
index.html
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html><html><head>
<meta charset="utf-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="robots" content="index, follow">
<link rel="canonical" href="http://casperjs.org/">
<title>CasperJS, a navigation scripting and testing utility for PhantomJS</title>
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="keywords" content="phantomjs, phantom, casperjs, casper, browser, javascript, navigation, scripting, test, testing, scrape, scraping">
<meta name="description" content="CasperJS is a browser navigation scripting & testing utility written in Javascript on top of PhantomJS.">
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Asap:400,700,400italic,700italic&subset=latin,latin-ext">
<link rel="stylesheet" href="prettify/prettify.css">
<link rel="stylesheet" href="css/casper.css">
<link rel="shortcut icon" href="favicon.ico">
</head>
<body data-spy="scroll" data-offset="50">
<a href="http://github.com/n1k0/casperjs" class="contribute">
<img src="https://a248.e.akamai.net/assets.github.com/img/30f550e0d38ceb6ef5b81500c64d970b7fb0f028/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6f72616e67655f6666373630302e706e67" alt="Fork me on GitHub">
</a>
<div class="navbar navbar-fixed-top" data-spy="scroll" id="topbar">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">CasperJS</a>
<div class="nav-collapse">
<ul class="nav">
<li><a href="#installation">Install</a></li>
<li><a href="#quickstart">Quickstart</a></li>
<li><a href="#apidoc">API</a></li>
<li><a href="#cli"><acronym title="Command Line Interface">CLI</acronym></a></li>
<li><a href="#events-filters">Events</a></li>
<li><a href="#client-side-utils">Client-side utils</a></li>
<li><a href="#logging">Logging</a></li>
<li><a href="#extending">Extending</a></li>
<li><a href="#testing">Testing</a></li>
<li><a href="#faq"><acronym title="Frequently Asked Questions">FAQ</acronym></a></li>
<li><a href="#download">Download</a></li>
<li><a href="https://groups.google.com/forum/#!forum/casperjs">Support</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container" id="overview">
<div class="content">
<section id="about"><div class="page-header">
<h1>
CasperJS
<small>
is a navigation scripting & testing utility for
<a href="http://phantomjs.org/">PhantomJS</a>, written in
Javascript
</small>
</h1>
</div>
<div class="row">
<div class="span8">
<article class="alert just-informative">
<p>
CasperJS is an open source <strong>navigation scripting &
testing utility</strong> written in Javascript and based on
<a href="http://www.phantomjs.org/">PhantomJS</a> — the scriptable
headless <a href="http://www.webkit.org/">WebKit</a>
engine. It eases the process of <strong>defining a full navigation
scenario</strong> and provides useful <strong>high-level functions,
methods & syntactic sugar</strong> for doing common tasks such as:
</p>
<ul>
<li>defining & ordering browsing navigation steps</li>
<li>filling & submitting forms</li>
<li>clicking & following links</li>
<li>capturing screenshots of a page (or part of it)</li>
<li>making assertions on remote DOM</li>
<li>logging events</li>
<li>downloading resources, including binary ones</li>
<li>writing functional test suites, saving results as JUnit XML</li>
<li>scraping Web contents</li>
</ul>
</article>
</div>
<aside class="span4 download">
<h1>Download</h1>
<p>
CasperJS latest released version is <strong>0.6.7</strong>,<br>
see the <a href="https://github.com/n1k0/casperjs/blob/master/CHANGELOG.md#files">CHANGELOG</a>.
</p>
<div class="dl-links">
<p>
<a href="https://github.com/n1k0/casperjs/zipball/0.6.7" class="btn btn-success">
Download as .zip archive
</a>
</p>
<p>
<a href="https://github.com/n1k0/casperjs/tarball/0.6.7" class="btn btn-success">
Download as .tar.gz archive
</a>
</p>
</div>
<p>
Or download CasperJS at <a href="http://jspkg.com/packages/casperjs">jspkg.com</a>
</p>
<p class="social center">
<a href="http://flattr.com/thing/586241/CasperJS-a-navigation-scripting-and-testing-utility-for-PhantomJS" target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
<a href="https://twitter.com/share" class="twitter-share-button" data-url="http://casperjs.org/" data-via="casperjs_org" data-hashtags="casperjs">Tweet</a>
</p>
</aside>
</div>
<div class="row">
<div class="span12">
<blockquote>
<q>In case you haven’t seen CasperJS yet, go and take a look, it’s an <em>extremely</em> useful companion to PhantomJS.</q>
<cite><a href="http://ariya.ofilabs.com/2012/03/phantomjs-and-travis-ci.html">Ariya Hidayat</a>, creator of PhantomJS</cite>
</blockquote>
</div>
</div>
<div class="row">
<article class="span5">
<h1>Get started</h1>
<p>
Browse the <a href="https://github.com/n1k0/casperjs/tree/master/samples">sample
examples repository</a>.
Get <a href="https://groups.google.com/forum/#!forum/casperjs">support</a>.
Checkout the <a href="https://github.com/n1k0/casperjs">code at Github</a>.
Don't hesitate to fork and send a pull request for any cool example
of yours as well! Troubleshooting? Read the <a href="#faq">FAQ</a> or
<a href="https://github.com/n1k0/casperjs/issues">open an issue</a>. Follow
<a href="https://twitter.com/casperjs_org">@casperjs_org</a> on Twitter.
</p>
</article>
<div class="span7 demo">
<p class="center"><img alt="" src="images/demo.png"></p>
</div>
</div></section>
<section id="installation">
<div class="page-header">
<h1>Installation</h1>
</div>
<div id="installation_contents"><p><a href="http://phantomjs.org/">PhantomJS</a> >= 1.3 must be installed (1.5.0 highly
recommended). Check out <a href="http://code.google.com/p/phantomjs/wiki/Installation">PhantomJS' installation
instructions</a>, and:
</p>
<ul>
<li><p>Ensure to always install the latest available version of PhantomJS, and prefer
static builds over other package installation methods</p>
</li>
<li><p><span class="label label-warning">Ubuntu users</span> Double check the
version of PhantomJS provided by your apt repository. Often, only PhantomJS
1.2 is provided.</p>
</li>
</ul>
<p>Once PhantomJS's installed on your machine, you should obtain something like this:
</p>
<pre><code>$ phantomjs --version
1.5.0</code></pre>
<p>Now just follow these instructions:
</p>
<pre><code>$ git clone git://github.com/n1k0/casperjs.git
$ cd casperjs
$ git checkout tags/0.6.7
$ ln -sf `pwd`/bin/casperjs /usr/local/bin/casperjs</code></pre>
<p>So now you should get something like this:
</p>
<pre><code>$ casperjs --version
0.6.7</code></pre>
<p>You are now ready to write your first script!
</p>
<p><span class="label label-info">Note</span> The casperjs executable is written
in <a href="http://python.org/">Python</a>, so you can also run it using the python command:
</p>
<pre><code>$ python /path/to/casperjs/bin/casperjs
CasperJS version 0.6.7 at /Users/niko/casperjs
Usage: casperjs script.(js|coffee) [options...]
Read the docs http://casperjs.org/</code></pre>
<p><span class="label label-info">Note</span> If for some reason you don't have
access to Python, please check this FAQ entry.
</p>
</div>
</section>
<section id="quickstart">
<div class="page-header">
<h1>Quickstart</h1>
</div>
<div id="quickstart_contents"><p>In the following example, we'll query google for two terms consecutively,
<em>"capserjs"</em> and <em>"phantomjs"</em>, aggregate the result links in a standard <code>Array</code>
and output the result to the console.
</p>
<p>Fire up your favorite editor and save the javascript code below in a
<code>googlelinks.js</code> file:
</p>
<pre><code class="javascript">var links = [];
var casper = require('casper').create();
function getLinks() {
var links = document.querySelectorAll('h3.r a');
return Array.prototype.map.call(links, function(e) {
return e.getAttribute('href')
});
}
casper.start('http://google.fr/', function() {
// search for 'casperjs' from google form
this.fill('form[action="/search"]', { q: 'casperjs' }, true);
});
casper.then(function() {
// aggregate results for the 'casperjs' search
links = this.evaluate(getLinks);
// now search for 'phantomjs' by filling the form again
this.fill('form[action="/search"]', { q: 'phantomjs' }, true);
});
casper.then(function() {
// aggregate results for the 'phantomjs' search
links = links.concat(this.evaluate(getLinks));
});
casper.run(function() {
// echo results in some pretty fashion
this.echo(links.length + ' links found:');
this.echo(' - ' + links.join('\n - ')).exit();
});</code></pre>
<p>Run it:
</p>
<pre><code>$ casperjs googlelinks.js
20 links found:
- https://github.com/n1k0/casperjs
- https://github.com/n1k0/casperjs/issues/2
- https://github.com/n1k0/casperjs/tree/master/samples
- https://github.com/n1k0/casperjs/commits/master/
- http://www.facebook.com/people/Casper-Js/100000337260665
- http://www.facebook.com/public/Casper-Js
- http://hashtags.org/tag/CasperJS/
- http://www.zerotohundred.com/newforums/members/casper-js.html
- http://www.yellowpages.com/casper-wy/j-s-enterprises
- http://local.trib.com/casper+wy/j+s+chinese+restaurant.zq.html
- http://www.phantomjs.org/
- http://code.google.com/p/phantomjs/
- http://code.google.com/p/phantomjs/wiki/QuickStart
- http://svay.com/blog/index/post/2011/08/31/Paris-JS-10-%3A-Introduction-%C3%A0-PhantomJS
- https://github.com/ariya/phantomjs
- http://dailyjs.com/2011/01/28/phantoms/
- http://css.dzone.com/articles/phantom-js-alternative
- http://pilvee.com/blog/tag/phantom-js/
- http://ariya.blogspot.com/2011/01/phantomjs-minimalistic-headless-webkit.html
- http://www.readwriteweb.com/hack/2011/03/phantomjs-the-power-of-webkit.php</code></pre>
<h3>CoffeeScript</h3>
<p>You can also write Casper scripts using the <a href="http://jashkenas.github.com/coffee-script/">CoffeeScript
syntax</a>:
</p>
<pre><code class="coffeescript">getLinks = ->
links = document.querySelectorAll "h3.r a"
Array::map.call links, (e) -> e.getAttribute "href"
links = []
casper = require('casper').create()
casper.start "http://google.fr/", ->
# search for 'casperjs' from google form
@fill "form[action='/search']", q: "casperjs", true
casper.then ->
# aggregate results for the 'casperjs' search
links = @evaluate getLinks
# search for 'phantomjs' from google form
@fill "form[action='/search']", q: "phantomjs", true
casper.then ->
# concat results for the 'phantomjs' search
links = links.concat @evaluate(getLinks)
casper.run ->
# display results
@echo links.length + " links found:"
@echo(" - " + links.join("\n - ")).exit()</code></pre>
<p>Just remember to suffix your script with the <code>.coffee</code>extension.
</p>
</div>
</section>
<section id="apidoc">
<div class="page-header">
<h1>API Documentation</h1>
</div>
<div class="row">
<div class="span9" id="apidoc_contents"><p>Casper source code is quite heavily documented using <code>jsdoc</code>, but below
you'll find the whole API documentation with sample code.
</p>
<h2>The Casper class</h2>
<p>The most easiest way to instantiate a casper instance is to use the
module <code>create()</code> method:
</p>
<pre><code class="javascript">var casper = require('casper').create();</code></pre>
<p>But you can also retrieve the main Function and instantiate it by
yourself:
</p>
<pre><code class="javascript">var casper = new require('casper').Casper();</code></pre>
<h3 id="phantom_Casper_options"><code>Casper([Object options])</code></h3>
<p>Both the <code>Casper</code> constructor and the <code>create()</code> function accept a
single <code>options</code> argument which is a standard javascript object:
</p>
<pre><code class="javascript">var casper = require('casper').create({
loadImages: false,
loadPlugins: false
});</code></pre>
<h2>Casper options</h2>
<p>All the available options are detailed below:
</p>
<table class="table table-striped table-condensed" caption="Casper options">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clientScripts</code></td>
<td><code>Array</code></td>
<td><code>[]</code></td>
<td>
A collection of script filepaths to include to every
page loaded
</td>
</tr>
<tr>
<td><code>faultTolerant</code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>
Catch and log exceptions when executing steps in a
non-blocking fashion
</td>
</tr>
<tr>
<td><code>httpStatusHandlers</code></td>
<td><code>Object</code></td>
<td><code>{}</code></td>
<td>
A javascript Object containing functions to call when a
requested resource has a given HTTP status code. A
<a href="https://github.com/n1k0/casperjs/blob/master/samples/statushandlers.js">dedicated
sample</a> is provided as an example.
</td>
</tr>
<tr>
<td><code>logLevel</code></td>
<td><code>String</code></td>
<td><code>"error"</code></td>
<td>
Logging level (see the <a href="#logging">logging
section</a> for more information)
</td>
</tr>
<tr>
<td><code>onAlert</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
A function to be called when a javascript <code>alert()</code>
is triggered
</td>
</tr>
<tr>
<td><code>onDie</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
A function to be called when <code>Casper#die()</code>
is called
</td>
</tr>
<tr>
<td><code>onError</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
A function to be called when an <code>"error"</code>
level event occurs
</td>
</tr>
<tr>
<td><code>onLoadError</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
A function to be called when a requested resource cannot
be loaded
</td>
</tr>
<tr>
<td><code>onPageInitialized</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>A function to be called after <code>WebPage</code>
instance has been initialized</td>
</tr>
<tr>
<td><code>onResourceReceived</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
Proxy method for PhantomJS' <code>WebPage#onResourceReceived()</code>
callback, but the current Casper instance is passed as
first argument.
</td>
</tr>
<tr>
<td><code>onResourceRequested</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>
Proxy method for PhantomJS' <code>WebPage#onResourceRequested()</code>
callback, but the current Casper instance is passed as
first argument.
</td>
</tr>
<tr>
<td><code>onStepComplete</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td>A function to be executed when a step function execution
is finished.</td>
</tr>
<tr>
<td><code>onStepTimeout</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td> A function to be executed when a step function
execution time exceeds the value of the <code>stepTimeout</code>
option, if any has been set. </td>
</tr>
<tr>
<td><code>onTimeout</code></td>
<td><code>Function</code></td>
<td><code>null</code></td>
<td> A function to be executed when script execution time
exceeds the value of the <code>timeout</code> option, if
any has been set. </td>
</tr>
<tr>
<td><code>page</code></td>
<td><code>WebPage</code></td>
<td><code>null</code></td>
<td>An existing <code>WebPage</code> instance</td>
</tr>
<tr>
<td><code>pageSettings</code></td>
<td><code>Object</code></td>
<td><code>{}</code></td>
<td>
<p>
PhantomJS's <code>WebPage</code> settings object.
<a href="http://code.google.com/p/phantomjs/wiki/Interface#settings_(object)">Available settings</a> are:
</p>
<ul>
<li>
<code>javascriptEnabled</code> defines whether to execute the
script in the page or not (default to true)
</li>
<li>
<code>loadImages</code> defines whether to load the inlined images
or not
</li>
<li>
<code>loadPlugins</code> defines whether to load NPAPI plugins
(Flash, Silverlight, ...) or not
</li>
<li>
<code>localToRemoteUrlAccessEnabled</code> defines whether local
resource (e.g. from file) can access remote URLs or not (default to false)
</li>
<li>
<code>userAgent</code> defines the user agent sent to server when
the web page requests resources.
</li>
<li>
<code>userName</code> sets the user name used for HTTP
authentication
</li>
<li>
<code>password</code> sets the password used for HTTP
authentication
</li>
<li>
<code>XSSAuditingEnabled</code> defines whether load requests
should be monitored for cross-site scripting attempts (default to
false)
</li>
</ul>
</td>
</tr>
<tr>
<td><code>stepTimeout</code></td>
<td><code>Number</code></td>
<td><code>null</code></td>
<td> Max step timeout in milliseconds; when set, every
defined step function will have to execute before this
timeout value has been reached. You can define the <code>onStepTimeout()</code>
callback to catch such a case. By default, the script will
<code>die()</code> with an error message. </td>
</tr>
<tr>
<td><code>timeout</code></td>
<td><code>Number</code></td>
<td><code>null</code></td>
<td>Max timeout in milliseconds</td>
</tr>
<tr>
<td><code>verbose</code></td>
<td><code>Boolean</code></td>
<td><code>false</code></td>
<td>Realtime output of log messages</td>
</tr>
<tr>
<td><code>viewportSize</code></td>
<td><code>Object</code></td>
<td><code>null</code></td>
<td>Viewport size, eg. <code>{width: 800, height: 600}</code></td>
</tr>
</tbody>
</table>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">var casper = require('casper').create({
clientScripts: [
'includes/jquery.js', // These two scripts will be injected in remote
'includes/underscore.js' // DOM on every request
],
logLevel: "info", // Only "info" level messages will be logged
onError: function(self, m) { // Any "error" level message will be written
console.log('FATAL:' + m); // on the console output and PhantomJS will
self.exit(); // terminate
},
pageSettings: {
loadImages: false, // The WebPage instance used by Casper will
loadPlugins: false // use these settings
}
});</code></pre>
<p>But no worry, usually you'll just need to instantiate Casper using
<code>require('casper').create()</code>.
</p>
<h3 id="phantom_Casper_back"><code>Casper#back()</code></h3>
<p>Moves back a step in browser's history.
</p>
<pre><code class="javascript">casper.start('http://foo.bar/1')
casper.thenOpen('http://foo.bar/2');
casper.thenOpen('http://foo.bar/3');
casper.back();
casper.run(function() {
console.log(this.getCurrentUrl()); // 'http://foo.bar/2'
});</code></pre>
<p>Also have a look at <a href="#phantom_Casper_forward"><code>Casper.forward()</code></a>.
</p>
<h3 id="phantom_Casper_base64encode"><code>Casper#base64encode(String url [, String method, Object data])</code></h3>
<p>Encodes a resource using the base64 algorithm synchronously using
client-side XMLHttpRequest.
</p>
<p><span class="label label-info">Note</span> We cannot use <code>window.btoa()</code>
because it fails miserably in the version of WebKit shipping with PhantomJS.
</p>
<p>Example: retrieving google logo image encoded in base64:
</p>
<pre><code class="javascript">var base64logo = null;
casper.start('http://www.google.fr/', function() {
base64logo = this.base64encode('http://www.google.fr/images/srpr/logo3w.png');
});
casper.run(function() {
this.echo(base64logo).exit();
});</code></pre>
<p>You can also perform an HTTP POST request to retrieve the contents to
encode:
</p>
<pre><code class="javascript">var base46contents = null;
casper.start('http://domain.tld/download.html', function() {
base46contents = this.base64encode('http://domain.tld/', 'POST', {
param1: 'foo',
param2: 'bar'
});
});</code></pre>
<pre><code class="javascript">casper.run(function() {
this.echo(base46contents).exit();
});</code></pre>
<h3 id="phantom_Casper_click"><code>Casper#click(String selector)</code></h3>
<p>Performs a click on the element matching the provided CSS3 selector. The method tries two strategies sequentially:
</p>
<ol>
<li>trying to trigger a MouseEvent in Javascript</li>
<li>using native QtWebKit event if the previous attempt failed</li>
</ol>
<p>Example:
</p>
<pre><code class="javascript">casper.start('http://google.fr/');
casper.thenEvaluate(function(term) {
document.querySelector('input[name="q"]').setAttribute('value', term);
document.querySelector('form[name="f"]').submit();
}, { term: 'CasperJS' });
casper.then(function() {
// Click on 1st result link
this.click('h3.r a');
});
casper.then(function() {
console.log('clicked ok, new location is ' + this.getCurrentUrl());
});
casper.run();</code></pre>
<p><span class="label label-info">Hint</span> If you want the mouse to click a
given point within the viewport area, you can use the <code>mouse</code> property of the
<code>Casper</code> instance:
</p>
<pre><code class="javascript">casper.then(function() {
this.mouse.click(150, 200);
});</code></pre>
<h3 id="phantom_Casper_capture"><code>Casper#capture(String targetFilepath, Object clipRect)</code></h3>
<p>Proxy method for PhantomJS' <code>WebPage#render</code>. Adds a clipRect parameter
for automatically setting page clipRect setting values and sets it back
once done.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.capture('google.png', {
top: 100,
left: 100,
width: 500,
height: 400
});
});
casper.run();</code></pre>
<h3 id="phantom_Casper_captureSelector"><code>Casper#captureSelector(String targetFile, String selector)</code></h3>
<p>Captures the page area containing the provided selector.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.weather.com/', function() {
this.captureSelector('weather.png', '.twc-story-block');
});
casper.run();</code></pre>
<h3 id="phantom_Casper_clear"><code>Casper#clear()</code></h3>
<p>Clears the current page execution environment context. Useful to avoid
having previously loaded DOM contents being still active.
</p>
<p>Think of it as a way to stop javascript execution within the remote DOM
environment.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.clear(); // javascript execution in this page has been stopped
});
casper.then(function() {
// ...
});
casper.run();</code></pre>
<p><span class="label label-info">Note</span> This method has been added in 0.6.5.
</p>
<h3 id="phantom_Casper_debugHTML"><code>Casper#debugHTML()</code></h3>
<p>Logs the HTML code of the current page directly to the standard output,
for debugging purpose.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.debugHTML();
});
casper.run();</code></pre>
<h3 id="phantom_Casper_debugPage"><code>Casper#debugPage()</code></h3>
<p>Logs the textual contents of the current page directly to the standard
output, for debugging purpose.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.debugPage();
});
casper.run();</code></pre>
<h3 id="phantom_Casper_die"><code>Casper#die(String message[, int status])</code></h3>
<p>Exits phantom with a logged error message and an optional exit status
code.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.die("Fail.", 1);
});
casper.run();</code></pre>
<h3 id="phantom_Casper_download"><code>Casper#download(String url, String target)</code></h3>
<p>Saves a remote resource onto the filesystem.
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
var logoUrl = 'http://www.google.fr/intl/fr/about/corporate/company/';
this.download(logoUrl, 'google_company.html');
});
casper.run(function() {
this.echo('Done.').exit();
});</code></pre>
<h3 id="phantom_Casper_each"><code>Casper#each(Array array, Function fn)</code></h3>
<p>Iterates over provided array items and execute a callback.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">var links = [
'http://google.com/',
'http://yahoo.com/',
'http://bing.com/'
];
casper.start().each(links, function(self, link) {
self.thenOpen(link, function() {
this.echo(this.getTitle());
});
});
casper.run();</code></pre>
<p><span class="label label-info">Hint</span> Have a look at the
<a href="https://github.com/n1k0/casperjs/blob/master/samples/googlematch.js">googlematch.js</a>
sample script for concrete usecase.
</p>
<h3 id="phantom_Casper_echo"><code>Casper#echo(String message[, String style])</code></h3>
<p>Prints something to stdout, optionally with some fancy color (see the
<a href="#colorizer"><code>Colorizer</code></a> section of this document for more
information).
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.echo('Page title is: ' + this.evaluate(function() {
return document.title;
}), 'INFO'); // Will be printed in green on the console
});
casper.run();</code></pre>
<h3 id="phantom_Casper_evaluate"><code>Casper#evaluate(function fn[, Object replacements])</code></h3>
<p>Evaluates an expression in the page context, a bit like what PhantomJS'
<code>WebPage#evaluate</code> does, but can also handle passed arguments if you
define their context:
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.evaluate(function(username, password) {
document.querySelector('#username').value = username;
document.querySelector('#password').value = password;
document.querySelector('#submit').click();
}, {
username: 'sheldon.cooper',
password: 'b4z1ng4'
});</code></pre>
<p><span class="label label-info">Note</span> For filling and submitting forms, rather use the
<a href="#phantom_Casper_fill"><code>Casper#fill()</code></a> method.
</p>
<h3 id="phantom_Casper_evaluateOrDie"><code>Casper#evaluateOrDie(function fn[, String message])</code></h3>
<p>Evaluates an expression within the current page DOM and <code>die()</code> if it
returns anything but <code>true</code>.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://foo.bar/home', function() {
this.evaluateOrDie(function() {
return /logged in/.match(document.title);
}, 'not authenticated');
});
casper.run();</code></pre>
<h3 id="phantom_Casper_exit"><code>Casper#exit([int status])</code></h3>
<p>Exits PhantomJS with an optional exit status code.
</p>
<h3 id="phantom_Casper_exists"><code>Casper#exists(String selector)</code></h3>
<p>Checks if any element within remote DOM matches the provided CSS3
selector.
</p>
<pre><code class="javascript">casper.start('http://foo.bar/home', function() {
if (this.exists('#my_super_id')) {
this.echo('found #my_super_id', 'INFO');
} else {
this.echo('#my_super_id not found', 'ERROR');
}
});
casper.run();</code></pre>
<h3 id="phantom_Casper_fetchText"><code>Casper#fetchText(String selector)</code></h3>
<p>Retrieves text contents matching a given CSS3 selector. If you provide one matching
more than one element, their textual contents will be concatenated.
</p>
<pre><code class="javascript">casper.start('http://google.com/search?q=foo', function() {
this.echo(this.fetchText('h3'));
}).run();</code></pre>
<h3 id="phantom_Casper_forward"><code>Casper#forward()</code></h3>
<p>Moves a step forward in browser's history.
</p>
<pre><code class="javascript">casper.start('http://foo.bar/1')
casper.thenOpen('http://foo.bar/2');
casper.thenOpen('http://foo.bar/3');
casper.back(); // http://foo.bar/2
casper.back(); // http://foo.bar/1
casper.forward(); // http://foo.bar/2
casper.run();</code></pre>
<p>Also have a look at <a href="#phantom_Casper_back"><code>Casper.back()</code></a>.
</p>
<h3 id="phantom_Casper_log"><code>Casper#log(String message[, String level, String space])</code></h3>
<p>Logs a message with an optional level in an optional space. Available
levels are <code>debug</code>, <code>info</code>, <code>warning</code> and <code>error</code>. A space is a kind of
namespace you can set for filtering your logs. By default, Casper logs
messages in two distinct spaces: <code>phantom</code> and <code>remote</code>, to distinguish
what happens in the PhantomJS environment from the remote one.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.log("I'm logging an error", "error");
});
casper.run();</code></pre>
<h3 id="phantom_Casper_fill"><code>Casper#fill(String selector, Object values[, Boolean submit])</code></h3>
<p>Fills the fields of a form with given values and optionally submits it.
</p>
<p>Example with this sample html form:
</p>
<pre><code class="html"><form action="/contact" id="contact-form" enctype="multipart/form-data">
<input type="text" name="subject"/>
<textearea name="content"></textearea>
<input type="radio" name="civility" value="Mr"/> Mr
<input type="radio" name="civility" value="Mrs"/> Mrs
<input type="text" name="name"/>
<input type="email" name="email"/>
<input type="file" name="attachment"/>
<input type="checkbox" name="cc"/> Receive a copy
<input type="submit"/>
</form></code></pre>
<p>A script to fill and submit this form:
</p>
<pre><code class="javascript">casper.start('http://some.tld/contact.form', function() {
this.fill('form#contact-form', {
'subject': 'I am watching you',
'content': 'So be careful.',
'civility': 'Mr',
'name': 'Chuck Norris',
'email': 'chuck@norris.com',
'cc': true,
'attachment': '/Users/chuck/roundhousekick.doc'
}, true);
});
casper.then(function() {
this.evaluateOrDie(function() {
return /message sent/.test(document.body.innerText);
}, 'sending message failed');
});
casper.run(function() {
this.echo('message sent').exit();
});</code></pre>
<p>Please Don't use CasperJS nor PhantomJS to send spam, or I'll be calling
the Chuck. More seriously, please just don't.
</p>
<h3 id="phantom_Casper_getCurrentUrl"><code>Casper#getCurrentUrl()</code></h3>
<p>Retrieves current page URL. <span class="label label-info">Note</span> the url
will be url-decoded.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.echo(this.getCurrentUrl()); // "http://www.google.fr/"
});
casper.run();</code></pre>
<h3 id="phantom_Casper_getGlobal"><code>Casper#getGlobal(String name)</code></h3>
<p>Retrieves a global variable value within the remote DOM environment by
its name.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.echo(this.getGlobal('innerWidth')); // 1024
});
casper.run();</code></pre>
<h3 id="phantom_Casper_getTitle"><code>Casper#getTitle()</code></h3>
<p>Retrieves current page title.
</p>
<p><strong>Example:</strong>
</p>
<pre><code class="javascript">casper.start('http://www.google.fr/', function() {
this.echo(this.getTitle()); // "Google"
});
casper.run();</code></pre>
<h3 id="phantom_Casper_mouseClick"><code>Casper#mouseClick(String selector)</code></h3>
<p><span class="label label-warning">Warning</span> This method has been deprecated since 0.6. Use
<a href="#phantom_Casper_click"><code>Casper.click()</code></a> instead.
</p>