url-checker 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520fdbebbffff313fced72bdff28b582b954c226
-  data.tar.gz: cf5b0d0c5d1ffb6446db835312f524c0c5f47036
+  metadata.gz: bc8f608df4641ec27291dca1cc2170b2dde74210
+  data.tar.gz: 157d02f42cb51fd56272580b93ac5e87b6e3ad2b
 SHA512:
-  metadata.gz: f7bb7f5c95da1a5e90eba3706f35874dcf6a6c1ef26154ff5b1d66dc06a81f4bd155421b784ab1aafba5764c22cc8ea08f184414f15639e739627d575ce37a90
-  data.tar.gz: 98dab8c5b611986b7215e1d1d0bfff84b29a9552823ac48b8d94c7f18688a80cac44680ae7f2433b85288ee7a5c7aa26757f181bb7627650a5fc6f75c755e96a
+  metadata.gz: 54c89e9bd0322c92b915c8613ae60a3e65d414b1b349b468691a970ffc3a5e1bc5570fe2775f292da86bcb13305c6dbc6f6fc36c862590b73b34aa2756bc1fdd
+  data.tar.gz: 792b7708b2652eece3adfb76a354ca8156bd88fdf40178557bec69e7555f088941f8f2aaba5f6e8e3927bb55c63b30b230f5104314656d4a9b09ec50e0520601

data/README.md

