henchman-sync 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f864ccdbb1adb044b16389e17adf74cc7757d26
-  data.tar.gz: 0ed7300956a883823681114bca11bb6985557c4b
+  metadata.gz: 83e05f1424105e5e73efd0efcd56291a7167d002
+  data.tar.gz: 8f5047f31c81304402b96a91563b8ac0614c0b59
 SHA512:
-  metadata.gz: 43a0697682a79bd283b855ec7c1c59dc7f6de7a6547a9b523effeb8e66dce7f7775283e3c93ee961be6ce4fb15f7238adb2f6f96192625c25ecaf21ebb8e9a1f
-  data.tar.gz: b38df428d8700ac444c63ba55fc2dffa778e9b7cbd06f0732c02385e05e41ffaac9ccc1c4c8ce930b165e3beaa4f2c60b7ba8055dc857e3f955d3610dbfe7523
+  metadata.gz: a69d6220254d81047b7826d8c318035e67de8e8f2d7e0aff3cdf37cfc3b38a2db60322a5fffb27e2388399455cde7394e6984fa971fa51e6ef74f4ebd00e0487
+  data.tar.gz: 46772a0505241b492ea0e3e4e4a49225acca0f46cbe63c895f57cc92352db3c2a962b210c1cc0995a9359c32ab95286db671e302205f545517566096d65021b5

data/README.md

@@ -6,11 +6,9 @@ When you (single) click on a track in iTunes the application will check if that
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
 
-Or install it yourself as:
-
-    $ gem install henchman
+    $ gem install henchman-sync
 
 ## Usage
 
@@ -36,6 +34,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## 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)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/gremerritt/henchman.

data/lib/applescript.rb

@@ -13,19 +13,16 @@ module Henchman
       "end tell"
     end
 
-    def prompt_script
+    def prompt_script prompt
       "tell application \"iTunes\"\n"\
-      "  display dialog \"Fetch?\"\n"\
+      "  display dialog \"Fetch #{prompt}?\"\n"\
       "end tell"
     end
 
-    def update_track_location_script selection, local_file
+    def update_track_location_script track_id, local_file
       "tell application \"iTunes\"\n"\
       "  try\n"\
-      "    set data_tracks to "\
-      "      (every track whose artist is \"#{selection[:artist].gsub(/'/){ %q('"'"') }}\" and "\
-      "                         album  is \"#{selection[:album].gsub(/'/){ %q('"'"') }}\"  and "\
-      "                         name   is \"#{selection[:track].gsub(/'/){ %q('"'"') }}\")\n"\
+      "    set data_tracks to (every track whose database ID is \"#{track_id}\")\n"\
       "    if (count of data_tracks) is 1 then\n"\
       "      set location of (item 1 of data_tracks) to "\
       "        (POSIX file \"#{local_file.gsub(/'/){ %q('"'"') }}\")\n"\
@@ -46,10 +43,12 @@ module Henchman
       "      set data_artist to artist of selection as string\n"\
       "      set data_album to album of selection as string\n"\
       "      set data_title to name of selection as string\n"\
+      "      set data_id to database ID of selection as string\n"\
       "      set data_location to POSIX path of (location of selection as string)\n"\
       "      set str to data_artist & \"#{@delimiter}\" & "\
       "                 data_album  & \"#{@delimiter}\" & "\
       "                 data_title  & \"#{@delimiter}\" & "\
+      "                 data_id  & \"#{@delimiter}\" & "\
       "                 data_location\n"\
       "      return str\n"\
       "    end if\n"\
@@ -62,17 +61,94 @@ module Henchman
     def get_album_tracks_script artist, album
       "tell application \"iTunes\"\n"\
       "  try\n"\
-      "    set data_tracks to "\
+      "    set album_tracks to "\
       "        (every track whose artist is \"#{artist}\" "\
       "                        and album is \"#{album}\")\n"\
