ndd-url_checker 0.2.1 → 0.3.0

data/lib/ndd/url_checker/reporting_url_checker.json.erb

@@ -1,20 +1,27 @@
 {
   "benchmark": {
-    "utime": "<%= benchmark.utime %>",
-    "stime": "<%= benchmark.stime %>",
-    "total": "<%= benchmark.total %>",
-    "real": "<%= benchmark.real %>",
-    "size": "<%= results.size %>",
-    "throughput": "<%= benchmark.real/results.size %>"
+    "total_duration": <%= benchmark.total_duration %>,
+    "average_duration": <%= benchmark.average_duration %>,
+    "average_throughput": <%= benchmark.average_throughput %>
+  },
+  "statistics": {
+    "count": <%= urls.count %>,
+    "valid_count": <%= urls.valid_count %>,
+    "direct_count": <%= urls.direct_count %>,
+    "redirected_count": <%= urls.redirected_count %>,
+    "invalid_count": <%= urls.invalid_count %>,
+    "failed_count": <%= urls.failed_count %>,
+    "too_many_redirects_count": <%= urls.too_many_redirects_count %>,
+    "unknown_host_count": <%= urls.unknown_host_count %>
   },
   "results": [
-  <% results.each_with_index do |status, index| %>
+  <% statuses.each_with_index do |status, index| %>
     {
       "index": <%= index+1 %>,
       "url": "<%= status.uri %>",
       "code": "<%= status.code %>",
-      "comment": "<% if status.invalid? %><%= status.error %><% end %>"
-    }<% if index < results.size - 1 %>,<% end %>
+      "details": "<% if status.invalid? %><%= status.error %><% end %>"
+    }<% if index < statuses.size - 1 %>,<% end %>
   <% end %>
   ]
 }

data/lib/ndd/url_checker/reporting_url_checker.rb

@@ -24,22 +24,33 @@ module NDD
       def check(*urls)
         results = nil
         benchmark = Benchmark.measure { results = @delegate.check(*urls) }
-        @logger.debug "Checking #{urls.size} URL(s) benchmark: #{benchmark}"
+        @logger.debug "Checked #{urls.size} URL(s) benchmark: #{benchmark}"
 
         if urls.size > 1
-          @context = OpenStruct.new(
-              {
-                  benchmark: benchmark,
-                  results: results.sort_by { |status| status.uri }
-              })
+          statuses = results.map { |status| StatusDecorator.new(status) }.sort_by { |status| status.uri }
         else
-          @context = OpenStruct.new(
-              {
-                  benchmark: benchmark,
-                  results: [results]
-              })
+          statuses = [results].map { |status| StatusDecorator.new(status) }
         end
 
+        @context = OpenStruct.new
+        @context.statuses = statuses
+
+        @context.urls = OpenStruct.new
+        @context.urls.count = urls.size
+        @context.urls.valid_count = statuses.select { |status| status.valid? }.size
+        @context.urls.direct_count = statuses.select { |status| status.code == :direct }.size
+        @context.urls.redirected_count = statuses.select { |status| status.code == :redirected }.size
+        @context.urls.invalid_count = statuses.select { |status| status.invalid? }.size
+        @context.urls.failed_count = statuses.select { |status| status.code == :failed }.size
+        @context.urls.too_many_redirects_count = statuses.select { |status| status.code == :too_many_redirects }.size
+        @context.urls.unknown_host_count = statuses.select { |status| status.code == :unknown_host }.size
+
+        @context.benchmark = OpenStruct.new
+        @context.benchmark.raw = benchmark
+        @context.benchmark.total_duration = benchmark.real
+        @context.benchmark.average_duration = benchmark.real / urls.size
+        @context.benchmark.average_throughput= urls.size / benchmark.real
+
         results
       end
 

data/lib/ndd/url_checker/status.rb

@@ -49,7 +49,7 @@ module NDD
       end
 
       # When a generic error is raised.
