sla 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c4f0612c8ccebbc1c29a22eee3ad61cd7610563
-  data.tar.gz: 1e6ed70e361c653b2c780e4be344ecd624529efc
+  metadata.gz: 40e98d12594ea7a28b2dc3d13bc739052d94e5b6
+  data.tar.gz: 7e3cfcd96379993df956f848ada469bd51d60680
 SHA512:
-  metadata.gz: b2c1eb8bc98e1c0139e7e7155744cba9266364c6edc1f5bd254af233643f4eee50693171fc247f3555b31e1d1a6191df90bcb763dac825935253274805bee1ba
-  data.tar.gz: 216a0aa3ca464ad342826f60c1f1e73dbde5b5f0d17aadafe24551d658f52e665d7ae3513b5b086039e66b5f9800d27f447caa54c5ffd9cec58e341bbb9205d0
+  metadata.gz: 1097f835963ed1be41a4b71fa14aace3a9d3ea03398d182125a96bdd6c893fe9d98fd604514184b8d727590376964d26641cb97d0b03b7f5ddafbe22523920f9
+  data.tar.gz: e2a63d7e2210d7f78863cb8032dd2128276d7ba8417bb12076f7beba40a373d93e9f85f43daeb69c43d5ab3ee9e15ca80956ba21e6a153a170d7bb0c6ff203c0

data/README.md

@@ -25,6 +25,30 @@ Or with bundler:
 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
 --------------------------------------------------
 
@@ -48,12 +72,20 @@ Options:
     Set cache life in seconds [default: 86400]
 
   --cache-dir DIR
-    Set the cache directory [default: cache]
+    Set the cache directory
 