-      "    set data_tracks_str to \"\"\n"\
-      "    repeat with data_track in data_tracks\n"\
-      "      set data_tracks_str to data_tracks_str & (name of data_track) as string\n"\
-			"      if (name of (last item of data_tracks)) is not (name of data_track) then\n"\
-			"        set data_tracks_str to data_tracks_str & \"#{@delimiter}\"\n"\
-			"      end if\n"\
+      "    set str to \"\"\n"\
+      "    repeat with album_track in album_tracks\n"\
+      "      set data_location to location of album_track as string\n"\
+      "      if data_location is equal to \"missing value\" then\n"\
+      "        set data_artist to artist of album_track as string\n"\
+      "        set data_album to album of album_track as string\n"\
+      "        set data_title to name of album_track as string\n"\
+      "        set data_id to database ID of album_track as string\n"\
+      "        set str to str & data_artist & \"#{@delimiter}\" "\
+      "                       & data_album  & \"#{@delimiter}\" "\
+      "                       & data_title  & \"#{@delimiter}\" "\
+      "                       & data_id     & \"#{@delimiter*2}\"\n"\
+      "      end if\n"\
       "    end repeat\n"\
-      "    return data_tracks_str\n"\
+      "    return str\n"\
+      "  on error\n"\
+      "    return 0\n"\
+      "  end try\n"\
+      "end tell"
+    end
+
+    def get_playlist_script
+      "tell application \"iTunes\"\n"\
+      "	 try\n"\
+    	"    set selected_playlist to (get view of front window)\n"\
+      "    set playlist_name to name of selected_playlist as string\n"\
+      "    set playlist_special to special kind of selected_playlist as string\n"\
+      "    set str to playlist_name & \"#{@delimiter}\" & playlist_special\n"\
+      "    return str\n"\
+      "	 on error\n"\
+      "    return 0\n"\
+      "  end try\n"\
+      "end tell"\
+    end
+
+    # def get_playlist_tracks_script playlist, offset, size
+    #   "tell application \"iTunes\"\n"\
+    #   "  try\n"\
+    #   "    set playlist_tracks to every track in playlist \"#{playlist}\"\n"\
+    #   "    if (#{offset} + 1) * #{size} is less than (count of playlist_tracks) then\n"\
+    #   "      set max to (#{offset} + 1) * #{size}\n"\
+    #   "    else\n"\
+    #   "      set max to count of playlist_tracks\n"\
+    #   "    end if\n"\
+    #   "    set min to (#{offset} * #{size}) + 1\n"\
+    #   "    display dialog min\n"\
+    #   "    display dialog max\n"\
+    #   "    set str to \"\"\n"\
+    #   "    repeat with n from min to max\n"\
+    #   "      set data_track to item n of playlist_tracks\n"\
+    #   "      set data_artist to artist of data_track as string\n"\
+    #   "      set data_album to album of data_track as string\n"\
+    #   "      set data_title to name of data_track as string\n"\
+    #   "      set data_id to database ID of data_track as string\n"\
+    #   "      set data_location to POSIX path of (location of data_track as string)\n"\
+    #   "      set str to str & data_artist & \"#{@delimiter}\" "\
+    #   "                     & data_album & \"#{@delimiter}\" "\
+    #   "                     & data_title & \"#{@delimiter}\" "\
+    #   "                     & data_id & \"#{@delimiter}\" "\
+    #   "                     & data_location & \"#{@delimiter*2}\n"\
+    #   "    end repeat\n"\
+    #   "  on error\n"\
+    #   "    return 0\n"\
+    #   "  end try\n"\
+    #   "end tell"
+    # end
+    def get_playlist_tracks_script playlist
+      "tell application \"iTunes\"\n"\
+      "  try\n"\
+      "    set playlist_tracks to every track in playlist \"#{playlist}\"\n"\
+      "    set str to \"\"\n"\
+      "    repeat with playlist_track in playlist_tracks\n"\
+      "      set data_location to location of playlist_track as string\n"\
+      "      if data_location is equal to \"missing value\" then\n"\
+      "        set data_artist to artist of playlist_track as string\n"\
+      "        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}\" "\
+      "                       & data_id     & \"#{@delimiter*2}\"\n"\
+      "      end if\n"\
+      "    end repeat\n"\
+      "    return str\n"\
       "  on error\n"\
       "    return 0\n"\
       "  end try\n"\
@@ -83,32 +159,65 @@ module Henchman
       "osascript -e '#{script}' 2> /dev/null"
     end
 