-      # @param error [StandardError|String] the generic error.
+      # @param error [StandardError] the generic error.
       # @return [self]
       def failed(error)
         @error = error

data/lib/ndd/url_checker/status_decorator.rb

@@ -0,0 +1,64 @@
+require 'delegate'
+
+module NDD
+  module UrlChecker
+
+    # Decorate a [Status] for reporting.
+    # @author David DIDIER
+    class StatusDecorator < SimpleDelegator
+
+      def code_as_css
+        code.to_s.gsub(/_/, '-')
+      end
+
+      def details_title
+        case code
+          when :direct then
+            nil
+          when :redirected then
+            uris.size - 1
+          when :failed then
+            return nil unless error
+            return error.class.to_s
+          when :too_many_redirects then
+            uris.size - 1
+          when :unknown_host then
+            return uris.last
+        end
+      end
+
+      def details_body
+        case code
+          when :direct then
+            nil
+          when :redirected then
+            uris.map { |uri| "- #{uri}\n" }.join
+          when :failed then
+            return nil unless error
+            return error.body if error.kind_of?(Net::HTTPResponse)
+            return error.to_s
+          when :too_many_redirects then
+            uris.map { |uri| "- #{uri}\n" }.join
+          when :unknown_host then
+            uris.map { |uri| "- #{uri}\n" }.join
+        end
+      end
+
+      def details_body_as_html
+        body = <<-HTML.gsub(/^ +/, '')
+          <p><em>Status:</em> #{code}</p>
+          <p><em>URIs:</em><p>
+          <ol>#{uris.map { |uri| "<li>#{uri}</li>" }.join}</ol>
+        HTML
+
+        if error
+          body += "<p><em>Error:</em> #{error.class.to_s}</p>"
+          body += "<p><pre>#{error.body}</pre></p>" if error.kind_of?(Net::HTTPResponse)
+        end
+
+        body
+      end
+    end
+
+  end
+end

data/ndd-url_checker.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: ndd-url_checker 0.2.1 ruby lib
+# stub: ndd-url_checker 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ndd-url_checker"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["David DIDIER"]
-  s.date = "2014-12-15"
+  s.date = "2015-06-09"
   s.description = "Validate URLs"
   s.email = "c_inconnu2@yahoo.fr"
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "lib/ndd/url_checker/reporting_url_checker.json.erb",
     "lib/ndd/url_checker/reporting_url_checker.rb",
     "lib/ndd/url_checker/status.rb",
+    "lib/ndd/url_checker/status_decorator.rb",
     "lib/ndd/url_checker/threaded_url_checker.rb",
     "ndd-url_checker.gemspec",
     "spec/ndd/url_checker/abstract_url_checker_spec.rb",
@@ -58,6 +59,7 @@ Gem::Specification.new do |s|
     "spec/ndd/url_checker/reporting_url_checker/single_url.json",
     "spec/ndd/url_checker/reporting_url_checker/single_url.txt",
     "spec/ndd/url_checker/reporting_url_checker_spec.rb",
+    "spec/ndd/url_checker/status_decorator_spec.rb",
     "spec/ndd/url_checker/status_spec.rb",
     "spec/ndd/url_checker/threaded_url_checker_spec.rb",
     "spec/spec_helper.rb",
@@ -66,7 +68,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/ddidier/ndd-url_checker"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.4"
+  s.rubygems_version = "2.4.8"
   s.summary = "Validate URLs"
 
   if s.respond_to? :specification_version then

data/spec/ndd/url_checker/abstract_url_checker_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NDD::UrlChecker::AbstractUrlChecker do
+RSpec.describe NDD::UrlChecker::AbstractUrlChecker do
 
   context '#check' do
     it 'is not implemented' do

data/spec/ndd/url_checker/blocking_url_checker_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NDD::UrlChecker::BlockingUrlChecker do
+RSpec.describe NDD::UrlChecker::BlockingUrlChecker do
 
   before(:all) do
     # Logging.logger.root.level = :debug