@@ -0,0 +1,34 @@
+[![Code Climate](https://codeclimate.com/github/HarlemSquirrel/url-checker/badges/gpa.svg)](https://codeclimate.com/github/HarlemSquirrel/url-checker)
+
+# URL Checker
+
+A Ruby CLI for checking a list of URLs from a CSV file. Checkout the [RubGems page](https://rubygems.org/gems/url-checker). 
+
+## Getting started
+
+### Install and run from RubyGems
+
+```sh
+$ gem install url-checker
+$ checkurls path/to/file.csv
+```
+
+### Install and run manually
+
+Clone the repo and bundle
+
+```sh
+$ git clone https://github.com/HarlemSquirrel/url-checker.git
+$ bundle install
+```
+
+Try the test file
+
+```sh
+$ bin/checkurls spec/fixtures/test.csv
+ 404 Not Found http://google.com/cheese
+ 301 Moved Permanently http://google.com
+ 200 OK https://www.google.com
+  3 URLs checked with 1 issue(s).
+  Results saved to spec/fixtures/test_results_2017-02-19-11:44:27.csv
+```

data/bin/checkurls

@@ -3,4 +3,4 @@
 
 require_relative '../lib/url_checker'
 
-UrlChecker.call
+UrlChecker::UrlChecker.call

data/config/environment.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+require 'colorize'
+require 'csv'
+require 'net/http'
+
+require_relative '../lib/url_checker'
+require_relative '../lib/url_checker/url_checker'
+require_relative '../lib/url_checker/version'

data/lib/url_checker.rb

@@ -1,83 +1,7 @@
 # frozen_string_literal: true
-require_relative '../config/environment'
-
-# The main class
-class UrlChecker
-  BAD_CALL_MSG = 'Please call with one CSV file with URLs in the first column'
-  RESULTS_HEADERS = %w(Response URL).freeze
-
-  attr_reader :file_path, :results_file_path
-
-  def initialize(file_path:)
-    @file_path = file_path
-  end
-
-  def call
-    @results = [RESULTS_HEADERS]
-    @num_issues = 0
-    check_urls_from_csv
-    display_summary
-    write_results
-  end
-
-  def self.call
-    if ARGV.length == 1 && ARGV.first.match?(/\.csv\z/)
-      url_checker = new(file_path: ARGV.first).call
-    else
-      puts BAD_CALL_MSG.red
-    end
-    url_checker
-  end
-
-  private
 
-  attr_accessor :num_issues, :results
-
-  def check_url(url)
-    uri = URI(url)
-    response = Net::HTTP.get_response uri
-    collect_result response, url
-    display_result response, url
-  end
-
-  def check_urls_from_csv
-    threads = []
-    CSV.foreach(file_path) do |row|
-      url = row[0]
-      threads << Thread.new { check_url url } if url.match?(/http/)
-    end
-    threads.each(&:join)
-  end
-
-  def collect_result(response, url)
-    line = ["#{response.code} #{response.message}", url]
-    results << line
-  end
-
-  def display_result(response, url)
-    msg = " #{response.code} #{response.message} #{url}"
-    case response
-    when Net::HTTPSuccess, Net::HTTPRedirection
-      puts msg.green
-    else
-      @num_issues += 1
-      puts msg.red
-    end
-  end
-
-  def display_summary
-    num_checked = results.length - 1
-    msg = "  #{num_checked} URLs checked with #{num_issues} issue(s)."
-    num_issues.positive? ? puts(msg.yellow) : puts(msg.green)
-  end
+require_relative '../config/environment'
 
-  def write_results
-    time = Time.now.strftime('%Y-%m-%d-%H:%M:%S')
-    @results_file_path = file_path.gsub('.csv', "_results_#{time}.csv")
-    puts "  Results saved to #{results_file_path}"
-    CSV.open(results_file_path, 'wb') do |csv|
-      results.each { |r| csv << r }
-    end
-    results_file_path
-  end
+# The main module
+module UrlChecker
 end

data/lib/url_checker/url_checker.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module UrlChecker
+  # The main class
+  class UrlChecker
+    BAD_CALL_MSG = 'Please call with one CSV file with URLs in the first column'
+    RESULTS_HEADERS = %w(Response URL).freeze
+
+    attr_reader :file_path, :results_file_path
+
+    def initialize(file_path:)
+      @file_path = file_path
+    end
+
+    def call
+      @results = [RESULTS_HEADERS]
+      @num_issues = 0
+      display_summary Benchmark.measure { check_urls_from_csv }.real
+      write_results
+    end
+
+    def self.call
+      if ARGV.length == 1 && ARGV.first.match?(/\.csv\z/)
+        url_checker = new(file_path: ARGV.first).call
+      else
+        puts BAD_CALL_MSG.red
+      end
+      url_checker
+    end
+
+    private
+
+    attr_accessor :num_issues, :results
+
+    def check_url(url)
+      uri = URI(url)
+      response = Net::HTTP.get_response uri
+      collect_result response, url
+      display_result response, url
+    end
+
+    def check_urls_from_csv
+      threads = []
+      CSV.foreach(file_path) do |row|
+        url = row[0]
+        threads << Thread.new { check_url url } if url.match?(/http/)
+      end
+      threads.each(&:join)
+    end
+
+    def collect_result(response, url)
+      line = ["#{response.code} #{response.message}", url]
+      results << line
+    end
+
+    def display_result(response, url)
+      msg = " #{response.code} #{response.message} #{url}"
+      case response
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        puts msg.green
+      else
+        @num_issues += 1
+        puts msg.red
+      end
+    end
+
+    def display_summary(run_time)
+      num_checked = results.length - 1
+      msg = "  #{num_checked} URLs checked with #{num_issues} issue(s) in #{run_time.round 2} s."
+      num_issues.positive? ? puts(msg.yellow) : puts(msg.green)
+    end
+
+    def write_results
+      time = Time.now.strftime('%Y-%m-%d-%H:%M:%S')
+      @results_file_path = file_path.gsub('.csv', "_results_#{time}.csv")
+      puts "  Results saved to #{results_file_path}"
+      CSV.open(results_file_path, 'wb') do |csv|
+        results.each { |r| csv << r }
+      end
+      results_file_path
+    end
+  end
+end

data/lib/url_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UrlChecker
+  VERSION = '1.0.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: url-checker
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin McCormack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,15 +24,19 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: A Ruby CLI for checking a list of URLs from a CSV file
+description: A Ruby CLI for checking a list of URLs from a CSV file.
 email: HarlemSquirrel@gmail.com
 executables:
 - checkurls
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/checkurls
+- config/environment.rb
 - lib/url_checker.rb
+- lib/url_checker/url_checker.rb
+- lib/url_checker/version.rb
 homepage: https://github.com/HarlemSquirrel/url-checker
 licenses:
 - MIT
@@ -56,5 +60,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: A Ruby CLI for checking a list of URLs from a CSV file
+summary: Check URLs from a CSV
 test_files: []