Merge pull request #24 from cryogenian/ready/screenshots

screenshots, window management

Author: cryogenian

docs/Selenium.md

@@ -216,6 +216,18 @@ isEnabled :: forall e. Element -> Aff (selenium :: SELENIUM | e) Boolean
 getInnerHtml :: forall e. Element -> Aff (selenium :: SELENIUM | e) String
 ```
 
+#### `getSize`
+
+``` purescript
+getSize :: forall e. Element -> Aff (selenium :: SELENIUM | e) Size
+```
+
+#### `getLocation`
+
+``` purescript
+getLocation :: forall e. Element -> Aff (selenium :: SELENIUM | e) Location
+```
+
 #### `clearEl`
 
 ``` purescript
@@ -235,4 +247,54 @@ takeScreenshot :: forall e. Driver -> Aff (selenium :: SELENIUM | e) String
 
 Returns png base64 encoded png image
 
+#### `saveScreenshot`
+
+``` purescript
+saveScreenshot :: forall e. String -> Driver -> Aff (selenium :: SELENIUM | e) Unit
+```
+
+Saves screenshot to path
+
+#### `getWindow`
+
+``` purescript
+getWindow :: forall e. Driver -> Aff (selenium :: SELENIUM | e) Window
+```
+
+#### `getWindowPosition`
+
+``` purescript
+getWindowPosition :: forall e. Window -> Aff (selenium :: SELENIUM | e) Location
+```
+
+#### `getWindowSize`
+
+``` purescript
+getWindowSize :: forall e. Window -> Aff (selenium :: SELENIUM | e) Size
+```
+
+#### `maximizeWindow`
+
+``` purescript
+maximizeWindow :: forall e. Window -> Aff (selenium :: SELENIUM | e) Unit
+```
+
+#### `setWindowPosition`
+
+``` purescript
+setWindowPosition :: forall e. Location -> Window -> Aff (selenium :: SELENIUM | e) Unit
+```
+
+#### `setWindowSize`
+
+``` purescript
+setWindowSize :: forall e. Size -> Window -> Aff (selenium :: SELENIUM | e) Unit
+```
+
+#### `getWindowScroll`
+
+``` purescript
+getWindowScroll :: forall e. Driver -> Aff (selenium :: SELENIUM | e) Location
+```
+
 

docs/Selenium/Monad.md

@@ -22,6 +22,48 @@ getDriver :: forall e o. Selenium e o Driver
 
 get driver from context
 
+#### `getWindow`
+
+``` purescript
+getWindow :: forall e o. Selenium e o Window
+```
+
+#### `getWindowPosition`
+
+``` purescript
+getWindowPosition :: forall e o. Selenium e o Location
+```
+
+#### `getWindowSize`
+
+``` purescript
+getWindowSize :: forall e o. Selenium e o Size
+```
+
+#### `maximizeWindow`
+
+``` purescript
+maximizeWindow :: forall e o. Selenium e o Unit
+```
+
+#### `setWindowPosition`
+
+``` purescript
+setWindowPosition :: forall e o. Location -> Selenium e o Unit
+```
+
+#### `setWindowSize`
+
+``` purescript
+setWindowSize :: forall e o. Size -> Selenium e o Unit
+```
+
+#### `getWindowScroll`
+
+``` purescript
+getWindowScroll :: forall e o. Selenium e o Location
+```
+
 #### `apathize`
 
 ``` purescript
@@ -90,14 +132,14 @@ locator :: forall e o. (Element -> Selenium e o Element) -> Selenium e o Locator
 
 get element by action returning an element
 ```purescript
-locator \el -> do 
-  commonElements <- byCss ".common-element" >>= findElements el 
+locator \el -> do
+  commonElements <- byCss ".common-element" >>= findElements el
   flaggedElements <- traverse (\el -> Tuple el <$> isVisible el) commonElements
   maybe err pure $ foldl foldFn Nothing flaggedElements
   where
   err = throwError $ error "all common elements are not visible"
   foldFn Nothing (Tuple el true) = Just el
-  foldFn a _ = a 
+  foldFn a _ = a
 ```
 
 #### `findElement`
@@ -106,7 +148,7 @@ locator \el -> do
 findElement :: forall e o. Locator -> Selenium e o (Maybe Element)
 ```
 
-Tries to find element and return it wrapped in `Just` 
+Tries to find element and return it wrapped in `Just`
 
 #### `findElements`
 
@@ -134,6 +176,18 @@ findChildren :: forall e o. Element -> Locator -> Selenium e o (List Element)
 getInnerHtml :: forall e o. Element -> Selenium e o String
 ```
 
+#### `getSize`
+
+``` purescript
+getSize :: forall e o. Element -> Selenium e o Size
+```
+
+#### `getLocation`
+
+``` purescript
+getLocation :: forall e o. Element -> Selenium e o Location
+```
+
 #### `isDisplayed`
 
 ``` purescript