data/spec/ndd/url_checker/forked_url_checker_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NDD::UrlChecker::ForkedUrlChecker do
+RSpec.describe NDD::UrlChecker::ForkedUrlChecker do
 
   before(:all) do
     # Logging.logger.root.level = :debug

data/spec/ndd/url_checker/parallel_url_checker_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NDD::UrlChecker::ParallelUrlChecker do
+RSpec.describe NDD::UrlChecker::ParallelUrlChecker do
 
   before(:all) do
     # Logging.logger.root.level = :debug

data/spec/ndd/url_checker/reporting_url_checker/custom.txt.erb

@@ -1,6 +1,6 @@
-count = <%= results.size %>
+count = <%= statuses.size %>
 
-<% results.each_with_index do |status, index| %>
+<% statuses.each_with_index do |status, index| %>
 - index = <%= index+1 %>
 - uri = <%= status.uri %>
 - valid = <%= status.valid? %>

data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.csv

@@ -1,4 +1,6 @@
-Index,URL,Result,Code,Comment
-1,http://www.google.com,valid,direct,
+Index,URL,Result,Code,Details
+1,http://www.google.com,valid,redirected,
 2,http://www.google.de,invalid,failed,some error
-3,http://www.google.fr,valid,direct,
+3,http://www.google.es,invalid,too_many_redirects,
+4,http://www.google.fr,valid,direct,
+5,http://www.google.it,invalid,unknown_host,

data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.html

@@ -2,110 +2,245 @@
 <html lang="en">
 
 <head>
-    <meta charset="UTF-8">
-    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
-    <style>
-        body {
-            padding: 1em;
+    <meta charset="UTF-8" />
+
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css" />
+    <style type="text/css">
+        .popover-title {
+            font-weight: bold;
+        }
+
+        .popover-content em {
+            font-style: normal;
+            font-weight: bold;
+        }
+
+        .popover-content ol {
+            margin-left: -20px;
         }
     </style>
 
-    <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
-    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
+    <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
+    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
     <script language="JavaScript">
-        $(document).ready(function() {
-            $('input[type=radio][name=urlsFilter]').change(function() {
-                if (this.value == 'all') {
-                    $('tr').show();
-                }
-                else if (this.value == 'invalid') {
-                    $('tr').not('.danger').hide();
-                }
+        if (!window.ndd_url_checker) {
+            window.ndd_url_checker = {};
+        }
+
+        ndd_url_checker.STATES = ['direct', 'redirected', 'failed', 'too-many-redirects', 'unknown-host'];
+
+        ndd_url_checker.displayStates = function () {
+            var displayStates = {};
+            $.each(ndd_url_checker.STATES, function (_, state) {
+                var checked = $('.display-' + state).is(':checked');
+                displayStates[state] = checked;
+            });
+            return displayStates;
+        }
+
+        ndd_url_checker.filter = function () {
+            var displayStates = ndd_url_checker.displayStates();
+
+            $.each(displayStates, function (state, display) {
+                $('.result-' + state).toggle(display);
             });
+        }
+
+        $(document).ready(function () {
+            // show or hide results depending on their state
+            $.each(ndd_url_checker.STATES, function (_, state) {
+                $('.display-' + state).change(function () {
+                    ndd_url_checker.filter();
+                });
+            });
+
+            // activate all tooltips
+            $('[data-toggle="popover"]')
+                    .popover()
+                    .click(function (e) {
+                        e.preventDefault();
+                    });
         });
     </script>
 </head>
 
+
 <body>
 
-<h1>URL Checker Report</h1>
-
-<table class="table table-condensed table-hover" style="width: auto">
-    <tbody>
-    <tr>
-        <td>User CPU time</td>
-        <td>XXX second(s)</td>
-    </tr>
-    <tr>
-        <td>System CPU time</td>
-        <td>XXX second(s)</td>
-    </tr>
-    <tr>
-        <td>Total time</td>
-        <td>XXX second(s)</td>
-    </tr>
-    <tr>
-        <td>Elapsed real time</td>
-        <td>XXX second(s)</td>
-    </tr>
-    <tr>
-        <td>Number of URLs</td>
-        <td>3</td>
-    </tr>
-    <tr>
-        <td>Average time for 1 URL</td>
-        <td>XXX second(s)</td>
-    </tr>
-    </tbody>
-</table>
-
-<div class="radio">
-    <label>
-        <input type="radio" name="urlsFilter" id="showAllUrls" value="all" checked="true" />
-        Show all URLs
-    </label>
-</div>
-<div class="radio">
-    <label>
-        <input type="radio" name="urlsFilter" id="showInvalidUrls" value="invalid" />
-        Show invalid URLs
-    </label>
-</div>
+<div class="container">
+
+    <div class="page-header">
+        <h1>
+            <span class="glyphicon glyphicon-list-alt" aria-hidden="true"></span>
+            URL Checker Report
+        </h1>
+    </div>
+
+
+    <div class="row">
+        <div class="col-md-4">
+            <dl class="page-info dl-horizontal">
+                <dt>Number of URLs</dt>
+                <dd>5</dd>
+                <dt>Duration</dt>
+                <dd>123.456 s</dd>
+                <dt>Average duration</dt>
+                <dd>123.456 s/URL</dd>
+                <dt>Average throughput</dt>
+                <dd>123.456 URL/s</dd>
+            </dl>
+        </div>
+        <div class="col-md-4">
+            <dl class="page-info dl-horizontal">
+                <dt>Valid URLS</dt>
+                <dd>2</dd>
+                <dt>direct</dt>
+                <dd>1</dd>
+                <dt>redirected</dt>
+                <dd>1</dd>
+            </dl>
+        </div>
+        <div class="col-md-4">
+            <dl class="page-info dl-horizontal">
+                <dt>Invalid URLS</dt>
+                <dd>3</dd>
+                <dt>failed</dt>
+                <dd>1</dd>
+                <dt>too many redirects</dt>
+                <dd>1</dd>
+                <dt>unknown host</dt>
+                <dd>1</dd>
+            </dl>
+        </div>
+    </div>
+    <hr />
+
+
+    <div class="row page-controls hidden-print">
+        <div class="col-md-6">
+            <span>Valid URLs:</span>
+
+            <div class="btn-group page-display" data-toggle="buttons">
+                <label class="btn btn-default active">
+                    <input type="checkbox" autocomplete="off" class="display-direct" checked="true" />
+                    Direct (1)
+                </label>
+                <label class="btn btn-default active">
+                    <input type="checkbox" autocomplete="off" class="display-redirected" checked="true" />
+                    Redirected (1)
+                </label>
+            </div>
+        </div>
+        <div class="col-md-6">
+            <span>Invalid URLs:</span>
+
+            <div class="btn-group page-display" data-toggle="buttons">
+                <label class="btn btn-default active">
+                    <input type="checkbox" autocomplete="off" class="display-failed" checked="true" />
+                    Failed (1)
+                </label>
+                <label class="btn btn-default active">
+                    <input type="checkbox" autocomplete="off" class="display-too-many-redirects" checked="true" />
+                    Too many redirects (1)
+                </label>
+                <label class="btn btn-default active">
+                    <input type="checkbox" autocomplete="off" class="display-unknown-host" checked="true" />
+                    Unknown host (1)
+                </label>
+            </div>
+        </div>
+    </div>
+    <hr />
+
 
-<table class="table table-condensed table-hover" style="width: auto">
-    <thead>
-    <tr>
-        <th>#</th>
-        <th>URL</th>
-        <th>Code</th>
-        <th>Comment</th>
-    </tr>
-    </thead>
-    <tbody>
-
-    <tr class="">
-        <td>1</td>
-        <td><a href="http://www.google.com" target="_blank">http://www.google.com</a></td>
-        <td>direct</td>
-        <td></td>
-    </tr>
-
-    <tr class="danger">
-        <td>2</td>
-        <td><a href="http://www.google.de" target="_blank">http://www.google.de</a></td>
-        <td>failed</td>
-        <td>some error</td>
-    </tr>
-
-    <tr class="">
-        <td>3</td>
-        <td><a href="http://www.google.fr" target="_blank">http://www.google.fr</a></td>
-        <td>direct</td>
-        <td></td>
-    </tr>
-
-    </tbody>
-</table>
+    <table id="results" class="table table-condensed table-hover">
+        <thead>
+        <tr>
+            <th>#</th>
+            <th>URL</th>
+            <th>Code</th>
+            <th>Details</th>
+        </tr>
+        </thead>
+        <tbody>
+
+        <tr class="result result-redirected ">
+            <td>1</td>
+            <td><a href="http://www.google.com" target="_blank">http://www.google.com</a></td>
+            <td>redirected</td>
+            <td>1</td>
+            <td>
+                <a href="#" data-toggle="popover" data-placement="left" data-trigger="focus"
+                   data-html="true" title="http://www.google.com" data-content="<p><em>Status:</em> redirected</p>
+                    <p><em>URIs:</em><p>
+                    <ol><li>http://www.google.com</li><li>http://www.google.fr</li></ol>
+                ">
+                    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
+                </a>
+            </td>
+        </tr>
+
+        <tr class="result result-failed danger">
+            <td>2</td>
+            <td><a href="http://www.google.de" target="_blank">http://www.google.de</a></td>
+            <td>failed</td>
+            <td>StandardError</td>
+            <td>
+                <a href="#" data-toggle="popover" data-placement="left" data-trigger="focus"
+                   data-html="true" title="http://www.google.de" data-content="<p><em>Status:</em> failed</p>
+                    <p><em>URIs:</em><p>
+                    <ol><li>http://www.google.de</li></ol>
+                    <p><em>Error:</em> StandardError</p>">
+                    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
+                </a>
+            </td>
+        </tr>
+
+        <tr class="result result-too-many-redirects danger">
+            <td>3</td>
+            <td><a href="http://www.google.es" target="_blank">http://www.google.es</a></td>
+            <td>too_many_redirects</td>
+            <td>1</td>
+            <td>
+                <a href="#" data-toggle="popover" data-placement="left" data-trigger="focus"
+                   data-html="true" title="http://www.google.es" data-content="<p><em>Status:</em> too_many_redirects</p>
+                    <p><em>URIs:</em><p>
+                    <ol><li>http://www.google.es</li><li>http://www.google.fr</li></ol>
+                ">
+                    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
+                </a>
+            </td>
+        </tr>
+
+        <tr class="result result-direct ">
+            <td>4</td>
+            <td><a href="http://www.google.fr" target="_blank">http://www.google.fr</a></td>
+            <td>direct</td>
+            <td></td>
+            <td>
+            </td>
+        </tr>
+
+        <tr class="result result-unknown-host danger">
+            <td>5</td>
+            <td><a href="http://www.google.it" target="_blank">http://www.google.it</a></td>
+            <td>unknown_host</td>
+            <td>http://www.google.it</td>
+            <td>
+                <a href="#" data-toggle="popover" data-placement="left" data-trigger="focus"
+                   data-html="true" title="http://www.google.it" data-content="<p><em>Status:</em> unknown_host</p>
+                    <p><em>URIs:</em><p>
+                    <ol><li>http://www.google.it</li></ol>
+                ">
+                    <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
+                </a>
+            </td>
+        </tr>
+
+        </tbody>
+    </table>
+
+</div>
 
 </body>
 </html>