ndd-url_checker 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99d36713ad66fe4e91a94f8244232de75f4c9e2c
-  data.tar.gz: 49b3313cc7ef54b102f1af8a2e921f9b96e5c70e
+  metadata.gz: 0ddb514dd4940f3ca4e1c12b26d11569a5d14196
+  data.tar.gz: def79c9bdbfaa493381bcc6bce5e147363afba86
 SHA512:
-  metadata.gz: eb756c557e6c76cb1f5ba947b383e3b3a5baec440f7b4ae1763251744fb925050a5724588d779ea51f1901948abf2777c77bd5f86c57734117a533794144a7b6
-  data.tar.gz: 3d1aa11d6dec0ea8159bb643b6cebe52f33d84b979e0f2bd858356085a616e5c170af888e72cb8f5872a0617421c0e34541b5ace207e12eaf7ff537a6d3e1727
+  metadata.gz: 46cc5e1d3a0442608626e1d86d7e77730b8a5f012781a7711fd7de39f88999e7d776137b9493dcc2117f28db7636b9f439a7c773fcc383c6b5f50e40bdef6e10
+  data.tar.gz: de7f6677ed2b53345150cbb1eb71cc8ee0608957bb28b31f273e43af58dd5b50a68b8794cfab2a48229bcec4f593f4ad297d82d740d50705d034b3337e5bdaa0

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 # NDD URL Checker changelog
 
+## Version 0.2.1
+
+- Replaced status class by status code in reports
+- Added CSV and JSON reports
+
 ## Version 0.2.0
 
 - Switched to named parameters
 - Fixed documentation
-- Removed the `UrlChecker#validate` method.
-- Changed the type of the return value of `UrlChecker#check`.
+- Removed the `UrlChecker#validate` method
+- Changed the type of the return value of `UrlChecker#check`
+- Added `ReportingUrlChecker`
 
 ## Version 0.1.0
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

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

@@ -0,0 +1,4 @@
+Index,URL,Result,Code,Comment
+<% results.each_with_index do |status, index| %>
+<%= index+1 %>,<%= status.uri %>,<%= status.valid? ? 'valid' : 'invalid' %>,<%= status.code %>,<% if status.invalid? %><%= status.error %><% end %>
+<% end %>

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

@@ -77,7 +77,7 @@
   <tr>
     <th>#</th>
     <th>URL</th>
-    <th>Result</th>
+    <th>Code</th>
     <th>Comment</th>
   </tr>
   </thead>
@@ -86,7 +86,7 @@
       <tr class="<%= status.invalid? ? 'danger' : '' %>">
         <td><%= index+1 %></td>
         <td><a href="<%= status.uri %>" target="_blank"><%= status.uri %></a></td>
-        <td><%= status.class %></td>
+        <td><%= status.code %></td>
         <td><% if status.invalid? %><%= status.error %><% end %></td>
       </tr>
   <% end %>

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

@@ -0,0 +1,20 @@
+{
+  "benchmark": {
+    "utime": "<%= benchmark.utime %>",
+    "stime": "<%= benchmark.stime %>",
+    "total": "<%= benchmark.total %>",
+    "real": "<%= benchmark.real %>",
+    "size": "<%= results.size %>",
+    "throughput": "<%= benchmark.real/results.size %>"
+  },
+  "results": [
+  <% results.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 %>
+  <% end %>
+  ]
+}

data/lib/ndd/url_checker/reporting_url_checker.rb

@@ -67,13 +67,11 @@ module NDD
       def template_path(symbol_or_path)
         case symbol_or_path
           when :csv then
-            # File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker.csv.erb'))
-            raise 'TODO'
+            File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker.csv.erb'))
           when :html then
             File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker.html.erb'))
           when :json then
-            # File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker.json.erb'))
-            raise 'TODO'
+            File.expand_path(File.join(File.dirname(__FILE__), 'reporting_url_checker.json.erb'))
           else
             symbol_or_path
         end

data/ndd-url_checker.gemspec

@@ -2,11 +2,11 @@
 # 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
+# stub: ndd-url_checker 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ndd-url_checker"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -37,7 +37,9 @@ Gem::Specification.new do |s|
     "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.csv.erb",
     "lib/ndd/url_checker/reporting_url_checker.html.erb",
+    "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/threaded_url_checker.rb",
@@ -46,8 +48,15 @@ Gem::Specification.new do |s|
     "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/custom.txt.erb",
+    "spec/ndd/url_checker/reporting_url_checker/multiple_urls.csv",
     "spec/ndd/url_checker/reporting_url_checker/multiple_urls.html",