@@ -224,7 +278,7 @@ getTitle :: forall e o. Selenium e o String
 sequence :: forall e o. Sequence Unit -> Selenium e o Unit
 ```
 
-Run sequence of actions 
+Run sequence of actions
 
 #### `actions`
 
@@ -260,6 +314,12 @@ quit :: forall e o. Selenium e o Unit
 takeScreenshot :: forall e o. Selenium e o String
 ```
 
+#### `saveScreenshot`
+
+``` purescript
+saveScreenshot :: forall e o. String -> Selenium e o Unit
+```
+
 #### `findExact`
 
 ``` purescript

docs/Selenium/Types.md

@@ -18,6 +18,12 @@ data SELENIUM :: !
 data Driver :: *
 ```
 
+#### `Window`
+
+``` purescript
+data Window :: *
+```
+
 #### `Until`
 
 ``` purescript
@@ -131,7 +137,7 @@ data Method
 ```
 
 Copied from `purescript-affjax` because the only thing we
-need from `affjax` is `Method`                    
+need from `affjax` is `Method`
 
 ##### Instances
 ``` purescript
@@ -157,7 +163,13 @@ instance xhrStateIsForeign :: IsForeign XHRState
 #### `Location`
 
 ``` purescript
-type Location = { x :: Number, y :: Number }
+type Location = { x :: Int, y :: Int }
+```
+
+#### `Size`
+
+``` purescript
+type Size = { width :: Int, height :: Int }
 ```
 
 #### `ControlKey`

src/Selenium.js

@@ -1,7 +1,9 @@
 // module Selenium
 
 var webdriver = require("selenium-webdriver"),
-    By = webdriver.By;
+    By = webdriver.By,
+    fs = require("fs"),
+    path = require("path");
 
 exports.get = function(driver) {
     return function(url) {
@@ -253,6 +255,18 @@ exports.getInnerHtml = function(el) {
     };
 };
 
+exports.getSize = function(el) {
+    return function(cb, eb) {
+        el.getSize().then(cb).thenCatch(eb);
+    };
+};
+
+exports.getLocation = function(el) {
+    return function(cb, eb) {
+        el.getLocation().then(cb).thenCatch(eb);
+    };
+};
+
 function execute(driver) {
     return function(action) {
         return function(cb, eb) {
@@ -284,3 +298,92 @@ exports.takeScreenshot = function(driver) {
             .thenCatch(eb);
     };
 };
+
+
+exports.saveScreenshot = function(fileName) {
+    return function(driver) {
+        return function(cb, eb) {
+            driver.takeScreenshot()
+                .then(function(str) {
+                    fs.writeFile(path.resolve(fileName),
+                                 str.replace(/^data:image\/png;base64,/,""),
+                                 {
+                                     encoding: "base64",
+                                     flag: "w+"
+                                 },
+                                 function(err) {
+                                     if (err) return eb(err);
+                                     return cb();
+                                 });
+                })
+                .thenCatch(eb);
+        };
+    };
+};
+
+
+exports.getWindow = function(window) {
+    return function(cb, eb) {
+        try {
+            return cb(window.manage().window());
+        }
+        catch (e) {
+            return eb(e);
+        }
+    };
+};
+
+exports.getWindowPosition = function(window) {
+    return function(cb, eb) {
+        return window.getPosition()
+            .then(cb)
+            .thenCatch(eb);
+    };
+};
+
+exports.getWindowSize = function(window) {
+    return function(cb, eb) {
+        return window.getSize()
+            .then(cb)
+            .thenCatch(eb);
+    };
+};
+
+exports.maximizeWindow = function(window) {
+    return function(cb, eb) {
+        return window.maximize()
+            .then(cb)
+            .thenCatch(eb);
+    };
+};
+
+exports.setWindowPosition = function(loc) {
+    return function(window) {
+        return function(cb, eb) {
+            return window.setPosition(loc.x, loc.y)
+                .then(cb)
+                .thenCatch(eb);
+        };
+    };
+};
+
+exports.setWindowSize = function(size) {
+    return function(window) {
+        return function(cb, eb) {
+            return window.setSize(size.width, size.height)
+                .then(cb)
+                .thenCatch(eb);
+        };
+    };
+};
+
+exports.getWindowScroll = function(driver) {
+    return function(cb, eb) {
+        driver.executeScript(function() {
+            return {
+                x: window.scrollX,
+                y: window.scrollY
+            };
+        }).then(cb).thenCatch(eb);
+    };
+};