uptime_monitor 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac52cdfd40d5e93ff2f32cd163a786699c2e8d8f
-  data.tar.gz: e5489ade6c72a1e2a87ece3da4db581c8a49267b
+  metadata.gz: 3f0887d811bb871c4123ec7bbeda82f357e2e63e
+  data.tar.gz: 6799a662dc592781a68d6373d4499d330eb5fe79
 SHA512:
-  metadata.gz: d6e325144ef9cea5377966e04b99fc022f80b74df4a97ac832da304b55b5726bb37c3cb81731acb2eec43851c5e380c02690d7afdf300d161ffd142ab1061dff
-  data.tar.gz: 489af5a84dc5ae43aeff4a19442a7c452b660e29fe4374a14128344912825fb5c927b9f830779134020767914ffe80c57bd9a011f1a7cc4a4a7b19508ee7cebe
+  metadata.gz: 9b654292ee7ec3da0702b7088084054c5f3aef73fbe3d8a552ff20fec06abc10cad30a9d86bc454cf93351ccaa9d4bf0099310471a9e6e9f6a9eabf4c59abf1d
+  data.tar.gz: bb5cdfc4f36cff159a3136bf46be110d397376c3872839190e31e3e2527ea42d688864dbba896e666e9b2198924fb87b2d418874c54d883e0403ab261aa92c1d

data/Gemfile

@@ -6,6 +6,10 @@ gem 'headless', "~> 1.0.2"
 gem 'watir-webdriver', git: 'https://github.com/watir/watir-webdriver.git'
 gem 'watir-webdriver-performance', "~> 0.2.4"
 gem 'activesupport'
+gem 'carrierwave', "0.4.10"
+gem 'aws'
+gem "aws-s3"
+
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -14,9 +14,18 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    addressable (2.3.5)
+    addressable (2.3.8)
     atomic (1.1.14)
+    aws (2.10.2)
+      http_connection
+      uuidtools
+      xml-simple
+    aws-s3 (0.6.3)
+      builder
+      mime-types
+      xml-simple
     builder (3.2.2)
+    carrierwave (0.4.10)
     childprocess (0.5.5)
       ffi (~> 1.0, >= 1.0.11)
     coderay (1.1.0)
@@ -24,7 +33,7 @@ GEM
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
     ffi (1.9.6)
-    git (1.2.6)
+    git (1.2.9.1)
     github_api (0.10.1)
       addressable
       faraday (~> 0.8.1)
@@ -32,10 +41,10 @@ GEM
       multi_json (~> 1.4)
       nokogiri (~> 1.5.2)
       oauth2
-    hashie (2.0.5)
+    hashie (3.4.1)
     headless (1.0.2)
-    highline (1.6.20)
-    httpauth (0.2.0)
+    highline (1.7.1)
+    http_connection (1.4.4)
     i18n (0.6.9)
     jeweler (1.8.8)
       builder
@@ -47,27 +56,26 @@ GEM
       rake
       rdoc
     json (1.8.1)
-    jwt (0.1.8)
-      multi_json (>= 1.5)
+    jwt (1.4.1)
     method_source (0.8.2)
