uptime_monitor 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55829816e114b87b0d4f9e584256c9f9f1ae1c8d
-  data.tar.gz: 71a7f7f48ca8267e05fd2e975342c09b6723cffb
+  metadata.gz: c3f61d132de121f2a13283ec56d030eef62f4d40
+  data.tar.gz: 147e6f471ea6a98b88564e5d27146fed984dc942
 SHA512:
-  metadata.gz: c2f0b6bb1bb0574f5d3c0092422565e02d10c183642a456fb85b7510f96d7fb44fe97ae7fbc7f44b95c44858a9405534ec4104371d8f1416239843281f409757
-  data.tar.gz: e79436645ed829c2b7705e05963f6d3e6f6613e6c012abef848c90867d90231ac24b7b30698edf10ba21fe63c34cfe61b4a35a8375922a602520024f127b2e51
+  metadata.gz: b9ad8a58fb8de43e2b7e0e74f4d4b55822c8cee4357950f29ea23aedf596816d3b204a06025e9232a3d799527a77b10f5f75e729d11f0df4ddb863f7a4670574
+  data.tar.gz: bfc374f0434af353033d49fd18bafe6317a4ce9a27d219f1137cd5ee7a4afc833cfac6a80590166d88df51269b3345f6b584232c019c867dff773a2ad586417f

data/.env.examples

@@ -0,0 +1,4 @@
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+RAGIOS_HERCULES_S3_DIR=
+RAGIOS_HERCULES_ENABLE_SCREENSHOTS=

data/.travis.yml

@@ -1,6 +1,23 @@
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.2.3
+env:
+  - DOCKER_COMPOSE_VERSION=1.16.1
 
-script: bundle exec rspec -fd spec
+addons:
+  apt:
+    packages:
+      - docker-ce
+
+
+before_install:
+  - sudo rm /usr/local/bin/docker-compose
+  - curl -L https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-`uname -s`-`uname -m` > docker-compose
+  - chmod +x docker-compose
+  - sudo mv docker-compose /usr/local/bin
+
+before_script:
+  - docker-compose build
+
+script:
+  - docker-compose run unit_tests
+
+after_script:
+  - docker-compose down

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:2.4.1-stretch
+
+COPY . /usr/src/uptime_monitor
+WORKDIR /usr/src/uptime_monitor
+RUN bundle install

data/Gemfile

@@ -1,16 +1,15 @@
 source "http://rubygems.org"
 
-gem 'headless', "~> 1.0.2"
-gem 'watir-webdriver', "~> 0.9.1"
+# gem 'headless', "~> 1.0.2"
+gem 'watir'
 gem 'watir-webdriver-performance', "~> 0.2.4"
 gem "aws-s3"
 gem "treetop"
-gem "selenium-webdriver", '~> 2.53.4'
 
 group :development do
   gem "rspec"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
+  gem "jeweler", "~> 2.3.7"
   gem "pry"
 end

data/Gemfile.lock

@@ -6,90 +6,89 @@ GEM
       builder
       mime-types
       xml-simple
-    builder (3.2.2)
-    childprocess (0.5.9)
+    builder (3.2.3)
+    childprocess (0.8.0)
       ffi (~> 1.0, >= 1.0.11)
-    coderay (1.1.1)
+    coderay (1.1.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.13)
-    git (1.2.9.1)
-    github_api (0.13.1)
+    ffi (1.9.18)
+    git (1.3.0)
+    github_api (0.16.0)
       addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      oauth2
-    hashie (3.4.3)
-    headless (1.0.2)
-    highline (1.7.8)
-    jeweler (2.0.1)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    hashie (3.5.7)
+    highline (1.7.10)
+    jeweler (2.3.7)
       builder
-      bundler (>= 1.0)
+      bundler (>= 1)
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych (~> 2.2)
       rake
       rdoc
-    json (1.8.3)
-    jwt (1.5.1)
-    method_source (0.8.2)
-    mime-types (3.0)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2015.1120)
-    mini_portile2 (2.0.0)
-    multi_json (1.12.1)
-    multi_xml (0.5.5)
+      semver2
+    json (1.8.6)
+    jwt (1.5.6)
+    method_source (0.9.0)
+    mime-types (2.99.3)
+    mini_portile2 (2.3.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    oauth2 (1.1.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0, < 1.5.2)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
     polyglot (0.3.5)
-    pry (0.10.3)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (1.6.4)
-    rake (10.5.0)
+      method_source (~> 0.9.0)
+    psych (2.2.4)
+    rack (2.0.3)
+    rake (12.3.0)
     rdoc (3.12.2)
       json (~> 1.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.3)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubyzip (1.2.0)
-    selenium-webdriver (2.53.4)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.8.0)
       childprocess (~> 0.5)
       rubyzip (~> 1.0)
-      websocket (~> 1.0)
-    slop (3.6.0)
-    thread_safe (0.3.5)
-    treetop (1.6.4)
+    semver2 (3.4.2)
+    thread_safe (0.3.6)
+    treetop (1.6.9)
       polyglot (~> 0.3)
-    watir-webdriver (0.9.1)
+    watir (6.10.2)
+      selenium-webdriver (~> 3.4, >= 3.4.1)
+    watir-webdriver (0.9.9)
       selenium-webdriver (>= 2.46.2)
     watir-webdriver-performance (0.2.4)
       watir-webdriver
-    websocket (1.2.3)
     xml-simple (1.1.5)
 
 PLATFORMS
@@ -98,15 +97,13 @@ PLATFORMS
 DEPENDENCIES
   aws-s3
   bundler (~> 1.0)
-  headless (~> 1.0.2)
-  jeweler (~> 2.0.1)
+  jeweler (~> 2.3.7)
   pry
   rdoc (~> 3.12)
   rspec
-  selenium-webdriver (~> 2.53.4)
   treetop
-  watir-webdriver (~> 0.9.1)
+  watir
   watir-webdriver-performance (~> 0.2.4)
 
 BUNDLED WITH
-   1.11.2
+   1.15.1

data/README.md

@@ -1,16 +1,17 @@
 uptime_monitor (Hercules)
 ==========================
