RubyGems - ndd-url_checker - Versions diffs - 0.3.2 → 0.3.3 - Mend

ndd-url_checker 0.3.2 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +8 -0
data/LICENSE.txt +18 -17
data/README.md +14 -7
data/lib/ndd/url_checker.rb +6 -0
data/lib/ndd/url_checker/reporting_url_checker.rb +4 -0
data/lib/ndd/url_checker/status.rb +1 -0
data/lib/ndd/url_checker/status_decorator.rb +11 -0
data/lib/ndd/url_checker/version.rb +5 -0
metadata +9 -249
data/.document +0 -5
data/.rspec +0 -1
data/.ruby-gemset +0 -1
data/.ruby-version +0 -1
data/.travis.yml +0 -16
data/Gemfile +0 -50
data/Gemfile.lock +0 -162
data/Guardfile +0 -38
data/Rakefile +0 -51
data/VERSION +0 -1
data/lib/ndd/url_checker/reporting_url_checker.csv.erb +0 -4
data/lib/ndd/url_checker/reporting_url_checker.html.erb +0 -188
data/lib/ndd/url_checker/reporting_url_checker.json.erb +0 -27
data/ndd-url_checker.gemspec +0 -134
data/spec/ndd/url_checker/abstract_url_checker_spec.rb +0 -11
data/spec/ndd/url_checker/blocking_url_checker_spec.rb +0 -12
data/spec/ndd/url_checker/forked_url_checker_spec.rb +0 -12
data/spec/ndd/url_checker/parallel_url_checker_spec.rb +0 -62
data/spec/ndd/url_checker/reporting_url_checker/custom.txt.erb +0 -8
data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.csv +0 -6
data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.html +0 -246
data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.json +0 -49
data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.txt +0 -26
data/spec/ndd/url_checker/reporting_url_checker/single_url.csv +0 -2
data/spec/ndd/url_checker/reporting_url_checker/single_url.html +0 -182
data/spec/ndd/url_checker/reporting_url_checker/single_url.json +0 -25
data/spec/ndd/url_checker/reporting_url_checker/single_url.txt +0 -6
data/spec/ndd/url_checker/reporting_url_checker_spec.rb +0 -131
data/spec/ndd/url_checker/status_decorator_spec.rb +0 -208
data/spec/ndd/url_checker/status_spec.rb +0 -510
data/spec/ndd/url_checker/threaded_url_checker_spec.rb +0 -13
data/spec/spec_helper.rb +0 -81
data/spec/support/multiple_url_checker_spec.rb +0 -58
data/spec/support/single_url_checker_spec.rb +0 -252

data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.json DELETED Viewed

@@ -1,49 +0,0 @@
-{
-  "benchmark": {
-    "total_duration": 123.456,
-    "average_duration": 123.456,
-    "average_throughput": 123.456
-  },
-  "statistics": {
-    "count": 5,
-    "valid_count": 2,
-    "direct_count": 1,
-    "redirected_count": 1,
-    "invalid_count": 3,
-    "failed_count": 1,
-    "too_many_redirects_count": 1,
-    "unknown_host_count": 1
-  },
-  "results": [
-    {
-      "index": 1,
-      "url": "http://www.google.com",
-      "code": "redirected",
-      "details": ""
-    },
-    {
-      "index": 2,
-      "url": "http://www.google.de",
-      "code": "failed",
-      "details": "some error"
-    },
-    {
-      "index": 3,
-      "url": "http://www.google.es",
-      "code": "too_many_redirects",
-      "details": ""
-    },
-    {
-      "index": 4,
-      "url": "http://www.google.fr",
-      "code": "direct",
-      "details": ""
-    },
-    {
-      "index": 5,
-      "url": "http://www.google.it",
-      "code": "unknown_host",
-      "details": ""
-    }
-  ]
-}

data/spec/ndd/url_checker/reporting_url_checker/multiple_urls.txt DELETED Viewed

@@ -1,26 +0,0 @@
-count = 5
-- index = 1
-- uri = http://www.google.com
-- valid = true
-- code = redirected
-- index = 2
-- uri = http://www.google.de
-- valid = false
-- code = failed
-- index = 3
-- uri = http://www.google.es
-- valid = false
-- code = too_many_redirects
-- index = 4
-- uri = http://www.google.fr
-- valid = true
-- code = direct
-- index = 5
-- uri = http://www.google.it
-- valid = false
-- code = unknown_host

