git.iko.soy/rowtype-yoga/purescript-lunapark
on main help sign in
prepare release
738a9fbMaxim Zimaliev
.travis.ymlnew file+15
@@ -0,0 +1,15 @@
1+language: node_js
2+dist: trusty
3+sudo: required
4+node_js: stable
5+install:
6+ - npm install
7+ - npm install -g bower
8+ - bower install --production
9+script:
10+ - npm run -s build
11+after_success:
12+- >-
13+ test $TRAVIS_TAG &&
14+ echo $GITHUB_TOKEN | pulp login &&
15+ echo y | pulp publish --no-push
LICENSEnew file+201
@@ -0,0 +1,201 @@
1+ Apache License
2+ Version 2.0, January 2004
3+ http://www.apache.org/licenses/
4+
5+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+ 1. Definitions.
8+
9+ "License" shall mean the terms and conditions for use, reproduction,
10+ and distribution as defined by Sections 1 through 9 of this document.
11+
12+ "Licensor" shall mean the copyright owner or entity authorized by
13+ the copyright owner that is granting the License.
14+
15+ "Legal Entity" shall mean the union of the acting entity and all
16+ other entities that control, are controlled by, or are under common
17+ control with that entity. For the purposes of this definition,
18+ "control" means (i) the power, direct or indirect, to cause the
19+ direction or management of such entity, whether by contract or
20+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+ outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+ "You" (or "Your") shall mean an individual or Legal Entity
24+ exercising permissions granted by this License.
25+
26+ "Source" form shall mean the preferred form for making modifications,
27+ including but not limited to software source code, documentation
28+ source, and configuration files.
29+
30+ "Object" form shall mean any form resulting from mechanical
31+ transformation or translation of a Source form, including but
32+ not limited to compiled object code, generated documentation,
33+ and conversions to other media types.
34+
35+ "Work" shall mean the work of authorship, whether in Source or
36+ Object form, made available under the License, as indicated by a
37+ copyright notice that is included in or attached to the work
38+ (an example is provided in the Appendix below).
39+
40+ "Derivative Works" shall mean any work, whether in Source or Object
41+ form, that is based on (or derived from) the Work and for which the
42+ editorial revisions, annotations, elaborations, or other modifications
43+ represent, as a whole, an original work of authorship. For the purposes
44+ of this License, Derivative Works shall not include works that remain
45+ separable from, or merely link (or bind by name) to the interfaces of,
46+ the Work and Derivative Works thereof.
47+
48+ "Contribution" shall mean any work of authorship, including
49+ the original version of the Work and any modifications or additions
50+ to that Work or Derivative Works thereof, that is intentionally
51+ submitted to Licensor for inclusion in the Work by the copyright owner
52+ or by an individual or Legal Entity authorized to submit on behalf of
53+ the copyright owner. For the purposes of this definition, "submitted"
54+ means any form of electronic, verbal, or written communication sent
55+ to the Licensor or its representatives, including but not limited to
56+ communication on electronic mailing lists, source code control systems,
57+ and issue tracking systems that are managed by, or on behalf of, the
58+ Licensor for the purpose of discussing and improving the Work, but
59+ excluding communication that is conspicuously marked or otherwise
60+ designated in writing by the copyright owner as "Not a Contribution."
61+
62+ "Contributor" shall mean Licensor and any individual or Legal Entity
63+ on behalf of whom a Contribution has been received by Licensor and
64+ subsequently incorporated within the Work.
65+
66+ 2. Grant of Copyright License. Subject to the terms and conditions of
67+ this License, each Contributor hereby grants to You a perpetual,
68+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+ copyright license to reproduce, prepare Derivative Works of,
70+ publicly display, publicly perform, sublicense, and distribute the
71+ Work and such Derivative Works in Source or Object form.
72+
73+ 3. Grant of Patent License. Subject to the terms and conditions of
74+ this License, each Contributor hereby grants to You a perpetual,
75+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+ (except as stated in this section) patent license to make, have made,
77+ use, offer to sell, sell, import, and otherwise transfer the Work,
78+ where such license applies only to those patent claims licensable
79+ by such Contributor that are necessarily infringed by their
80+ Contribution(s) alone or by combination of their Contribution(s)
81+ with the Work to which such Contribution(s) was submitted. If You
82+ institute patent litigation against any entity (including a
83+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84+ or a Contribution incorporated within the Work constitutes direct
85+ or contributory patent infringement, then any patent licenses
86+ granted to You under this License for that Work shall terminate
87+ as of the date such litigation is filed.
88+
89+ 4. Redistribution. You may reproduce and distribute copies of the
90+ Work or Derivative Works thereof in any medium, with or without
91+ modifications, and in Source or Object form, provided that You
92+ meet the following conditions:
93+
94+ (a) You must give any other recipients of the Work or
95+ Derivative Works a copy of this License; and
96+
97+ (b) You must cause any modified files to carry prominent notices
98+ stating that You changed the files; and
99+
100+ (c) You must retain, in the Source form of any Derivative Works
101+ that You distribute, all copyright, patent, trademark, and
102+ attribution notices from the Source form of the Work,
103+ excluding those notices that do not pertain to any part of
104+ the Derivative Works; and
105+
106+ (d) If the Work includes a "NOTICE" text file as part of its
107+ distribution, then any Derivative Works that You distribute must
108+ include a readable copy of the attribution notices contained
109+ within such NOTICE file, excluding those notices that do not
110+ pertain to any part of the Derivative Works, in at least one
111+ of the following places: within a NOTICE text file distributed
112+ as part of the Derivative Works; within the Source form or
113+ documentation, if provided along with the Derivative Works; or,
114+ within a display generated by the Derivative Works, if and
115+ wherever such third-party notices normally appear. The contents
116+ of the NOTICE file are for informational purposes only and
117+ do not modify the License. You may add Your own attribution
118+ notices within Derivative Works that You distribute, alongside
119+ or as an addendum to the NOTICE text from the Work, provided
120+ that such additional attribution notices cannot be construed
121+ as modifying the License.
122+
123+ You may add Your own copyright statement to Your modifications and
124+ may provide additional or different license terms and conditions
125+ for use, reproduction, or distribution of Your modifications, or
126+ for any such Derivative Works as a whole, provided Your use,
127+ reproduction, and distribution of the Work otherwise complies with
128+ the conditions stated in this License.
129+
130+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131+ any Contribution intentionally submitted for inclusion in the Work
132+ by You to the Licensor shall be under the terms and conditions of
133+ this License, without any additional terms or conditions.
134+ Notwithstanding the above, nothing herein shall supersede or modify
135+ the terms of any separate license agreement you may have executed
136+ with Licensor regarding such Contributions.
137+
138+ 6. Trademarks. This License does not grant permission to use the trade
139+ names, trademarks, service marks, or product names of the Licensor,
140+ except as required for reasonable and customary use in describing the
141+ origin of the Work and reproducing the content of the NOTICE file.
142+
143+ 7. Disclaimer of Warranty. Unless required by applicable law or
144+ agreed to in writing, Licensor provides the Work (and each
145+ Contributor provides its Contributions) on an "AS IS" BASIS,
146+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+ implied, including, without limitation, any warranties or conditions
148+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+ PARTICULAR PURPOSE. You are solely responsible for determining the
150+ appropriateness of using or redistributing the Work and assume any
151+ risks associated with Your exercise of permissions under this License.
152+
153+ 8. Limitation of Liability. In no event and under no legal theory,
154+ whether in tort (including negligence), contract, or otherwise,
155+ unless required by applicable law (such as deliberate and grossly
156+ negligent acts) or agreed to in writing, shall any Contributor be
157+ liable to You for damages, including any direct, indirect, special,
158+ incidental, or consequential damages of any character arising as a
159+ result of this License or out of the use or inability to use the
160+ Work (including but not limited to damages for loss of goodwill,
161+ work stoppage, computer failure or malfunction, or any and all
162+ other commercial damages or losses), even if such Contributor
163+ has been advised of the possibility of such damages.
164+
165+ 9. Accepting Warranty or Additional Liability. While redistributing
166+ the Work or Derivative Works thereof, You may choose to offer,
167+ and charge a fee for, acceptance of support, warranty, indemnity,
168+ or other liability obligations and/or rights consistent with this
169+ License. However, in accepting such obligations, You may act only
170+ on Your own behalf and on Your sole responsibility, not on behalf
171+ of any other Contributor, and only if You agree to indemnify,
172+ defend, and hold each Contributor harmless for any liability
173+ incurred by, or claims asserted against, such Contributor by reason
174+ of your accepting any such warranty or additional liability.
175+
176+ END OF TERMS AND CONDITIONS
177+
178+ APPENDIX: How to apply the Apache License to your work.
179+
180+ To apply the Apache License to your work, attach the following
181+ boilerplate notice, with the fields enclosed by brackets "{}"
182+ replaced with your own identifying information. (Don't include
183+ the brackets!) The text should be enclosed in the appropriate
184+ comment syntax for the file format. We also recommend that a
185+ file or class name and description of purpose be included on the
186+ same "printed page" as the copyright notice for easier
187+ identification within third-party archives.
188+
189+ Copyright {yyyy} {name of copyright owner}
190+
191+ Licensed under the Apache License, Version 2.0 (the "License");
192+ you may not use this file except in compliance with the License.
193+ You may obtain a copy of the License at
194+
195+ http://www.apache.org/licenses/LICENSE-2.0
196+
197+ Unless required by applicable law or agreed to in writing, software
198+ distributed under the License is distributed on an "AS IS" BASIS,
199+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+ See the License for the specific language governing permissions and
201+ limitations under the License.
README.mdnew file+49
@@ -0,0 +1,49 @@
1+## Disclaimer
2+
3++ This is WIP: some things weren't implemented, some might have bugs. Filling issues and prs are welcomed!
4++ All files in `vendor` folders: three drivers and selenium jar -- are subjects of appropriate copyrights.
5+
6+## Purescript W3C webdriver protocol bindings
7+
8+The main purpose of this library is to provide purescript webdriver/json-wire protocol bindings, such that
9+won't involve any JavaScript dependencies.
10+
11+## Architecture
12+
13++ There is a module that encodes any possible error returned by Selenium.
14++ Low-level API uses `purescript-argonaut`'s `Json` type and `purescript-affjax`s helper functions (`get`, `post` etc)
15++ Endpoints are constructed using `Endpoint@Lunapark.Endpoint` type. This module also provides helper functions
16+returning `Aff _ (Either Error Json)`
17++ Types of requests and resposes live in `Lunapark.Types` module.
18++ High-level API uses `purescript-run`. There are several functors, but the main two are: `LunaparkF` and `ActionF`.
19+This functor embed in `Run` encode almost all posible interactions with w3c/selenium server.
20++ At first `ActionF` functor (that is a functor that encodes all posible actions like click, hover) is interpreted to
21+`LunaparkF`, then `LunaparkF` is interpreted into `Run` with `EXCEPT` and `AFF|EFF` effects.
22++ `Lunapark` is facade library on top of api, functors and error.
23++ Capabilities are represented via gradually typed datastructure `Array Capability`. `init` function takes a record
24+`{ alwaysMatch: Array Capability, firstMatch: Array (Array Capability) }`. `firstMatch` must have at least on array.
25++ To construct interpreter you need call `init@Lunapark.API`. The result would be `Aff _ (Either Error Interpreter)`,
26+where `Interpreter` is function taking `Lunapark` monad and unwrapping it into `Run` with `EXCEPT` and `AFF|EFF`. E.g.
27+
28+```purescript
29+main = launchAff do
30+ interpreterOrError ← init "http://localhost:4444/wd/hub" { alwaysMatch: [], firstMatch: [[BrowserName Chrome]] }
31+ case intepreterOrError of
32+ Left err → throwError $ error "An error during selenium session initialization occured"
33+ Right interpret → Run.runBaseAff' $ Run.runExcept $ interpret do
34+ go "http://my-site.com"
35+ el ← findElement $ ByCss $ CSS.fromString ".my-class"
36+ clickEl el
37+ login ← findElement $ ByCss $ CSS.fromString "#login"
38+ password ← findElement $ ByCss $ CSS.fromString "#password"
39+ moveTo { origin: login, x: 0, y: 0, duration: Milliseconds 1000.0 }
40+ click
41+ sendKeys "login"
42+ moveTo { origin: password, x: 0, y: 0, duration: Milliseconds 100.0 }
43+ sendKeys "secret"
44+ sendKeys "\\xE007"
45+```
46++ The interpreter takes care about implemented and non-implemented features of particular driver. E.g. if driver supports
47+`GET@/session/:sessionId/timeouts` via W3C standard it will use it otherwise the interpreter makes it a chain call of
48+JsonWire commands. The same works for actions: they are interpreted into either `POST@/session/:sessionId/action` or
49+chains of JsonWire commands.
bower.json+25−6
@@ -1,15 +1,34 @@
1{
1{
2 "name": "purescript-lunapark",
2 "name": "purescript-lunapark",
3+ "homepage": "https://github.com/slamdata/purescript-lunapark",
4+ "authors": [
5+ "Maxim Zimaliev <zimaliev@gmail.com>"
6+ ],
7+ "description": "Webdriver/JsonWire bindings for PureScript",
8+ "license": "Apache-2.0",
9+ "keywords": [
10+ "purescript",
11+ "selenium",
12+ "webdriver",
13+ "jsonwire"
14+ ],
15+ "repository": {
16+ "type": "git",
17+ "url": "git://github.com/slamdata/purescript-lunapark.git"
18+ },
19+ "ignore": [
20+ "**/*.",
21+ "node_modules",
22+ "bower_components",
23+ "output",
24+ "test"
25+ ],
3 "dependencies": {
26 "dependencies": {
4 "purescript-affjax": "^5.0.0",
27 "purescript-affjax": "^5.0.0",
5− "purescript-debug": "^3.0.0",
6− "purescript-codec-argonaut": "^5.0.0",
7 "purescript-argonaut": "^3.1.0",
28 "purescript-argonaut": "^3.1.0",
8 "purescript-css": "^3.4.0",
29 "purescript-css": "^3.4.0",
9 "purescript-node-fs-aff": "^5.0.0",
30 "purescript-node-fs-aff": "^5.0.0",
10− "purescript-node-child-process": "^4.0.0",
31+ "purescript-run": "^1.0.1",
11− "purescript-node-process": "^5.0.0",
32+ "purescript-xpath": "cryogenian/purescript-xpath#master"
12− "purescript-free": "^4.3.0",
13− "purescript-run": "^1.0.1"
14 }
33 }
15}
34}
package.json+2−6
@@ -1,22 +1,18 @@
1{
1{
2 "name": "purescript-lunapark",
2 "name": "purescript-lunapark",
3− "version": "1.0.0",
3+ "private": true,
4− "description": "",
5− "main": "index.js",
6 "scripts": {
4 "scripts": {
7 "build": "pulp build -- --censor-lib --strict --stash",
5 "build": "pulp build -- --censor-lib --strict --stash",
8 "build:non-strict": "pulp build",
6 "build:non-strict": "pulp build",
9 "bundle": "purs bundle \"output/**/*.js\" --output ./index.js --main Main --module Main",
7 "bundle": "purs bundle \"output/**/*.js\" --output ./index.js --main Main --module Main",
10 "ide": "purs ide server"
8 "ide": "purs ide server"
11 },
9 },
12− "author": "",
13− "license": "ISC",
10+ "license": "Apache-2.0",
14 "dependencies": {
11 "dependencies": {
15 "chromedriver": "^2.37.0",
12 "chromedriver": "^2.37.0",
16 "pulp": "^12.0.1",
13 "pulp": "^12.0.1",
17 "purescript": "^0.11.7",
14 "purescript": "^0.11.7",
18 "purescript-psa": "^0.6.0",
15 "purescript-psa": "^0.6.0",
19− "selenium-webdriver": "^4.0.0-alpha.1",
20 "xhr2": "^0.1.4"
16 "xhr2": "^0.1.4"
21 }
17 }
22}
18}
src/Lunapark/API.purs−8
@@ -38,14 +38,6 @@ type LunaparkEffects e =
38 , fs ∷ FS.FS
38 , fs ∷ FS.FS
39 | e)
39 | e)
40
40
41−-- | Example
42−-- | ```purescript
43−-- | runLunapark ← init "http://localhost:4444/wd/hub" SM.empty
44−-- | result ← runLunapark do
45−-- | setTimeouts timeouts
46−-- | go "http://google.com"
47−-- | findElement ...
48−-- | ```
49init
41init
50 ∷ ∀ e m r a
42 ∷ ∀ e m r a
51 . MonadAff (LunaparkEffects e) m
43 . MonadAff (LunaparkEffects e) m
src/Lunapark/Types.purs−1
@@ -431,7 +431,6 @@ renderDriverPaths ps = map renderDriverPath pairs
431 Chrome → "-Dwebdriver.chrome.driver"
431 Chrome → "-Dwebdriver.chrome.driver"
432 Firefox → "-DWebdriver.gecko.driver"
432 Firefox → "-DWebdriver.gecko.driver"
433
433
434−
435data PageLoad
434data PageLoad
436 = Normal
435 = Normal
437 | Eager
436 | Eager