awesome_bot 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44c4121f5cf211f02e3f55149a31681a4e5eb854
-  data.tar.gz: ebe9cfa3f4bd160fe34c12b3737c8bcabdce2512
+  metadata.gz: 61e7d39fd465602a61c824ad316ac2d6f0b116c3
+  data.tar.gz: 8e662e958ea3c4744d0e2ac64e94ea32755e2e82
 SHA512:
-  metadata.gz: ffcb771a6ac91866f80aba48188d059467928a1c0e8bdd3c726da95e800585bccd2d0e3319e471fc94285748e9b79db9f3796375883efdf42f8816c7222f3d3d
-  data.tar.gz: c374442c4a9fdeb8bab0c912f590f8c71f42aa04ee870b2edcdc65beaa529e7d7d5066c5754f69b26f17503635d2534405ed067dfc0fb8c591259528f34b518f
+  metadata.gz: e4226ba76b6387d7b5a3ed4c251613ca39be19c366494694d954e4984e3286e2e1e13a791842cc7ba57fe9293e90dcb042ca372236de7ab834c68bf2f3d26c70
+  data.tar.gz: d9d51330bf8f9f70e76178b291a973e7e46998dc9448fcf7025734dbca6c9a11343427a63c367441a00eb432e6b607d23bfa3b9dd39c35a51b78dd17ff098ae7

data/.travis.yml

@@ -12,6 +12,7 @@ script:
   - awesome_bot bin/assets/test-timeout --allow-timeout --set-timeout 1
   - awesome_bot bin/assets/test-timeout-and-redirect --allow-timeout --set-timeout 1 --allow-redirect
   - awesome_bot bin/assets/test-redirect --allow-redirect
+  - awesome_bot bin/assets/test-redirect --allow-redirect -a 301
   - awesome_bot bin/assets/test-statuses --white-list bot,bad,super
   - awesome_bot bin/assets/test-errors
   - awesome_bot -f bin/assets/test-no-issues,bin/assets/test-no-links

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Changes by [Daniel Khamsing][] unless otherwise noted.
 
+# 1.12.0
+
+- add `allow` option to allow specific error status codes, i.e. `--allow 301` or `--allow 403,429`
+
 # 1.11.0
 
 - [net] set `awesome_bot` user agent

data/README.md

@@ -22,6 +22,7 @@ Verify links in [awesome](status/status.md) projects
 Usage: awesome_bot [file or files]
        awesome_bot [options]
     -f, --files [files]              Comma separated files to check
+    -a, --allow [errors]             Status code errors to allow
         --allow-dupe                 Duplicate URLs are allowed
         --allow-ssl                  SSL errors are allowed
         --allow-redirect             Redirected URLs are allowed
@@ -32,11 +33,12 @@ Usage: awesome_bot [file or files]
 
 - You can check multiple files (comma separated or `*` pattern, look below for details).
 
-- By default, `awesome_bot` flags duplicates and URL redirects.
+- By default, duplicate URLs or any status code other than `200` are flagged as failures.
 
   - Use option `--allow-dupe` to allow duplicates.
-  - Use option `--allow-redirect` to all redirects.
-  - You can white list links so that they won't be flagged. `-w domain1.com/post/article,domain2.com` white lists `domain1.com/post/article` and all links matching `domain2.com`.
+  - Use option `--allow-redirect` to allow redirects.
+  - Use option `--allow` to allow specific status code errors.
+  - Use option `--white-list` (`-w` for short) to prevent links from being flagged: `-w domain1.com/post/article,domain2.com` white lists `domain1.com/post/article` and all links matching `domain2.com`.
 
 ### Examples
 
@@ -63,7 +65,7 @@ Issues :-(
 ```
 
 ```shell
-$ awesome_bot README.md --allow-dupe --allow-redirect --w rubydoc,giphy
+$ awesome_bot README.md --allow-dupe --allow-redirect -w rubydoc,giphy
 # allow redirects, dupes and white list all links matching rubydoc and giphy
 
 $ awesome_bot README.md,README-zh.md
@@ -72,8 +74,12 @@ $ awesome_bot README.md,README-zh.md
 $ awesome_bot docs/*.md
 # check all markdown files in docs/ directory
 
-$ awesome_bot README.md --allow-timeout --t 5
+$ awesome_bot README.md --allow-timeout -t 5
 # speed up validation by setting a timeout of 5s per link request and allowing timeouts
+
+$ awesome_bot README.md --allow 403,429
+# allow status code errors 403 and 429
+# --allow 301 would be similar to --allow-redirect
 ```
 
 ```shell
@@ -90,7 +96,7 @@ Switched to a new branch 'new-branch'
 (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 
+  1. https://github.com/dkhamsing
 Checking URLs: ✓
 No issues :-)
 

data/lib/awesome_bot/cli.rb

@@ -19,6 +19,7 @@ module AwesomeBot
                       "       #{PROJECT} [options]"
 
         opts.on('-f', '--files [files]',         Array,     'Comma separated files to check')     { |val| options['files'] = val }
+        opts.on('-a', '--allow [errors]',        Array,     'Status code errors to allow')        { |val| options['errors'] = 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 }
@@ -74,6 +75,9 @@ module AwesomeBot
 
       puts "> Checking links in #{filename}"
 
+      errors = options['errors']
+      puts "> Will allow errors: #{errors.join ','}" unless errors.nil?
+
       skip_dupe = options['allow_dupe']
       puts '> Will allow duplicate links' if skip_dupe == true
 
@@ -116,6 +120,7 @@ module AwesomeBot
       allow_timeouts = false if allow_timeouts.nil?
 
       options = {
+        'errors' => errors,
         'redirect' => allow_redirects,
         'ssl'      => allow_ssl,
         'timeout'  => allow_timeouts

data/lib/awesome_bot/result.rb

@@ -46,6 +46,12 @@ module AwesomeBot
         end
       end
 
+      unless options['errors'].nil?
+        options['errors'].each do |c|
+          s = s.reject { |x| x['status']==c.to_i }
+        end
+      end
+
       s
     end
 

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.11.0'
+  VERSION = '1.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-31 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel