recover_itunes_ratings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5b5411273b36b55660fd6d23955d9b911d1af3b
+  data.tar.gz: 6d3956ae72f4f8022fd8dd04936c815ebdb66f89
+SHA512:
+  metadata.gz: edffe849a9b824c30fd868b58c40942e0d4f726817966556e7f934f365689cda447beedf6475b94b45fc9a0b00291b2a251cf086c311f1b48829cb9c128ab11e
+  data.tar.gz: 7c4afb194f050800c394bb23523964ce7a9a71cd0e4f0ebc119816b71765a9ef1a70b78eca7dfe867938cefa0a58afa9cf9c5bd09847df2f10b836a2261808ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Milo Winningham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# recover_itunes_ratings
+
+Reads the song ratings from an iTunes library XML file and applies them to your current iTunes library via AppleScript. This may be useful to restore song ratings that were lost due to a bug in iTunes, Apple Music, or iCloud Music Library.
+
+## Installation
+
+    $ gem install recover_itunes_ratings
+
+## Usage
+
+    $ recover_itunes_ratings "iTunes Music Library.xml" [options]
+
+    By default, only prints the ratings that will be changed.
+
+    -a, --albums                     Reset all user-supplied album ratings
+    -r, --run                        Run instead of only printing changes
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec recover_itunes_ratings` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quadule/recover_itunes_ratings.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "recover_itunes_ratings"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/exe/recover_itunes_ratings

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "recover_itunes_ratings"
+
+options = {
+  dry_run: true,
+  reset_album_ratings: false
+}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: recover_itunes_ratings "iTunes Music Library.xml" [options]'
+
+  opts.separator ""
+  opts.separator "By default, only prints the ratings that will be changed."
+  opts.separator ""
+
+  opts.on("-a", "--albums", "Reset all user-supplied album ratings") do |v|
+    options[:reset_album_ratings] = true
+  end
+
+  opts.on("-r", "--run", "Run instead of only printing changes") do |v|
+    options[:dry_run] = false
+  end
+end
+optparse.parse!
+
+if ARGV.empty?
+  puts optparse
+  exit(-1)
+end
+
+RecoverItunesRatings::Runner.new(ARGV[0], options).run

data/lib/recover_itunes_ratings.rb

@@ -0,0 +1,2 @@
+require "recover_itunes_ratings/runner"
+require "recover_itunes_ratings/version"

data/lib/recover_itunes_ratings/matched_tracks.rb

@@ -0,0 +1,18 @@
+require "rb-scpt"
+
+module RecoverItunesRatings
+  # Matches saved ratings with current iTunes tracks.
+  class MatchedTracks
+    def initialize(ratings, app = ::Appscript.app("iTunes"))
+      @ratings = ratings
+      @app = app
+    end
+
+    def each
+      @ratings.each do |id, saved_rating|
+        track = @app.tracks[::Appscript.its.persistent_ID.eq(id)].get.first
+        yield track, saved_rating if track
+      end
+    end
+  end
+end

data/lib/recover_itunes_ratings/runner.rb

@@ -0,0 +1,32 @@
+require "recover_itunes_ratings/matched_tracks"
+require "recover_itunes_ratings/saved_ratings"
+
+module RecoverItunesRatings
+  # Restores each rating found in the library XML to the current iTunes library.
+  class Runner
+    def initialize(library_xml_path, dry_run: true, reset_album_ratings: false)
+      @dry_run = dry_run
+      @reset_album_ratings = reset_album_ratings
+
+      @ratings = SavedRatings.new(library_xml_path)
+      @tracks = MatchedTracks.new(@ratings)
+    end
+
+    def run
+      @tracks.each do |track, saved_rating|
+        if @reset_album_ratings && track.album_rating_kind.get == :user
+          name = "#{track.artist.get} - #{track.album.get}"
+          puts "[#{track.album_rating.get/20} -> X] Album: #{name}"
+          track.album_rating.set(-1) unless @dry_run
+        end
+
+        current_rating = track.rating.get
+        next unless saved_rating && current_rating != saved_rating
+
+        name = "#{track.artist.get} - #{track.name.get}"
+        puts "[#{current_rating/20} -> #{saved_rating/20}]  Song: #{name}"
+        track.rating.set(saved_rating) unless @dry_run
+      end
+    end
+  end
+end

data/lib/recover_itunes_ratings/saved_ratings.rb

@@ -0,0 +1,31 @@
+require "itunes_parser/nokogiri_sax"
+
+module RecoverItunesRatings
+  # Enumerates the track ratings in an iTunes Library XML file.
+  class SavedRatings
+    IGNORED_TYPES = ["Music Video", "Movie", "Home Video", "TV Show", "Podcast",
+    "iTunes U", "Audiobook", "Book", "Voice Memo"]
+
+    def initialize(library_xml_path)
+      @path = library_xml_path
+    end
+
+    def each
+      parse on_track: ->(data) {
+        next if data["Track Type"] == "Remote"
+        next if IGNORED_TYPES.any?(&data.method(:has_key?))
+        next if IGNORED_TYPES.any? { |t| data["Genre"] == t }
+
+        yield data["Persistent ID"], data["Rating"].to_i
+      }
+    end
+
+    private def library
+      open(@path, "r")
+    end
+
+    private def parse(*args)
+      ::ItunesParser::NokogiriSax.new(library, *args).parse
+    end
+  end
+end

data/lib/recover_itunes_ratings/version.rb

@@ -0,0 +1,3 @@
+module RecoverItunesRatings
+  VERSION = "0.1.0"
+end

data/recover_itunes_ratings.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recover_itunes_ratings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recover_itunes_ratings"
+  spec.version       = RecoverItunesRatings::VERSION
+  spec.authors       = ["Milo Winningham"]
+  spec.email         = ["milo@winningham.net"]
+
+  spec.summary       = %q{Restores iTunes ratings from an iTunes library XML file.}
+  spec.homepage      = "https://github.com/quadule/recover_itunes_ratings"
+  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", "vendor"]
+
+  spec.add_dependency "rb-scpt", "~> 1.0.1"
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/vendor/itunes_parser/nokogiri_sax.rb

@@ -0,0 +1,155 @@
+# From itunes_parser by Pete Higgins
+# http://github.com/phiggins/itunes_parser
+
+require 'nokogiri'
+
+module ItunesParser
+  class NokogiriSax
+    class SaxDoc < Nokogiri::XML::SAX::Document
+      def initialize on_track, on_playlist
+        super()
+        @on_track, @on_playlist = on_track, on_playlist
+        @with_callbacks = on_track || on_playlist
+        @tracks, @playlists = [], [] unless @with_callbacks
+        @buffer = ""
+      end
+
+      def error(error_message)
+        raise error_message
+      end
+
+      #def start_element(name, attrs = [])
+      def start_element_namespace(name, *)
+        case name
+        when 'dict' ; start_dict
+        when 'array'
+          start_playlist_items if @key_string == 'Playlist Items'
+        end
+      end
+
+      #def end_element(name)
+      def end_element_namespace(name, *)
+        case name
+        when 'key'
+          @key_string = @buffer.strip
+        when 'dict'
+          end_dict
+        when 'array'
+          if @parsing_playlist_items
+            end_playlist_items
+          elsif @parsing_playlists
+            end_playlists
+          end
+        else
+          if @parsing_playlist_items
+            @current_playlist_items << @buffer.to_i
+          elsif @parsing_playlists || @parsing_tracks
+            if name == 'true'
+              @current << @key_string << true
+            elsif name == 'false'
+              @current << @key_string << false
+            else
+              @current << @key_string << @buffer.strip
+            end
+          end
+        end
+
+        @buffer = ""
+      end
+
+      def characters(string)
+        @buffer << string
+      end
+
+      def start_tracks
+        #puts " ** parsing tracks"
+        @parsing_tracks = true
+        @current = []
+      end
+
+      def end_tracks
+        #puts " ** end tracks"
+        @parsing_tracks = false
+      end
+
+      def start_playlists
+        #puts " ** parsing playlists"
+        @parsing_playlists = true
+        @current = []
+      end
+
+      def end_playlists
+        @parsing_playlists = false
+      end
+
+      def start_playlist_items
+        #puts " ** parsing playlist items"
+        @current_playlist_items = []
+        @parsing_playlist_items = true
+      end
+
+      def end_playlist_items
+        #puts " ** end playlist items"
+        @parsing_playlist_items = false
+        @current << "Playlist Items"
+        @current << @current_playlist_items
+      end
+
+      def start_dict
+        case @key_string
+        when "Tracks"
+          start_tracks
+        when "Playlists"
+          start_playlists
+        end
+      end
+
+      def end_dict
+        if @parsing_playlists && !@parsing_playlist_items
+          current = Hash[*@current]
+          if !@with_callbacks
+            @playlists.push(current)
+          elsif @on_playlist
+            @on_playlist.call(current)
+          end
+          @current = []
+        elsif @parsing_tracks
+          if @current == []
+            end_tracks
+          else
+            current = Hash[*@current]
+            if !@with_callbacks
+              @tracks.push(current)
+            elsif @on_track
+              @on_track.call(current)
+            end
+            @current = []
+          end
+        end
+      end
+    end
+
+    def initialize(xml, params={})
+      @xml = xml
+
+      @on_track = params[:on_track]
+      @on_playlist = params[:on_playlist]
+    end
+
+    def on_track &block
+      @on_track = block
+    end
+
+    def on_playlist &block
+      @on_playlist = block
+    end
+
+    def parse
+      document = SaxDoc.new(@on_track, @on_playlist)
+      parser = Nokogiri::XML::SAX::Parser.new(document)
+      parser.parse(@xml)
+
+      self
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: recover_itunes_ratings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Milo Winningham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-scpt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- milo@winningham.net
+executables:
+- recover_itunes_ratings
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/recover_itunes_ratings
+- lib/recover_itunes_ratings.rb
+- lib/recover_itunes_ratings/matched_tracks.rb
+- lib/recover_itunes_ratings/runner.rb
+- lib/recover_itunes_ratings/saved_ratings.rb
+- lib/recover_itunes_ratings/version.rb
+- recover_itunes_ratings.gemspec
+- vendor/itunes_parser/nokogiri_sax.rb
+homepage: https://github.com/quadule/recover_itunes_ratings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- vendor
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Restores iTunes ratings from an iTunes library XML file.
+test_files: []