unsavory 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6003a2ee811476e80f9203f4064fb5479e9447ae
-  data.tar.gz: 6b92d8fd928058d879b4d2fe77a82bcc53895f75
+  metadata.gz: cc56464c97a4ee80fe1c35e371a103a90de10bc9
+  data.tar.gz: 42ddd718d418035adbdbd6b55e73e10ef370847e
 SHA512:
-  metadata.gz: b2a74acb97b11f5367ec363a32909c0c98bf556543ad6cd1640263992738b43b313c832cd84e5052993dddcac3aaf057680e369d0cf242b67234a0036a9f9632
-  data.tar.gz: 420bcb560f56f9093d3349bc4ec1319dd2c9f2bb7949f96a99efea211047e19495d1928735dfa8472ac0980fb7c947956e56bb390a65a9462142f81e2f23b33b
+  metadata.gz: 28919e21cf5030872d78a7ff8267d806b9c28c6d0db6d70f63fa8e0a80c88173407515c74b5ed4e102860ae67a0d03b6ff7e8fbd428bfbed2c8935831c7568f8
+  data.tar.gz: 11ddf8eaac111e52cf972fcef1d280e8170c0d0ebb36037da42d583c2baaa62b274224ca13bd4c9fd28693a9d5004f348cefae4ba892b15da163bcc92a1f79c9

data/README.rdoc

@@ -2,13 +2,29 @@
 
 unsavory is a little Ruby script which checks your Pinboard bookmarks for dead links (ENOENT or HTTP status code 404) and removes them. Additionally it will also inform you about links which return a status code other than 200 (OK).
 
-== Usage
-
-After installing unsavory with
+== Installation
 
   $ gem install unsavory
 
-you can start it from the command-line like this:
+== Options
+
+  unsavory [OPTIONS]
+
+  -h, --help:
+     show help
+
+  -d, --dry-run:
+     only log outdated links without deleting them
+
+  -p, --http-proxy:
+     specify an HTTP proxy (e.g. --http-proxy="http://webproxy:8080")
+
+  -l, --log-file:
+     location of the log file (default: ./unsavory.log)
+
+== Usage
+
+You can start the program from the command-line like this:
 
   $ unsavory
 
@@ -18,15 +34,17 @@ It will first check if it can find the configuration file '~/.unsavory', which s
 
 In case this file doesn't exist, HighLine will be used to prompt for login credentials. If this gem isn't available, the script will display an error message and abort.
 
-When run, unsavory will generate display a progressbar and an estimate time until completion:
+While running unsavory will display a progressbar and an estimated time until completion:
 
   Enter Pinboard username: citizen428
   Enter Pinboard password: *************
 
   citizen428 has 774 bookmarks.
-  URLs:            3% |o                                         | ETA:  00:09:34
+  Checking:        3% |o                                         | ETA:  00:09:34
+
+It will also create a logfile which contains information on deleted URLs, as well as redirects and all HTTP response codes other than 200 (OK).
 
-It will also create a logfile name 'unsavory.log' in the directory where it was started. The log contains information on deleted URLs, as well as redirects and all HTTP response codes other than 200 (OK).
+If you don't want to actually delete links, please use the '--dry-run' option (also available as '-n').
 
 == Warning
 
@@ -37,10 +55,12 @@ Any link that returns an HTTP status code of 404 will be deleted without warning
 # Write tests.
 # Use tests to clean up code.
 # Add option to replace links with Archive.org links
+# Add option to update redirects
 
 == Thanks
 
 # thelibrarian[https://github.com/thelibrarian]: for implementing HTTPS support and the '--dry-run' option
+# thomd[https://github.com/thomd]: for adding proxy support
 
 == Author
 

data/bin/unsavory

@@ -9,8 +9,13 @@ require_relative "../lib/pinboard_client.rb"
 require_relative "../lib/utilities.rb"
 
 opts = Utilities.get_options
-pinboard_client = PinboardClient.new(opts[:user], opts[:pass])
-logger = Logger.new('unsavory.log')
+pinboard_client = PinboardClient.new(opts)
+# if the first arg is nil, Net::HTTP:Proxy returns a Net::HTTP object
+http_client = Net::HTTP::Proxy(*opts.values_at(:proxy_host,
+                                               :proxy_port,
+                                               :proxy_user,
+                                               :proxy_pass))
+logger = Logger.new(opts[:logfile])
 
 logger.info "Unsavory started: #{Time.now.strftime('%Y-%m-%d %H:%M')}"
 