+    mime-types (2.4.3)
     minitest (4.7.5)
     multi_json (1.8.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     nokogiri (1.5.10)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    rack (1.5.2)
-    rake (10.1.0)
+    rack (1.6.0)
+    rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (2.14.1)
@@ -88,17 +96,22 @@ GEM
     thread_safe (0.1.3)
       atomic
     tzinfo (0.3.38)
+    uuidtools (2.1.5)
     watir-webdriver-performance (0.2.4)
       watir-webdriver
       watir-webdriver
     websocket (1.2.1)
+    xml-simple (1.1.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activesupport
+  aws
+  aws-s3
   bundler (~> 1.0)
+  carrierwave (= 0.4.10)
   headless (~> 1.0.2)
   jeweler (~> 1.8.7)
   pry

data/README.md

@@ -384,14 +384,12 @@ Sometimes it's useful to run validations outside Ragios to verify that the valid
 ```ruby
 require 'uptime_monitor'
 
+page_element1 = [:title]
+page_element2 = [:div]
 monitor = {
-  monitor: "About Us page",
-  url: "https://www.southmunn.com/aboutus",
-  browser: ["firefox", headless: false],
-  exists?: [
-              [{div: {class: "box_content"}}, [includes_text: "SouthMunn is a Website Uptime Monitoring SASS created and maintained by"]],
-              [img: {src: "https://fc03.deviantart.net/fs14/f/2007/047/f/2/Street_Addiction_by_gizmodus.jpg"}],
-           ],
+  url: "http://obi-akubue.org",
+  browser: ["firefox", headless: true],
+  exists?: [page_element1, page_element2]
 }
 
 u = Ragios::Plugin::UptimeMonitor.new
@@ -399,30 +397,35 @@ u.init(monitor)
 u.test_command?
 #=> true
 u.test_result
-#=> {[{:div=>{:class=>"box_content"}},
-#  [{:includes_text=>
-#     "SouthMunn is a Website Uptime Monitoring SASS created and maintained by"}]]=>
-#  :exists_as_expected,
-# [{:img=>
-#    {:src=>
-#      "https://fc03.deviantart.net/fs14/f/2007/047/f/2/Street_Addiction_by_gizmodus.jpg"}}]=>
-#  :exists_as_expected}
-
+#=> {
+#     :results =>
+#       [
+#         [[:title], "exists_as_expected"], 
+#         [[:div], "exists_as_expected"]
+#     ]
+# }
+
+#test result for a failed test during downtime
+page_element = [:title, [text: "dont_exist"]]
+monitor = {
+  url: "http://obi-akubue.org",
+  browser: ["firefox", headless: true],
+  exists?: [page_element]
+}
 
-#test result during downtime
+u.init(monitor)
 u.test_command?
 #=> false
 u.test_result
-#=> {[{:div=>{:class=>"box_content"}},
-#  [{:includes_text=>
-#     "SouthMunn is a Website Uptime Monitoring SASS created and maintained by"}]]=>
-#  :does_not_exist_as_expected,
-# [{:img=>
-#    {:src=>
-#      "https://fc03.deviantart.net/fs14/f/2007/047/f/2/Street_Addiction_by_gizmodus.jpg"}}]=>
-#  :does_not_exist_as_expected}
+#=> {
+#     :results=>
+#       [
+#          [[:title, [{:text=>"dont_exist"}]], "does_not_exist_as_expected"]
+#       ]
+# }
 ```
-In the above example the test_command?() method runs all 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?().
+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
 It can be very useful to test validations individually before adding them to Ragios. This can be done by running plugin's browser object directly.
@@ -445,8 +448,67 @@ browser.close
 The above example creates a browser object and visits the url. The exists? method takes a single validation as arguement and performs the validation on the url, it returns true if the validation passes and returns false if the validation fails. In the first validation it checks if the title tag on the url includes the text 'ruby'.
 
 
+##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.
+```
+RAGIOS_HERCULES_ENABLE_SCREENSHOTS=true
+```
+Also set environment variables for the Amazon s3 account you want to use for storing the screenshots,
+```
+AWS_ACCESS_KEY_ID=xxxxxxx
+AWS_SECRET_ACCESS_KEY=xxxxxx
+RAGIOS_HERCULES_S3_DIR=xxxxxx
+```
+The above env vars are for the Amazon AWS access key, AWS secret key and s3 directory/bucket you want to use for storage. First create this s3 bucket manually.
+
+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'
+
+page_element = [:title, [text: "dont_exist"]]
+monitor = {
+  url: "http://obi-akubue.org",
+  browser: ["firefox", headless: true],
+  exists?: [page_element]
+}
+
+u = Ragios::Plugin::UptimeMonitor.new
+u.init(monitor)
+u.test_command?
+#=>false
+u.test_result
+#=>  {
+#      :results=>
+#        [
+#          [[:title, [{:text=>"dont_exist"}]], "does_not_exist_as_expected"]
+#        ],
+#      :screenshot=>
+#        "http://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 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```
+example:
+```ruby
+page_element = [:title]
+monitor = {
+  url: "http://obi-akubue.org",
+  browser: ["firefox", headless: true],
+  exists?: [page_element],
+  disable_screenshots: true
+}
+
+ragios.create(monitor)
+```
+This will diable screenshots only for this monitor, no screenshots will be taken when its test fails.
+
 ##Specification:
-<pre lang="ruby">
+```ruby
 monitor = {
   monitor: "My Website",
   url: "http://mysite.com",
@@ -470,7 +532,7 @@ monitor = {
   browser: ["firefox", headless: true]
 }
 ragios.create(monitor)
-</pre>
+```
 
 
 ##License:

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/uptime_monitor/browser.rb

@@ -109,6 +109,14 @@ module Hercules
       rescue Watir::Wait::TimeoutError
         false
       end
+      def capture_screenshot
+        filename = "#{RAGIOS_HERCULES_SCREENSHOT_DIR}/screenshot#{Time.now.to_i}.png"
+        @browser.screenshot.save(filename)
+        file = File.open(filename)
+        uploader = Hercules::UptimeMonitor::ScreenShotUploader.new
+        uploader.store!(file)
+        uploader.url
+      end
     private
       def goto(url, browser_name)
         client = Selenium::WebDriver::Remote::Http::Default.new

data/lib/uptime_monitor/screen_shot_uploader.rb

@@ -0,0 +1,7 @@
+module Hercules
+  module UptimeMonitor
+    class ScreenShotUploader < CarrierWave::Uploader::Base
+      storage :s3
+    end
+  end
+end

data/lib/uptime_monitor/uptime_monitor.rb

@@ -4,11 +4,13 @@ module Ragios
       attr_reader :monitor
       attr_reader :test_result
       attr_reader :success
+      attr_reader :screenshot_url
+      attr_reader :has_screenshot
 
       def initialize
         @test_result = ActiveSupport::OrderedHash.new
         @result_set = []
-        @test_result = {results: @result_set }
+        @test_result = {results: @result_set}
       end
 
       def init(monitor)
@@ -24,10 +26,12 @@ module Ragios
       def test_command?
         @result_set = []
         @success = true
+        @has_screenshot = false
         browser_reader = Hercules::UptimeMonitor::BrowserReader.new(@monitor.browser)
         start_browser(@monitor.url, browser_reader.browser_name, browser_reader.headless)
         exists(@monitor.exists?)
-        @test_result = {results: @result_set }
+        @test_result = {results: @result_set}
+        @test_result[:screenshot] = @screenshot_url if @has_screenshot
         close_browser
         @success
       rescue Net::ReadTimeout => e
@@ -49,7 +53,12 @@ module Ragios
 
       def exists(page_elements)
         page_elements.each do |page_element|
-          @browser.exists?(page_element) ? result!(page_element, true) : result!(page_element, false)
+          if @browser.exists?(page_element) 
+            result!(page_element, true) 
+          else 
+            take_screenshot
+            result!(page_element, false)
+          end
         end
       end
 
@@ -58,6 +67,13 @@ module Ragios
         result = state ? [page_element, "exists_as_expected"] : [page_element, "does_not_exist_as_expected"]
         @result_set << result
       end
+
+      def take_screenshot
+        if RAGIOS_HERCULES_ENABLE_SCREENSHOTS && not(@monitor.disable_screenshots) && not(@has_screenshot) 
+          @screenshot_url = @browser.capture_screenshot 
+          @has_screenshot = true
+        end
+      end   
     end
   end
 end

data/lib/uptime_monitor.rb

@@ -3,6 +3,8 @@ require 'watir-webdriver'
 require 'watir-webdriver-performance'
 require 'ostruct'
 require 'active_support'
+require 'carrierwave'
+require 'aws'
 
 def require_all(path)
   Dir.glob(File.dirname(__FILE__) + path + '/*.rb') do |file|
@@ -10,4 +12,22 @@ def require_all(path)
   end
 end
 
+def setup_screenshot_dir
+  FileUtils.mkdir_p RAGIOS_HERCULES_SCREENSHOT_DIR
+  FileUtils.rm_rf(Dir.glob("#{RAGIOS_HERCULES_SCREENSHOT_DIR}/*"))
+end
+
+RAGIOS_HERCULES_SCREENSHOT_DIR = "#{Dir.pwd}/screenshots/tmp"
+RAGIOS_HERCULES_ENABLE_SCREENSHOTS = ENV['RAGIOS_HERCULES_ENABLE_SCREENSHOTS'] == 'true' ? true : false
+
+if RAGIOS_HERCULES_ENABLE_SCREENSHOTS
+  setup_screenshot_dir
+  CarrierWave.configure do |config|
+    config.s3_access_key_id =  ENV['AWS_ACCESS_KEY_ID']
+    config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    config.s3_bucket = ENV['RAGIOS_HERCULES_S3_DIR']
+  end
+  CarrierWave.clean_cached_files! 
+end
+
 require_all '/uptime_monitor'

data/spec/uptime_monitor_spec.rb

@@ -40,6 +40,8 @@ describe Ragios::Plugin::UptimeMonitor do
     page_element = [:title]
     @uptime_monitor.exists([page_element])
     @uptime_monitor.test_result.should == {:results => [[page_element, "exists_as_expected"]]}
+    @uptime_monitor.has_screenshot.should == nil #since no test_command? was run
+    @uptime_monitor.screenshot_url.should == nil
     @uptime_monitor.success.should == nil #since no test_command? was run
     @uptime_monitor.close_browser
   end
@@ -50,6 +52,9 @@ describe Ragios::Plugin::UptimeMonitor do
     page_element = [:title, [text: "dont_exist"]]
     @uptime_monitor.exists([page_element])
     @uptime_monitor.test_result.should == {:results => [[page_element, "does_not_exist_as_expected"]]}
+    if @uptime_monitor.has_screenshot
+      !!(/^.*\.png$/.match(@uptime_monitor.screenshot_url)).should == true
+    end
     @uptime_monitor.success.should == false
     @uptime_monitor.close_browser
   end
@@ -62,6 +67,10 @@ describe Ragios::Plugin::UptimeMonitor do
     @uptime_monitor.init(monitor)
     @uptime_monitor.test_command?.should == true
     @uptime_monitor.test_result.should == {:results => [[page_element, "exists_as_expected"]]}
+    @uptime_monitor.has_screenshot.should == false
+    @uptime_monitor.screenshot_url.should == nil
+    @uptime_monitor.success.should == true 
+    @uptime_monitor.close_browser
   end
   it "runs a test that fails" do
     page_element = [:title, [text: "dont_exist"]]
@@ -71,6 +80,26 @@ describe Ragios::Plugin::UptimeMonitor do
               }
     @uptime_monitor.init(monitor)
     @uptime_monitor.test_command?.should == false
-    @uptime_monitor.test_result.should == {:results => [[page_element, "does_not_exist_as_expected"]]}
+    @uptime_monitor.test_result.should  include(:results => [[page_element, "does_not_exist_as_expected"]])
+    if @uptime_monitor.has_screenshot
+      !!(/^.*\.png$/.match(@uptime_monitor.screenshot_url)).should == true
+    end
+    @uptime_monitor.success.should == false     
+    @uptime_monitor.close_browser
+  end
+  it "can disable screenshot capture when a test fails for individual monitors" do 
+    page_element = [:title, [text: "dont_exist"]]
+    monitor = {
+      url: "http://obi-akubue.org",
+      browser: ["firefox", headless: true],
+      exists?: [page_element],
+      disable_screenshots: true
+    }
+    @uptime_monitor.init(monitor)
+    @uptime_monitor.test_command?.should == false
+    @uptime_monitor.has_screenshot.should == false
+    @uptime_monitor.screenshot_url.should == nil
+    @uptime_monitor.success.should == false 
+    @uptime_monitor.close_browser
   end
 end

data/uptime_monitor.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: uptime_monitor 0.1.1 ruby lib
+# stub: uptime_monitor 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "uptime_monitor"
-  s.version = "0.1.1"
+  s.version = "0.2.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 = "2015-03-21"
+  s.date = "2015-04-12"
   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.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/uptime_monitor.rb",
     "lib/uptime_monitor/browser.rb",
     "lib/uptime_monitor/browser_reader.rb",
+    "lib/uptime_monitor/screen_shot_uploader.rb",
     "lib/uptime_monitor/uptime_monitor.rb",
     "spec/browser_reader_spec.rb",
     "spec/browser_spec.rb",
@@ -40,7 +41,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/obi-a/uptime_monitor"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.5"
+  s.rubygems_version = "2.4.6"
   s.summary = "Real browser website uptime monitoring plugin for Ragios"
 
   if s.respond_to? :specification_version then
@@ -51,6 +52,9 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<watir-webdriver>, [">= 0"])
       s.add_runtime_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<carrierwave>, ["= 0.4.10"])
+      s.add_runtime_dependency(%q<aws>, [">= 0"])
+      s.add_runtime_dependency(%q<aws-s3>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
@@ -61,6 +65,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<watir-webdriver>, [">= 0"])
       s.add_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
       s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<carrierwave>, ["= 0.4.10"])
+      s.add_dependency(%q<aws>, [">= 0"])
+      s.add_dependency(%q<aws-s3>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -72,6 +79,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<watir-webdriver>, [">= 0"])
     s.add_dependency(%q<watir-webdriver-performance>, ["~> 0.2.4"])
     s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<carrierwave>, ["= 0.4.10"])
+    s.add_dependency(%q<aws>, [">= 0"])
+    s.add_dependency(%q<aws-s3>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uptime_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - obi-a
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: headless
@@ -66,6 +66,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.10
+- !ruby/object:Gem::Dependency
+  name: aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +199,7 @@ files:
 - lib/uptime_monitor.rb
 - lib/uptime_monitor/browser.rb
 - lib/uptime_monitor/browser_reader.rb
+- lib/uptime_monitor/screen_shot_uploader.rb
 - lib/uptime_monitor/uptime_monitor.rb
 - spec/browser_reader_spec.rb
 - spec/browser_spec.rb
@@ -183,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Real browser website uptime monitoring plugin for Ragios