ndd-url_checker 0.1.1 → 0.2.0

data/lib/ndd/url_checker/status.rb

@@ -4,7 +4,7 @@ module NDD
     # The result of a URI test.
     # @author David DIDIER
     # @attr_reader code [String] the state
-    # @attr_reader error [String|StandardError] the last error if any
+    # @attr_reader error [String, StandardError] the last error if any
     # @attr_reader uris [Array<String>] the list of requested URI
     class Status
 
@@ -12,46 +12,45 @@ module NDD
       attr_reader :error
       attr_reader :uris
 
-      # Create a new NDD::UrlChecker::Status instance in the unknown state.
-      # @param uri [String|URI::HTTP] the requested URI.
+      # Creates a new instance in the :unknown state.
+      # @param uri [String, URI::HTTP] the requested URI.
       def initialize(uri)
         @uris = [uri.to_s]
         @code = :unknown
       end
 
-      # Returns the first requested URI.
-      # @return [String] the first requested URI.
+      # @return [String] the first requested URI.
       def uri
         uris.first
       end
 
-      # Note that the code :unknown is neither valid nor invalid.
-      # @return [Boolean] true if valid, false otherwise.
+      # Note that the :unknown code is neither valid nor invalid.
+      # @return [Boolean] true if valid, false otherwise.
       def valid?
         VALID_CODES.include? @code
       end
 
-      # Note that the code :unknown is neither valid nor invalid.
-      # @return [Boolean] true if invalid, false otherwise.
+      # Note that the :unknown code is neither valid nor invalid.
+      # @return [Boolean] true if invalid, false otherwise.
       def invalid?
         INVALID_CODES.include? @code
       end
 
-      # @return [Boolean] true if redirected, false otherwise.
+      # @return [Boolean] true if redirected, false otherwise.
       def redirected?
         @code == :redirected
       end
 
 
       # When the URI is valid without any redirect.
-      # @return [NDD::UrlChecker::Status] self.
+      # @return [self]
       def direct
         update_code(:direct, %i(unknown))
       end
 
-      # When a generic error is raised.
+      # When a generic error is raised.
       # @param error [StandardError|String] the generic error.
-      # @return [NDD::UrlChecker::Status] self.
+      # @return [self]
       def failed(error)
         @error = error
         update_code(:failed, %i(unknown redirected))
@@ -59,20 +58,20 @@ module NDD
 
       # Adds a new URI to the redirected URI list.
       # @param uri [String|URI::HTTP] the redirection URI.
-      # @return [NDD::UrlChecker::Status] self.
+      # @return [self]
       def redirected(uri)
         @uris << uri.to_s
         update_code(:redirected, %i(unknown redirected))
       end
 
-      # When there are too many redirects.
-      # @return [NDD::UrlChecker::Status] self.
+      # When there are too many redirects.
+      # @return [self]
       def too_many_redirects
         update_code(:too_many_redirects, %i(unknown redirected))
       end
 
-      # When the host cannot be resolved.
-      # @return [NDD::UrlChecker::Status] self.
+      # When the host cannot be resolved.
+      # @return [self]
       def unknown_host
         update_code(:unknown_host, %i(unknown redirected))
       end
@@ -82,15 +81,16 @@ module NDD
       end
 
 
+      # -------------------------------------------------------------------------------------------------- private -----
       private
 
       VALID_CODES = %i(direct redirected).freeze
       INVALID_CODES = %i(failed too_many_redirects unknown_host).freeze
 
-      # Updates the code if the transition is valid.
+      # Updates the code if the transition is valid.
       # @param code [Symbol] the new code.
       # @param valid_source_codes [Array<Symbol>] the codes from which the transition can happen.
-      # @return [NDD::UrlChecker::Status] self.
+      # @return [NDD::UrlChecker::Status] self.
       def update_code(code, valid_source_codes)
         unless valid_source_codes.include?(@code)
           raise "Changing the status code from :#{@code} to :#{code} is forbidden"

data/lib/ndd/url_checker/threaded_url_checker.rb

@@ -8,29 +8,31 @@ module NDD
 
     # An URL checker using threads to parallelize processing. Does not work on MRI.
     # @author David DIDIER
+    # @attr_reader delegate [#check] the delegate URL checker.
+    # @attr_reader parallelism [Fixnum] the number of threads.
     class ThreadedUrlChecker < AbstractUrlChecker
 
       attr_reader :delegate
+      attr_reader :parallelism
 
       # Create a new instance.
-      # @param [AbstractUrlChecker] delegate_checker defaults to {NDD::UrlChecker::BlockingUrlChecker}.
-      # @param [Fixnum] parallelism the number of threads.
-      def initialize(delegate_checker=nil, parallelism=10)
+      # @param delegate_checker [AbstractUrlChecker] defaults to {NDD::UrlChecker::BlockingUrlChecker}.
+      # @param parallelism [Fixnum] the number of threads.
+      def initialize(delegate_checker: nil, parallelism: 10)
         @logger = Logging.logger[self]
         @delegate = delegate_checker || BlockingUrlChecker.new
         @parallelism = parallelism
       end
 
+      # Checks that the given URLs are valid.
+      # @param urls [String, Array<String>] the URLs to check
+      # @return [NDD::UrlChecker::Status, Array<NDD::UrlChecker::Status>] a single status for a single URL, an array
+      #         of status for multiple parameters
       def check(*urls)
         # delegate.check(*urls)
         raise 'TODO'
       end
 
-      def validate(*urls)
-        # delegate.validate(*urls)
-        raise 'TODO'
-      end
-
     end
   end
 end

data/ndd-url_checker.gemspec

@@ -0,0 +1,123 @@
+# Generated by jeweler
+# 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.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "ndd-url_checker"
+  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 = ["David DIDIER"]
+  s.date = "2014-12-15"
+  s.description = "Validate URLs"
+  s.email = "c_inconnu2@yahoo.fr"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-gemset",
+    ".ruby-version",
+    ".travis.yml",
+    "CHANGELOG.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/ndd/url_checker.rb",
+    "lib/ndd/url_checker/abstract_url_checker.rb",
+    "lib/ndd/url_checker/blocking_url_checker.rb",
+    "lib/ndd/url_checker/forked_url_checker.rb",
+    "lib/ndd/url_checker/parallel_url_checker.rb",
+    "lib/ndd/url_checker/reporting_url_checker.html.erb",
+    "lib/ndd/url_checker/reporting_url_checker.rb",
+    "lib/ndd/url_checker/status.rb",
+    "lib/ndd/url_checker/threaded_url_checker.rb",
+    "ndd-url_checker.gemspec",
+    "spec/ndd/url_checker/abstract_url_checker_spec.rb",
+    "spec/ndd/url_checker/blocking_url_checker_spec.rb",
+    "spec/ndd/url_checker/forked_url_checker_spec.rb",
+    "spec/ndd/url_checker/parallel_url_checker_spec.rb",
+    "spec/ndd/url_checker/reporting_url_checker/multiple_urls.html",
+    "spec/ndd/url_checker/reporting_url_checker/single_url.html",
+    "spec/ndd/url_checker/reporting_url_checker_spec.rb",
+    "spec/ndd/url_checker/status_spec.rb",
+    "spec/ndd/url_checker/threaded_url_checker_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/multiple_url_checker_spec.rb",
+    "spec/support/single_url_checker_spec.rb"
+  ]
+  s.homepage = "http://github.com/ddidier/ndd-url_checker"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.4"
+  s.summary = "Validate URLs"
+
+  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<cod>, ["~> 0.6"])
+      s.add_runtime_dependency(%q<logging>, ["~> 1.8"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.7"])
+      s.add_development_dependency(%q<guard>, ["~> 2.8"])
+      s.add_development_dependency(%q<guard-bundler>, ["~> 2.0"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 4.3"])
+      s.add_development_dependency(%q<guard-spork>, ["~> 2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_development_dependency(%q<rspec-collection_matchers>, ["~> 1.1"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_development_dependency(%q<spork>, ["~> 0.9"])
+      s.add_development_dependency(%q<webmock>, ["~> 1.20"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+      s.add_development_dependency(%q<libnotify>, [">= 0"])
+      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
+    else
+      s.add_dependency(%q<cod>, ["~> 0.6"])
+      s.add_dependency(%q<logging>, ["~> 1.8"])
+      s.add_dependency(%q<bundler>, ["~> 1.7"])
+      s.add_dependency(%q<guard>, ["~> 2.8"])
+      s.add_dependency(%q<guard-bundler>, ["~> 2.0"])
+      s.add_dependency(%q<guard-rspec>, ["~> 4.3"])
+      s.add_dependency(%q<guard-spork>, ["~> 2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.1"])
+      s.add_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_dependency(%q<rspec-collection_matchers>, ["~> 1.1"])
+      s.add_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_dependency(%q<spork>, ["~> 0.9"])
+      s.add_dependency(%q<webmock>, ["~> 1.20"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+      s.add_dependency(%q<libnotify>, [">= 0"])
+      s.add_dependency(%q<rb-inotify>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cod>, ["~> 0.6"])
+    s.add_dependency(%q<logging>, ["~> 1.8"])
+    s.add_dependency(%q<bundler>, ["~> 1.7"])
+    s.add_dependency(%q<guard>, ["~> 2.8"])
+    s.add_dependency(%q<guard-bundler>, ["~> 2.0"])
+    s.add_dependency(%q<guard-rspec>, ["~> 4.3"])
+    s.add_dependency(%q<guard-spork>, ["~> 2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.1"])
+    s.add_dependency(%q<rspec>, ["~> 3.1"])
+    s.add_dependency(%q<rspec-collection_matchers>, ["~> 1.1"])
+    s.add_dependency(%q<simplecov>, ["~> 0.9"])
+    s.add_dependency(%q<spork>, ["~> 0.9"])
+    s.add_dependency(%q<webmock>, ["~> 1.20"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+    s.add_dependency(%q<libnotify>, [">= 0"])
+    s.add_dependency(%q<rb-inotify>, [">= 0"])
+  end
+end
+

data/spec/ndd/url_checker/abstract_url_checker_spec.rb

@@ -2,12 +2,6 @@ require 'spec_helper'
 
 describe NDD::UrlChecker::AbstractUrlChecker do
 
-  context '#validate' do
-    it 'is not implemented' do
-      expect { subject.validate('http://www.valid.mock/') }.to raise_error /must be implemented/
-    end
-  end
-
   context '#check' do
     it 'is not implemented' do
       expect { subject.check('http://www.valid.mock/') }.to raise_error /must be implemented/

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

@@ -0,0 +1,111 @@
+<!DOCTYPE html>
+<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;
+        }
+    </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 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();
+                }
+            });
+        });
+    </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>
+
+<table class="table table-condensed table-hover" style="width: auto">
+    <thead>
+    <tr>
+        <th>#</th>
+        <th>URL</th>
+        <th>Result</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>NDD::UrlChecker::Status</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>NDD::UrlChecker::Status</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>NDD::UrlChecker::Status</td>
+        <td></td>
+    </tr>
+
+    </tbody>
+</table>
+
+</body>
+</html>

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

@@ -0,0 +1,97 @@
+<!DOCTYPE html>
+<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;
+        }
+    </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 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();
+                }
+            });
+        });
+    </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>1</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>
+
+<table class="table table-condensed table-hover" style="width: auto">
+    <thead>
+    <tr>
+        <th>#</th>
+        <th>URL</th>
+        <th>Result</th>
+        <th>Comment</th>
+    </tr>
+    </thead>
+    <tbody>
+
+    <tr class="">
+        <td>1</td>
+        <td><a href="http://www.google.fr" target="_blank">http://www.google.fr</a></td>
+        <td>NDD::UrlChecker::Status</td>
+        <td></td>
+    </tr>
+
+    </tbody>
+</table>
+
+</body>
+</html>

