prepare release

.travis.yml

@@ -0,0 +1,15 @@
+language: node_js
+dist: trusty
+sudo: required
+node_js: stable
+install:
+  - npm install
+  - npm install -g bower
+  - bower install --production
+script:
+  - npm run -s build
+after_success:
+- >-
+  test $TRAVIS_TAG &&
+  echo $GITHUB_TOKEN | pulp login &&
+  echo y | pulp publish --no-push

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,49 @@
+## Disclaimer
+
++ This is WIP: some things weren't implemented, some might have bugs. Filling issues and prs are welcomed!
++ All files in `vendor` folders: three drivers and selenium jar -- are subjects of appropriate copyrights.
+
+## Purescript W3C webdriver protocol bindings
+
+The main purpose of this library is to provide purescript webdriver/json-wire protocol bindings, such that
+won't involve any JavaScript dependencies.
+
+## Architecture
+
++ There is a module that encodes any possible error returned by Selenium.
++ Low-level API uses `purescript-argonaut`'s `Json` type and `purescript-affjax`s helper functions (`get`, `post` etc)
++ Endpoints are constructed using `Endpoint@Lunapark.Endpoint` type. This module also provides helper functions
+returning `Aff _ (Either Error Json)`
++ Types of requests and resposes live in `Lunapark.Types` module.
++ High-level API uses `purescript-run`. There are several functors, but the main two are: `LunaparkF` and `ActionF`.
+This functor embed in `Run` encode almost all posible interactions with w3c/selenium server.
++ At first `ActionF` functor (that is a functor that encodes all posible actions like click, hover) is interpreted to
+`LunaparkF`, then `LunaparkF` is interpreted into `Run` with `EXCEPT` and `AFF|EFF` effects.
++ `Lunapark` is facade library on top of api, functors and error.
++ Capabilities are represented via gradually typed datastructure `Array Capability`. `init` function takes a record
+`{ alwaysMatch: Array Capability, firstMatch: Array (Array Capability) }`. `firstMatch` must have at least on array.
++ To construct interpreter you need call `init@Lunapark.API`. The result would be `Aff _ (Either Error Interpreter)`,
+where `Interpreter` is function taking `Lunapark` monad and unwrapping it into `Run` with `EXCEPT` and `AFF|EFF`. E.g.
+
+```purescript
+main = launchAff do
+  interpreterOrError ← init "http://localhost:4444/wd/hub" { alwaysMatch: [], firstMatch: [[BrowserName Chrome]] }
+  case intepreterOrError of
+    Left err → throwError $ error "An error during selenium session initialization occured"
+    Right interpret → Run.runBaseAff' $ Run.runExcept $ interpret do
+      go "http://my-site.com"
+      el ← findElement $ ByCss $ CSS.fromString ".my-class"
+      clickEl el
+      login ← findElement $ ByCss $ CSS.fromString "#login"
+      password ← findElement $ ByCss $ CSS.fromString "#password"
+      moveTo { origin: login, x: 0, y: 0, duration: Milliseconds 1000.0 }
+      click
+      sendKeys "login"
+      moveTo { origin: password, x: 0, y: 0, duration: Milliseconds 100.0 }
+      sendKeys "secret"
+      sendKeys "\\xE007"
+```
++ The interpreter takes care about implemented and non-implemented features of particular driver. E.g. if driver supports
+`GET@/session/:sessionId/timeouts` via W3C standard it will use it otherwise the interpreter makes it a chain call of
+JsonWire commands. The same works for actions: they are interpreted into either `POST@/session/:sessionId/action` or
+chains of JsonWire commands.

bower.json

@@ -1,15 +1,34 @@
 {
   "name": "purescript-lunapark",
+  "homepage": "https://github.com/slamdata/purescript-lunapark",
+  "authors": [
+    "Maxim Zimaliev <zimaliev@gmail.com>"
+  ],
+  "description": "Webdriver/JsonWire bindings for PureScript",
+  "license": "Apache-2.0",
+  "keywords": [
+    "purescript",
+    "selenium",
+    "webdriver",
+    "jsonwire"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/slamdata/purescript-lunapark.git"
+  },
+  "ignore": [
+    "**/*.",
+    "node_modules",
+    "bower_components",
+    "output",
+    "test"
+  ],
   "dependencies": {
     "purescript-affjax": "^5.0.0",
-    "purescript-debug": "^3.0.0",
-    "purescript-codec-argonaut": "^5.0.0",
     "purescript-argonaut": "^3.1.0",
     "purescript-css": "^3.4.0",
     "purescript-node-fs-aff": "^5.0.0",
-    "purescript-node-child-process": "^4.0.0",
-    "purescript-node-process": "^5.0.0",
-    "purescript-free": "^4.3.0",
-    "purescript-run": "^1.0.1"
+    "purescript-run": "^1.0.1",
+    "purescript-xpath": "cryogenian/purescript-xpath#master"
   }
 }

package.json

@@ -1,22 +1,18 @@
 {
   "name": "purescript-lunapark",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "private": true,
   "scripts": {
     "build": "pulp build -- --censor-lib --strict --stash",
     "build:non-strict": "pulp build",
     "bundle": "purs bundle \"output/**/*.js\" --output ./index.js --main Main --module Main",
     "ide": "purs ide server"
   },
-  "author": "",
-  "license": "ISC",
+  "license": "Apache-2.0",
   "dependencies": {
     "chromedriver": "^2.37.0",
     "pulp": "^12.0.1",
     "purescript": "^0.11.7",
     "purescript-psa": "^0.6.0",
-    "selenium-webdriver": "^4.0.0-alpha.1",
     "xhr2": "^0.1.4"
   }
 }

src/Lunapark/API.purs

@@ -38,14 +38,6 @@ type LunaparkEffects e =
   , fs ∷ FS.FS
   | e)
 
--- | Example
--- | ```purescript
--- | runLunapark ← init "http://localhost:4444/wd/hub" SM.empty
--- | result ← runLunapark do
--- |   setTimeouts timeouts
--- |   go "http://google.com"
--- |   findElement ...
--- | ```
 init
   ∷ ∀ e m r a
   . MonadAff (LunaparkEffects e) m

src/Lunapark/Types.purs

@@ -431,7 +431,6 @@ renderDriverPaths ps = map renderDriverPath pairs
     Chrome → "-Dwebdriver.chrome.driver"
     Firefox → "-DWebdriver.gecko.driver"
 
-
 data PageLoad
   = Normal
   | Eager