data/spec/ndd/url_checker/reporting_url_checker/single_url.csv DELETED Viewed

	@@ -1,2 +0,0 @@
1	- Index,URL,Result,Code,Details
2	- 1,http://www.google.fr,valid,direct,

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

@@ -1,182 +0,0 @@
-<!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 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.3/jquery.min.js"></script>
-    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
-    <script language="JavaScript">
-        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>
-<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>1</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>1</dd>
-                <dt>direct</dt>
-                <dd>1</dd>
-                <dt>redirected</dt>
-                <dd>0</dd>
-            </dl>
-        </div>
-        <div class="col-md-4">
-            <dl class="page-info dl-horizontal">
-                <dt>Invalid URLS</dt>
-                <dd>0</dd>
-                <dt>failed</dt>
-                <dd>0</dd>
-                <dt>too many redirects</dt>
-                <dd>0</dd>
-                <dt>unknown host</dt>
-                <dd>0</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 (0)
-                </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 (0)
-                </label>
-                <label class="btn btn-default active">
-                    <input type="checkbox" autocomplete="off" class="display-too-many-redirects" checked="true" />
-                    Too many redirects (0)
-                </label>
-                <label class="btn btn-default active">
-                    <input type="checkbox" autocomplete="off" class="display-unknown-host" checked="true" />
-                    Unknown host (0)
-                </label>
-            </div>
-        </div>
-    </div>
-    <hr />
-    <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-direct ">
-            <td>1</td>
-            <td><a href="http://www.google.fr" target="_blank">http://www.google.fr</a></td>
-            <td>direct</td>
-            <td></td>
-            <td>
-            </td>
-        </tr>
-        </tbody>
-    </table>
-</div>
-</body>
-</html>

data/spec/ndd/url_checker/reporting_url_checker/single_url.json DELETED Viewed

@@ -1,25 +0,0 @@
-{
-  "benchmark": {
-    "total_duration": 123.456,
-    "average_duration": 123.456,
-    "average_throughput": 123.456
-  },
-  "statistics": {
-    "count": 1,
-    "valid_count": 1,
-    "direct_count": 1,
-    "redirected_count": 0,
-    "invalid_count": 0,
-    "failed_count": 0,
-    "too_many_redirects_count": 0,
-    "unknown_host_count": 0
-  },
-  "results": [
-    {
-      "index": 1,
-      "url": "http://www.google.fr",
-      "code": "direct",
-      "details": ""
-    }
-  ]
-}

data/spec/ndd/url_checker/reporting_url_checker/single_url.txt DELETED Viewed

@@ -1,6 +0,0 @@
-count = 1
-- index = 1
-- uri = http://www.google.fr
-- valid = true
-- code = direct

data/spec/ndd/url_checker/reporting_url_checker_spec.rb DELETED Viewed