-  --color
+  --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 -c360 -d10
+  sla check example.com --cache-dir my_cache --no-log
+  sla check example.com --depth 10 --log my_log.log
 ```

data/lib/sla/cache.rb

@@ -2,6 +2,14 @@ module SLA
   class Cache
     include Singleton
 
+    def self.get(url)
+      instance.cache.get url
+    end
+
+    def self.settings
+      instance.cache
+    end
+
     def cache
       @cache ||= cache!
     end

data/lib/sla/checker.rb

@@ -1,8 +1,8 @@
 module SLA
-  class Checker < Base
+  class Checker
     include Colsole
 
-    attr_accessor :checked_links, :results, :max_depth, :next_check
+    attr_accessor :checked_links, :max_depth, :next_check
 
     def initialize
       @max_depth = 10
@@ -14,30 +14,31 @@ module SLA
       checked_links.count
     end
 
-    def on_check(urls=nil, depth=1, &block)
-      urls ||= [base_url]
+    def on_check(urls, depth=1, &block)
+      urls = [urls] if urls.is_a? String
 
       self.next_check = []
 
       urls.each do |url|
         check_url url, depth, &block
-        if depth < max_depth
+        if depth < max_depth && !next_check.empty?
           on_check next_check, depth+1, &block
         end
       end
     end
 
     def check_url(url, depth, &_block)
-      page = Page.new url, depth: depth, base_url: base_url
+      page = Page.new url, depth: depth
       page.validate
-      checked_links.push url
 
       yield page if block_given? 
       return if depth >= max_depth
+      return if checked_links.include? url
+
+      checked_links.push url
 
       page.links.each do |link|
-        next if checked_links.include? link.url
-        next_check.push link.url
+        next_check.push link.url unless next_check.include? link.url
       end
     end
   end

data/lib/sla/command_line.rb

@@ -1,5 +1,5 @@
 module SLA
-  class CommandLine < Base
+  class CommandLine
     include Singleton
     include Colsole
 
@@ -17,7 +17,8 @@ module SLA
 
     def handle(args)
       if args['check']
-        @no_color = args['--color']
+        @no_color = args['--no-color']
+        @no_log = args['--no-log']
         check_domain args
       end
     end
@@ -25,34 +26,38 @@ module SLA
     def check_domain(args)
       checker = Checker.new
       checker.max_depth    = args['--depth'].to_i
-      checker.cache.life   = args['--cache'].to_i
-      checker.cache.dir    = args['--cache-dir'] if args['--cache-dir']
-      url_manager.base_url = args['DOMAIN']
+      Cache.settings.life  = args['--cache'].to_i
+      Cache.settings.dir   = args['--cache-dir'] if args['--cache-dir']
+      logfile              = args['--log']
+      start_url            = args['DOMAIN']
 
-      File.unlink 'log.log' if File.exist? 'log.log'
+      start_url = "http://#{start_url}" unless start_url[0..3] == 'http'
+
+      File.unlink logfile if File.exist? logfile
 
       count = 1
       failed = 0
 
-      open('log.log', 'a') do |f|
-        checker.on_check do |page|
-          indent = '-' * page.depth
+      log = []
 
-          status = page.status
-          colored_status = color_status status
-          failed +=1 if status != '200'
+      checker.on_check start_url do |page|
+        indent = '-' * page.depth
 
-          say    "#{count} #{colored_status} #{indent} #{page.name}"
-          f.puts "#{count} #{status} #{indent} #{page.name}"
-          count += 1
-        end
+        status = page.status
+        colored_status = color_status status
+        failed +=1 if status != '200'
 
-        color = failed > 0 ? '!txtred!' : '!txtgrn!'
-        color = "" if @no_color
-        say "#{color}Done with #{failed} failures"
-        f.puts "Done with #{failed} failures"
+        say "#{count} #{colored_status} #{indent} #{page.name}"
+        log.push "#{count} #{status} #{indent} #{page.name}" 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
 
     def color_status(status)

data/lib/sla/docopt.txt

@@ -18,9 +18,17 @@ Options:
   --cache-dir DIR
     Set the cache directory
 
-  --color
+  --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 -c360 -d10
+  sla check example.com --cache-dir my_cache --no-log
+  sla check example.com --depth 10 --log my_log.log

data/lib/sla/link.rb

@@ -1,15 +1,41 @@
 module SLA
   class Link
-    attr_accessor :text, :url
+    attr_accessor :text, :href
+    attr_reader :parent
 
-    def initialize(text, url)
-      @text = text
-      @url = url
+    def initialize(href, opts={})
+      @href = href
+      @text = opts[:text]
+      self.parent = opts[:parent] || @href
+    end
+
+    def uri
+      @uri ||= URI.parse href
+    end
+
+    def parent=(url)
+      @parent = url.is_a?(String) ? URI.parse(url) : url
     end
 
     def path
-      uri = URI.parse url
       uri.request_uri
     end
+
+    def full_uri
+      return uri if uri.absolute? || !parent.absolute?
+      URI.join parent, href
+    end
+
+    def url
+      full_uri.to_s
+    end
+
+    def external?
+      parent.host != full_uri.host
+    end
+
+    def interesting?
+      !external? && full_uri.scheme =~ /^http/
+    end
   end
 end

data/lib/sla/page.rb

@@ -1,5 +1,5 @@
 module SLA
-  class Page < Base
+  class Page
     attr_accessor :depth, :status, :base_uri
     attr_reader :url
 
@@ -32,21 +32,12 @@ module SLA
       end
     end
 
-    def protocol
-      @protocol ||= protocol!
-    end
-
-    def protocol!
-      uri = URI.parse url
-      uri.scheme
-    end
-
     def content
       @content ||= content!
     end
 
     def content!
-      response = cache.get url
+      response = Cache.get url
       self.status = response.error ? '404' : '200'
       self.base_uri = response.base_uri
       response.content
@@ -61,12 +52,11 @@ module SLA
     end
 
     def links!
-      links = doc.css('a')
+      anchors = doc.css('a')
       result = []
-      links.each do |link|
-        href = url_manager.absolute link['href'], base_uri
-        next unless href
-        result.push Link.new link.text, href
+      anchors.each do |a|
+        link = Link.new a['href'], text: a.text, parent: base_uri
+        result.push link if link.interesting?
       end
       result
     end

data/lib/sla/version.rb

@@ -1,3 +1,3 @@
 module SLA
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/sla.rb

@@ -6,14 +6,8 @@ require 'docopt'
 require 'uri'
 
 require 'sla/version'
-require 'sla/base'
 require 'sla/page'
 require 'sla/link'
 require 'sla/checker'
 require 'sla/command_line'
 require 'sla/cache'
-require 'sla/url_manager'
-
-# Remove before deploy
-# require 'byebug'
-# require 'pp'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sla
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -160,14 +160,12 @@ files:
 - README.md
 - bin/sla
 - lib/sla.rb
-- lib/sla/base.rb
 - lib/sla/cache.rb
 - lib/sla/checker.rb
 - lib/sla/command_line.rb
 - lib/sla/docopt.txt
 - lib/sla/link.rb
 - lib/sla/page.rb
-- lib/sla/url_manager.rb
 - lib/sla/version.rb
 homepage: https://github.com/DannyBen/sla
 licenses:
@@ -192,5 +190,5 @@ rubyforge_project:
 rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: Site Link Analyzer
+summary: Command Line Site Link Analyzer
 test_files: []

data/lib/sla/base.rb

@@ -1,17 +0,0 @@
-module SLA
-  class Base
-    attr_accessor :domain
-
-    def cache
-      @cache ||= Cache.instance.cache
-    end
-
-    def url_manager
-      @url_manager ||= UrlManager.instance
-    end
-
-    def base_url
-      url_manager.base_url.to_s
-    end
-  end
-end

data/lib/sla/url_manager.rb

@@ -1,23 +0,0 @@
-module SLA
-  class UrlManager < Base
-    include Singleton
-
-    attr_reader :uri, :base_url
-
-    def base_url=(url)
-      url = "http://#{url}" unless url[0..3] == 'http'
-      response = cache.get url
-      @base_url = response.base_uri
-    end
-
-    def absolute(relative, base=nil)
-      return false if relative =~ /^(tel|mailto|#)/
-      base ||= base_url
-      relative = URI.encode relative
-      result = URI.join(base, relative)
-
-      return false unless result.host == base_url.host
-      result.to_s
-    end
-  end
-end