-[![Build Status](https://travis-ci.org/obi-a/uptime_monitor.png?branch=master)](https://travis-ci.org/obi-a/uptime_monitor)
 [![Gem Version](https://badge.fury.io/rb/uptime_monitor.svg)](http://badge.fury.io/rb/uptime_monitor)
 
-Uptime_monitor is a [ragios](https://github.com/obi-a/ragios) plugin that uses a real web browser to perform transactions on a website to ensure that features of the site are still working correctly. It can check elements of a webpage to ensure they still exist and it can also perform transactions like a website login to ensure that the process still works correctly.
 
-##Requirements
-Ruby: At least Ruby 2.3.0 or higher is recommended
+Uptime_monitor is a [ragios](https://github.com/obi-a/ragios) plugin that uses a real web browser to perform actions on a website to ensure that features of the site are still working correctly. It can check elements of a webpage to ensure they still exist and it can also perform actions like a website login to ensure that the process still works correctly. When uptime_monitor detects a problem with the website, Uptime_monitor can take a screenshot of the web page it sees, and it can also record a video of the actions it performed on the website. The video feature is not yet implemented.
+
+## Requirements
+Ruby: At least Ruby 2.4.1 or higher is recommended
 
 [Ragios](https://github.com/obi-a/ragios)
 
-##Installation:
+
+## Installation:
  Add the uptime_monitor gem to your ragios Gemfile
  ```ruby
  gem "uptime_monitor"
@@ -19,24 +20,20 @@ Run bundle install from the ragios root directory
  ```
  bundle install
  ```
-In the Ragios root directory, in the file ```config.rb```, add to line 1
-```ruby
-require 'uptime_monitor'
-```
 Restart ragios
 
-##Run in a Docker Container
-(Optional) A docker container is available with the uptime_monitor plugin and all its dependencies already setup and configured. You can run it out of the box with minimal effort in this docker container. See details here: [Using Maestro](https://github.com/obi-a/maestro).
+To run Ragios with uptime_monitor and all its dependencies already setup and configured in Docker Compose,  See details here: [Using Maestro](https://github.com/obi-a/maestro). This is the easiest way to get Ragios and Uptime_monitor up and running.
+
 
-##Usage:
+## Usage:
 A quick example, to monitor the title tag of a web page to ensure that it hasn't changed. Using [Ragios ruby client](http://www.whisperservers.com/ragios/ragios-saint-ruby/using-ragios)
-````ruby
+```ruby
 monitor = {
   monitor: "My Blog title tag",
   url: "http://obi-akubue.org",
   every: "5m",
   contact: "admin@obiora.com",
-  via: "gmail_notifier",
+  via: "ses",
   plugin: "uptime_monitor",
   exists?: 'title.with_text("Obi Akubue")',
   browser: "firefox"
@@ -49,13 +46,13 @@ exists?: 'title.with_text("Obi Akubue")'
 ```
 When the title tag on the web page doesn't match the text "Obi Akubue", a failure notification will be sent out to the provided contact "admin@obiora.com".
 
-###Using the plugin
+### Using the plugin
 To use the uptime monitor plugin add the key/value pair to the monitor
 ```ruby
 plugin: "uptime_monitor"
 ```
 
-###Browsers
+### Browsers
 A browser is specified, by adding a browser key/value pair to the monitor
 ```ruby
 browser: "firefox"
@@ -66,27 +63,16 @@ browser: "chrome"
 browser: "safari"
 browser: "phantomjs"
 ```
-uptime_monitor uses [Watir Webdriver](http://watirwebdriver.com), firefox runs out of the box with no configuration required. To use Chrome or Safari see the Watir Webdriver documentation on downloading the appropriate driver binary and configuration.
+uptime_monitor uses [Watir](http://watir.com), to easily access the different browsers see the development section, running uptime_monitor with Selenium Grid and Docker Compose.
 
-By default, the browsers don't run headless, to run the browser headless, you can specify it in the format below:
-```ruby
-browser: "firefox headless"
-```
-This will run firefox as a headless browser. You should have [Xvfb](https://en.wikipedia.org/wiki/Xvfb) installed to run a non-headless browsers as headless. Headless browsers like Phantomjs don't require Xvfb.
-
-To run Chrome browser as headless
-```ruby
-browser: "chrome headless"
-```
-
-###Validations
+### Validations
 To verify that a html element exists on the web page, a validation needs to be added to the monitor. Validations are specified with the exists? key/value pair which takes a string of html elements as it's value. It verifies that the html elements in the array exists on the current web page.
 ```ruby
 exists?: "h1 div"
 ```
 The above example will verify that a h1 and a div exists on the page.
 
-####HTML Elements
+#### HTML Elements
 The simplest way to specify a html element is using the element name.
 ```ruby
 exists?: "h1 div a img span"
@@ -109,7 +95,7 @@ div.where(id:"test", class: "test-section")
 ```
 Specifes a div with id="test" and class="test-section".
 
-####Multiple validations
+#### Multiple validations
 Multiple validations can be added to a monitor, see below:
 ```ruby
 validations = <<-eos
@@ -123,7 +109,7 @@ monitor = {
   url: "http://obi-akubue.org",
   every: "5m",
   contact: "admin@obiora.com",
-  via: "gmail_notifier",
+  via: "ses",
   plugin: "uptime_monitor",
   exists?: validations,
   browser: "firefox"
@@ -134,7 +120,7 @@ ragios.create(monitor)
 In the above example the string variable *validations* contains validations that need to be performed when the monitor runs. During execution, the monitor will visit the website and verify that all the html elements specified in the validations exists on the page, if any of them doesn't exist, a notification of the failure will be sent out.
 
 
-####Standard attributes
+#### Standard attributes
 
 Only standard attributes for an element can be included in the above format *div.where(id: "test")*, for example a div has the following standard attributes id, class, lang, dir, title, align, onclick, ondblclick, onmousedown, onmouseup, onmouseover, onmousemove, onmouseout, onkeypress, onkeydown, onkeyup. So *div.where(class: "anything")* will work.
 
@@ -149,7 +135,7 @@ div.where(data-brand: "toyota")
 will give an error because "data-brand" is not a standard attibute for div, to specify elements by data or custom attributes use css selectors, see below.
 
 
-####Using CSS Selectors
+#### Using CSS Selectors
 HTML elements can also be specified with css selectors.
 ```ruby
 element.where(css: "#rss-link")
@@ -161,7 +147,7 @@ To specify an element by data attributes
 element.where(css: "[data-brand='toyota']")
 ```
 
-####Helpers for HTML elements
+#### Helpers for HTML elements
 Helpers are available to make some elements easier to reason about:
 
 #####Links
@@ -181,7 +167,7 @@ link.where(text: "Click Here")
 link.where(href: "https://www.southmunn.com/aboutus")
 ```
 
-#####Buttons
+##### Buttons
 ```ruby
 button.where(id: "searchsubmit")
 ```
@@ -196,16 +182,16 @@ More readable than the input tag
 input.where(id: "search")
 ```
 
-#####Checkboxes
+##### Checkboxes
 ```ruby
 checkbox.where(value: "Butter")
 ```
-#####Radio Buttons
+##### Radio Buttons
 ```ruby
 radio.where(name: "group1", value: "Milk")
 ```
 
-#####Drop Down menus
+##### Drop Down menus
 ```html
 <select name="mydropdown">
 <option value="Milk">Fresh Milk</option>
@@ -228,7 +214,7 @@ Options of the drop-down menu can be specified using option
 option.where(value: "Milk")
 ```
 
-####Text Validations
+#### Text Validations
 A text validation is used to verify that the text content of a html element hasn't changed. For example,
 ```ruby
 exists?: 'title.with_text("Welcome to my site")'
@@ -245,14 +231,14 @@ exists?: 'div.where(class: "box_content").includes_text("SouthMunn is a Website"
 ```
 Text validations can be used on html elements that can contain text like title, div, span, h1, h2 etc.
 
-####Actions
+#### Actions
 Validations can also include actions. The actions are performed on the html element after it is verfied that the element exists. Example to set a text field's value
 ```ruby
 exists?: 'text_field.where(id: "username").set("admin")'
 ```
 The above example is an action that will set the text field's value to the string "admin".
 
-#####Actions on html elements
+##### Actions on html elements
 Common actions performed on elements are set, select and click.
 
 For example to set value for a textfield or textarea.
@@ -278,14 +264,14 @@ checkbox.where(name: "checkbox").click
 link.where(text: "Click Here").click
 button.where(id: "submit").click
 ```
-####Waiting
+#### Waiting
 For webpages that use a lot of AJAX, it's possible to wait until an element exists, by using the wait_for keyword. This keyword takes an element as value. It is a special type of validation, it will wait for 30 seconds for the provided element to exist, if the element doesn't exist in 30 seconds the validation fails.
 ```ruby
 wait_for div.where(id: "open-section")
 ```
 The above example will wait 30 seconds until the div exists, if it doesn't exist after 30 seconds the validation will fail.
 
-####Multiple validations and actions
+#### Multiple validations and actions
 ```ruby
 validations = <<-eos
   text_field.where(id: "username").set("admin")
@@ -301,7 +287,7 @@ When actions like clicking a link, changes the current page, the following valid
 A combination of multiple validations and actions form the basis for performing transactions.
 
 
-####Performing Transactions
+#### Performing Transactions
 Transactions are achieved by a combination of multiple validations and actions.
 
 Example, to monitor the keyword search feature on my blog, notice the validations in the exists? key's value:
@@ -319,7 +305,7 @@ monitor = {
   url: "http://obi-akubue.org",
   every: "1h",
   contact: "admin@obiora.com",
-  via: "gmail_notifier",
+  via: "ses",
   plugin: "uptime_monitor",
   exists?: steps,
   browser: "firefox"
@@ -387,27 +373,58 @@ monitor = {
   via: "email_notifier",
   plugin: "uptime_monitor",
   exists?: login_process,
-  browser: "firefox headless"
+  browser: "firefox"
 }
 
 ragios.create(monitor)
 ```
 
-####Testing the validations outside Ragios
+## Running Uptime Monitor outside Ragios with Docker Compose
+
+First clone the uptime_monitor Repo on github.
+
+```
+git clone git@github.com:obi-a/uptime_monitor.git
+```
+
+Change to the uptime_monitor directory:
+```
+cd uptime_monitor
+```
+
+Build the docker containers:
+```
+docker-compose build
+```
+This builds the uptime_monitor container
+
+Load the uptime_monitor into PRY console in a container:
+```
+docker-compose run  --rm uptime_monitor
+```
+This will give you access to the entire uptime_monitor and all its objects loaded into PRY console. It will also run Selenium Grid and firefox in separate docker containers already connected to the uptime_monitor.
+
+
+## Testing the validations outside Ragios
 Sometimes it's useful to run validations outside Ragios to verify that the validations are syntactically correct and don't raise any exceptions. This is best done by running the uptime_monitor plugin as a Plain Old Ruby Object.
-```ruby
-require 'uptime_monitor'
 
+First load uptime_monitor into PRY console:
+```
+docker-compose run uptime_monitor
+```
+From the console you can load the uptime_monitor directly:
+
+```ruby
 monitor = {
   url: "http://obi-akubue.org",
-  browser: "firefox headless",
+  browser: "firefox",
   exists?: "title div"
 }
 
-u = Ragios::Plugin::UptimeMonitor.new
+u = Ragios::Plugins::UptimeMonitor.new
 u.init(monitor)
 u.test_command?
-#=> true
+# => true
 u.test_result
 #=> {
 #     :results =>
@@ -417,18 +434,18 @@ u.test_result
 #       ]
 #   }
 
-#test result for a failed test during downtime
+# test result for a failed test during downtime
 monitor = {
   url: "http://obi-akubue.org",
-  browser: "firefox headless",
+  browser: "firefox",
   exists?: 'title.with_text("something")'
 }
 
 u.init(monitor)
 u.test_command?
-#=> false
+# => false
 u.test_result
-#=> {
+# => {
 #     :results =>
 #       [
 #         ["title, with text \"something\"", "does_not_exist_as_expected"]
@@ -438,15 +455,12 @@ u.test_result
 In the above example the *test_command?* method runs the validations and returns true when all validations passes, returns false when any of the validation fails. *test_result* is a hash that contains the result of the tests ran by *test_command?*.
 
 
-####Testing individual validations
+## Testing individual validations
 It can be very useful to test validations/actions individually before adding them to Ragios. This can be done by running plugin's browser directly.
 ```ruby
-require 'uptime_monitor'
-
 url= "http://obi-akubue.org"
-headless = false
 browser_name = "firefox"
-browser = Hercules::Maestro::Browser.new(url, browser_name, headless)
+browser = Hercules::Maestro::Browser.new(url, browser_name)
 
 browser.exists? 'title.includes_text("ruby")'
 
@@ -456,14 +470,14 @@ browser.exists? 'checkbox.where(name: "checkbox").click'
 
 browser.close
 ```
-The above example will launch firebox and open the provided url. The exists?() method takes a single validation/action as parameter and performs the validation on the current page, it returns true if the validation passes and returns false if the validation fails. In the first validation
+The above example will launch firebox and open the provided url. The `exists?` method takes a single validation/action as parameter and performs the validation on the current page, it returns true if the validation passes and returns false if the validation fails. In the first validation
 ```
 browser.exists? 'title.includes_text("ruby")'
 ```
 it checks if the title tag on the current webpage includes the text 'ruby'.
 
 
-##Screenshots
+## Screenshots
 The uptime_monitor can be configured to take a screenshot of the webpage when a test fails. This screenshot is uploaded to Amazon s3 and its url is included in the test_result. So the website admin can see what the site looks like when transaction failed.
 
 This feature is disable by default, to enable it set following environment variable.
@@ -481,15 +495,13 @@ The above env vars are for the Amazon AWS access key, AWS secret key and s3 dire
 With the screenshots feature enabled, the results of a failed test will include a screenshot of the webpage when the test failed.
 See an example below:
 ```ruby
-require 'uptime_monitor'
-
 monitor = {
   url: "http://obi-akubue.org",
-  browser: "firefox headless",
+  browser: "firefox",
   exists?: 'title.with_text("dont_exist")'
 }
 
-u = Ragios::Plugin::UptimeMonitor.new
+u = Ragios::Plugins::UptimeMonitor.new
 u.init(monitor)
 u.test_command?
 #=>false
@@ -500,18 +512,18 @@ u.test_result
 #          ["title, with text \"dont_exist\"", "does_not_exist_as_expected"]
 #        ],
 #      :screenshot=>
-#        "http://screenshot-ragios.s3.amazonaws.com/uploads/screenshot1428783237.png"
+#        "https://screenshot-ragios.s3.amazonaws.com/uploads/screenshot1428783237.png"
 #    }
 ```
 Notice that *test_result* includes a url to the screenshot  of the webpage when the test failed. This test result is also included in the notifications sent to site admin by Ragios when a test fails. So this way the admin can see exactly what webpage looked like when the transaction failed.
 
-##Disable screenshots on individual monitors
-To disable screenshots on a particular monitor add the key/value pair ```disable_screenshots: true```
+## Disable screenshots on individual monitors
+While using Ragios, to disable screenshots on a particular monitor add the key/value pair ```disable_screenshots: true```
 example:
 ```ruby
 monitor = {
   url: "http://obi-akubue.org",
-  browser: "firefox headless",
+  browser: "firefox",
   exists?: "title",
   disable_screenshots: true
 }
@@ -520,7 +532,12 @@ ragios.create(monitor)
 ```
 This will diable screenshots only for this monitor, no screenshots will be taken when its test fails.
 
-##License:
+### To run all the unit tests
+```
+docker-compose run  --rm unit_tests
+```
+
+## License:
 MIT License.
 
-Copyright (c) 2014 Obi Akubue, obi-akubue.org
+Copyright (c) 2017 Obi Akubue, obi-akubue.org

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.7.0

data/docker-compose.yml

@@ -0,0 +1,52 @@
+version: '3'
+services:
+  firefox:
+    image: selenium/node-firefox:3.8.1-erbium
+    volumes:
+      - /dev/shm:/dev/shm
+    depends_on:
+      - hub
+    environment:
+      HUB_HOST: hub
+
+  chrome:
+    image: selenium/node-chrome:3.8.1-erbium
+    volumes:
+      - /dev/shm:/dev/shm
+    depends_on:
+      - hub
+    environment:
+      HUB_HOST: hub
+
+  hub:
+    image: selenium/hub:3.8.1-erbium
+    ports:
+      - "4444:4444"
+
+  uptime_monitor:
+    build: .
+    volumes:
+      - .:/usr/src/uptime_monitor
+    links:
+      - firefox:firefox
+    environment:
+      AWS_ACCESS_KEY_ID:
+      AWS_SECRET_ACCESS_KEY:
+      RAGIOS_HERCULES_S3_DIR:
+      RAGIOS_HERCULES_ENABLE_SCREENSHOTS:
+      BROWSER: firefox
+    entrypoint: bundle exec rake repl
+
+  unit_tests:
+    build: .
+    volumes:
+      - .:/usr/src/uptime_monitor
+    links:
+      - firefox:firefox
+    environment:
+      AWS_ACCESS_KEY_ID:
+      AWS_SECRET_ACCESS_KEY:
+      RAGIOS_HERCULES_S3_DIR:
+      RAGIOS_HERCULES_ENABLE_SCREENSHOTS:
+      BROWSER: firefox
+    entrypoint: bundle exec rspec -fd spec

data/lib/uptime_monitor.rb

@@ -1,5 +1,6 @@
-require 'headless'
-require 'watir-webdriver'
+# Headless is no longer needed will be removed later
+# require 'headless'
+require 'watir'
 require 'watir-webdriver-performance'
 require 'ostruct'
 require 'aws/s3'
@@ -32,8 +33,8 @@ end
 if RAGIOS_HERCULES_ENABLE_SCREENSHOTS
   setup_screenshot_dir
   AWS::S3::Base.establish_connection!(
-    :access_key_id     => ENV['AMAZON_ACCESS_KEY_ID'],
-    :secret_access_key => ENV['AMAZON_SECRET_ACCESS_KEY']
+    :access_key_id     => ENV['AWS_ACCESS_KEY_ID'],
+    :secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
   )
   clear_screenshots_cache!
 end

data/lib/uptime_monitor/browser.rb

@@ -1,7 +1,7 @@
 module Hercules
   module UptimeMonitor
     class Browser
-      def initialize(url, browser_name = "firefox", is_headless = false)
+      def initialize(url, browser_name = :firefox, is_headless = false)
         start_headless if is_headless
         goto(url,browser_name)
       end
@@ -119,8 +119,12 @@ module Hercules
     private
       def goto(url, browser_name)
         client = Selenium::WebDriver::Remote::Http::Default.new
-        client.timeout = 180 # seconds – default is 60
-        @browser = Watir::Browser.new browser_name, http_client: client
+        client.read_timeout = 180 # seconds – default is 60
+
+        options = {http_client: client}
+        options[:url] = "http://#{ENV['BROWSER']}:5555/wd/hub" if ENV['BROWSER']
+
+        @browser = Watir::Browser.new browser_name, options
         @browser.goto url
       end
       def start_headless

data/lib/uptime_monitor/uptime_monitor.rb

@@ -1,5 +1,5 @@
 module Ragios
-  module Plugin
+  module Plugins
     class UptimeMonitor
       attr_reader :monitor
       attr_reader :test_result

data/spec/browser_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Hercules::UptimeMonitor::Browser do
   before(:all) do
     url= "http://obi-akubue.org"
-    headless = true
+    headless = false
     browser_name = "firefox"
     @browser = Hercules::UptimeMonitor::Browser.new(url, browser_name, headless)
   end
@@ -32,7 +32,7 @@ describe Hercules::UptimeMonitor::Browser do
   it "cannot apply an action on element that can't respond to it " do
     element = @browser.get_element({button: {id: "searchsubmit"}})
     element.exists?.should ==  true
-    expect{@browser.apply_action?(element, {set: "github"})}.to raise_error
+    expect{@browser.apply_action?(element, {set: "github"})}.to raise_error(/undefined method `set'/)
   end
   it "cannot apply action in wrong form" do
     element = @browser.get_element({text_field: {id: "s"}})
@@ -119,7 +119,7 @@ describe Hercules::UptimeMonitor::Browser do
   end
   it "cannot check an element exists using unusual attributes unless its a css query" do
     element = @browser.get_element({div: {unusual_attribute: "something_else", id: "something_else"}})
-    expect{element.exists?}.to raise_error(Watir::Exception::MissingWayOfFindingObjectException)
+    element.exists?.should == false
   end
   it "can check an element exists using unusual attributes with css query" do
     element = @browser.get_element({element: {css: '[data-name="message"]'}})
@@ -156,7 +156,7 @@ describe Hercules::UptimeMonitor::Browser do
   end
   it "cannot check if page_element_exists if first is in wrong form" do
    element = [{div: {unusual_attribute: "something_else", id: "something_else"}}]
-   expect{@browser.page_element_exists?(element)}.to raise_error(Hercules::UptimeMonitor::UnknownPageElement)
+   @browser.page_element_exists?(element).should == false
   end
   it "can check if page_element_exists" do
     @browser.exists?([{text_field: {id: "s"}}]).should == true

data/spec/browsers_lang_parser_spec.rb

@@ -10,7 +10,7 @@ describe Hercules::UptimeMonitor::BrowsersLangParser do
     @parser.parse("_,0any_non_whitespace").should == {browser: "_,0any_non_whitespace", headless: false}
   end
   it "raises an exception for invalid browser name" do
-    expect { @parser.parse("\n") }.to raise_error
+    expect { @parser.parse("\n") }.to raise_error(/no implicit conversion of nil into String/)
     expect { @parser.parse(" ") }.to raise_error(Hercules::UptimeMonitor::ParserSyntaxError)
   end
   it "parses valid specification for headless browser operation" do

data/spec/uptime_monitor_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe Ragios::Plugin::UptimeMonitor do
+describe Ragios::Plugins::UptimeMonitor do
   before(:each) do
-    @uptime_monitor = Ragios::Plugin::UptimeMonitor.new
+    @uptime_monitor = Ragios::Plugins::UptimeMonitor.new
   end
   it "sets the correct test result for success" do
     @uptime_monitor.result!("page_element", state = true)
@@ -36,7 +36,7 @@ describe Ragios::Plugin::UptimeMonitor do
   it "runs a test that passes" do
     monitor = {
       url: "http://obi-akubue.org",
-      browser: "firefox headless",
+      browser: "firefox",
       exists?: "title"
     }
     @uptime_monitor.init(monitor)
@@ -50,7 +50,7 @@ describe Ragios::Plugin::UptimeMonitor do
   it "runs a test that fails" do
     monitor = {
       url: "http://obi-akubue.org",
-      browser: "firefox headless",
+      browser: "firefox",
       exists?: 'title.with_text("dont_exist")'
     }
     @uptime_monitor.init(monitor)
@@ -65,7 +65,7 @@ describe Ragios::Plugin::UptimeMonitor do
   it "can disable screenshot capture when a test fails for individual monitors" do
     monitor = {
       url: "http://obi-akubue.org",
-      browser: "firefox headless",
+      browser: "firefox",
       exists?: 'title.with_text("dont_exist")',
       disable_screenshots: true
     }

data/uptime_monitor.gemspec

@@ -2,31 +2,34 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: uptime_monitor 0.6.3 ruby lib
+# stub: uptime_monitor 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "uptime_monitor"
-  s.version = "0.6.3"
+  s.name = "uptime_monitor".freeze
+  s.version = "0.7.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["obi-a"]
-  s.date = "2016-07-10"
-  s.description = "A Ragios plugin that uses a real web browser to monitor transactions on a website for availability"
-  s.email = "obioraakubue@yahoo.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["obi-a".freeze]
+  s.date = "2018-01-27"
+  s.description = "A Ragios plugin that uses a real web browser to monitor transactions on a website for availability".freeze
+  s.email = "obioraakubue@yahoo.com".freeze
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
   ]
   s.files = [
     ".document",
+    ".env.examples",
     ".travis.yml",
+    "Dockerfile",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
     "README.md",
     "Rakefile",
     "VERSION",
+    "docker-compose.yml",
     "lib/uptime_monitor.rb",
     "lib/uptime_monitor/browser.rb",
     "lib/uptime_monitor/browsers.treetop",
@@ -42,51 +45,45 @@ Gem::Specification.new do |s|
     "spec/uptime_monitor_spec.rb",
     "uptime_monitor.gemspec"
   ]
-  s.homepage = "http://github.com/obi-a/uptime_monitor"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.8"
-  s.summary = "Real browser website uptime monitoring plugin for Ragios"
+  s.homepage = "http://github.com/obi-a/uptime_monitor".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.11".freeze
+  s.summary = "Real browser website uptime monitoring plugin for Ragios".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<headless>, ["~> 1.0.2"])
-      s.add_runtime_dependency(%q<watir-webdriver>, ["~> 0.9.1"])
-      s.add_runtime_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
-      s.add_runtime_dependency(%q<aws-s3>, [">= 0"])
-      s.add_runtime_dependency(%q<treetop>, [">= 0"])
-      s.add_runtime_dependency(%q<selenium-webdriver>, ["~> 2.53.4"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_runtime_dependency(%q<watir>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<watir-webdriver-performance>.freeze, ["~> 0.2.4"])
+      s.add_runtime_dependency(%q<aws-s3>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<treetop>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+      s.add_development_dependency(%q<pry>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<headless>, ["~> 1.0.2"])
-      s.add_dependency(%q<watir-webdriver>, ["~> 0.9.1"])
-      s.add_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
-      s.add_dependency(%q<aws-s3>, [">= 0"])
-      s.add_dependency(%q<treetop>, [">= 0"])
-      s.add_dependency(%q<selenium-webdriver>, ["~> 2.53.4"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<watir>.freeze, [">= 0"])
+      s.add_dependency(%q<watir-webdriver-performance>.freeze, ["~> 0.2.4"])
+      s.add_dependency(%q<aws-s3>.freeze, [">= 0"])
+      s.add_dependency(%q<treetop>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+      s.add_dependency(%q<pry>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<headless>, ["~> 1.0.2"])
-    s.add_dependency(%q<watir-webdriver>, ["~> 0.9.1"])
-    s.add_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
-    s.add_dependency(%q<aws-s3>, [">= 0"])
-    s.add_dependency(%q<treetop>, [">= 0"])
-    s.add_dependency(%q<selenium-webdriver>, ["~> 2.53.4"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<watir>.freeze, [">= 0"])
+    s.add_dependency(%q<watir-webdriver-performance>.freeze, ["~> 0.2.4"])
+    s.add_dependency(%q<aws-s3>.freeze, [">= 0"])
+    s.add_dependency(%q<treetop>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.7"])
+    s.add_dependency(%q<pry>.freeze, [">= 0"])
   end
 end
 

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: uptime_monitor
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - obi-a
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-10 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: headless
+  name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: watir-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: watir-webdriver-performance
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.53.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.53.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.3.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.3.7
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -174,13 +146,16 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".env.examples"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
+- docker-compose.yml
 - lib/uptime_monitor.rb
 - lib/uptime_monitor/browser.rb
 - lib/uptime_monitor/browsers.treetop
@@ -215,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Real browser website uptime monitoring plugin for Ragios