henchman-sync 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83e05f1424105e5e73efd0efcd56291a7167d002
-  data.tar.gz: 8f5047f31c81304402b96a91563b8ac0614c0b59
+  metadata.gz: 00b0b426fe2f85ce317502bbfec6dbe6545f757d
+  data.tar.gz: 0d62c14e6b5d9fe87241e4e94e31264f2b6f99a3
 SHA512:
-  metadata.gz: a69d6220254d81047b7826d8c318035e67de8e8f2d7e0aff3cdf37cfc3b38a2db60322a5fffb27e2388399455cde7394e6984fa971fa51e6ef74f4ebd00e0487
-  data.tar.gz: 46772a0505241b492ea0e3e4e4a49225acca0f46cbe63c895f57cc92352db3c2a962b210c1cc0995a9359c32ab95286db671e302205f545517566096d65021b5
+  metadata.gz: 0141c85238c432b3ed3a6441ecff9d5639626339e8f3ce6137ce600b2a3da28917a3ad176850cee3d3e1a5848aeb0788e71afa4bfcddacd1595f634851624d23
+  data.tar.gz: 5d0d0d6a43f71ad8d0a01c83d42611880820a3f26442074f08b61c166914103076d5cfd7f1a14c903ada9e0b710cc4beacbaaf9f199c4914ea13139743473682

data/README.md

@@ -22,11 +22,25 @@ This will guide you through setting up the application, including linking your D
 
 This starts the henchman daemon. You can now select a track in iTunes which is not available locally, and you will be asked if you'd like to fetch the track from your Dropbox. The application will also automatically download the rest of the album that contains the track you selected.
 
+You can also click on a playlist, and if that playlist has tracks that are not available locally, they will be downloaded for you.
+
+Starting the henchman daemon will also create a task to cleanse your iTunes tracks twice per day*. The task runs at 12:00 AM and PM (or as soon as possible if the machine was asleep at that time.) Any track that hasn't been played in more than 24 hours AND wasn't downloaded in the last 24 hours will be removed from your machine. You can also run the clean manually by running
+
+    $ henchman clean
+
+You can also run
+
+    $ henchman clean --played_date 'true'
+
+To remove tracks that haven't been played in the last 24 hours (ignoring when the track was last downloaded.)
+
+* = as of version 0.3.0 - if you were running an earlier version simply stop and re-start henchman
+
 ## Troubleshooting
 
-Running the `configure` command creates a `~/.henchman` direction. This directory contains your configuration file, as well as log files and a shell script used for running the application. If nothing appears to be happening in iTunes after running `henchman start` your best bet is to check the log files.
+Running the `configure` command creates a `~/.henchman` direction. This directory contains your configuration file, as well as log files and a shell scripts used for running the application. If nothing appears to be happening in iTunes after running `henchman start` your best bet is to check the log files.
 
-By default, the application checks if iTunes is open every 10 seconds. It it is, it continues to poll iTunes every 3 seconds to see if a track is selected. If you'd like to change these, you can edit the `config` YAML file. If you edit the `poll_itunes_open` setting, you'll need to stop and re-start the henchman daemon.
+By default, the application checks if iTunes is open every 10 seconds. If it is, it continues to poll iTunes every 3 seconds to see if a track is selected. If you'd like to change these, you can edit the `config` YAML file. If you edit the `poll_itunes_open` setting, you'll need to stop and re-start the henchman daemon.
 
 ## Development
 
@@ -36,9 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## TODO
 
-    - Add job to cleanup tracks that haven't been in X number of minutes
-    - Figure out how to download playlist with a "'" in them
-    - Move off of the 'dropbox-sdk' gem, since it uses their API V1, which will be depreciated June 28th, 2017 (or just buck up and update the gem myself)
+  - Move off of the 'dropbox-sdk' gem, since it uses their API V1, which will be depreciated June 28th, 2017 (or just buck up and update the gem myself)
 
 ## Contributing
 

data/lib/applescript.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Henchman
 
   class AppleScript
@@ -15,7 +17,7 @@ module Henchman
 
     def prompt_script prompt
       "tell application \"iTunes\"\n"\
-      "  display dialog \"Fetch #{prompt}?\"\n"\
+      "  display dialog \"Fetch #{prompt.gsub(/'/){ %q('"'"') }}?\"\n"\
       "end tell"
     end
 
@@ -62,8 +64,8 @@ module Henchman
       "tell application \"iTunes\"\n"\
       "  try\n"\
       "    set album_tracks to "\
-      "        (every track whose artist is \"#{artist}\" "\
-      "                        and album is \"#{album}\")\n"\
+      "        (every track whose artist is \"#{artist.gsub(/'/){ %q('"'"') }}\" "\
+      "                        and album is \"#{album.gsub(/'/){ %q('"'"') }}\")\n"\
       "    set str to \"\"\n"\
       "    repeat with album_track in album_tracks\n"\
       "      set data_location to location of album_track as string\n"\
@@ -133,7 +135,7 @@ module Henchman
     def get_playlist_tracks_script playlist
       "tell application \"iTunes\"\n"\
       "  try\n"\
-      "    set playlist_tracks to every track in playlist \"#{playlist}\"\n"\
+      "    set playlist_tracks to every track in playlist \"#{playlist.gsub(/'/){ %q('"'"') }}\"\n"\
       "    set str to \"\"\n"\
       "    repeat with playlist_track in playlist_tracks\n"\
       "      set data_location to location of playlist_track as string\n"\
@@ -142,9 +144,9 @@ module Henchman
       "        set data_album to album of playlist_track as string\n"\
       "        set data_title to name of playlist_track as string\n"\
       "        set data_id to database ID of playlist_track as string\n"\
-      "        set str to str & data_artist & \"#{@delimiter}\" "\
-      "                       & data_album  & \"#{@delimiter}\" "\
-      "                       & data_title  & \"#{@delimiter}\" "\
+      "        set str to str & data_artist & \"#{@delimiter}\""\
+      "                       & data_album  & \"#{@delimiter}\""\
+      "                       & data_title  & \"#{@delimiter}\""\
       "                       & data_id     & \"#{@delimiter*2}\"\n"\
       "      end if\n"\
       "    end repeat\n"\
@@ -155,6 +157,28 @@ module Henchman
       "end tell"
     end
 
+    def get_tracks_with_location_script
+      "tell application \"iTunes\"\n"\
+      "  try\n"\
+      "    set all_tracks to every track in playlist \"Music\"\n"\
+		  "    set str to \"\"\n"\
+		  "    repeat with cur_track in all_tracks\n"\
+			"      set data_location to location of cur_track as string\n"\
+			"      if data_location is not equal to \"missing value\" then\n"\
+			"        set data_id to database ID of cur_track as string\n"\
+			"        set data_date to played date of cur_track\n"\
+			"        set str to str & data_id   & \"#{@delimiter}\""\
+      "                       & data_date & \"#{@delimiter}\""\
+      " & (POSIX path of data_location as string) & \"#{@delimiter*2}\"\n"\
+			"      end if\n"\
+		  "    end repeat\n"\
+		  "    return str\n"\
+      "  on error\n"\
+		  "    return 0\n"\
+	    "  end try\n"\
+      "end tell\n"\
+    end
+
     def applescript_command(script)
       "osascript -e '#{script}' 2> /dev/null"
     end
@@ -173,6 +197,20 @@ module Henchman
       track
     end
 
