check-sitemap 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e40861b2488ec746e7342b62f35d7dcdee70d9c1
+  data.tar.gz: 948236bbae97c569352ad28bae4b935b893dd44f
+SHA512:
+  metadata.gz: eee047424f31dcc5dceb83ea4f8881be7f7122b09348ec479fd6a5ef8c60a58da1d56b24dc5a6e7feba5d14f95270da3f34faa48f5fe75edb0afb2975013dfd1
+  data.tar.gz: 573b0e64f5cb98da98c194077b26772f177a8c6eccccb898f66a1c22fa7a241cd329d12453cf5dc31164d77f72f0664989906d1e91b9721a1c701a46c20c187b

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'nokogiri'
+gem 'rainbow'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    check-sitemap (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  check-sitemap!
+  nokogiri
+  rainbow
+  rake (~> 10.0)
+  rspec (~> 3.7)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marcos G. Zimmermann
+
+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 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

@@ -0,0 +1,30 @@
+# Check Sitemap
+
+`check-sitemap` is agem that pulls a sitemap and checks all of the URLs listed in it.
+
+## Installation
+
+    $ gem install check-sitemap
+
+## Usage
+
+
+    $ checksitemap <location> [options]
+
+Remote url:
+
+    $ checksitemap http://example.com/sitemap.xml
+
+Local filename:
+
+    $ checksitemap path/to/sitemap.xml.gz # Yeah.. works also with gziped files(Remote or local)
+
+
+It process all the files included in the sitemap index. Use `--concurrence=<num threads>` to parallel process sitemap urls.
+
+    $ checksitemap http://example.com/sitemap_index.xml --concurrence=5
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/check-sitemap.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "check-sitemap"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/check-sitemap.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'check_sitemap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'check-sitemap'
+  spec.version       = CheckSitemap::VERSION
+  spec.authors       = ['Marcos G. Zimmermann']
+  spec.email         = ['mgzmaster@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Check URLs in a sitemap.xml'
+  spec.description   = 'Parse a sitemap.xml URLS and check status of each URL'
+  spec.homepage      = 'https://github.com/marcosgz/check-sitemap'
+
+  spec.executables << 'checksitemap'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

data/exe/checksitemap

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require 'check-sitemap'
+require 'optparse'
+
+url = String(ARGV.shift)
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: checksitemap <url> [options]"
+
+  opts.on("-c CONCURRENCY", "--concurrency=CONCURRENCY", "processor threads to use. (Default: 1)") do |v|
+    CheckSitemap.config.num_threads = v.to_i if v.to_i > 0
+  end
+
+  opts.on("-t TIMEOUT", "--timeout TIMEOUT", "set HTTP Timeout. (Default: 30)") do |v|
+    CheckSitemap.config.timeout = v.to_i if v.to_i > 0
+  end
+
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    CheckSitemap.config.verbose = v
+  end
+end
+
+parser.parse!(ARGV)
+
+if (url.size > 0) && !(url =~ /^-/)
+  sitemap = CheckSitemap::CommandLine.new(url)
+  sitemap.process!
+else
+  puts parser.display
+end

data/lib/check-sitemap.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+require 'open-uri'
+require 'zlib'
+require 'nokogiri'
+require 'timeout'
+require 'uri'
+require 'rainbow'
+require 'openssl'
+
+require 'check_sitemap/version'
+require 'check_sitemap/errors'
+
+module CheckSitemap
+
+  autoload 'XMLReader',     'check_sitemap/xml_reader'
+  autoload 'CommandLine',   'check_sitemap/command_line'
+  autoload 'Config',        'check_sitemap/config'
+  autoload 'CheckURL',      'check_sitemap/check_url'
+
+  def config
+    @config ||= Config.new
+  end
+
+  def log(msg)
+    puts(msg) if config.verbose?
+  end
+
+  extend self
+end

data/lib/check_sitemap/check_url.rb

@@ -0,0 +1,35 @@
+class CheckSitemap::CheckURL
+
+  def self.call(url)
+    uri = URI.parse(url)
+    h = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == 'https'
+      h.use_ssl = true
+      h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    head = \
+      begin
+        Timeout::timeout(::CheckSitemap.config.timeout) do
+          h.start do |ua|
+            ua.head(String(uri.path).empty? ? '/' : uri.path)
+          end
+        end
+      rescue Timeout::Error
+        puts "#{Rainbow(url).yellow} => #{Rainbow('timeout').red}"
+      rescue => e
+        puts "#{Rainbow(url).yellow} => #{Rainbow(e.message).red}"
+      end
+
+    case head.code.to_i
+    when 301
+      puts "#{Rainbow(url).yellow} => redirect to #{Rainbow(head['location']).blue}"
+    when 200
+      puts "#{Rainbow(url).yellow} => #{Rainbow('OK').green}"
+    when 404
+      puts "#{Rainbow(url).yellow} => #{Rainbow('Not found').red}"
+    else
+      puts "#{url} => #{Rainbow(head.code.to_s).indianred}"
+    end
+  end
+end

data/lib/check_sitemap/command_line.rb

@@ -0,0 +1,37 @@
+class CheckSitemap::CommandLine
+
+  def initialize(url_or_filename)
+    @url_or_filename = url_or_filename
+  end
+
+  def process!
+    reader = ::CheckSitemap::XMLReader.new(@url_or_filename)
+    if reader.sitemap_index?
+      reader.each do |url|
+        queue << url
+      end
+      [].tap do |threads|
+        ::CheckSitemap.config.num_threads.to_i.times do
+          threads << Thread.new do
+            until queue.empty?
+              url = queue.pop(true) rescue nil
+              if url
+                ::CheckSitemap::CommandLine.new(url).process!
+              end
+            end
+          end
+        end
+      end.each { |t| t.join }
+    elsif reader.urlset?
+      reader.each do |url|
+        ::CheckSitemap.config.adapter.call(url)
+      end
+    end
+  end
+
+  protected
+
+  def queue
+    @queue ||= Queue.new
+  end
+end

data/lib/check_sitemap/config.rb

@@ -0,0 +1,20 @@
+class CheckSitemap::Config
+  attr_writer :verbose, :num_threads, :timeout, :adapter
+
+  def verbose?
+    !!@verbose
+  end
+
+  def num_threads
+    @num_threads ||= 1
+  end
+
+  def timeout
+    @timeout ||= 30
+  end
+
+  def adapter
+    @adapter ||= CheckSitemap::CheckURL
+  end
+
+end

data/lib/check_sitemap/errors.rb

@@ -0,0 +1,12 @@
+module CheckSitemap
+  class Error < StandardError
+  end
+  class HTTPNotFound < Error
+  end
+  class FileNotFound < Error
+  end
+  class InvalidContentType < Error
+  end
+  class XMLSyntaxError < Error
+  end
+end

data/lib/check_sitemap/version.rb

@@ -0,0 +1,3 @@
+module CheckSitemap
+  VERSION = '0.2.0'.freeze
+end

data/lib/check_sitemap/xml_reader.rb

@@ -0,0 +1,70 @@
+class CheckSitemap::XMLReader
+  include Enumerable
+
+  def initialize(filename, options={})
+    @url_or_filename = filename
+    @options = {}
+  end
+
+  def sitemap_index?
+    doc.css('sitemapindex > sitemap').any?
+  end
+
+  def urlset?
+    doc.css('urlset > url').any?
+  end
+
+  def each(&block)
+    return results.to_enum(:each) unless block_given?
+
+    doc.css('loc').each do |loc|
+      block.call loc.content
+    end
+  end
+
+  protected
+
+  def doc
+    @doc ||= begin
+      CheckSitemap.log("Reading: '#{ @url_or_filename }'")
+      Nokogiri::XML(read_xml) { |config| config.strict }
+    rescue Nokogiri::XML::SyntaxError => e
+      raise(CheckSitemap::XMLSyntaxError.new(e.message))
+    end
+  end
+
+  def read_xml
+    @xml_file = begin
+      if gzip?
+        gz=Zlib::GzipReader.new(raw_file)
+        gz.read
+      elsif xml?
+        raw_file.read
+      end || raise(CheckSitemap::InvalidContentType.new("File format or MIME type is not supported: '#{mime_type(raw_file)}'"))
+    end
+  end
+
+  def raw_file
+    @raw_file ||= download!
+  end
+
+  def gzip?
+    File.extname(@url_or_filename) == '.gz'
+  end
+
+  def xml?
+    File.extname(@url_or_filename) == '.xml'
+  end
+
+  def download!
+    begin
+      CheckSitemap.log("Opening '#{ @url_or_filename }'")
+      open(@url_or_filename)
+    rescue Errno::ENOENT => e
+      raise CheckSitemap::FileNotFound.new("Missing filename '#{@url_or_filename}'")
+    rescue OpenURI::HTTPError => e
+      raise CheckSitemap::HTTPNotFound.new("HTTP request to '#{@url_or_filename}' failed")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: check-sitemap
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Parse a sitemap.xml URLS and check status of each URL
+email:
+- mgzmaster@gmail.com
+executables:
+- checksitemap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- check-sitemap.gemspec
+- exe/checksitemap
+- lib/check-sitemap.rb
+- lib/check_sitemap/check_url.rb
+- lib/check_sitemap/command_line.rb
+- lib/check_sitemap/config.rb
+- lib/check_sitemap/errors.rb
+- lib/check_sitemap/version.rb
+- lib/check_sitemap/xml_reader.rb
+homepage: https://github.com/marcosgz/check-sitemap
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Check URLs in a sitemap.xml
+test_files: []