awesome_bot 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd7f4c9d4a4ef27387f5be98562f0f639678e8ff
-  data.tar.gz: 490ef9bdb314344c878e2eb0954c7182db6eb0be
+  metadata.gz: 1aa43c6f8d790d1333e7777dbd1794552c1f5b51
+  data.tar.gz: ab95e39072c0bc07dce439e09baaba53feac1776
 SHA512:
-  metadata.gz: d78425a7f1b3b074532c45962ff28f75a321d9e38cc2c018b62765243b883cd8f7bd329af6ab83a1439a720cf819365fdaf8b2a494519660828f2cb4ab0d3375
-  data.tar.gz: af9d27a79f04c2b457335cff51fba1454eb16d744d8ea05ce75c63beb926512390a74f803eab61b6b9cbb9f69f204783daded626e0a1093f14d57daac214f02e
+  metadata.gz: bd052b6b4b58b4cfd60c148aa8f79158aa523e71c8403a5dfa6ff0fea57bc2503a10bd4a4e9e772daf8eebe8ae3a2944ad159d746587840b6cc3a06ce8aa7d19
+  data.tar.gz: 2a95a657d668d72ea67fba69f19a400323d9669938230a9cdee1468f3c01e15de8f0504b7bfcceb00c8f3472eb3850cd900a5588efe38829e62aa7607e390dcb

data/.travis.yml

@@ -2,11 +2,10 @@ language: ruby
 rvm:
   - 2.2
 before_script:
-  - export PATH=$PATH:$PWD/bin/
-  - bundle install
+  - rake 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
+  - awesome_bot README.md --allow-dupe --white-list gph.is,bot.svg,codeload,badge

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# awesome_bot
+
+## 0.1.0
+
+- initial version
+
+## 1.0.0
+
+- correct failure logic
+- rename `run` to `check`
+- isolate cli
+- [cli] simply usage, output version
+- [gemspec] update
+- [travis] simplify
+
+## Contact
+
+- [github.com/dkhamsing](https://github.com/dkhamsing)
+- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)

data/README.md

@@ -7,14 +7,13 @@
 `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)
+[![Gem Version](https://badge.fury.io/rb/awesome_bot.svg)](https://badge.fury.io/rb/awesome_bot)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'awesome_bot'
-```
+    gem 'awesome_bot', '~> 0.1'
 
 And then execute:
 
@@ -26,9 +25,25 @@ Or install it yourself as:
 
 ## Usage
 
+### Library
+
+```ruby
+irb(main):001:0> require 'awesome_bot'
+=> true
+irb(main):002:0> c = File.read 'README.md'
+=> "..."
+irb(main):003:0> AwesomeBot.check c
+=> [false, [{"url"=>"http://gph.is/1gU5itl", "status"=>301},..]
+# returning false, statuses and dupes if there are errors
+# otherwise returning true
 ```
-awesome_bot <file> [--allow-dupe] [--white-list item1,item2,..]
-```
+
+More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot/0.1.0).
+
+### Command Line
+
+    awesome_bot <file> [--allow-dupe] [--white-list item1,item2,..]
+
 
 ```shell
 $ awesome_bot README.md
@@ -95,13 +110,13 @@ language: ruby
 rvm:
   - 2.2
 before_script:
-  - wget https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/wip -O /tmp/temp.tar.gz
+  - wget https://codeload.github.com/dkhamsing/awesome_bot/tar.gz/master -O /tmp/temp.tar.gz
   - tar -xvf /tmp/temp.tar.gz
-  - export PATH=$PATH:$PWD/awesome_bot-wip/bin/
-  - cd awesome_bot-wip
+  - export PATH=$PATH:$PWD/awesome_bot-master/bin/
+  - cd awesome_bot-master
   - bundle install
 script:  
-  - awesome_bot ../README.md
+  - awesome_bot ../README.md 
 ```
 
 ## Credits

data/awesome_bot.gemspec

@@ -9,15 +9,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Daniel Khamsing']
   spec.email         = ['dkhamsing8@gmail.com']
 
-  spec.summary       = 'Validate awesome project URLs.'
+  spec.summary       = AwesomeBot::PROJECT_DESCRIPTION
   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.bindir        = 'bin'
+  spec.executables   = [AwesomeBot::PROJECT]
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_runtime_dependency 'faraday', '~> 0.9.2' # validate urls
   spec.add_runtime_dependency 'uri', '~> 4.4.29' # get urls

data/lib/awesome_bot.rb

@@ -1,4 +1,5 @@
-require 'awesome_bot/command'
+require 'awesome_bot/cli'
+require 'awesome_bot/check'
 
 # Validate awesome project URLs
 module AwesomeBot

data/lib/awesome_bot/{command.rb → check.rb}

@@ -1,64 +1,16 @@
 require 'awesome_bot/links'
 require 'awesome_bot/statuses'
-require 'awesome_bot/version'
 require 'awesome_bot/white_list'
 
-# Command
+# Check links
 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)
+    def check(content, white_listed = nil, skip_dupe = false, verbose = false)
       dupe_success = skip_dupe
 
       puts '> Will not check for duplicate links' if skip_dupe && verbose

data/lib/awesome_bot/cli.rb

@@ -0,0 +1,51 @@
+require 'awesome_bot/version'
+
+# Command line interface
+module AwesomeBot
+  OPTION_DUPE = 'allow-dupe'
+  OPTION_WHITE_LIST = 'white-list'
+
+  USAGE = "\t"
+
+  class << self
+    def cli
+      option_d = "--#{OPTION_DUPE}"
+      option_w = "--#{OPTION_WHITE_LIST}"
+
+      if ARGV.count == 0
+        puts "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"\
+             "\nVersion #{VERSION}, see #{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 unless check(content, white_listed, skip_dupe, true) == true
+
+      exit
+    end
+  end # class
+end

data/lib/awesome_bot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,15 +66,17 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-description: Check for valid and duplicate URLs in a file
+description: Check for valid and duplicate URLs in a file. Great for "awesome" projects.
 email:
 - dkhamsing8@gmail.com
-executables: []
+executables:
+- awesome_bot
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -89,7 +91,8 @@ files:
 - bin/console
 - bin/setup
 - lib/awesome_bot.rb
-- lib/awesome_bot/command.rb
+- lib/awesome_bot/check.rb
+- lib/awesome_bot/cli.rb
 - lib/awesome_bot/links.rb
 - lib/awesome_bot/statuses.rb
 - lib/awesome_bot/version.rb
@@ -106,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -117,5 +120,5 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Validate awesome project URLs.
+summary: Check for valid and duplicate URLs in a file. Great for "awesome" projects.
 test_files: []