+    def get_tracks_with_location
+      tracks = Array.new
+      tmp_tracks = %x(#{applescript_command(get_tracks_with_location_script)}).chomp
+      tmp_tracks = tmp_tracks.split @delimiter*2
+      tmp_tracks.each do |track|
+        next if track.empty?
+        tmp_track = track.split @delimiter
+        tracks.push( {:id   => tmp_track[0],
+                      :date => DateTime.parse(tmp_track[1]),
+                      :path => tmp_track[2]} )
+      end
+      tracks
+    end
+
     def get_playlist
       playlist = %x(#{applescript_command(get_playlist_script)}).chomp
       playlist = playlist.split @delimiter
@@ -187,7 +225,7 @@ module Henchman
       tracks = Array.new
       tmp_tracks = %x(#{applescript_command(get_playlist_tracks_script playlist)}).chomp
       tmp_tracks = tmp_tracks.split @delimiter*2
-      tmp_tracks.each_with_index do |track, index|
+      tmp_tracks.each do |track|
         next if track.empty?
         tmp_track = track.split @delimiter
         tracks.push( {:artist => tmp_track[0],
@@ -204,7 +242,7 @@ module Henchman
       tracks = Array.new
       tmp_tracks = %x(#{applescript_command(get_album_tracks_script artist, album)}).chomp
       tmp_tracks = tmp_tracks.split @delimiter*2
-      tmp_tracks.each_with_index do |track, index|
+      tmp_tracks.each do |track|
         next if track.empty?
         tmp_track = track.split @delimiter
         next if tmp_track[3] == selection[:id]

data/lib/cache.rb

@@ -0,0 +1,63 @@
+require "templates"
+require "date"
+
+module Henchman
+
+  class Cache
+
+    def initialize
+      begin
+        @cache_file = File.expand_path("~/.henchman/cache")
+        @cache = YAML.load_file(@cache_file)
+        raise "Incorrectly formatted cache" if !(@cache.include? :ignore)
+
+        @cache[:ignore].each_value { |val| val.default = 0 }
+      rescue StandardError => err
+        puts "Error opening cache file (#{err})"
+        @cache = Henchman::Templates.cache
+      end
+      @cache[:history].default = DateTime.new
+    end
+
+    def config config
+      @config = config
+    end
+
+    def update_ignore type, identifier
+      return false if !(valid_ignore_type? type)
+      @cache[:ignore][type][identifier] = Time.now.to_i
+    end
+
+    def ignore? type, identifier
+      return false if !(valid_ignore_type? type)
+      @cache[:ignore][type][identifier] >= (Time.now.to_i - @config[:reprompt_timeout])
+    end
+
+    def get_time_last_downloaded track
+      @cache[:history][track[:id].to_i]
+    end
+
+    def tag track
+      @cache[:history][track[:id].to_i] = DateTime.now
+    end
+
+    def delete track
+      @cache[:history].delete track[:id].to_i
+    end
+
+    def flush
+      File.open(@cache_file, "w") { |f| f.write( @cache.to_yaml ) }
+    end
+
+    def valid_ignore_type? type
+      if !(Henchman::Templates.cache[:ignore].keys.include? type)
+        puts "Invalid type '#{type}' for ignore cache check"
+        false
+      else
+        true
+      end
+    end
+
+  end
+
+end

data/lib/clean.rb

@@ -0,0 +1,59 @@
+require "applescript"
+require "cache"
+require "date"
+
+module Henchman
+
+  class Clean
+
+    def self.run played_date
+
+      puts "Cleanup ran at #{DateTime.now.strftime('%m-%d-%Y %k:%M:%S%p')}"
+
+      played_date = (played_date == 'true') ? true : false
+
+      @appleScript = Henchman::AppleScript.new
+      @cache = Henchman::Cache.new
+      begin
+        @config = YAML.load_file(File.expand_path('~/.henchman/config'))
+        @cache.config @config
+        @appleScript.setup @config
+      rescue StandardError => err
+        puts "Error opening config file. Try rerunning `henchman configure`"
+        return
+      end
+
+      cutoff = DateTime.now - 1
+
+      tracks = @appleScript.get_tracks_with_location
+      tracks.each do |track|
+        cache_time = @cache.get_time_last_downloaded track
+        if track[:date] < cutoff && ((cache_time < cutoff) || played_date)
+          cleanup track
+        end
+      end
+
+      @cache.flush
+
+    end
+
+    def self.cleanup track
+      filepath = track[:path]
+      File.delete filepath
+      @cache.delete track
+      puts "Deleted #{filepath}"
+
+      while File.dirname(filepath) != @config[:root]
+        filepath = File.dirname(filepath)
+        begin
+          Dir.rmdir(filepath)
+          puts "Deleted #{filepath}"
+        rescue SystemCallError => msg
+          break
+        end
+      end
+    end
+
+  end
+
+end

data/lib/core.rb

@@ -1,5 +1,6 @@
-require "dropbox.rb"
-require "applescript.rb"
+require "dropbox"
+require "applescript"
+require "cache"
 require "yaml"
 
 module Henchman
@@ -8,24 +9,14 @@ module Henchman
 
     def self.run
       @appleScript = Henchman::AppleScript.new
-
-      begin
-        cache_file = File.expand_path("~/.henchman/cache")
-        @ignore = YAML.load_file(cache_file)
-        raise "Incorrectly formatted cache" if !(@ignore.include? :artist)
-        
-        @ignore.each_value { |val| val.default = 0 }
-      rescue StandardError => err
-        puts "Error opening cache file (#{err})"
-        @ignore = Henchman::Templates.cache
-      end
-
+      @cache = Henchman::Cache.new
       threads = []
       update_cache = false
 
       while itunes_is_active?
         begin
           @config = YAML.load_file(File.expand_path('~/.henchman/config'))
+          @cache.config @config
         rescue StandardError => err
           puts "Error opening config file. Try rerunning `henchman configure`"
           return
@@ -42,14 +33,15 @@ module Henchman
         track = @appleScript.get_selection
 
         if track_selected? track
-          if (missing_track_selected? track) && !(ignore? :artist, track[:artist])
+          if (missing_track_selected? track) && !(@cache.ignore? :artist, track[:artist])
             update_cache = true
-            update_ignore :artist, track[:artist]
+            @cache.update_ignore :artist, track[:artist]
             if @appleScript.fetch? "#{track[:album]} by #{track[:artist]}"
               begin
                 # first download the selected track
                 dropbox_path   = @dropbox.search_for track
                 file_save_path = @dropbox.download track, dropbox_path
+                @cache.tag track
 
                 # if we downloaded it, update the location of the track in iTunes
                 unless !file_save_path
@@ -57,7 +49,7 @@ module Henchman
                   # if the update failed, cleanup that directory and don't bother
                   # doing the rest of the album
                   if !updated
-                    cleanup file_save_path
+                    cleanup file_save_path, track
                     next
                   end
 
@@ -76,9 +68,9 @@ module Henchman
           playlist = @appleScript.get_playlist
           if playlist
             playlist_tracks = @appleScript.get_playlist_tracks playlist
-            if (!playlist_tracks.empty?) && !(ignore? :playlist, playlist)
+            if (!playlist_tracks.empty?) && !(@cache.ignore? :playlist, playlist)
               update_cache = true
-              update_ignore :playlist, playlist
+              @cache.update_ignore :playlist, playlist
               if @appleScript.fetch? playlist
                 threads << Thread.new{ download_tracks playlist_tracks }
               end
@@ -89,26 +81,7 @@ module Henchman
       end
 
       threads.each { |thr| thr.join }
-      File.open(cache_file, "w") { |f| f.write( @ignore.to_yaml ) } if update_cache
-    end
-
-    def self.update_ignore type, identifier
-      return false if !(valid_ignore_type? type)
-      @ignore[type][identifier] = Time.now.to_i
-    end
-
-    def self.ignore? type, identifier
-      return false if !(valid_ignore_type? type)
-      @ignore[type][identifier] >= (Time.now.to_i - @config[:reprompt_timeout])
-    end
-
-    def self.valid_ignore_type? type
-      if !(Henchman::Templates.cache.keys.include? type)
-        puts "Invalid type '#{type}' for ignore cache check"
-        false
-      else
-        true
-      end
+      @cache.flush if update_cache
     end
 
     def self.track_selected? track
@@ -132,21 +105,23 @@ module Henchman
         # first download the selected track
         dropbox_path   = @dropbox.search_for track
         file_save_path = @dropbox.download track, dropbox_path
+        @cache.tag track
 
         # if we downloaded it, update the location of the track in iTunes
         unless !file_save_path
           updated = @appleScript.set_track_location track, file_save_path
 
           # if the update failed, remove that file
-          cleanup file_save_path if !updated
+          cleanup file_save_path, track if !updated
         end
       rescue StandardError => err
         puts err
       end
     end
 
-    def self.cleanup file_save_path
+    def self.cleanup file_save_path, track
       File.delete file_save_path
+      @cache.delete track
       while File.dirname(file_save_path) != @config[:root]
         file_save_path = File.dirname(file_save_path)
         begin

data/lib/henchman/version.rb

@@ -1,3 +1,3 @@
 module Henchman
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/henchman.rb

@@ -2,6 +2,7 @@ require "henchman/version"
 require "configure"
 require "launchd_handler"
 require "core"
+require "clean"
 require "commander/import"
 require "yaml"
 
@@ -43,5 +44,16 @@ module Henchman
       end
     end
 
+    command :clean do |c|
+      c.syntax = 'henchman clean [options]'
+      c.description = 'Remove tracks from the file system that are old. '\
+                      'Should not be ran manually.'
+      c.option '--played_date \'true\'/\'false\'', String, 'Delete tracks based only on last played date'
+      c.action do |args, options|
+        options.default :played_date => 'false'
+        Henchman::Clean.run options.played_date
+      end
+    end
+
   end
 end

data/lib/launchd_handler.rb

@@ -13,28 +13,39 @@ module Henchman
         return if !Henchman.connect
       end
 
-      puts "Creating agent"
-      plist      = Henchman::Templates.plist
-      plist_path = File.expand_path("~/Library/LaunchAgents/com.henchman.plist")
-      shell_script_path = File.expand_path("~/.henchman/run.sh")
+      puts "Creating agents"
+      plist_main       = Henchman::Templates.plist_main
+      plist_path_main  = File.expand_path("~/Library/LaunchAgents/com.henchman.plist")
+      plist_clean      = Henchman::Templates.plist_clean
+      plist_path_clean = File.expand_path("~/Library/LaunchAgents/com.henchman.clean.plist")
+      shell_script_path_main  = File.expand_path("~/.henchman/run.sh")
+      shell_script_path_clean = File.expand_path("~/.henchman/clean.sh")
       cache_path        = File.expand_path("~/.henchman/cache")
-      File.write(plist_path, plist)
-      File.write(shell_script_path, Henchman::Templates.shell_script)
+      File.write(plist_path_main, plist_main)
+      File.write(shell_script_path_main, Henchman::Templates.shell_script('run'))
+      File.write(plist_path_clean, plist_clean)
+      File.write(shell_script_path_clean, Henchman::Templates.shell_script('clean'))
       File.open(cache_path, "w") { |f| f.write( Henchman::Templates.cache.to_yaml ) }
 
       puts "Launching agent"
-      `chmod +x #{shell_script_path}`
-      `launchctl load #{plist_path}`
+      `chmod +x #{shell_script_path_main}`
+      `chmod +x #{shell_script_path_clean}`
+      `launchctl load #{plist_path_main}`
+      `launchctl load #{plist_path_clean}`
 
-      puts "Launched successful! You are now running henchman."
+      puts "Launched successfully! You are now running henchman."
     end
 
     def self.stop
       puts "Stopping agents"
-      plist_path = File.expand_path("~/Library/LaunchAgents/com.henchman.plist")
-      `launchctl unload #{plist_path}`
-      `rm #{plist_path}`
+      plist_path_main = File.expand_path("~/Library/LaunchAgents/com.henchman.plist")
+      plist_path_clean = File.expand_path("~/Library/LaunchAgents/com.henchman.clean.plist")
+      `launchctl unload #{plist_path_main}`
+      `launchctl unload #{plist_path_clean}`
+      `rm #{plist_path_main}`
+      `rm #{plist_path_clean}`
       `rm #{File.expand_path("~/.henchman/run.sh")}`
+      `rm #{File.expand_path("~/.henchman/clean.sh")}`
       `rm #{File.expand_path("~/.henchman/cache")}`
       `rm #{File.expand_path("~/.henchman/stdout.log")}`
       `rm #{File.expand_path("~/.henchman/stderr.log")}`

data/lib/templates.rb

@@ -1,6 +1,6 @@
 module Henchman
   class Templates
-    def self.plist
+    def self.plist_main
       config = YAML.load_file(File.expand_path('~/.henchman/config'))
 
       "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"\
@@ -24,9 +24,45 @@ module Henchman
       "</plist>"
     end
 
-    def self.shell_script
+    def self.plist_clean
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"\
+      "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" "\
+      "\"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"\
+      "<plist version=\"1.0\">\n"\
+      "<dict>\n"\
+      "\t<key>Label</key>\n"\
+      "\t<string>henchman_clean</string>\n"\
+      "\t<key>ProgramArguments</key>\n"\
+      "\t<array>\n"\
+      "\t\t<string>#{File.expand_path('~/.henchman/clean.sh')}</string>\n"\
+      "\t</array>\n"\
+      "\t<key>StartCalendarInterval</key>\n"\
+      "\t<array>\n"\
+      "\t<!-- Run twice a day. At 12:00 AM and at 12:00 PM -->\n"\
+      "\t\t<dict>\n"\
+      "\t\t\t<key>Hour</key>\n"\
+      "\t\t\t<integer>00</integer>\n"\
+      "\t\t\t<key>Minute</key>\n"\
+      "\t\t\t<integer>00</integer>\n"\
+      "\t\t</dict>\n"\
+      "\t\t<dict>\n"\
+      "\t\t\t<key>Hour</key>\n"\
+      "\t\t\t<integer>12</integer>\n"\
+      "\t\t\t<key>Minute</key>\n"\
+      "\t\t\t<integer>00</integer>\n"\
+      "\t\t</dict>\n"\
+      "\t</array>\n"\
+      "\t<key>StandardOutPath</key>\n"\
+      "\t<string>#{File.expand_path('~/.henchman/stdout.log')}</string>\n"\
+      "\t<key>StandardErrorPath</key>\n"\
+      "\t<string>#{File.expand_path('~/.henchman/stderr.log')}</string>\n"\
+      "</dict>\n"\
+      "</plist>"
+    end
+
+    def self.shell_script command
       "#!/bin/sh\n"\
-      "#{`which henchman`.chomp} run"
+      "#{`which henchman`.chomp} #{command}"
     end
 
     def self.config
@@ -46,8 +82,11 @@ module Henchman
 
     def self.cache
       {
-        :artist   => Hash.new(0),
-        :playlist => Hash.new(0)
+        :ignore => {
+                     :artist   => Hash.new(0),
+                     :playlist => Hash.new(0)
+                   },
+        :history => Hash.new
       }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: henchman-sync
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Greg Merritt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -100,6 +100,8 @@ files:
 - exe/henchman
 - henchman.gemspec
 - lib/applescript.rb
+- lib/cache.rb
+- lib/clean.rb
 - lib/configure.rb
 - lib/core.rb
 - lib/dropbox.rb