data/spec/ndd/url_checker/reporting_url_checker_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe NDD::UrlChecker::ReportingUrlChecker do
+
+  before(:all) do
+    # Logging.logger.root.level = :debug
+  end
+
+  subject(:checker) { NDD::UrlChecker::ReportingUrlChecker.new(NDD::UrlChecker::BlockingUrlChecker.new) }
+
+  it_behaves_like 'a single URL checker'
+  it_behaves_like 'a multiple URL checker'
+
+
+  # ------------------------------------------------------------------------------------------------------ #report -----
+  describe '#report' do
+
+    context 'when checking a single URL' do
+      it 'creates an HTML report' do
+        expected_result = NDD::UrlChecker::Status.new('http://www.google.fr').direct
+        checker = double
+        expect(checker).to receive(:check).and_return(expected_result)
+
+        report_checker = NDD::UrlChecker::ReportingUrlChecker.new(checker)
+        report_checker.check(expected_result.uri)
+
+        actual_report = actual_report(report_checker, 'single_url.html')
+        expected_report = expected_report('single_url.html')
+        expect(actual_report).to eq expected_report
+      end
+    end
+
+    context 'when checking multiple URLs' do
+      it 'creates an HTML report' do
+        expected_results = [
+            NDD::UrlChecker::Status.new('http://www.google.fr').direct,
+            NDD::UrlChecker::Status.new('http://www.google.com').direct,
+            NDD::UrlChecker::Status.new('http://www.google.de').failed('some error')
+        ]
+        checker = double
+        expect(checker).to receive(:check).and_return(expected_results)
+
+        report_checker = NDD::UrlChecker::ReportingUrlChecker.new(checker)
+        report_checker.check(*expected_results.map { |status| status.uri })
+
+        actual_report = actual_report(report_checker, 'multiple_urls.html')
+        expected_report = expected_report('multiple_urls.html')
+        expect(actual_report).to eq expected_report
+      end
+    end
+  end
+
+
+  # ------------------------------------------------------------------------------------------------------ private -----
+  private
+
+  def actual_report(report_checker, output_file_name)
+    # actual_file = '/tmp/multiple_urls.html'
+    actual_file = Tempfile.new(output_file_name)
+    actual_report = report_checker.report(:html, actual_file)
+    expect(actual_report).to eq actual_file.read
+    actual_report.gsub(/^\s+/, '').gsub(/<td>[\d\.e-]+ second\(s\)<\/td>/, '<td>XXX second(s)</td>')
+  end
+
+  def expected_report(expected_file_name)
+    expected_path = File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker/' + expected_file_name))
+    expected_report = File.new(expected_path).read
+    expected_report.gsub(/^\s+/, '')
+  end
+end

data/spec/spec_helper.rb

@@ -27,6 +27,7 @@ Spork.prefork do
   require 'logging'
   require 'rspec'
   require 'rspec/collection_matchers'
+  require 'tempfile'
   require 'webmock/rspec'
 
   # ----- code coverage
@@ -79,5 +80,4 @@ Spork.each_run do
   Dir["#{lib_path}/**/*.rb"].each { |file| require file }
   Dir["#{spec_dir}/support/**/*.rb"].each { |file| require file }
 
-  require 'ndd/url_checker'
 end

data/spec/support/multiple_url_checker_spec.rb

@@ -17,26 +17,18 @@ RSpec.shared_examples 'a multiple URL checker' do |skip_verify|
     let!(:stub1) { stub_request(:get, 'http://www.valid.mock/').to_return(status: 200) }
     let!(:stub2) { stub_request(:get, 'http://www.invalid.mock/').to_raise(SocketError) }
 
-    describe '#validate' do
-      it 'returns a map of the results indexed by the URI' do
-        results = subject.validate('http://www.valid.mock/', 'http://www.invalid.mock/')
-        expect(results).to have(2).items
-        expect(results['http://www.valid.mock/']).to be_truthy
-        expect(results['http://www.invalid.mock/']).to be_falsey
-      end
-    end
-
     describe '#check' do
       it 'returns a map of the results indexed by the URI' do
         results = subject.check('http://www.valid.mock/', 'http://www.invalid.mock/')
         expect(results).to have(2).items
+        results_hash = results.reduce({}) { |hash, result| hash[result.uri] = result; hash }
 
-        status1 = results['http://www.valid.mock/']
+        status1 = results_hash['http://www.valid.mock/']
         expect(status1.code).to eq :direct
         expect(status1.uri).to eq 'http://www.valid.mock/'
         expect(status1.error).to be_nil
 
-        status2 = results['http://www.invalid.mock/']
+        status2 = results_hash['http://www.invalid.mock/']
         expect(status2.code).to eq :failed
         expect(status2.uri).to eq 'http://www.invalid.mock/'
         expect(status2.error).to be_a StandardError