-    def get_selection ret
+    def get_selection
       selection = %x( #{applescript_command(get_selection_script)} ).chomp
-      info = selection.split(@delimiter)
-      if info.empty?
+      info = selection.split @delimiter
+      track = Hash.new
+      if !info.empty?
+        track[:artist] = info[0]
+        track[:album]  = info[1]
+        track[:track]  = info[2]
+        track[:id]     = info[3]
+        track[:path]   = info[4]
+      end
+      track
+    end
+
+    def get_playlist
+      playlist = %x(#{applescript_command(get_playlist_script)}).chomp
+      playlist = playlist.split @delimiter
+      if playlist[1] != 'none'
         false
-      elsif info[3] == "/missing value" || !File.exists?(info[3])
-        ret[:artist]   = info[0]
-        ret[:album]    = info[1]
-        ret[:track]    = info[2]
-        true
       else
-        false
+        playlist[0]
+      end
+    end
+
+    def get_playlist_tracks playlist
+      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|
+        next if track.empty?
+        tmp_track = track.split @delimiter
+        tracks.push( {:artist => tmp_track[0],
+                      :album  => tmp_track[1],
+                      :track  => tmp_track[2],
+                      :id     => tmp_track[3]} )
       end
+      tracks
     end
 
     def get_album_tracks_of selection
       artist = selection[:artist]
       album  = selection[:album]
-      tracks = %x(#{applescript_command(get_album_tracks_script artist, album)}).chomp
-      tracks = tracks.split(@delimiter)
-      tracks.delete selection[:track]
+      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|
+        next if track.empty?
+        tmp_track = track.split @delimiter
+        next if tmp_track[3] == selection[:id]
+        tracks.push( {:artist => tmp_track[0],
+                      :album  => tmp_track[1],
+                      :track  => tmp_track[2],
+                      :id     => tmp_track[3]} )
+      end
       tracks
     end
 
-    def fetch?
-      (%x(#{applescript_command(prompt_script)}).chomp == "button returned:OK") ? true : false
+    def fetch? prompt
+      (%x(#{applescript_command(prompt_script prompt)}).chomp == "button returned:OK") ? true : false
     end
 
     def get_active_app
@@ -116,7 +225,7 @@ module Henchman
     end
 
     def set_track_location selection, local_file
-      ret = %x(#{applescript_command(update_track_location_script selection, local_file)}).chomp
+      ret = %x(#{applescript_command(update_track_location_script selection[:id], local_file)}).chomp
       if ret.empty? || ret == '0'
         puts "Could not update location of #{selection.values.join(':')} to #{local_file}"
         false

data/lib/core.rb

@@ -12,11 +12,13 @@ module Henchman
       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 = Hash.new
+        @ignore = Henchman::Templates.cache
       end
-      @ignore.default = 0
 
       threads = []
       update_cache = false
@@ -37,40 +39,50 @@ module Henchman
           return
         end
 
-        selection = Hash.new
-        track_selected = @appleScript.get_selection selection
-
-        if track_selected && @ignore[selection[:artist]] < (Time.now.to_i - @config[:reprompt_timeout])
-          update_cache = true
-          @ignore.delete selection[:artist]
-          if @appleScript.fetch?
-            puts "searching"
-            begin
-              # first download the selected track
-              dropbox_path   = @dropbox.search_for selection
-              file_save_path = @dropbox.download selection, dropbox_path
-
-              # if we downloaded it, update the location of the track in iTunes
-              unless !file_save_path
-                updated = @appleScript.set_track_location selection, file_save_path
-                # if the update failed, cleanup that directory and don't bother
-                # doing the rest of the album
-                if !updated
-                  cleanup file_save_path
-                  next
+        track = @appleScript.get_selection
+
+        if track_selected? track
+          if (missing_track_selected? track) && !(ignore? :artist, track[:artist])
+            update_cache = true
+            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
+
+                # 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, cleanup that directory and don't bother
+                  # doing the rest of the album
+                  if !updated
+                    cleanup file_save_path
+                    next
+                  end
+
+                  # now that we've gotten the selected track, spawn off another process
+                  # to download the rest of the tracks on the album - spatial locality FTW
+                  album_tracks = @appleScript.get_album_tracks_of track
+                  threads << Thread.new{ download_tracks album_tracks }
                 end
-
-                # now that we've gotten the selected track, spawn off another process
-                # to download the rest of the tracks on the album - spatial locality FTW
-                album_tracks = @appleScript.get_album_tracks_of selection
-                threads << Thread.new{ download_album_tracks selection, album_tracks }
+              rescue StandardError => err
+                puts err
+                next
+              end
+            end
+          end
+        else
+          playlist = @appleScript.get_playlist
+          if playlist
+            playlist_tracks = @appleScript.get_playlist_tracks playlist
+            if (!playlist_tracks.empty?) && !(ignore? :playlist, playlist)
+              update_cache = true
+              update_ignore :playlist, playlist
+              if @appleScript.fetch? playlist
+                threads << Thread.new{ download_tracks playlist_tracks }
               end
-            rescue StandardError => err
-              puts err
-              next
             end
-          else
-            @ignore[selection[:artist]] = Time.now.to_i
           end
         end
         sleep @config[:poll_track]
@@ -80,31 +92,56 @@ module Henchman
       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
+    end
+
+    def self.track_selected? track
+      !track.empty?
+    end
+
+    def self.missing_track_selected? track
+      track[:path] == '/missing value'
+    end
+
     def self.itunes_is_active?
       @appleScript.get_active_app == 'iTunes'
     end
 
-    def self.download_album_tracks selection, album_tracks
-      album_tracks.each do |album_track|
-        selection[:track] = album_track
-        begin
-          # first download the selected track
-          dropbox_path   = @dropbox.search_for selection
-          file_save_path = @dropbox.download selection, dropbox_path
-
-          # if we downloaded it, update the location of the track in iTunes
-          unless !file_save_path
-            updated = @appleScript.set_track_location selection, file_save_path
-            # if the update failed, remove that file
-            if !updated
-              cleanup file_save_path
-              next
-            end
-          end
-        rescue StandardError => err
-          puts err
-          next
+    def self.download_tracks album_tracks
+      album_tracks.each { |album_track| download_and_update album_track }
+    end
+
+    def self.download_and_update track
+      begin
+        # first download the selected track
+        dropbox_path   = @dropbox.search_for track
+        file_save_path = @dropbox.download track, dropbox_path
+
+        # 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
         end
+      rescue StandardError => err
+        puts err
       end
     end
 

data/lib/dropbox.rb

@@ -44,7 +44,11 @@ module Henchman
 
     def search_for selection
       # search Dropbox for the file
-      results = @client.search(@config[:dropbox][:root], selection[:track])
+      begin
+        results = @client.search(@config[:dropbox][:root], selection[:track])
+      rescue DropboxError => msg
+        raise "Error accessing Dropbox Search API on #{selection.values.join(':')}: #{msg}"
+      end
 
       # get rid of any results that are directories
       results.reject! { |result| result['is_dir'] }

data/lib/henchman/version.rb

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

data/lib/launchd_handler.rb

@@ -20,7 +20,7 @@ module Henchman
       cache_path        = File.expand_path("~/.henchman/cache")
       File.write(plist_path, plist)
       File.write(shell_script_path, Henchman::Templates.shell_script)
-      File.open(cache_path, "w") { |f| f.write( {}.to_yaml ) }
+      File.open(cache_path, "w") { |f| f.write( Henchman::Templates.cache.to_yaml ) }
 
       puts "Launching agent"
       `chmod +x #{shell_script_path}`

data/lib/templates.rb

@@ -30,18 +30,25 @@ module Henchman
     end
 
     def self.config
-      yml = {
-              :dropbox => {:key => '',
-                           :secret => '',
-                           :access_token => '',
-                           :user_id => '',
-                           :root     => ''},
-              :root => '',
-              :poll_itunes_open => 10,
-              :poll_track => 3,
-              :reprompt_timeout => 300,
-              :delimiter => '|~|'
-            }
+      {
+        :dropbox => {:key => '',
+                     :secret => '',
+                     :access_token => '',
+                     :user_id => '',
+                     :root     => ''},
+        :root => '',
+        :poll_itunes_open => 10,
+        :poll_track => 3,
+        :reprompt_timeout => 300,
+        :delimiter => '|~|'
+      }
+    end
+
+    def self.cache
+      {
+        :artist   => Hash.new(0),
+        :playlist => Hash.new(0)
+      }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: henchman-sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Greg Merritt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander