ndd-url_checker 0.1.1

data/spec/ndd/url_checker/threaded_url_checker_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe NDD::UrlChecker::ThreadedUrlChecker do
+
+  before(:all) do
+    # Logging.logger.root.level = :debug
+  end
+
+  # TODO
+  # it_behaves_like 'a single URL checker'
+  # it_behaves_like 'a multiple URL checker', skip_verify = true
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rubygems'
+require 'spork'
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+# Spork prefork
+# Loading more in this block will cause your tests to run faster. However, if you change any
+# configuration or code from libraries loaded here, you'll need to restart spork for it take effect.
+# ----------------------------------------------------------------------------------------------------------------------
+
+lib_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+spec_dir = File.dirname(__FILE__)
+
+Spork.prefork do
+
+  # ----- load path
+
+  $LOAD_PATH.unshift(lib_path)
+  $LOAD_PATH.unshift(spec_dir)
+
+  # ----- requirements
+
+  require 'logging'
+  require 'rspec'
+  require 'rspec/collection_matchers'
+  require 'webmock/rspec'
+
+  # ----- code coverage
+
+  if ENV['COVERAGE'] and not ENV['DRB']
+    require 'simplecov'
+    SimpleCov.start 'test_frameworks'
+  end
+
+  # ----- logging
+
+  Logging.logger.root.appenders = Logging.appenders.stdout
+  Logging.logger.root.level = :off
+
+  # ----- RSpec configuration
+
+  RSpec.configure do |config|
+
+    config.mock_with :rspec
+
+    # ----- filters
+    config.alias_example_to :fit, :focused
+    config.filter_run_including :focused
+    config.order = 'random'
+    config.run_all_when_everything_filtered = true
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+  end
+
+end
+
+
+# ----------------------------------------------------------------------------------------------------------------------
+# Spork each_run
+# This code will be run each time you run your specs.
+# ----------------------------------------------------------------------------------------------------------------------
+
+Spork.each_run do
+
+  # ----- code coverage
+
+  # if ENV['COVERAGE'] and not ENV['DRB']
+  #   require 'simplecov'
+  #   SimpleCov.start 'test_frameworks'
+  # end
+
+  # ----- files reload
+  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

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+# @param [Boolean] skip_verify because a forked process cannot be verified
+RSpec.shared_examples 'a multiple URL checker' do |skip_verify|
+
+  before(:all) do
+    WebMock.allow_net_connect!
+  end
+
+  before(:each) do
+    WebMock.reset!
+  end
+
+
+  # ------------------------------------------------------------------------------------------------- multiple URL -----
+  context 'when there are multiple URLs' do
+    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
+
+        status1 = results['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/']
+        expect(status2.code).to eq :failed
+        expect(status2.uri).to eq 'http://www.invalid.mock/'
+        expect(status2.error).to be_a StandardError
+      end
+    end
+
+    after(:each) do
+      unless skip_verify
+        expect(stub1).to have_been_requested
+        expect(stub2).to have_been_requested
+      end
+    end
+  end
+
+
+  # ------------------------------------------------------------------------------------------------------ private -----
+  private
+
+  def stub_redirect(from, to)
+    stub_request(:get, from).to_return(status: 301, headers: {Location: to})
+  end
+end
+
+# expect(subject.valid?('http://www.google.fr')).to be_truthy
+# expect(subject.valid?('http://www.google.fr/')).to be_truthy
+# expect(subject.valid?('http://www.invalid123456789xyz.com')).to be_falsey
+# expect(subject.valid?('http://www.invalid123456789xyz.com/')).to be_falsey

data/spec/support/single_url_checker_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+RSpec.shared_examples 'a single URL checker' do
+
+  before(:all) do
+    WebMock.allow_net_connect!
+  end
+
+  before(:each) do
+    WebMock.reset!
+  end
+
+  # ------------------------------------------------------------------------------------------------------- direct -----
+  context 'when the URL is valid' do
+    let!(:stub) { stub_request(:get, 'http://www.valid.mock/').to_return(status: 200) }
+
+    describe '#validate' do
+      it 'returns true' do
+        expect(subject.validate('http://www.valid.mock/')).to be_truthy
+      end
+    end
+
+    describe '#check' do
+      let (:status) { subject.check('http://www.valid.mock/') }
+
+      it 'returns a status with a :direct code' do
+        expect(status.code).to eq :direct
+      end
+      it 'returns a status with the requested URI' do
+        expect(status.uris).to eq ['http://www.valid.mock/']
+      end
+      it 'returns a status with no error' do
+        expect(status.error).to be_nil
+      end
+    end
+
+    after(:each) do
+      expect(stub).to have_been_requested
+    end
+  end
+
+  # --------------------------------------------------------------------------------------------------- redirected -----
+  context 'when there are not too many redirects' 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_request(:get, 'http://www.redirect4.mock/').to_return(status: 200) }
+
+    describe '#validate' do
+      it 'returns true' do
+        expect(subject.validate('http://www.redirect1.mock/')).to be_truthy
+      end
+    end
+
+    describe '#check' do
+      let (:status) { subject.check('http://www.redirect1.mock/') }
+
+      it 'returns a status with a :direct code' do
+        expect(status.code).to eq :redirected
+      end
+
+      it 'returns a status with the requested URI' do
+        expect(status.uri).to eq 'http://www.redirect1.mock/'
+      end
+
+      it 'returns a status with the requested URIs' do
+        expect(status.uris).to eq (1..4).to_a.map { |i| "http://www.redirect#{i}.mock/" }
+      end
+    end
+
+    after(:each) do
+      [stub1, stub2, stub3, stub4].each { |stub| expect(stub).to have_been_requested }
+    end
+  end
+
+  # ------------------------------------------------------------------------------------------- too_many_redirects -----
+  context 'when there are too many redirects' 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/') }
+
+    describe '#validate' do
+      it 'returns false' do
+        expect(subject.validate('http://www.redirect1.mock/')).to be_falsey
+      end
+    end
+
+    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/" }
+      end
+    end
+
+    after(:each) do
+      [stub1, stub2, stub3, stub4, stub5].each { |stub| expect(stub).to have_been_requested }
+    end
+  end
+
+  # ------------------------------------------------------------------------------------------------- unknown_host -----
+  context 'when the URL cannot be resolved' do
+    let!(:stub) {
+      error = SocketError.new('getaddrinfo: Name or service not known')
+      stub_request(:get, 'http://www.invalid.mock/').to_raise(error)
+    }
+
+    describe '#validate' do
+      it 'returns false' do
+        expect(subject.validate('http://www.invalid.mock/')).to be_falsey
+      end
+    end
+
+    describe '#check' do
+      let (:status) { subject.check('http://www.invalid.mock/') }
+
+      it 'returns a status with a :unknown_host code' do
+        expect(status.code).to eq :unknown_host
+      end
+      it 'returns a status with the requested URI' do
+        expect(status.uri).to eq 'http://www.invalid.mock/'
+      end
+      it 'returns a status with no error' do
+        expect(status.error).to be_nil
+      end
+    end
+
+    after(:each) do
+      expect(stub).to have_been_requested
+    end
+  end
+
+  # ------------------------------------------------------------------------------------------------- socket error -----
+  context 'when there is a socket error' do
+    let!(:stub) { stub_request(:get, 'http://www.invalid.mock/').to_raise(SocketError) }
+
+    describe '#validate' do
+      it 'returns false' do
+        expect(subject.validate('http://www.invalid.mock/')).to be_falsey
+      end
+    end
+
+    describe '#check' do
+      let (:status) { subject.check('http://www.invalid.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.invalid.mock/'
+      end
+      it 'returns a status with the raised error' do
+        expect(status.error).to be_a SocketError
+      end
+    end
+
+    after(:each) do
+      expect(stub).to have_been_requested
+    end
+  end
+
+  # -------------------------------------------------------------------------------------------------------- error -----
+  context 'when there is an unexpected error' do
+    let!(:stub) { stub_request(:get, 'http://www.error.mock/').to_raise('Some error') }
+
+    describe '#validate' do
+      it 'returns false' do
+        expect(subject.validate('http://www.error.mock/')).to be_falsey
+      end
+    end
+
+    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 StandardError
+      end
+    end
+
+    after(:each) do
+      expect(stub).to have_been_requested
+    end
+  end
+
+
+  # ------------------------------------------------------------------------------------------------------ private -----
+  private
+
+  def stub_redirect(from, to)
+    stub_request(:get, from).to_return(status: 301, headers: {Location: to})
+  end
+end
+
+# expect(subject.valid?('http://www.google.fr')).to be_truthy
+# expect(subject.valid?('http://www.google.fr/')).to be_truthy
+# expect(subject.valid?('http://www.invalid123456789xyz.com')).to be_falsey
+# expect(subject.valid?('http://www.invalid123456789xyz.com/')).to be_falsey

metadata

@@ -0,0 +1,312 @@
+--- !ruby/object:Gem::Specification
+name: ndd-url_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David DIDIER
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cod
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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: []
+extensions: []
+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/status.rb
+- lib/ndd/url_checker/threaded_url_checker.rb
+- 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/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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Validate URLs
+test_files: []