awesome_bot 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e4a96c0cd7a8268af60e722d10c9b239110970b
-  data.tar.gz: 424ed53ce3270b4790a7558d41c18427bae9cd76
+  metadata.gz: 579b7cb269ffa2b68154fb856d45ce053ec0d521
+  data.tar.gz: be39e06b6476aa7dc46a46c8b191ba72f1480645
 SHA512:
-  metadata.gz: 77ef0e9e6069c316dba78f0c8e868920cb4e5a7a970558ae4d77369f3daeb78d360bdc289174762a802d4e823559816ddd2d25a082fe16bbe87b70ec82251ad4
-  data.tar.gz: 35060b12c0219745a3ff7363d402cd6e4f6dc91b54c7666791098cdbb675fb7e52e2e617aef5eb9b6c6d1f45d4bb24429029e40cee479f6edc5ab8c88912a67d
+  metadata.gz: 3d18b3b61f7e4bc5dc0d72408ea9201b1b795f18274e1933f83d80626310f99438d239aaba01e78abeef7395b16511076bb8c3ce10397bf120a1454b1ea024b6
+  data.tar.gz: f4c6b23f500f4de422332e2f3cb8261ba612314e60440152bd0648394a31f7a05c29315f4a21988d153f396bf3193f9eb1146a899bad8ff5a55bef527d6de1af

data/.travis.yml

@@ -17,5 +17,6 @@ script:
   - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-no-links
   - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-redirect --allow-redirect
   - awesome_bot bin/assets/test-no-* --allow-redirect
+  - awesome_bot bin/assets/test-ssl --allow-ssl
   - awesome_bot README.md --allow-dupe --white-list gph.is,giphy,travis-ci.org,codeload,badge,rubydoc,rubygems,circleci
   - gem install awesome_bot

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Changes by [Daniel Khamsing][] unless otherwise noted.
 
+# 1.10.0
+
+- add `allow-ssl` option, suggested by [Joe Block](https://github.com/unixorn)
+
 # 1.9.1
 
 - [fix] url redirect location encoding, reported by [@hoppfrosch](https://github.com/hoppfrosch)

data/README.md

@@ -23,6 +23,7 @@ Usage: awesome_bot [file or files]
        awesome_bot [options]
     -f, --files [files]              Comma separated files to check
         --allow-dupe                 Duplicate URLs are allowed
+        --allow-ssl                  SSL errors are allowed
         --allow-redirect             Redirected URLs are allowed
         --allow-timeout              URLs that time out are allowed
     -t, --set-timeout [seconds]      Set connection timeout
@@ -75,6 +76,27 @@ $ awesome_bot README.md --allow-timeout --t 5
 # speed up validation by setting a timeout of 5s per link request and allowing timeouts
 ```
 
+```shell
+(master) $ git branch
+* master
+(master) $ git checkout -b new-branch
+Switched to a new branch 'new-branch'
+(new-branch) $ touch new-readme.md && echo 'https://github.com/dkhamsing' >> new-readme.md
+(new-branch) $ git add new-readme.md
+(new-branch) $ git commit -m 'Testing'
+[new-branch ef47336] Testing
+ 1 file changed, 1 insertion(+)
+ create mode 100644 new-readme.md
+(new-branch) $ git diff master.. --name-only | grep '.md' | xargs awesome_bot
+> Checking links in new-readme.md
+Links to check: 1
+  1. https://github.com/dkhamsing 
+Checking URLs: ✓
+No issues :-)
+
+Wrote results to ab-results-new-readme.md.json
+```
+
 ### Library
 
 ```ruby

data/bin/assets/test-ssl

@@ -0,0 +1,5 @@
+https://www.gitbook.io/book/gitbookio/markdown
+https://this-week-in-rust.org/
+https://kismatic.com/
+https://kismatic.com/community/introducing-kubernetes-weekly-news/
+https://data.nasdaq.com/

data/bin/assets/test-timeout

@@ -1,2 +1,3 @@
 http://www.cmr.osu.edu/browse/datasets
 https://github.com
+http://github.com

data/lib/awesome_bot/check.rb

@@ -19,15 +19,11 @@ module AwesomeBot
         timeout = options['timeout']
       end
 
-      yield "> Will allow duplicate links \n" if skip_dupe && block_given?
+      links = links_filter(links_find(content))
 
-      temp = links_filter(links_find(content))
-
-      r = Result.new(temp, white_listed)
+      r = Result.new(links, white_listed)
       r.skip_dupe = skip_dupe
 
-      yield "> White list links matching: #{white_listed.join ', '} \n" if r.white_listing && block_given?
-
       r.dupes = r.links.select { |e| r.links.count(e) > 1 }
 
       yield "Links to check: #{r.links.count}" if block_given?

data/lib/awesome_bot/cli.rb

@@ -8,7 +8,7 @@ module AwesomeBot
   RESULTS_PREFIX = 'ab-results'
 
   class << self
-    def cli
+    def cli()
       require 'optparse'
 
       ARGV << '-h' if ARGV.empty?
@@ -18,12 +18,13 @@ module AwesomeBot
         opts.banner = "Usage: #{PROJECT} [file or files] \n"\
                       "       #{PROJECT} [options]"
 
-        opts.on("-f", "--files [files]", Array, 'Comma separated files to check')  { |val| options['files'] = val }
-        opts.on("--allow-dupe", TrueClass, 'Duplicate URLs are allowed')  { |val| options['allow_dupe'] = val }
-        opts.on("--allow-redirect", TrueClass, 'Redirected URLs are allowed')  { |val| options['allow_redirect'] = val }
-        opts.on("--allow-timeout", TrueClass, 'URLs that time out are allowed')  { |val| options['allow_timeout'] = val }
-        opts.on("-t", "--set-timeout [seconds]", Integer, 'Set connection timeout')  { |val| options['timeout'] = val }
-        opts.on("-w", "--white-list [urls]", Array, 'Comma separated URLs to white list')  { |val| options['white_list'] = val }
+        opts.on('-f', '--files [files]',         Array,     'Comma separated files to check')     { |val| options['files'] = val }
+        opts.on('--allow-dupe',                  TrueClass, 'Duplicate URLs are allowed')         { |val| options['allow_dupe'] = val }
+        opts.on('--allow-ssl',                   TrueClass, 'SSL errors are allowed')             { |val| options['allow_ssl'] = val }
+        opts.on('--allow-redirect',              TrueClass, 'Redirected URLs are allowed')        { |val| options['allow_redirect'] = val }
+        opts.on('--allow-timeout',               TrueClass, 'URLs that time out are allowed')     { |val| options['allow_timeout'] = val }
+        opts.on('-t', '--set-timeout [seconds]', Integer,   'Set connection timeout')             { |val| options['timeout'] = val }
+        opts.on('-w', '--white-list [urls]',     Array,     'Comma separated URLs to white list') { |val| options['white_list'] = val }
 
         opts.on_tail("--help") do
           puts opts
@@ -74,10 +75,14 @@ module AwesomeBot
       puts "> Checking links in #{filename}"
 
       skip_dupe = options['allow_dupe']
+      puts '> Will allow duplicate links' if skip_dupe == true
 
       allow_redirects = options['allow_redirect']
       puts '> Will allow redirects' if allow_redirects == true
 
+      allow_ssl = options['allow_ssl']
+      puts '> Will allow SSL errors' if allow_ssl == true
+
       allow_timeouts = options['allow_timeout']
       puts '> Will allow network timeouts' if allow_timeouts == true
 
@@ -86,10 +91,12 @@ module AwesomeBot
       timeout = options['timeout']
       puts "> Connection timeout = #{timeout}s" unless timeout.nil?
 
+      puts "> White list links matching: #{white_listed.join ', '} " unless white_listed.nil?
+
       options = {
-        'whitelist' => white_listed,
         'allowdupe' => skip_dupe,
-        'timeout' => timeout
+        'timeout'   => timeout,
+        'whitelist' => white_listed
       }
       r = check content, options do |o|
         print o
@@ -105,9 +112,16 @@ module AwesomeBot
       end
 
       allow_redirects = false if allow_redirects.nil?
+      allow_ssl = false if allow_ssl.nil?
       allow_timeouts = false if allow_timeouts.nil?
 
-      if r.success(allow_redirects, allow_timeouts) == true
+      options = {
+        'redirect' => allow_redirects,
+        'ssl'      => allow_ssl,
+        'timeout'  => allow_timeouts
+      }
+
+      if r.success(options) == true
         puts 'No issues :-)'
         cli_write_results(filename, r)
         return STATUS_OK
@@ -115,10 +129,10 @@ module AwesomeBot
         puts "\nIssues :-("
 
         print "> Links \n"
-        if r.success_links(allow_redirects, allow_timeouts)
+        if r.success_links(options)
           puts "  All OK #{STATUS_OK}"
         else
-          o = order_by_loc r.statuses_issues(allow_redirects, allow_timeouts), content
+          o = order_by_loc r.statuses_issues(options), content
           o.each_with_index do |x, k|
             puts output x, k, pad_list(o), digits
           end

data/lib/awesome_bot/result.rb

@@ -21,28 +21,36 @@ module AwesomeBot
       @links = links.partition { |u| AwesomeBot.white_list @w, u }
     end
 
-    def statuses_issues(allow_redirects = false, allow_timeouts = false)
+    def statuses_issues(options=nil)
+      options = {
+        'timeout'=>false,
+        'ssl'=>false,
+        'redirect'=>false
+      } if options.nil?
+
       s = status.select { |x| x['status'] != 200 }
-      r = s.reject { |x| AwesomeBot.status_is_redirected? x['status'] }
-      t = s.reject do |x|
-        (x['status'] == STATUS_ERROR) && ((x['error'].message == 'Net::ReadTimeout') || (x['error'].message == 'execution expired'))
+
+      if options['timeout']
+        s = s.reject do |x|
+          ( (x['error'].message == 'Net::ReadTimeout') || (x['error'].message == 'execution expired') || (x['error'].message.include? 'timed out') ) unless x['error'].nil?
+        end
       end
 
-      if (allow_redirects == false) && (allow_timeouts == false)
-        return s
-      elsif (allow_redirects == true) && (allow_timeouts == false)
-        return r
-      elsif (allow_redirects == false) && (allow_timeouts == true)
-        return t
-      else
-        return r.reject do |x|
-          (x['status'] == STATUS_ERROR) && ((x['error'].message == 'Net::ReadTimeout') || (x['error'].message == 'execution expired'))
+      if options['redirect']
+        s = s.reject { |x| AwesomeBot.status_is_redirected? x['status'] }
+      end
+
+      if options['ssl']
+        s =  s.reject do |x|
+          ( (x['error'].message.include? 'server certificate') || (x['error'].message.include? 'SSL_connect') ) unless x['error'].nil?
         end
       end
+
+      s
     end
 
-    def success(allow_redirects = false, allow_timeouts = false)
-      success_dupe && success_links(allow_redirects, allow_timeouts)
+    def success(options)
+      success_dupe && success_links(options)
     end
 
     def success_dupe
@@ -50,8 +58,8 @@ module AwesomeBot
       links.uniq.count == links.count
     end
 
-    def success_links(allow_redirects = false, allow_timeouts = false)
-      statuses_issues(allow_redirects, allow_timeouts).count == 0
+    def success_links(options)
+      statuses_issues(options).count==0
     end
 
     def white_listing

data/lib/awesome_bot/version.rb

@@ -5,5 +5,5 @@ module AwesomeBot
                         'Great for "awesome" projects.'
   PROJECT_URL = 'https://github.com/dkhamsing/awesome_bot'
 
-  VERSION = '1.9.1'
+  VERSION = '1.10.0'
 end

data/status/list-travis-ci

@@ -61,7 +61,7 @@ sergeyklay/awesome-phalcon
 ipfs/awesome-ipfs
 iJackUA/awesome-vagrant
 ramitsurana/awesome-kubernetes
-bucaran/awesome-fish
+brj/awesome-fish
 yenchenlin1994/awesome-watchos
 MakinGiants/awesome-mobile-dev
 MakinGiants/awesome-mobile-dev

data/status/status.md

@@ -67,7 +67,7 @@ Status | Config | Repo
 [![Build Status](https://travis-ci.org/ipfs/awesome-ipfs.svg)](https://travis-ci.org/ipfs/awesome-ipfs) | [`config`](https://github.com/ipfs/awesome-ipfs/blob/master/.travis.yml) | [ipfs/awesome-ipfs](https://github.com/ipfs/awesome-ipfs) 
 [![Build Status](https://travis-ci.org/iJackUA/awesome-vagrant.svg)](https://travis-ci.org/iJackUA/awesome-vagrant) | [`config`](https://github.com/iJackUA/awesome-vagrant/blob/master/.travis.yml) | [iJackUA/awesome-vagrant](https://github.com/iJackUA/awesome-vagrant) 
 [![Build Status](https://travis-ci.org/ramitsurana/awesome-kubernetes.svg)](https://travis-ci.org/ramitsurana/awesome-kubernetes) | [`config`](https://github.com/ramitsurana/awesome-kubernetes/blob/master/.travis.yml) | [ramitsurana/awesome-kubernetes](https://github.com/ramitsurana/awesome-kubernetes) 
-[![Build Status](https://travis-ci.org/bucaran/awesome-fish.svg)](https://travis-ci.org/bucaran/awesome-fish) | [`config`](https://github.com/bucaran/awesome-fish/blob/master/.travis.yml) | [bucaran/awesome-fish](https://github.com/bucaran/awesome-fish) 
+[![Build Status](https://travis-ci.org/brj/awesome-fish.svg)](https://travis-ci.org/brj/awesome-fish) | [`config`](https://github.com/brj/awesome-fish/blob/master/.travis.yml) | [brj/awesome-fish](https://github.com/brj/awesome-fish) 
 [![Build Status](https://travis-ci.org/yenchenlin1994/awesome-watchos.svg)](https://travis-ci.org/yenchenlin1994/awesome-watchos) | [`config`](https://github.com/yenchenlin1994/awesome-watchos/blob/master/.travis.yml) | [yenchenlin1994/awesome-watchos](https://github.com/yenchenlin1994/awesome-watchos) 
 [![Build Status](https://travis-ci.org/MakinGiants/awesome-mobile-dev.svg)](https://travis-ci.org/MakinGiants/awesome-mobile-dev) | [`config`](https://github.com/MakinGiants/awesome-mobile-dev/blob/master/.travis.yml) | [MakinGiants/awesome-mobile-dev](https://github.com/MakinGiants/awesome-mobile-dev) 
 [![Build Status](https://travis-ci.org/MakinGiants/awesome-mobile-dev.svg)](https://travis-ci.org/MakinGiants/awesome-mobile-dev) | [`config`](https://github.com/MakinGiants/awesome-mobile-dev/blob/master/.travis.yml) | [MakinGiants/awesome-mobile-dev](https://github.com/MakinGiants/awesome-mobile-dev) 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -49,6 +49,7 @@ files:
 - bin/assets/test-no-links
 - bin/assets/test-parse
 - bin/assets/test-redirect
+- bin/assets/test-ssl
 - bin/assets/test-statuses
 - bin/assets/test-timeout
 - bin/assets/test-timeout-and-redirect