awesome_bot 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f4eaebd0ceb7d910abbfcc44a70d69e31490ca9
-  data.tar.gz: 5b4e45aa0a884b43cf75f0ee173a0e90cc6db5b6
+  metadata.gz: 0c2ad393dacd395f168e5dcec9d326cf721aa840
+  data.tar.gz: 4f91280d25a56aac470f1277e6871ee143a3e7fb
 SHA512:
-  metadata.gz: ea6709ee56f65e61e8e15f3151c1301be3a19157c91d76e600dc25343c85adcda8153e14963bf873521be1ac4cb2a2392fd38828e408b4c352ccbadf5cacde64
-  data.tar.gz: 743870bb7619c31f7615717c89d5b7b9c5345a020748f8ba742ed04a74a5da92356acd0af952a368ed9917ae09ee281e88ed155741118c2d60d7b7a11ffd3f65
+  metadata.gz: f7527e8cdef9febad7a1150d7661225ddf424564ca370170dd7979f0b647dcea372042c5e64d74cb26c698c5fe98a4f60b786d37ce59d9a2c12457ac0cc13872
+  data.tar.gz: 0ef28356259469480e62deb04ec970ca3fdb8904cf11d65da8c446acc8df5bc1e5b137238cac3c4f265a058bf0459ea91269b5c9079ee6b4f9e632b820090924

data/.travis.yml

@@ -7,5 +7,8 @@ script:
   - awesome_bot
   - awesome_bot bin/assets/test-no-issues
   - awesome_bot bin/assets/test-no-links
+  - awesome_bot bin/assets/test-parse
   - awesome_bot bin/assets/test-dupe --allow-dupe
+  - 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 README.md --allow-dupe --white-list gph.is,bot.svg,codeload,badge,rubydoc

data/CHANGELOG.md

@@ -50,6 +50,10 @@
 
 - [gemspec] remove uri dependency
 
+# 1.4.0
+
+- add `--allow-timeout` and `--set-timeout` options
+
 ## Contact
 
 - [github.com/dkhamsing](https://github.com/dkhamsing)

data/README.md

@@ -43,7 +43,13 @@ More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
 
 ### Command Line
 
-    awesome_bot <file> [--allow-dupe] [--allow-redirect] [--white-list item1,item2,..]
+    awesome_bot <file> [--allow-dupe] [--allow-redirect] [--allow-timeout] [--set-timeout d] [--white-list item1,item2,..]    
+      file 		     Path to file
+      --allow-dupe 	 Duplicates URLs are allowed URLs
+      --allow-redirect  Redirected URLs are allowed
+      --allow-timeout   URLs that time out are allowed
+      --set-timeout 	Set connection timeout (seconds)
+      --white-list 	 Comma separated URLs to white list
 
 ```shell
 $ awesome_bot README.md
@@ -138,19 +144,27 @@ script:
 - https://github.com/matteocrippa/awesome-swift
 - https://github.com/iCHAIT/awesome-osx
 - https://github.com/ellisonleao/magictools
+- https://github.com/JStumpp/awesome-android
 - https://github.com/chentsulin/awesome-graphql
+- https://github.com/fasouto/awesome-dataviz
 - https://github.com/RichardLitt/awesome-conferences
 - https://github.com/stefanbuck/awesome-browser-extensions-for-github
 - https://github.com/afonsopacifer/awesome-flexbox
 - https://github.com/HQarroum/awesome-iot
+- https://github.com/filipelinhares/awesome-slack
+- https://github.com/notthetup/awesome-webaudio
 - https://github.com/ipfs/awesome-ipfs
-- https://github.com/christian-bromann/awesome-selenium
+- https://github.com/brunopulis/awesome-a11y
 - https://github.com/ramitsurana/awesome-kubernetes
+- https://github.com/benoitjadinon/awesome-xamarin
+- https://github.com/christian-bromann/awesome-selenium
 - https://github.com/vinkla/awesome-fuse
 - https://github.com/wfhio/awesome-job-boards
 - https://github.com/sotayamashita/awesome-css
 - https://github.com/MakinGiants/awesome-mobile-dev
 - https://github.com/unixorn/awesome-zsh-plugins
+- https://github.com/vredniy/awesome-newsletters
+- https://github.com/unixorn/git-extra-commands
 
 ## Credits
 

data/bin/assets/test-parse

@@ -0,0 +1,2 @@
+[Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google))
+her [dockerfiles](https://github.com/jfrazelle/dockerfiles))

data/bin/assets/test-timeout

@@ -0,0 +1,2 @@
+http://platipy.org
+https://github.com

data/bin/assets/test-timeout-and-redirect

@@ -0,0 +1,4 @@
+http://platipy.org
+https://github.com
+
+https://github.com/supermarin/Alcatraz

data/lib/awesome_bot/cli.rb

@@ -7,11 +7,17 @@ require 'awesome_bot/version'
 module AwesomeBot
   OPTION_DUPE = 'allow-dupe'
   OPTION_REDIRECT = 'allow-redirect'
+  OPTION_TIMEOUT_ALLOW = 'allow-timeout'
+  OPTION_TIMEOUT_SET = 'set-timeout'
   OPTION_WHITE_LIST = 'white-list'
 
   USAGE = "\t"
 
   class << self
+    def make_option(o)
+      "--#{o}"
+    end
+
     def output(x, k)
       s = x['status']
       print "#{k + 1}. "
@@ -22,16 +28,21 @@ module AwesomeBot
     end
 
     def cli
-      option_d = "--#{OPTION_DUPE}"
-      option_r = "--#{OPTION_REDIRECT}"
-      option_w = "--#{OPTION_WHITE_LIST}"
+      option_d = make_option OPTION_DUPE
+      option_r = make_option OPTION_REDIRECT
+      option_t = make_option OPTION_TIMEOUT_SET
+      option_t_a = make_option OPTION_TIMEOUT_ALLOW
+      option_w = make_option OPTION_WHITE_LIST
 
       if ARGV.count == 0
         puts "Usage: #{PROJECT} <file> [#{option_d}] [#{option_r}] "\
+             "[#{option_t_a}] [#{option_t} d] "\
              "[#{option_w} item1,item2,..]\n"\
-             "#{USAGE} file \t\t Path to file \n"\
+             "#{USAGE} file \t\t  Path to file \n"\
              "#{USAGE} #{option_d} \t  Duplicates URLs are allowed URLs \n"\
              "#{USAGE} #{option_r} Redirected URLs are allowed \n"\
+             "#{USAGE} #{option_t_a}  URLs that time out are allowed \n"\
+             "#{USAGE} #{option_t} \t  Set connection timeout (seconds) \n"\
              "#{USAGE} #{option_w} \t  Comma separated URLs to white list \n"\
              "\nVersion #{VERSION}, see #{PROJECT_URL} for more information"
         exit
@@ -48,12 +59,22 @@ module AwesomeBot
         allow_redirects = options.include? option_r
         puts '> Will allow redirects' if allow_redirects == true
 
+        allow_timeouts = options.include? option_t_a
+        puts '> Will allow network timeouts' if allow_timeouts == true
+
         if options.include? option_w
           i = options.find_index(option_w) + 1
           white_listed = options[i].split ','
         end
+
+        if options.include? option_t
+          i = options.find_index(option_t) + 1
+          timeout = options[i].to_i
+          puts "> Connection timeout = #{timeout}s"
+        end
       else
         allow_redirects = false
+        allow_timeouts = false
       end
 
       begin
@@ -63,6 +84,7 @@ module AwesomeBot
         exit 1
       end
 
+      Faraday.options.timeout = timeout unless timeout.nil?
 
       log = Log.new(true)
       r = check(content, white_listed, skip_dupe, log)
@@ -74,18 +96,19 @@ module AwesomeBot
         end
       end
 
-      if r.success(allow_redirects) == true
+      if r.success(allow_redirects, allow_timeouts) == true
         puts 'No issues :-)'
         # exit ?
       else
         puts "\nIssues :-("
 
         print "> Links \n"
-        if r.success_links(allow_redirects)
+        if r.success_links(allow_redirects, allow_timeouts)
           puts "  All OK #{STATUS_OK}"
         else
-          r.statuses_issues(allow_redirects).each_with_index do |x, k|
-            output x, k
+          r.statuses_issues(allow_redirects, allow_timeouts)
+            .each_with_index do |x, k|
+              output x, k
           end
         end
 

data/lib/awesome_bot/result.rb

@@ -20,15 +20,28 @@ module AwesomeBot
       @rejected, @links = links.partition { |u| AwesomeBot.white_list @w, u }
     end
 
-    def statuses_issues(allow_redirects = false)
+    def statuses_issues(allow_redirects = false, allow_timeouts = false)
       s = status.select { |x| x['status'] != 200 }
-      return s if allow_redirects == false
-
-      s.reject { |x| (x['status'] > 299) && (x['status'] < 400) }
+      r = s.reject { |x| (x['status'] > 299) && (x['status'] < 400) }
+      t = s.reject do |x|
+        (x['status'] == -1) && ((x['error'].message == 'Net::ReadTimeout') || (x['error'].message == 'execution expired'))
+      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'] == -1) && ((x['error'].message == 'Net::ReadTimeout') || (x['error'].message == 'execution expired'))
+        end
+      end
     end
 
-    def success(allow_redirects = false)
-      success_dupe && success_links(allow_redirects)
+    def success(allow_redirects = false, allow_timeouts = false)
+      success_dupe && success_links(allow_redirects, allow_timeouts)
     end
 
     def success_dupe
@@ -36,8 +49,8 @@ module AwesomeBot
       links.uniq.count == links.count
     end
 
-    def success_links(allow_redirects = false)
-      statuses_issues(allow_redirects).count == 0
+    def success_links(allow_redirects = false, allow_timeouts = false)
+      statuses_issues(allow_redirects, allow_timeouts).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.3.3'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -74,6 +74,9 @@ files:
 - bin/assets/test-no-dupes
 - bin/assets/test-no-issues
 - bin/assets/test-no-links
+- bin/assets/test-parse
+- bin/assets/test-timeout
+- bin/assets/test-timeout-and-redirect
 - bin/awesome_bot
 - bin/console
 - bin/setup