sla 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b603ee409c9bb9d7846dfd6d843496f961bd91edb04a4186c4ba3629ab9d2e
-  data.tar.gz: 9d7b4862e1878354cf0dca9a62be98ad2db8b9f3aece306bb1ffdc439f27451d
+  metadata.gz: 20e5f6a05020d9aecc2ad6754a7a22cee70e18f45e3bc5f679daabb2042c749a
+  data.tar.gz: 2d5b0290dd9dd25169bbb89ff20df4aea66db616ea65585a56a982866579f568
 SHA512:
-  metadata.gz: 9ed2eba3bb08b65766d7ef2246219f95271b44501e7a0085123427c33a4d8598bc1495d796a8aea5bd0e547a8266cc650bd500c539e0afb2ad8093ee4c67bfca
-  data.tar.gz: bb9da599ff06fe917615d039086a51bd54070b8f80aa3785a02db6a09fe70921080d388ba27004763d42090667bbbb4b77ecab3a61ac8128d2e90952d61d9b15
+  metadata.gz: cc586125c98e82786f0c747fcdf9d21f45d933564e4aba416036d21a39a70c72bdb974665c8e6a6f5c5b17a4ad323a52bb896205f4e5bb7e49002dd4370b1d84
+  data.tar.gz: 10fadfccf9da8a7b427f6512bfb6365f890dc70cc01646280a5de51aeebee38026942dc78b30e1c5dac9196015e3e9565a804bf13e8c9c3c7c2bed00c9a5ca49

data/README.md

@@ -1,101 +1,80 @@
-Site Link Analyzer
-==================================================
-
-[![Gem Version](https://badge.fury.io/rb/sla.svg)](https://badge.fury.io/rb/sla)
-[![Build Status](https://travis-ci.com/DannyBen/sla.svg?branch=master)](https://travis-ci.com/DannyBen/sla)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f78192aead8a74535a24/maintainability)](https://codeclimate.com/github/DannyBen/sla/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/f78192aead8a74535a24/test_coverage)](https://codeclimate.com/github/DannyBen/sla/test_coverage)
-
----
-
-SLA is a simple broken links checker, with built in caching.
-
----
-
-Install
---------------------------------------------------
-
-```
-$ gem install sla
-```
-
-Or with bundler:
-
-```ruby
-gem 'sla'
-```
-
-
-Features
---------------------------------------------------
-
-- Easy to use command line interface
-- Built in caching, to avoid over stressing the server
-- Outputs the site tree to screen and log file
-
-
-Example Output
---------------------------------------------------
-```
-$ sla check localhost:3000
-1 200 - http://localhost:3000
-2 200 -- /whiskey
-3 200 --- /whiskey/tango
-4 404 ---- /whiskey/tango/foxtrot
-5 200 -- /ten
-6 200 --- /ten/four
-7 200 -- /roger
-Done with 1 failures
-```
-
-
-Usage
---------------------------------------------------
-
-```
-$ sla --help
-SLA
-
-Usage:
-  sla check DOMAIN [options]
-  sla (-h|--help|--version)
-
-Commands:
-  check
-    Start checking for broken links on a given domain
-  
-Options:
-  --depth, -d DEPTH
-    Set crawling depth [default: 5]
-
-  --cache, -c LIFE
-    Set cache life [default: 1d]. LIFE can be in any of the 
-    following formats:
-      10  = 10 seconds
-      20s = 20 seconds
-      10m = 10 minutes
-      10h = 10 hours
-      10d = 10 days
-
-  --cache-dir DIR
-    Set the cache directory
-
-  --external
-    Also check external links
-
-  --no-color
-    Disable colors in output
-
-  --no-log
-    Disable logging
-
-  --log LOGFILE
-    Set the name of the logfile [default: sla.log]
-
-Examples:
-  sla check example.com
-  sla check example.com -c10m -d10
-  sla check example.com --cache-dir my_cache --no-log
-  sla check example.com --depth 10 --log my_log.log
-  sla check example.com --cache 30d
-```
+Site Link Analyzer
+==================================================
+
+[![Gem Version](https://badge.fury.io/rb/sla.svg)](https://badge.fury.io/rb/sla)
+[![Build Status](https://travis-ci.com/DannyBen/sla.svg?branch=master)](https://travis-ci.com/DannyBen/sla)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f78192aead8a74535a24/maintainability)](https://codeclimate.com/github/DannyBen/sla/maintainability)
+
+---
+
+SLA is a simple broken links checker, with built in caching.
+
+![SLA Demo](demo/cast.svg "SLA Demo")
+
+Install
+--------------------------------------------------
+
+```
+$ gem install sla
+```
+
+
+Features
+--------------------------------------------------
+
+- Easy to use command line interface.
+- Built in caching, to avoid overtaxing the server.
+- Show and save list of broken links to a log file.
+- Exits with non zero code on failure, for CI integration.
+
+
+Usage
+--------------------------------------------------
+
+```
+$ sla --help
+SLA
+
+Usage:
+  sla check DOMAIN [options]
+  sla (-h|--help|--version)
+
+Commands:
+  check
+    Start checking for broken links on a given domain.
+  
+Options:
+  --depth, -d DEPTH
+    Set crawling depth [default: 5].
+
+  --cache, -c LIFE
+    Set cache life [default: 1d]. LIFE can be in any of the 
+    following formats:
+      10  = 10 seconds
+      20s = 20 seconds
+      10m = 10 minutes
+      10h = 10 hours
+      10d = 10 days
+
+  --cache-dir DIR
+    Set the cache directory.
+
+  --external, -x
+    Also check external links.
+
+  --log, -l LOGFILE
+    Save errors to log file.
+
+  --ignore, -i URLS
+    Specify a list of space delimited URLs to skip.
+    URLs that start with the strings in this list will be skipped.
+
+Examples:
+  sla check example.com
+  sla check example.com -c10m -d10
+  sla check example.com --cache-dir my_cache
+  sla check example.com --depth 10 --log my_log.log
+  sla check example.com --cache 30d
+  sla check example.com --ignore "/admin /customer/login"
+
+```

data/bin/sla

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
 
 require 'sla'
-SLA::CommandLine.execute ARGV
+
+begin
+  SLA::CommandLine.execute ARGV
+rescue SLA::BrokenLinks => e
+  puts "(exit code 1)"
+  exit 1
+end

data/lib/sla.rb

@@ -1,13 +1,19 @@
-require 'webcache'
-require 'nokogiri'
-require 'colsole'
-require 'singleton'
-require 'super_docopt'
-require 'uri'
-
-require 'sla/version'
-require 'sla/link'
-require 'sla/checker'
-require 'sla/command_line'
-
-require 'byebug' if ENV['BYEBUG']
+require 'webcache'
+require 'nokogiri'
+require 'colsole'
+require 'singleton'
+require 'super_docopt'
+require 'uri'
+
+require 'sla/version'
+require 'sla/exceptions'
+require 'sla/link'
+require 'sla/checker'
+require 'sla/command_line'
+
+if ENV['BYEBUG']
+  # :nocov:
+  require 'byebug'
+  require 'lp'
+  # :nocov:
+end

data/lib/sla/checker.rb

@@ -2,12 +2,13 @@ module SLA
   class Checker
     include Colsole
 
-    attr_accessor :max_depth, :checked_links, :check_external
+    attr_accessor :max_depth, :checked_links, :check_external, :ignore
 
     def initialize
       @max_depth = 10
       @checked_links = []
       @check_external = false
+      @ignore = []
     end
 
     def count
@@ -17,7 +18,10 @@ module SLA
     def check(link, depth=1, &block)
       link = Link.new link, depth: depth if link.is_a? String
 
-      return if link.external? && !@check_external
+      return if link.external? && !check_external
+      ignore.each do |ignored|
+        return if link.ident.start_with? ignored
+      end
 
       link.validate
       yield link if block_given?

data/lib/sla/command_line.rb

@@ -1,75 +1,83 @@
-module SLA
-  class CommandLine < SuperDocopt::Base
-    include Colsole
-
-    version VERSION
-    docopt File.expand_path 'docopt.txt', __dir__
-    subcommands ['check']
-
-    def before_execute
-      @no_color = args['--no-color']
-      @no_log = args['--no-log']
-    end
-
-    def check
-      # :nocov:
-      if !$cache 
-        $cache ||= WebCache.new
-        $cache.life = args['--cache']
-        $cache.dir  = args['--cache-dir'] if args['--cache-dir']
-      end
-      # :nocov:
-
-      checker = Checker.new
-      checker.max_depth      = args['--depth'].to_i
-      checker.check_external = args['--external']
-      logfile                = args['--log']
-      start_url              = args['DOMAIN']
-
-      start_url = "http://#{start_url}" unless start_url[0..3] == 'http'
-
-      File.unlink logfile if File.exist? logfile
-
-      count = 1
-      failed = 0
-
-      log = []
-
-      checker.check start_url do |link|
-        indent = '-' * link.depth
-
-        status = link.status
-        colored_status = color_status status
-        failed +=1 if status != '200'
-
-        say "#{count} #{colored_status} #{indent} #{link.ident}"
-        log.push "#{count} #{status} #{indent} #{link.ident}" unless @no_log
-        count += 1
-      end
-
-      color = failed > 0 ? '!txtred!' : '!txtgrn!'
-      color = "" if @no_color
-      say "#{color}Done with #{failed} failures"
-      log.push "Done with #{failed} failures" unless @no_log
-
-      File.write logfile, log.join("\n") unless @no_log
-    end
-
-    private
-
-    def color_status(status)
-      return status if @no_color
-      # :nocov:
-      case status
-      when '200'
-        '!txtgrn!200!txtrst!'
-      when '404'
-        '!txtred!404!txtrst!'
-      else
-        status
-      end
-      # :nocov:
-    end
-
-  end
+module SLA
+  class CommandLine < SuperDocopt::Base
+    include Colsole
+
+    version VERSION
+    docopt File.expand_path 'docopt.txt', __dir__
+    subcommands ['check']
+
+    def before_execute
+      WebCache.life = args['--cache']
+      WebCache.dir  = args['--cache-dir'] if args['--cache-dir']
+    end
+
+    def check
+      checker = Checker.new
+      checker.max_depth = args['--depth'].to_i
+      logfile = args['--log']
+      start_url = args['DOMAIN']
+      ignore = args['--ignore']
+      ignore = ignore.split " " if ignore
+      screen_width = terminal_width
+      
+      checker.check_external = args['--external']
+      checker.ignore = ignore if ignore
+
+      start_url = "http://#{start_url}" unless start_url[0..3] == 'http'
+
+      File.unlink logfile if logfile and File.exist? logfile
+
+      count = 1
+      failed = 0
+
+      log = []
+
+      checker.check start_url do |link|
+        status = link.status
+        colored_status = color_status status
+        if status != '200'
+          failed +=1 
+          resay "#{colored_status} #{link.ident}"
+          log.push "#{status}  #{link.ident}" if logfile
+        end
+
+        message = "[#{failed}/#{count} @ #{link.depth}] #{status}"
+        remaining_width = screen_width - message.size - 4
+        trimmed_link = link.ident[0..remaining_width]
+        
+        resay "[#{failed}/#{count} @ #{link.depth}] #{colored_status} #{trimmed_link} "
+        count += 1
+
+        sleep ENV['SLA_SLEEP'].to_f if ENV['SLA_SLEEP']
+      end
+
+      color = failed > 0 ? '!txtred!' : '!txtgrn!'
+      resay "#{color}Done checking #{count} links with #{failed} failures"
+
+      if logfile      
+        logstring = log.join("\n") + "\n"
+        File.write logfile, logstring
+      end
+
+      if failed > 0 and !ENV['SLA_ALLOW_FAILS']
+        raise BrokenLinks 
+      end
+    end
+
+  private
+
+    def color_status(status)
+      case status
+      when '200'
+        '!txtgrn!200!txtrst!'
+      when '404'
+        '!txtred!404!txtrst!'
+      else
+        # :nocov:
+        status
+        # :nocov:
+      end
+    end
+
+  end
 end

data/lib/sla/docopt.txt

@@ -1,44 +1,43 @@
-SLA
-
-Usage:
-  sla check DOMAIN [options]
-  sla (-h|--help|--version)
-
-Commands:
-  check
-    Start checking for broken links on a given domain
-  
-Options:
-  --depth, -d DEPTH
-    Set crawling depth [default: 5]
-
-  --cache, -c LIFE
-    Set cache life [default: 1d]. LIFE can be in any of the 
-    following formats:
-      10  = 10 seconds
-      20s = 20 seconds
-      10m = 10 minutes
-      10h = 10 hours
-      10d = 10 days
-
-  --cache-dir DIR
-    Set the cache directory
-
-  --external
-    Also check external links
-
-  --no-color
-    Disable colors in output
-
-  --no-log
-    Disable logging
-
-  --log LOGFILE
-    Set the name of the logfile [default: sla.log]
-
-Examples:
-  sla check example.com
-  sla check example.com -c10m -d10
-  sla check example.com --cache-dir my_cache --no-log
-  sla check example.com --depth 10 --log my_log.log
-  sla check example.com --cache 30d
+SLA
+
+Usage:
+  sla check DOMAIN [options]
+  sla (-h|--help|--version)
+
+Commands:
+  check
+    Start checking for broken links on a given domain.
+  
+Options:
+  --depth, -d DEPTH
+    Set crawling depth [default: 5].
+
+  --cache, -c LIFE
+    Set cache life [default: 1d]. LIFE can be in any of the 
+    following formats:
+      10  = 10 seconds
+      20s = 20 seconds
+      10m = 10 minutes
+      10h = 10 hours
+      10d = 10 days
+
+  --cache-dir DIR
+    Set the cache directory.
+
+  --external, -x
+    Also check external links.
+
+  --log, -l LOGFILE
+    Save errors to log file.
+
+  --ignore, -i URLS
+    Specify a list of space delimited URLs to skip.
+    URLs that start with the strings in this list will be skipped.
+
+Examples:
+  sla check example.com
+  sla check example.com -c10m -d10
+  sla check example.com --cache-dir my_cache
+  sla check example.com --depth 10 --log my_log.log
+  sla check example.com --cache 30d
+  sla check example.com --ignore "/admin /customer/login"

data/lib/sla/exceptions.rb

@@ -0,0 +1,3 @@
+module SLA
+  class BrokenLinks < StandardError; end
+end

data/lib/sla/link.rb

@@ -24,7 +24,7 @@ module SLA
     end
 
     def content!
-      response = $cache.get url
+      response = WebCache.get url
       @status = response.error ? '404' : '200'
       @real_uri = response.base_uri
       response.content

data/lib/sla/version.rb

@@ -1,3 +1,3 @@
 module SLA
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sla
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: super_docopt
   requirement: !ruby/object:Gem::Requirement
@@ -66,104 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: runfile
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: adsf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: runfile-tasks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec_fixtures
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
 description: Check for broken links on a website
 email: db@dannyben.com
 executables:
@@ -177,6 +79,7 @@ files:
 - lib/sla/checker.rb
 - lib/sla/command_line.rb
 - lib/sla/docopt.txt
+- lib/sla/exceptions.rb
 - lib/sla/link.rb
 - lib/sla/version.rb
 homepage: https://github.com/DannyBen/sla
@@ -198,8 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Command Line Site Link Analyzer