+    "spec/ndd/url_checker/reporting_url_checker/multiple_urls.json",
+    "spec/ndd/url_checker/reporting_url_checker/multiple_urls.txt",
+    "spec/ndd/url_checker/reporting_url_checker/single_url.csv",
     "spec/ndd/url_checker/reporting_url_checker/single_url.html",
+    "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_spec.rb",
     "spec/ndd/url_checker/threaded_url_checker_spec.rb",

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

@@ -0,0 +1,8 @@
+count = <%= results.size %>
+
+<% results.each_with_index do |status, index| %>
+- index = <%= index+1 %>
+- uri = <%= status.uri %>
+- valid = <%= status.valid? %>
+- code = <%= status.code %>
+<% end %>

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

@@ -0,0 +1,4 @@
+Index,URL,Result,Code,Comment
+1,http://www.google.com,valid,direct,
+2,http://www.google.de,invalid,failed,some error
+3,http://www.google.fr,valid,direct,

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

@@ -77,7 +77,7 @@
     <tr>
         <th>#</th>
         <th>URL</th>
-        <th>Result</th>
+        <th>Code</th>
         <th>Comment</th>
     </tr>
     </thead>
@@ -86,21 +86,21 @@
     <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>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>NDD::UrlChecker::Status</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>NDD::UrlChecker::Status</td>
+        <td>direct</td>
         <td></td>
     </tr>
 

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

@@ -0,0 +1,30 @@
+{
+  "benchmark": {
+    "utime": "XXX",
+    "stime": "XXX",
+    "total": "XXX",
+    "real": "XXX",
+    "size": "3",
+    "throughput": "XXX"
+  },
+  "results": [
+    {
+      "index": 1,
+      "url": "http://www.google.com",
+      "code": "direct",
+      "comment": ""
+    },
+    {
+      "index": 2,
+      "url": "http://www.google.de",
+      "code": "failed",
+      "comment": "some error"
+    },
+    {
+      "index": 3,
+      "url": "http://www.google.fr",
+      "code": "direct",
+      "comment": ""
+    }
+  ]
+}

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

@@ -0,0 +1,16 @@
+count = 3
+
+- index = 1
+- uri = http://www.google.com
+- valid = true
+- code = direct
+
+- index = 2
+- uri = http://www.google.de
+- valid = false
+- code = failed
+
+- index = 3
+- uri = http://www.google.fr
+- valid = true
+- code = direct

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

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

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

@@ -77,7 +77,7 @@
     <tr>
         <th>#</th>
         <th>URL</th>
-        <th>Result</th>
+        <th>Code</th>
         <th>Comment</th>
     </tr>
     </thead>
@@ -86,7 +86,7 @@
     <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>direct</td>
         <td></td>
     </tr>
 

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

@@ -0,0 +1,18 @@
+{
+  "benchmark": {
+    "utime": "XXX",
+    "stime": "XXX",
+    "total": "XXX",
+    "real": "XXX",
+    "size": "1",
+    "throughput": "XXX"
+  },
+  "results": [
+    {
+      "index": 1,
+      "url": "http://www.google.fr",
+      "code": "direct",
+      "comment": ""
+    }
+  ]
+}

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

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

data/spec/ndd/url_checker/reporting_url_checker_spec.rb

@@ -16,22 +16,43 @@ describe NDD::UrlChecker::ReportingUrlChecker do
   describe '#report' do
 
     context 'when checking a single URL' do
-      it 'creates an HTML report' 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)
+        @report_checker = NDD::UrlChecker::ReportingUrlChecker.new(checker)
+        @report_checker.check(expected_result.uri)
+      end
+
+      it 'creates an CSV report' do
+        actual_report = actual_report(@report_checker, :csv, 'single_url.csv')
+        expected_report = expected_report('single_url.csv')
+        expect(actual_report).to eq expected_report
+      end
 
-        actual_report = actual_report(report_checker, 'single_url.html')
+      it 'creates an HTML report' do
+        actual_report = actual_report(@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(@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
-      it 'creates an HTML report' do
+      before(:each) do
         expected_results = [
             NDD::UrlChecker::Status.new('http://www.google.fr').direct,
             NDD::UrlChecker::Status.new('http://www.google.com').direct,
@@ -40,13 +61,34 @@ describe NDD::UrlChecker::ReportingUrlChecker do
         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 })
+        @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(@report_checker, :csv, 'multiple_urls.csv')
+        expected_report = expected_report('multiple_urls.csv')
+        expect(actual_report).to eq expected_report
+      end
 
-        actual_report = actual_report(report_checker, 'multiple_urls.html')
+      it 'creates an HTML report' do
+        actual_report = actual_report(@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(@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
 
@@ -54,12 +96,14 @@ describe NDD::UrlChecker::ReportingUrlChecker do
   # ------------------------------------------------------------------------------------------------------ private -----
   private
 
-  def actual_report(report_checker, output_file_name)
+  def actual_report(report_checker, report_type, output_file_name)
     # actual_file = '/tmp/multiple_urls.html'
     actual_file = Tempfile.new(output_file_name)
-    actual_report = report_checker.report(:html, actual_file)
+    actual_report = report_checker.report(report_type, 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>')
+    actual_report.gsub(/^\s+/, '')
+                 .gsub(/<td>[\d\.e-]+ second\(s\)<\/td>/, '<td>XXX second(s)</td>') # HTML
+                 .gsub(/"\d+\.\d+"/, '"XXX"').gsub(/"\d+\.\d+e-\d+"/, '"XXX"')      # JSON
   end
 
   def expected_report(expected_file_name)

data/spec/support/single_url_checker_spec.rb

@@ -66,16 +66,21 @@ RSpec.shared_examples 'a single URL checker' do
     let!(:stub1) { stub_redirect('http://www.redirect1.mock/', 'http://www.redirect2.mock/') }
     let!(:stub2) { stub_redirect('http://www.redirect2.mock/', 'http://www.redirect3.mock/') }
     let!(:stub3) { stub_redirect('http://www.redirect3.mock/', 'http://www.redirect4.mock/') }
-    let!(:stub4) { stub_redirect('http://www.redirect4.mock/', 'http://www.redirect5.mock/') }
-    let!(:stub5) { stub_redirect('http://www.redirect5.mock/', 'http://www.redirect6.mock/') }
+    let!(:stub4) { stub_redirect('http://www.redirect4.mock/', 'relative') }
+    let!(:stub5) { stub_redirect('http://www.redirect4.mock/relative', 'http://www.redirect5.mock/') }
 
     describe '#check' do
       it 'returns UrlChecker::Direct' do
         result = subject.check('http://www.redirect1.mock/')
         expect(result).to be_kind_of NDD::UrlChecker::Status
-        # expect(result).to be_kind_of UrlChecker::TooManyRedirect
         expect(result.uri).to eq 'http://www.redirect1.mock/'
-        expect(result.uris).to eq (1..6).to_a.map { |i| "http://www.redirect#{i}.mock/" }
+        expect(result.uris).to eq %w(http://www.redirect1.mock/
+                                     http://www.redirect2.mock/
+                                     http://www.redirect3.mock/
+                                     http://www.redirect4.mock/
+                                     http://www.redirect4.mock/relative
+                                     http://www.redirect5.mock/
+                                    )
       end
     end
 
@@ -133,7 +138,30 @@ RSpec.shared_examples 'a single URL checker' do
     end
   end
 
-  # -------------------------------------------------------------------------------------------------------- error -----
+  # ----------------------------------------------------------------------------------------------- expected error -----
+  context 'when there is an unexpected error' do
+    let!(:stub) { stub_request(:get, 'http://www.error.mock/').to_return(status: 400) }
+
+    describe '#check' do
+      let (:status) { subject.check('http://www.error.mock/') }
+
+      it 'returns a status with a :failed code' do
+        expect(status.code).to eq :failed
+      end
+      it 'returns a status with the requested URI' do
+        expect(status.uri).to eq 'http://www.error.mock/'
+      end
+      it 'returns a status with the raised error' do
+        expect(status.error).to be_a Net::HTTPBadRequest
+      end
+    end
+
+    after(:each) do
+      expect(stub).to have_been_requested
+    end
+  end
+
+  # --------------------------------------------------------------------------------------------- unexpected error -----
   context 'when there is an unexpected error' do
     let!(:stub) { stub_request(:get, 'http://www.error.mock/').to_raise('Some error') }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ndd-url_checker
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David DIDIER
@@ -274,7 +274,9 @@ files:
 - 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.csv.erb
 - lib/ndd/url_checker/reporting_url_checker.html.erb
+- 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/threaded_url_checker.rb
@@ -283,8 +285,15 @@ files:
 - 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/custom.txt.erb
+- spec/ndd/url_checker/reporting_url_checker/multiple_urls.csv
 - spec/ndd/url_checker/reporting_url_checker/multiple_urls.html
+- spec/ndd/url_checker/reporting_url_checker/multiple_urls.json
+- spec/ndd/url_checker/reporting_url_checker/multiple_urls.txt
+- spec/ndd/url_checker/reporting_url_checker/single_url.csv
 - spec/ndd/url_checker/reporting_url_checker/single_url.html
+- 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_spec.rb
 - spec/ndd/url_checker/threaded_url_checker_spec.rb