@@ -1,131 +0,0 @@
-require 'spec_helper'
-RSpec.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
-      before(:each) 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)
-      end
-      it 'creates an CSV report' do
-        actual_report = actual_report_csv(@report_checker, :csv, 'single_url.csv')
-        expected_report = expected_report('single_url.csv')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates an HTML report' do
-        actual_report = actual_report_html(@report_checker, :html, 'single_url.html')
-        expected_report = expected_report('single_url.html')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates an JSON report' do
-        actual_report = actual_report_json(@report_checker, :json, 'single_url.json')
-        expected_report = expected_report('single_url.json')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates a custom report' do
-        custom_template = File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker/custom.txt.erb'))
-        actual_report = actual_report(@report_checker, custom_template, 'single_url.txt')
-        expected_report = expected_report('single_url.txt')
-        expect(actual_report).to eq expected_report
-      end
-    end
-    context 'when checking multiple URLs' do
-      before(:each) do
-        expected_results = [
-            NDD::UrlChecker::Status.new('http://www.google.fr').direct,
-            NDD::UrlChecker::Status.new('http://www.google.com').redirected('http://www.google.fr'),
-            NDD::UrlChecker::Status.new('http://www.google.de').failed(StandardError.new('some error')),
-            NDD::UrlChecker::Status.new('http://www.google.es').redirected('http://www.google.fr').too_many_redirects,
-            NDD::UrlChecker::Status.new('http://www.google.it').unknown_host
-        ]
-        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 })
-      end
-      it 'creates an CSV report' do
-        actual_report = actual_report_csv(@report_checker, :csv, 'multiple_urls.csv')
-        expected_report = expected_report('multiple_urls.csv')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates an HTML report' do
-        actual_report = actual_report_html(@report_checker, :html, 'multiple_urls.html')
-        expected_report = expected_report('multiple_urls.html')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates an JSON report' do
-        actual_report = actual_report_json(@report_checker, :json, 'multiple_urls.json')
-        expected_report = expected_report('multiple_urls.json')
-        expect(actual_report).to eq expected_report
-      end
-      it 'creates a custom report' do
-        custom_template = File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker/custom.txt.erb'))
-        actual_report = actual_report(@report_checker, custom_template, 'multiple_urls.txt')
-        expected_report = expected_report('multiple_urls.txt')
-        expect(actual_report).to eq expected_report
-      end
-    end
-  end
-  # ------------------------------------------------------------------------------------------------------ private -----
-  private
-  def actual_report(report_checker, report_type, output_file_name)
-    # actual_file = File.new('/tmp/report.html', 'w+')
-    actual_file = Tempfile.new(output_file_name)
-    actual_report = report_checker.report(report_type, actual_file)
-    expect(actual_report).to eq actual_file.read
-    actual_report.gsub(/^\s+/, '')
-  end
-  def actual_report_csv(report_checker, report_type, output_file_name)
-    actual_report(report_checker, report_type, output_file_name)
-  end
-  def actual_report_html(report_checker, report_type, output_file_name)
-    actual_report = actual_report(report_checker, report_type, output_file_name)
-    actual_report
-        .gsub(/<dd>[\d\.e-]+ s<\/dd>/, '<dd>123.456 s</dd>')
-        .gsub(/<dd>[\d\.e-]+ URL\/s<\/dd>/, '<dd>123.456 URL/s</dd>')
-        .gsub(/<dd>[\d\.e-]+ s\/URL<\/dd>/, '<dd>123.456 s/URL</dd>')
-  end
-  def actual_report_json(report_checker, report_type, output_file_name)
-    actual_report = actual_report(report_checker, report_type, output_file_name)
-    actual_report.gsub(/\d+\.\d+(e-?\d*)?/, '123.456')
-  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/ndd/url_checker/status_decorator_spec.rb DELETED Viewed

@@ -1,208 +0,0 @@
-require 'spec_helper'
-# ----------------------------------------------------------------------------------------------------------------------
-RSpec.shared_examples 'a status' do |code|
-  context '#uri' do
-    it 'is decorated' do
-      expect(decorator.uri).to eq uri
-    end
-  end
-  context '#code' do
-    it 'is decorated' do
-      expect(decorator.code).to eq code
-    end
-  end
-end
-# ----------------------------------------------------------------------------------------------------------------------
-RSpec.describe NDD::UrlChecker::StatusDecorator do
-  let(:uri) { 'http://www.example.com' }
-  let(:status) { NDD::UrlChecker::Status.new(uri) }
-  let(:decorator) { NDD::UrlChecker::StatusDecorator.new(status) }
-  let(:redirect_uri_1) { 'http://www.redirected1.com' }
-  let(:redirect_uri_2) { 'http://www.redirected2.com' }
-  let(:redirect_uri_3) { 'http://www.redirected3.com' }
-  # ------------------------------------------------------------------------------------------------------- direct -----
-  context 'when code is :direct' do
-    before(:each) { status.direct }
-    it_behaves_like 'a status', :direct
-    context '#details_title' do
-      it 'returns nil' do
-        expect(decorator.details_title).to be_nil
-      end
-    end
-    context '#details_body' do
-      it 'returns nil' do
-        expect(decorator.details_body).to be_nil
-      end
-    end
-  end
-  # ------------------------------------------------------------------------------------------------------- failed -----
-  context 'when code is :failed' do
-    context 'and received a Net::HTTPResponse' do
-      before(:each) do
-        response = Net::HTTPForbidden.new('1.1', 403, 'forbidden!')
-        status.failed(response)
-        allow(response).to receive(:body).and_return('The forbidden body!')
-      end
-      it_behaves_like 'a status', :failed
-      context '#details_title' do
-        it 'returns the name of the class' do
-          expect(decorator.details_title).to eq 'Net::HTTPForbidden'
-        end
-      end
-      context '#details_body' do
-        it 'returns the body of the response' do
-          expect(decorator.details_body).to eq 'The forbidden body!'
-        end
-      end
-    end
-  end
-  # --------------------------------------------------------------------------------------------------- redirected -----
-  context 'when code is :redirected' do
-    context 'and redirected 1 time' do
-      before(:each) { status.redirected(redirect_uri_1) }
-      it_behaves_like 'a status', :redirected
-      context '#details_title' do
-        it 'returns the number of redirect' do
-          expect(decorator.details_title).to eq 1
-        end
-      end
-      context '#details_body' do
-        it 'returns the list of redirected URIs' do
-          expect(decorator.details_body).to eq <<-DOC.gsub(/^ +/, '')
-            - http://www.example.com
-            - http://www.redirected1.com
-          DOC
-        end
-      end
-    end
-    context 'and redirected 3 times' do
-      before(:each) do
-        status
-            .redirected(redirect_uri_1)
-            .redirected(redirect_uri_2)
-            .redirected(redirect_uri_3)
-      end
-      it_behaves_like 'a status', :redirected
-      context '#details_title' do
-        it 'returns the number of redirect' do
-          expect(decorator.details_title).to eq 3
-        end
-      end
-      context '#details_body' do
-        it 'returns the list of redirected URIs' do
-          expect(decorator.details_body).to eq <<-DOC.gsub(/^ +/, '')
-            - http://www.example.com
-            - http://www.redirected1.com
-            - http://www.redirected2.com
-            - http://www.redirected3.com
-          DOC
-        end
-      end
-    end
-  end
-  # ------------------------------------------------------------------------------------------- too_many_redirects -----
-  context 'when code is :too_many_redirects' do
-    context 'and redirected 1 time' do
-      before(:each) { status.redirected(redirect_uri_1).too_many_redirects }
-      it_behaves_like 'a status', :too_many_redirects
-      context '#details_title' do
-        it 'returns the number of redirect' do
-          expect(decorator.details_title).to eq 1
-        end
-      end
-      context '#details_body' do
-        it 'returns the list of redirected URIs' do
-          expect(decorator.details_body).to eq <<-DOC.gsub(/^ +/, '')
-            - http://www.example.com
-            - http://www.redirected1.com
-          DOC
-        end
-      end
-    end
-    context 'and redirected 3 times' do
-      before(:each) do
-        status
-            .redirected(redirect_uri_1)
-            .redirected(redirect_uri_2)
-            .redirected(redirect_uri_3)
-            .too_many_redirects
-      end
-      it_behaves_like 'a status', :too_many_redirects
-      context '#details_title' do
-        it 'returns the number of redirect' do
-          expect(decorator.details_title).to eq 3
-        end
-      end
-      context '#details_body' do
-        it 'returns the list of redirected URIs' do
-          expect(decorator.details_body).to eq <<-DOC.gsub(/^ +/, '')
-            - http://www.example.com
-            - http://www.redirected1.com
-            - http://www.redirected2.com
-            - http://www.redirected3.com
-          DOC
-        end
-      end
-    end
-  end
-  # ------------------------------------------------------------------------------------------------- unknown_host -----
-  context 'when code is :unknown_host' do
-    before(:each) { status.redirected(redirect_uri_1).unknown_host }
-    it_behaves_like 'a status', :unknown_host
-    context '#code_as_css' do
-      it 'returns a CSS class suffix' do
-        expect(decorator.code_as_css).to eq 'unknown-host'
-      end
-    end
-    context '#details_title' do
-      it 'returns the unknown URI' do
-        expect(decorator.details_title).to eq redirect_uri_1
-      end
-    end
-    context '#details_body' do
-      it 'returns the list of redirected URIs' do
-        expect(decorator.details_body).to eq <<-DOC.gsub(/^ +/, '')
-            - http://www.example.com
-            - http://www.redirected1.com
-        DOC
-      end
-    end
-  end
-end