@@ -21,12 +26,15 @@ unless urls
   exit 1
 end
 puts "\n#{opts[:user]} has #{urls.length} bookmarks."
-puts "You are using dry run mode. No links will be deleted!\n\n" if opts[:dry_run]
 
-pbar = ProgressBar.new("URLs", urls.size)
+if opts[:dry_run]
+  puts "You are using dry run mode. No links will be deleted!\n\n"
+end
+
+pbar = ProgressBar.new("Checking", urls.size)
 moved = 0
 
-urls.each_with_index do |url, idx|
+urls.each do |url|
   pbar.inc
   delete = false
   use_ssl = false
@@ -38,10 +46,9 @@ urls.each_with_index do |url, idx|
   end
 
   begin
-    Net::HTTP.start(uri.host, uri.port, :use_ssl => use_ssl) do |http|
+    http_client.start(uri.host, uri.port, :use_ssl => use_ssl) do |http|
       response = http.head(uri.path.empty? ? '/' : uri.path)
 
-      # handle redirects
       if response.is_a?(Net::HTTPRedirection)
         moved += 1
         logger.info "#{url} redirects to #{response['location']}"
@@ -74,4 +81,6 @@ end
 pbar.finish
 logger.close
 
-puts "\n#{moved} URIs are redirecting to new locations, you might want to fix them." if moved > 0
+if moved > 0
+  puts "\n#{moved} URIs are redirecting to new locations, you might want to fix them."
+end

data/lib/pinboard_client.rb

@@ -5,8 +5,9 @@ class PinboardClient
   base_uri 'https://api.pinboard.in/v1/'
   headers "User-Agent" => "Unsavory"
 
-  def initialize(user, password)
-    @options = {:basic_auth => {:username => user, :password => password}}
+  def initialize(opts)
+    @options = {:basic_auth => {:username => opts[:user], :password => opts[:pass]}}
+    self.class.http_proxy(*opts.values_at(:proxy_host, :proxy_port, :proxy_user, :proxy_pass))
   end
 
   def get_urls

data/lib/utilities.rb

@@ -2,7 +2,8 @@ require 'getoptlong'
 
 module Utilities
   class << self
-    CFG_FILE = File.join(ENV['HOME'], ".#{File.basename($0)}")
+    PROGRAM_NAME = File.basename($0)
+    CFG_FILE = File.join(ENV['HOME'], ".#{PROGRAM_NAME}")
 
     def get_options
       get_credentials.merge(parse_options)
@@ -11,7 +12,6 @@ module Utilities
     private
     def get_credentials
       if File.exists?(CFG_FILE)
-        puts "Using config file '#{CFG_FILE}'"
         user, pass = File.new(CFG_FILE).gets.chomp.split(':', 2)
       else
         begin
@@ -29,12 +29,43 @@ module Utilities
 
     def parse_options
       options = {}
-      opts = GetoptLong.new(['--dry-run', '-n', GetoptLong::NO_ARGUMENT])
+      opts = GetoptLong.new(
+        ['--dry-run', '-n', GetoptLong::NO_ARGUMENT],
+        ['--http-proxy', '-p', GetoptLong::REQUIRED_ARGUMENT],
+        ['--log-file', '-l', GetoptLong::REQUIRED_ARGUMENT],
+        ['--help', '-h', GetoptLong::NO_ARGUMENT]
+      )
 
-      opts.each do |opt, _|
+      opts.each do |opt, arg|
         case opt
+        when '--help'
+          puts <<EOF
+#{PROGRAM_NAME} [OPTIONS]
+
+-h, --help:
+   show help
+
+-d, --dry-run:
+   only log outdated links without deleting them
+
+-p, --http-proxy:
+   specify an HTTP proxy (e.g. --http-proxy="http://webproxy:8080")
+
+-l, --log-file:
+   location of the log file (default: ./unsavory.log)
+EOF
+          exit 0
         when '--dry-run'
           options[:dry_run] = true
+        when '--http-proxy'
+          options[:http_proxy] = true
+          uri = URI.parse(arg)
+          options[:proxy_host] = uri.host
+          options[:proxy_port] = uri.port || 8080
+          options[:proxy_user] = uri.user
+          options[:proxy_pass] = uri.password
+        when '--log-file'
+          options[:logfile] = File.expand_path(arg)
         end
       end
       options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unsavory
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Michael Kohl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty