awesome_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd7f4c9d4a4ef27387f5be98562f0f639678e8ff
+  data.tar.gz: 490ef9bdb314344c878e2eb0954c7182db6eb0be
+SHA512:
+  metadata.gz: d78425a7f1b3b074532c45962ff28f75a321d9e38cc2c018b62765243b883cd8f7bd329af6ab83a1439a720cf819365fdaf8b2a494519660828f2cb4ab0d3375
+  data.tar.gz: af9d27a79f04c2b457335cff51fba1454eb16d744d8ea05ce75c63beb926512390a74f803eab61b6b9cbb9f69f204783daded626e0a1093f14d57daac214f02e

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.2
+before_script:
+  - export PATH=$PATH:$PWD/bin/
+  - bundle install
+script:
+  - awesome_bot
+  - awesome_bot bin/assets/test-no-issues
+  - awesome_bot bin/assets/test-no-links
+  - awesome_bot bin/assets/test-dupe --allow-dupe
+  - awesome_bot README.md --allow-dupe --white-list gph.is,bot.svg

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in awesome_bot.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,119 @@
+# awesome_bot
+
+:rocket: Check for links in [awesome](https://github.com/sindresorhus/awesome) projects
+
+![](http://i.giphy.com/12qq4Em3MVuwJW.gif)
+
+`awesome_bot` checks for valid URLs in a file, it can be used to verify pull requests to update a README with [Travis](#travis).
+
+[![Build Status](https://travis-ci.org/dkhamsing/awesome_bot.svg)](https://travis-ci.org/dkhamsing/awesome_bot)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'awesome_bot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install awesome_bot
+
+## Usage
+
+```
+awesome_bot <file> [--allow-dupe] [--white-list item1,item2,..]
+```
+
+```shell
+$ awesome_bot README.md
+Checking links in ../README.md
+Links found: 35, 11 unique
+  1. https://github.com/sindresorhus/awesome
+  2. http://i.giphy.com/12qq4Em3MVuwJW.gif
+  3. https://travis-ci.org/dkhamsing/awesome_bot.svg
+  4. https://travis-ci.org/dkhamsing/awesome_bot
+  5. https://travis-ci.org/
+  6. http://gph.is/1gU5itl
+  7. https://github.com/dkhamsing
+  8. https://twitter.com/dkhamsing
+  9. https://github.com/dkhamsing/open-source-ios-apps/pull/159
+  10. https://github.com/dkhamsing/open-source-ios-apps/blob/master/.travis.yml
+  11. https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/wip
+Checking URLs: x✓✓✓x✓✓✓✓✓✓
+
+Issues :-(
+> Links
+  1. 301 http://gph.is/1gU5itl
+  2. 301 https://travis-ci.org/dkhamsing/awesome_bot.svg
+> Dupes
+  1. https://github.com/sindresorhus/awesome
+  2. http://i.giphy.com/12qq4Em3MVuwJW.gif
+  3. https://travis-ci.org/dkhamsing/awesome_bot.svg
+  4. https://travis-ci.org/dkhamsing/awesome_bot
+  5. https://travis-ci.org/
+  6. http://gph.is/1gU5itl
+  7. https://github.com/dkhamsing
+  8. https://twitter.com/dkhamsing
+  9. https://github.com/dkhamsing/open-source-ios-apps/pull/159
+  10. https://github.com/dkhamsing/open-source-ios-apps/blob/master/.travis.yml
+  11. https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/wip
+```
+
+```shell
+$ awesome_bot README.md --allow-dupe --white-list gph.is,bot.svg
+> Checking links in README.md
+> Will not check for duplicate links
+> White list: gph.is, bot.svg
+Links found: 27, 8 white listed, 9 unique
+  1. https://github.com/sindresorhus/awesome
+  2. http://i.giphy.com/12qq4Em3MVuwJW.gif
+  3. https://travis-ci.org/dkhamsing/awesome_bot
+  4. https://travis-ci.org/
+  5. https://github.com/dkhamsing
+  6. https://twitter.com/dkhamsing
+  7. https://github.com/dkhamsing/open-source-ios-apps/pull/159
+  8. https://github.com/dkhamsing/open-source-ios-apps/blob/master/.travis.yml
+  9. https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/wip
+Checking URLs: ✓✓✓✓✓✓✓✓✓
+No issues :-)
+```
+
+## Travis
+
+Use `awesome_bot` with [Travis](https://travis-ci.org/) to validate GitHub [pull requests](https://github.com/dkhamsing/open-source-ios-apps/pull/159).
+
+Example [`.travis.yml` file](https://github.com/dkhamsing/open-source-ios-apps/blob/master/.travis.yml)
+
+```
+language: ruby
+rvm:
+  - 2.2
+before_script:
+  - wget https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/wip -O /tmp/temp.tar.gz
+  - tar -xvf /tmp/temp.tar.gz
+  - export PATH=$PATH:$PWD/awesome_bot-wip/bin/
+  - cd awesome_bot-wip
+  - bundle install
+script:  
+  - awesome_bot ../README.md
+```
+
+## Credits
+
+- `faraday`, `parallel` and [more](awesome_bot.gemspec)
+- [giphy](http://gph.is/1gU5itl)
+
+## Contact
+
+- [github.com/dkhamsing](https://github.com/dkhamsing)
+- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)
+
+## License
+
+This project is available under the MIT license. See the [LICENSE](LICENSE) file for more info.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/awesome_bot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awesome_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = AwesomeBot::PROJECT
+  spec.version       = AwesomeBot::VERSION
+  spec.authors       = ['Daniel Khamsing']
+  spec.email         = ['dkhamsing8@gmail.com']
+
+  spec.summary       = 'Validate awesome project URLs.'
+  spec.description   = AwesomeBot::PROJECT_DESCRIPTION
+  spec.homepage      = AwesomeBot::PROJECT_URL
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9.2' # validate urls
+  spec.add_runtime_dependency 'uri', '~> 4.4.29' # get urls
+  spec.add_runtime_dependency 'parallel', '~> 1.6.1' # threading
+
+  spec.add_development_dependency 'bundler', '~> 1.7' # travis version
+end

data/bin/assets/test-dupe

@@ -0,0 +1,5 @@
+https://twitter.com
+https://twitter.com
+https://github.com/dkhamsing
+https://github.com
+https://github.com

data/bin/assets/test-link-issue

@@ -0,0 +1 @@
+http://google.com

data/bin/assets/test-no-dupes

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

data/bin/assets/test-no-issues

@@ -0,0 +1,2 @@
+https://twitter.com
+https://github.com

data/bin/assets/test-no-links

@@ -0,0 +1 @@
+blah blah

data/bin/awesome_bot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'awesome_bot'
+
+AwesomeBot.cli

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'awesome_bot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/awesome_bot.rb

@@ -0,0 +1,5 @@
+require 'awesome_bot/command'
+
+# Validate awesome project URLs
+module AwesomeBot
+end

data/lib/awesome_bot/command.rb

@@ -0,0 +1,126 @@
+require 'awesome_bot/links'
+require 'awesome_bot/statuses'
+require 'awesome_bot/version'
+require 'awesome_bot/white_list'
+
+# Command
+module AwesomeBot
+  NUMBER_OF_THREADS = 10
+
+  OPTION_DUPE = 'allow-dupe'
+  OPTION_WHITE_LIST = 'white-list'
+
+  STATUS_OK = '✓'
+  STATUS_OTHER = 'x'
+
+  USAGE = "\t"
+
+  class << self
+    def cli
+      option_d = "--#{OPTION_DUPE}"
+      option_w = "--#{OPTION_WHITE_LIST}"
+
+      if ARGV.count == 0
+        puts "#{PROJECT_DESCRIPTION} \n"\
+             "Usage: #{PROJECT} <file> [#{option_d}] "\
+             "[#{option_w} item1,item2,..]\n"\
+             "#{USAGE} file \t\t Path to file \n"\
+             "#{USAGE} #{option_d} \t Skip checking for duplicate URLs \n"\
+             "#{USAGE} #{option_w} \t Comma separated URLs to white list \n"\
+             "\nSee #{PROJECT_URL} for more information"
+
+        exit
+      end
+
+      filename = ARGV[0]
+      puts "> Checking links in #{filename}"
+
+      if ARGV.count > 1
+        options = ARGV.drop 1
+
+        skip_dupe = options.include? option_d
+
+        if options.include? option_w
+          i = options.find_index(option_w) + 1
+          white_listed = options[i].split ','
+        end
+      end
+
+      begin
+        content = File.read filename
+      rescue => error
+        puts "File open error: #{error}"
+        exit 1
+      end
+
+      exit 1 if run(content, white_listed, skip_dupe, true) == false
+
+      exit
+    end
+
+    def run(content, white_listed = nil, skip_dupe = false, verbose = false)
+      dupe_success = skip_dupe
+
+      puts '> Will not check for duplicate links' if skip_dupe && verbose
+
+      white_listing = !white_listed.nil?
+      puts "> White list: #{white_listed.join ', '}" if white_listing && verbose
+
+      links = links_filter(links_find(content))
+
+      if white_listing
+        rejected, links = links.partition { |u| white_list white_listed, u }
+      end
+
+      if verbose
+        print "Links found: #{links.count}"
+        print ", #{rejected.count} white listed" if white_listing
+        print ", #{links.uniq.count} unique" if links.count != links.uniq.count
+        puts ''
+        links.uniq.each_with_index { |u, j| puts "  #{j + 1}. #{u}" }
+      end
+
+      print 'Checking URLs: ' if verbose && (links.count > 0)
+      statuses =
+        statuses links.uniq, NUMBER_OF_THREADS, verbose, STATUS_OK, STATUS_OTHER
+      puts '' if verbose
+
+      statuses_issues = statuses.select { |x| x['status'] != 200 }
+      links_success = statuses_issues.count == 0
+
+      unless skip_dupe
+        dupe_success = links.uniq.count == links.count
+        dupes = links.select { |e| links.count(e) > 1 }
+      end
+
+      if links_success && dupe_success
+        puts 'No issues :-)' if verbose
+        return true
+      end
+
+      if verbose
+        puts "\nIssues :-("
+
+        print "> Links \n"
+        if links_success
+          puts "  All OK #{STATUS_OK}"
+        else
+          statuses_issues.each_with_index do |x, k|
+            puts "  #{k + 1}. #{x['status']} #{x['url']} "
+          end
+        end
+
+        unless skip_dupe
+          print "> Dupes \n"
+          if dupe_success
+            puts "  None #{STATUS_OK}"
+          else
+            dupes.uniq.each_with_index { |d, m| puts "  #{m + 1}. #{d}" }
+          end
+        end
+      end # if verbose
+
+      [false, statuses, dupes]
+    end # run
+  end # class
+end

data/lib/awesome_bot/links.rb

@@ -0,0 +1,17 @@
+# Get and filter links
+module AwesomeBot
+  require 'uri'
+
+  class << self
+    def links_filter(list)
+      list.reject { |x| x.length < 9 }
+        .map do |x|
+          x.gsub(/\).*/, '').gsub(/'.*/, '').gsub(/,.*/, '').gsub('/:', '/')
+        end
+    end
+
+    def links_find(content)
+      URI.extract(content, /http()s?/)
+    end
+  end # class
+end

data/lib/awesome_bot/statuses.rb

@@ -0,0 +1,24 @@
+# Get link status
+module AwesomeBot
+  require 'faraday'
+  require 'parallel'
+
+  class << self
+    def net_status(url)
+      Faraday.get(url).status
+    end
+
+    def statuses(links, threads, verbose, status_ok, status_other)
+      statuses = []
+      Parallel.each(links, in_threads: threads) do |u|
+        status = net_status u
+
+        print(status == 200 ? status_ok : status_other) if verbose
+
+        statuses.push('url' => u, 'status' => status)
+      end # Parallel
+
+      statuses
+    end
+  end # class
+end

data/lib/awesome_bot/version.rb

@@ -0,0 +1,8 @@
+# Project version and constants
+module AwesomeBot
+  PROJECT = 'awesome_bot'
+  PROJECT_DESCRIPTION = 'Check for valid and duplicate URLs in a file'
+  PROJECT_URL = 'https://github.com/dkhamsing/awesome_bot'
+
+  VERSION = '0.1.0'
+end

data/lib/awesome_bot/white_list.rb

@@ -0,0 +1,9 @@
+# Process white list
+module AwesomeBot
+  class << self
+    def white_list(list, item)
+      list.each { |x| return true if item.include? x }
+      false
+    end
+  end # class
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: awesome_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Khamsing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.29
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.29
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Check for valid and duplicate URLs in a file
+email:
+- dkhamsing8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- awesome_bot.gemspec
+- bin/assets/test-dupe
+- bin/assets/test-link-issue
+- bin/assets/test-no-dupes
+- bin/assets/test-no-issues
+- bin/assets/test-no-links
+- bin/awesome_bot
+- bin/console
+- bin/setup
+- lib/awesome_bot.rb
+- lib/awesome_bot/command.rb
+- lib/awesome_bot/links.rb
+- lib/awesome_bot/statuses.rb
+- lib/awesome_bot/version.rb
+- lib/awesome_bot/white_list.rb
+homepage: https://github.com/dkhamsing/awesome_bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Validate awesome project URLs.
+test_files: []