lastfm-itunes 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ac7d667b28a195b056b922d3dcc6c001c48ad08
+  data.tar.gz: 73cb90b8cd591c1ce0efc622573b10652cde7233
+SHA512:
+  metadata.gz: 6ba65237434407015611f2d4fb82ec9e1e28a0e68876c58630130a4ea95c813bad2470028c7177ed32b5678edef7da45a75e8b5bb5a61d4214a2c22ca82ac531
+  data.tar.gz: 6212eb19e200402efad603804b6d70710df13557f4c2a3e4be44249609c41d1d87262df04968e945a23879956b6f949fd870e47f9f9a31fd2fda7255fb45843f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jon Austin
+
+MIT License
+
+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,72 @@
+[![Code Climate](https://codeclimate.com/github/jonaustin/lastfm-itunes.png)](https://codeclimate.com/github/jonaustin/lastfm-itunes)
+
+# Lastfm iTunes Playlist Creator
+
+Easily create playlists of top Lastfm tracks from your iTunes library.
+
+http://jonaustin.io/posts/lastfm-itunes
+
+## Installation
+
+    gem install lastfm-itunes
+
+## Usage
+
+    lastfm-itunes
+
+Follow the prompts to generate a playlist:
+
+
+    Lastfm iTunes Playlist Creator
+    ==============================
+
+    Where is your iTunes Library XML file?  |~/Music/iTunes/iTunes Music Library.xml|
+    Where to store generated playlist?  |~/Music/iTunes/Lastfm Top Tracks.m3u|
+
+    Find or create Lastfm API secret and key here: http://www.last.fm/api/accounts
+    What is your Lastfm API Key?
+    What is your Lastfm API Secret?
+
+    1) Artist
+    2) User
+    Search Artist global top tracks or User top tracks?  2
+    Username?  echowarpt
+    Maximum number of tracks to fetch?  |all| 500
+
+    Extracting from iTunes....
+      Found 64 artists and 1543 tracks
+    Retrieving from Last.fm...
+      Found 309 iTunes tracks out of 500 Last.fm tracks
+
+    Generating Playlist.....
+
+    Success! Your playlist has been generated at: /Users/jon/Music/iTunes/Lastfm Top Tracks.m3u
+
+## Notes: 
+
+* Each artist in the library requires a separate API call to Lastfm to get the top tracks. As a result generation could several minutes or more if there are hundreds or thousands of artists to fetch.
+
+* It does not support tracks stored in the cloud. Haven't looked into whether this
+is possible or not. Feel free to send a pull request.
+
+* For convenience, lastfm credentials may be stored in ~/.config/lastfm-itunes.yml
+If that file exists, then it will auto-fill the Lastfm API key and secret.
+
+      api_key: ""
+      api_secret: ""
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+License
+-------
+
+Copyright (c) 2014 Jon Austin.
+
+Released under the MIT license. See `LICENSE.txt` for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+# RSpec
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/bin/lastfm-itunes

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'lastfm-itunes'
+require 'lastfm-itunes/cli'
+
+cli = LastfmItunes::CLI.new
+
+puts "\nLastfm iTunes Playlist Creator".color(:blue)
+puts ("="*30).color(:green)
+puts
+
+cli.ask_itunes
+cli.ask_m3u_path
+puts
+cli.get_lastfm_credentials
+
+puts
+search_type = cli.choose_search_type
+if search_type == 'Artist'
+  cli.ask_limit("Maximum number of tracks to fetch per artist?  ")
+elsif search_type == 'User'
+  cli.ask_username
+  cli.ask_limit("Maximum number of tracks to fetch?  ")
+end
+
+args = { itunes_xml_path: cli.itunes_xml_path,
+         credentials:     cli.lastfm_credentials,
+         search_class:    Object.const_get('LastfmItunes::Lastfm::' + search_type),
+         limit:           cli.limit }
+args.merge!(name: cli.username) if cli.search_type == 'User'
+
+puts
+puts "Extracting from iTunes....".color(:green)
+playlist = LastfmItunes::Playlist.new(args)
+puts "  Found #{playlist.itunes.artists.size} artists and #{playlist.itunes.tracks.size} tracks"
+
+
+puts "Retrieving from Last.fm...".color(:green)
+# Artist search requires multiple API queries so show progress bar that increments on
+# each artist found. (i.e. it could take a few minutes)
+total_lf_tracks = 0
+if cli.search_type == 'Artist'
+  progressbar = cli.progressbar(playlist.itunes.artists.size)
+  playlist.fetch_tracks do |num_tracks|
+    total_lf_tracks += (cli.limit && cli.limit < num_tracks ? cli.limit : num_tracks)
+    progressbar.increment
+  end
+else
+  playlist.fetch_tracks { |num_tracks| total_lf_tracks += num_tracks }
+end
+puts "  Found #{playlist.tracks.size} iTunes tracks out of #{total_lf_tracks} Last.fm tracks"
+
+puts "Generating Playlist.......".color(:green)
+generator = LastfmItunes::Generator.new(cli.m3u_path)
+generator.generate(playlist.track_paths)
+
+puts
+puts "Success! Your playlist has been generated at: ".color(:green) + "#{cli.m3u_path}".color(:yellow)

data/lastfm-itunes.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lastfm-itunes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lastfm-itunes'
+  spec.version       = LastfmItunes::VERSION
+  spec.authors       = ['Jon Austin']
+  spec.email         = ['jon.i.austin@gmail.com']
+  spec.summary       = %q{CLI tool to easily create m3u playlists of top Lastfm tracks from an iTunes library}
+  spec.description   = %q{Easily create playlists of top Lastfm tracks from your iTunes library.}
+  spec.homepage      = 'https://github.com/jonaustin/lastfm-itunes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rockstar',                '~> 0.8'
+  spec.add_dependency 'rainbow',                 '~> 1.99'
+  spec.add_dependency 'm3uzi',                   '~> 0.5'
+  spec.add_dependency 'highline',                '~> 1.6'
+  spec.add_dependency 'ruby-progressbar',        '~> 1.4'
+  spec.add_dependency 'andyw8-itunes-library',   '~> 0.1' # original does not have track.location* methods
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'bundler',      '~> 1.3'
+  spec.add_development_dependency 'rspec',        '~> 2.14'
+  spec.add_development_dependency 'simplecov',    '~> 0.8'
+  spec.add_development_dependency 'pry-byebug',   '~> 2.2'
+  spec.add_development_dependency 'vcr',          '~> 2.8'
+  spec.add_development_dependency 'webmock',      '~> 1.16'
+end

data/lib/lastfm-itunes.rb

@@ -0,0 +1,15 @@
+require 'rainbow'
+require 'pathname'
+require 'rockstar'
+require 'lastfm-itunes/patches/rockstar'
+require 'lastfm-itunes/tracks'
+require 'lastfm-itunes/playlist'
+require 'lastfm-itunes/generator'
+require 'lastfm-itunes/itunes'
+require 'lastfm-itunes/lastfm/search'
+require 'lastfm-itunes/lastfm/user'
+require 'lastfm-itunes/lastfm/artist'
+require 'lastfm-itunes/version'
+
+module LastfmItunes
+end

data/lib/lastfm-itunes/cli.rb

@@ -0,0 +1,109 @@
+require 'yaml'
+require 'highline/import'
+require 'ruby-progressbar'
+
+module LastfmItunes
+  class CLI
+    attr_reader :itunes_xml_path, :m3u_path, :limit
+    attr_reader :lastfm_credentials, :username, :search_type
+
+    def ask_itunes
+      @itunes_xml_path = ask("Where is your iTunes Library XML file?  ") do |q|
+        q.default = File.expand_path("~/Music/iTunes/iTunes Music Library.xml")
+      end
+    end
+
+    def ask_m3u_path(options={})
+      m3u_path = ask("Where to store generated playlist?  ") do |q|
+        q.default = options.fetch(:m3u_path, m3u_default_path.to_s)
+      end
+
+      if File.exists?(m3u_path)
+        answer = ask_overwrite_m3u
+        if answer == 'No'
+          m3u_path = ask_m3u_path(m3u_path: with_time(m3u_path))
+        end
+      end
+
+      @m3u_path = m3u_path
+    end
+
+    def get_lastfm_credentials
+      puts "Find or create Lastfm API secret and key here: http://www.last.fm/api/accounts".color(:yellow)
+
+      lastfm_yml_path = File.expand_path("~/.config/lastfm-itunes.yml")
+      lastfm_credentials = if File.exists?(lastfm_yml_path)
+                             YAML.load_file(lastfm_yml_path)
+                           else
+                             {}
+                           end
+      @lastfm_credentials = { api_key: ask_api_key(lastfm_credentials),
+                              api_secret:    ask_api_secret(lastfm_credentials) }
+    end
+
+    def ask_api_key(credentials=nil)
+      ask("What is your Lastfm API Key?  ") do |q|
+        q.default = credentials['api_key'] if credentials
+      end
+    end
+
+    def ask_api_secret(credentials=nil)
+      ask("What is your Lastfm API Secret?  ") do |q|
+        q.default = credentials['api_secret'] if credentials
+      end
+    end
+
+    def choose_search_type
+      @search_type = choose do |menu| 
+        menu.index = :number
+        menu.index_suffix = ") "
+
+        menu.prompt = "Search Artist global top tracks or User top tracks?  "
+
+        menu.choice "Artist"
+        menu.choice "User"
+      end
+    end
+
+    def ask_limit(question_text)
+      limit = ask(question_text) do |q|
+        q.default = 'all'
+      end
+      @limit = limit.to_i > 0 ? limit.to_i : nil
+    end
+
+    def ask_username
+      @username = ask("Username?  ") do |q|
+        q.validate = /\A\w+\Z/
+      end
+    end
+
+    def ask_overwrite_m3u
+      choose do |menu| 
+        menu.index = :number
+        menu.index_suffix = ") "
+
+        menu.prompt = "Overwite existing playlist file?  "
+
+        menu.choice "Yes"
+        menu.choice "No"
+      end
+    end
+
+    def progressbar(total)
+      ProgressBar.create(
+        starting_at: 0,
+        total: total,
+        format: "%a".color(:cyan) + "|".color(:magenta) + "%B".color(:green) + "|".color(:magenta) +  "%p%%".color(:cyan))
+    end
+
+    def m3u_default_path
+      Pathname(@itunes_xml_path).dirname.join('Lastfm Top Tracks.m3u')
+    end
+
+    def with_time(filepath)
+      time_str = Time.now.strftime("%Y-%m-%d_%H%M%S")
+      filepath.gsub(/\.m3u\Z/, " #{time_str}.m3u")
+    end
+  end
+end

data/lib/lastfm-itunes/generator.rb

@@ -0,0 +1,19 @@
+require 'm3uzi'
+require 'lastfm-itunes/patches/m3uzi'
+
+module LastfmItunes
+  class Generator
+    attr_reader :m3u
+
+    def initialize(m3u_path)
+      @m3u      = ::M3Uzi.new
+      @m3u.path = File.expand_path(m3u_path)
+    end
+
+    def generate(tracks, &block)
+      tracks.each { |t| @m3u.add_file(t) }
+      @m3u.write @m3u.path
+      @m3u
+    end
+  end
+end

data/lib/lastfm-itunes/itunes.rb

@@ -0,0 +1,27 @@
+require 'itunes/library'
+
+module LastfmItunes
+  class Itunes
+    include Tracks
+    attr_accessor :library, :tracks, :xml_path
+
+    def initialize(xml_path)
+      @xml_path = File.expand_path(xml_path)
+      @library = ::ITunes::Library.load(@xml_path)
+      raise InvalidLibraryException unless library.track_ids
+      @tracks = @library.music.tracks.select { |t| t.location_path }
+    end
+
+    alias :old_group_tracks_by_artist :group_tracks_by_artist
+    def group_tracks_by_artist
+      old_group_tracks_by_artist(@tracks)
+    end
+
+    def artists
+      @tracks.map(&:artist).uniq
+    end
+  end
+
+  class InvalidLibraryException < Exception; end
+end
+

data/lib/lastfm-itunes/lastfm/artist.rb

@@ -0,0 +1,30 @@
+module LastfmItunes::Lastfm
+  class Artist
+    include LastfmItunes::Tracks
+    attr_accessor :artist, :limit
+
+    def initialize(args={})
+      @artist = if args[:name]
+                  ::Rockstar::Artist.new( args.fetch(:name) )
+                else
+                  nil
+                end
+      @limit = args.fetch(:limit, 50) # default number returned by lastfm
+    end
+
+    def my_top_tracks(other_tracks, &block)
+      found_tracks = []
+      group_tracks_by_artist(other_tracks).each do |artist, tracks|
+        next unless artist
+        yield tracks.size if block_given?
+        @artist = Rockstar::Artist.new(artist)
+        found_tracks.concat intersection_of_tracks(top_tracks, tracks)
+      end
+      found_tracks
+    end
+
+    def top_tracks
+      artist.top_tracks
+    end
+  end
+end

data/lib/lastfm-itunes/lastfm/search.rb

@@ -0,0 +1,15 @@
+require 'forwardable'
+require 'delegate'
+
+module LastfmItunes::Lastfm
+  class Search < SimpleDelegator
+    extend Forwardable
+    delegate [:my_top_tracks, :top_tracks] => :@searcher
+
+    def initialize(args)
+      ::Rockstar.lastfm = args.fetch(:credentials)
+      @searcher = args.fetch(:search_class, Artist).new(args)
+    end
+  end
+end
+