ndd-url_checker 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 013fff194ae9760d6089a8d95fbb7bc37fa1ca30
-  data.tar.gz: c840c0b74fb3240cb79832a2a7f7154709ad4b8b
+  metadata.gz: 868566bed28d9a8caf5259c31fdd6b6b2ecb95ad
+  data.tar.gz: 8a9b63c51ca2e69439ceb9878b42bd39f4ff2d8c
 SHA512:
-  metadata.gz: 81691aaa997394bed87fa5d8104c1cd62bc84fd0951648c8b167b524000348f686724dabe2d9ac76b5ebea7f04cec2e5c95d0d6bce7f0a3b55ed11179faec78a
-  data.tar.gz: 2fa122594050d258bd2aaa008470e9e12f6bd81b90f28045ec6aa5f3e4c79793cd74d4b9b4148a6501575e56ac00c69d0e791c9e36d6fcff57b808df3797de76
+  metadata.gz: 870b530f65492340c01815bb2dbdc6c9d9696353ca5846be03a6a58bb489fee95ef2141909ef08415b593a61882ab9c08edbb4120bee35e701afeefbbb0ef35e
+  data.tar.gz: b611b6a1d9fcb60e213c1ae7ede2ff887acee9e1b4856ad514837ae9d22f4a7d8f2d105abe9656c9d952b027b97ac795f3e26bef8179aab57a8b4a1c4c244b1c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # NDD URL Checker changelog
 
+## Version 0.3.3
+
+- Update dependencies
+- Remove Jeweler and use default workflow
+- Add Ruby 2.3 to Travis build
+- Remove Ruby 2.0 and 2.1 from Travis build
+- Remove RDoc and tune Yardoc
+
 ## Version 0.3.2
 
 - Update dependencies to fix security alerts

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2014 David DIDIER
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2016 David DIDIER
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -11,13 +11,13 @@ An URL validator.
 
 The API documentation can be find at [RubyDoc](http://www.rubydoc.info/github/ddidier/ndd-url_checker).
 
+
+
 ## Prerequisites
 
-This gem requires Ruby 2.x and is tested with:
+This gem requires Ruby 2.x and [is tested against some versions](https://travis-ci.org/ddidier/ndd-url_checker).
+
 
-- Ruby 2.0.0
-- Ruby 2.1.6
-- Ruby 2.2.2
 
 ## Usage
 
@@ -78,7 +78,14 @@ report_as_text = checker.report(:json, '/some/report.json')
 report_as_text = checker.report('/some/template.erb', '/some/report.html')
 ```
 
-## Copyright
 
-Copyright (c) 2014 David DIDIER.
-See `LICENSE.txt` for further details.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddidier/ndd-url_checker.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/ndd/url_checker.rb

@@ -6,3 +6,9 @@ require 'ndd/url_checker/reporting_url_checker'
 require 'ndd/url_checker/status'
 require 'ndd/url_checker/status_decorator'
 require 'ndd/url_checker/threaded_url_checker'
+require 'ndd/url_checker/version'
+
+module NDD # :nodoc:
+  module UrlChecker # :nodoc:
+  end
+end

data/lib/ndd/url_checker/reporting_url_checker.rb

@@ -21,6 +21,10 @@ module NDD
         @delegate = delegate_checker
       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)
         results = nil
         benchmark = Benchmark.measure { results = @delegate.check(*urls) }

data/lib/ndd/url_checker/status.rb

@@ -76,6 +76,7 @@ module NDD
         update_code(:unknown_host, %i(unknown redirected))
       end
 
+      # Returns the status representation
       def to_s
         self.inspect
       end

data/lib/ndd/url_checker/status_decorator.rb

@@ -7,10 +7,16 @@ module NDD
     # @author David DIDIER
     class StatusDecorator < SimpleDelegator
 
+      # Returns the CSS class associated with the status.
       def code_as_css
         code.to_s.gsub(/_/, '-')
       end
 
+      # Returns:
+      # - nil if the status is :direct
+      # - the number of redirections if the status is :redirected or :too_many_redirects
+      # - the error if the status is :failed
+      # - the last URL if the status is :unknown_host
       def details_title
         case code
           when :direct then
@@ -27,6 +33,10 @@ module NDD
         end
       end
 
+      # Returns:
+      # - nil if the status is :direct
+      # - all the URLs if the status is :redirected or :too_many_redirects or :unknown_host
+      # - the error message if the status is :failed
       def details_body
         case code
           when :direct then
@@ -44,6 +54,7 @@ module NDD
         end
       end
 
+      # Returns an HTML description of the status.
       def details_body_as_html
         body = <<-HTML.gsub(/^ +/, '')
           <p><em>Status:</em> #{code}</p>

data/lib/ndd/url_checker/version.rb

@@ -0,0 +1,5 @@
+module NDD
+  module UrlChecker
+    VERSION = '0.3.3' # :nodoc:
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ndd-url_checker
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - David DIDIER
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cod
@@ -38,216 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.13'
-- !ruby/object:Gem::Dependency
-  name: guard-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.6'
-- !ruby/object:Gem::Dependency
-  name: guard-spork
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: spork
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.20'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.20'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: libnotify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rb-inotify
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Validate URLs
 email: c_inconnu2@yahoo.fr
 executables: []
@@ -256,53 +46,20 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 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.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/status_decorator.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/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_decorator_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
-homepage: http://github.com/ddidier/ndd-url_checker
+- lib/ndd/url_checker/version.rb
+homepage: https://github.com/ddidier/ndd-url_checker
 licenses:
 - MIT
 metadata: {}
@@ -314,7 +71,10 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -322,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Validate URLs