lastfm-m3u 0.2.3 → 0.2.4

data/.gitignore

@@ -18,6 +18,6 @@ tmp
 tags
 gems.tags
 lastfm.yml
-*m3u
+*.m3u
 m3u
 coverage

data/Rakefile

@@ -1,10 +1,12 @@
 #!/usr/bin/env rake
+require 'rubygems'
+require "bundler/setup"
 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 
+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-m3u

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'ostruct'
+require 'highline/import'
+require 'ruby-progressbar'
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'lastfm-m3u'
+require 'lastfm-m3u/util'
+
+options = OpenStruct.new
+OptionParser.new do |opts|
+  opts.banner = "LastfmM3u Playlist Creator".color(:blue)
+  opts.define_head "To get started: lastfm-m3u --init".color(:green)
+  opts.separator ""
+  opts.separator "Usage: lastfm-m3u [options]".color(:yellow)
+  opts.separator "Note: defaults to filename-only search. id3/both search is more thorough, but much slower"
+  opts.separator ""
+  opts.separator "Examples:"
+  #opts.separator "  lastfm-m3u # auto-search config-music_dir mp3 id3 tags for all unique artists, query last.fm for top tracks and create m3us for each artist from available track files"
+  opts.separator '  lastfm-m3u -a "Biosphere,Brian Eno"'
+  opts.separator "  lastfm-m3u -a Biosphere"
+  opts.separator "  lastfm-m3u -a Biosphere -t both"
+  opts.separator "  lastfm-m3u -a Biosphere -d ~/music/Biosphere"
+  #opts.separator "  lastfm-m3u -a Biosphere -o biosphere.m3u"
+  opts.separator ""
+  opts.separator ""
+  opts.separator "Options:"
+
+  # Type of search
+  types = %w[file id3 both]
+  type_aliases = { "f" => "file", "i" => "id3", "b" => "both" }
+  type_list = (type_aliases.keys + types).join(',')
+  opts.on("--type TYPE", "-t TYPE", types, type_aliases, "Select search type", "  (#{type_list})") do |type|
+    options.type = type.to_sym
+  end
+  options.type = :file if options.type.blank? or options.type.nil?
+
+  # init config
+  opts.on('-i', '--init', "init lastfm API access config") do |opt|
+    options.init = true
+  end
+
+  # List of artists
+  opts.on('-a "x,y,z"', Array, "one or more artists separated by commas (enclose with quotes if any spaces)") do |artists|
+    options.artists = artists
+  end
+
+  # directory
+  options.directory = Dir.pwd
+  opts.on("-d DIR", "--directory DIR", "music directory") do |directory|
+    options.directory = directory
+  end
+
+  #opts.on('-o', '--output FILENAME', 'Write m3u to FILENAME') do |fn| # writes single m3u when multiple artists
+    #options.out_file = fn
+  #end
+
+  opts.on('-p', '--path PATH', 'Specify path to use for m3u file entries (e.g. MPD requires a path relative to its music directory - i.e. -d /home/user/music/Biosphere -p /home/user/music where the second one is MPD\'s root)') do |path|
+    options.path = Pathname path
+  end
+
+  opts.on('-l', '--limit NUM', 'Specify limit of tracks to fetch from Last.fm (defaults to all)') do |limit|
+    options.limit = limit.to_i
+  end
+
+  opts.on('-f', '--not-found', 'Show not found') do
+    options.not_found = true
+  end
+
+  #opts.on('-f', '--force', 'Overwrite existing output file(s)') do
+    #options.force = true
+  #end
+
+  opts.on('--debug [LEVEL]', 'Enable debugging output (Optional Level :: 0=all, 1=info,warn,error, 2=warn,error, 3=error)') do |level|
+    if level
+      options.debug = level.to_i
+    else
+      options.debug = 0
+    end
+  end
+
+  opts.on_tail('-v', '--version', 'Show LastfmM3u version') do
+    puts "LastfmM3u v#{LastfmM3u::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Show this help message') do
+    puts opts
+    exit
+  end
+end.parse!
+
+if options.init
+  lastfm = LastfmM3u::Lastfm.new('')
+  exit
+end
+
+unless options.artists
+  puts "Please provide at least one artist (-a Elvis).".color(:red) + "  See".color(:green) + " --help".color(:yellow) + " for usage or".color(:green) + " --init".color(:yellow) + " to get started".color(:green)
+  exit
+end
+
+if options.debug
+  $logger.level = options.debug
+end
+
+options.artists.each do |artist|
+  not_found = []
+  lastfm = LastfmM3u::Lastfm.new(artist)
+  lastfm.root_dir = options.directory if options.directory
+  lastfm.limit = options.limit if options.limit
+  tracks = lastfm.artist.top_tracks
+
+  puts
+  puts "Searching filesystem with method: ".color(:green) + options.type.to_s.capitalize.color(:yellow)
+  puts
+  num_tracks = (options.limit.nil? ? tracks.size : options.limit)
+  progressbar = ProgressBar.create(starting_at: 0, total: num_tracks, format: "%a".color(:cyan) + "|".color(:magenta) + "%B".color(:green) + "|".color(:magenta) +  "%p%%".color(:cyan))
+  lastfm.find_tracks(tracks, options.type, progressbar).each do |track, track_set|
+    if track_set.empty?
+      not_found << track
+      next
+    end
+
+    if track_set.size > 1
+      unless found_track = LastfmM3u::Util.choose_track(track, track_set)
+        not_found << track
+        next
+      end
+      puts
+    else
+      found_track = track_set.first
+    end
+    if options.path
+      lastfm.m3u.add_file(found_track.relative_path_from options.path)
+    else
+      lastfm.m3u.add_file(found_track)
+    end
+  end
+  puts
+  margin = 10
+  output_size = artist.length+10
+  puts " "*margin + ("="*output_size).color(:blue)
+  puts artist.center(output_size+margin*2).color(:green)
+  puts " "*margin + "#{num_tracks - not_found.size} of #{num_tracks} tracks found".center(output_size).color(:green)
+  puts " "*margin + ("="*output_size).color(:blue)
+
+  lastfm.m3u.write(File.join(lastfm.m3u_path, "#{artist}.m3u"))
+
+  unless not_found.empty? or options.not_found.nil?
+    puts
+    puts "Not Found:".color(:red)
+    not_found.each {|track| puts "#{track}".color(:yellow) }
+  end
+
+end

data/lastfm-m3u.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'terminal-notifier-guard', '~> 1.5.3'
   gem.add_development_dependency 'rb-fsevent',              '~> 0.9'
   gem.add_development_dependency 'debugger',                '~> 1.5.0'
+  gem.add_development_dependency 'pry-debugger',            '~> 0.2'
   gem.add_development_dependency 'simplecov',               '~> 0.7.1'
 
   gem.add_dependency 'rockstar',          '~> 0.7.1'

data/lib/lastfm-m3u.rb

@@ -4,7 +4,6 @@ require 'pathname'
 require 'lastfm-m3u/version'
 
 require 'rockstar'
-require 'mp3info'
 require 'm3uzi'
 require 'rainbow'
 require 'ansi/logger'
@@ -12,6 +11,7 @@ require 'ansi/logger'
 require 'lastfm-m3u/base'
 require 'lastfm-m3u/lastfm'
 require 'lastfm-m3u/search/file_search'
+require 'lastfm-m3u/mp3_info_ext'
 
 module LastfmM3u
   $logger = ANSI::Logger.new(STDOUT)

data/lib/lastfm-m3u/base.rb

@@ -0,0 +1,11 @@
+module LastfmM3u
+  class Base
+    attr_accessor :m3u, :m3u_path
+
+    def initialize
+      @m3u_path = Dir.pwd
+      @m3u = M3Uzi.new
+    end
+  end
+end
+

data/lib/lastfm-m3u/lastfm.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+
+module LastfmM3u
+  class Lastfm < Base
+    attr_accessor :artist, :root_dir, :limit, :tracks
+
+    def initialize(artist, root_dir='/home/jon/music/trance')
+      FileUtils.mkdir_p "#{ENV['HOME']}/.config"
+      config_path = "#{ENV['HOME']}/.config/lastfm-m3u.yml"
+      unless File.exists? config_path
+        puts "Copying empty config file to #{config_path}...".color(:green)
+        FileUtils.cp File.join(File.dirname(__FILE__), '../../config/lastfm.yml.dist'), config_path
+      end
+      config_hash = YAML.load_file(config_path)
+      Rockstar.lastfm = config_hash
+      unless config_hash.values.any? {|v| v==''}
+        @artist = Rockstar::Artist.new artist
+        @root_dir = root_dir
+        @limit = nil
+        super()
+      else
+        puts "Please add your api_key and api_secret to:\n  #{config_path}\nGet your keys at http://www.last.fm/api/account".color(:yellow)
+        exit
+      end
+    end
+
+    def find_tracks(tracks, search_type = :file, progressbar = nil)
+      begin
+        raise InvalidSearchType unless SEARCH_TYPES.include?(search_type)
+      rescue InvalidSearchType
+        $logger.error("Invalid Search Type '#{search_type}', use one of #{SEARCH_TYPES.join(',')}")
+        exit
+      end
+      found_tracks = {}
+      search = LastfmM3u::FileSearch.new(root_dir)
+      self.limit ||= tracks.size
+      tracks[0..limit-1].each do |track|
+        track.name = CGI.unescapeHTML(track.name)
+        found_tracks[track.name] = search.find(track.name, {search_type: search_type})
+        progressbar.increment if progressbar
+      end
+      found_tracks
+    end
+
+  end
+
+  class InvalidSearchType < Exception; end
+end

data/lib/lastfm-m3u/mp3_info_ext.rb

@@ -0,0 +1,57 @@
+require 'mp3info'
+
+class Mp3InfoExt < Mp3Info
+  attr_reader :query, :query_type
+
+  def initialize(query, query_type, entry)
+    @query = query
+    @query_type = query_type
+    super(entry)
+  end
+
+  def found?
+    return true if @query_type == :track && title_found?
+    return true if @query_type == :album && album_found?
+    return true if @query_type == :artist && artist_found?
+    return false
+  end
+
+  # ARTIST
+  def artist_found?
+    tag2_artist_found? || tag1_artist_found?
+  end
+
+  def tag2_artist_found?
+    hastag2? && tag2.TPE1.downcase == query.downcase
+  end
+
+  def tag1_artist_found?
+    hastag1? && tag1.artist.downcase == query.downcase
+  end
+
+  # ALBUM
+  def album_found?
+    tag2_album_found? || tag1_album_found?
+  end
+
+  def tag2_album_found?
+    hastag2? && tag2.TALB.downcase == query.downcase
+  end
+
+  def tag1_album_found?
+    hastag1? && tag1.album.downcase == query.downcase
+  end
+
+  # TITLE
+  def title_found?
+    tag2_title_found? || tag1_title_found?
+  end
+
+  def tag2_title_found?
+    hastag2? && tag2.TIT2.downcase == query.downcase
+  end
+
+  def tag1_title_found?
+    hastag1? and tag1.title.downcase == query.downcase
+  end
+end

data/lib/lastfm-m3u/search/file_search.rb

@@ -0,0 +1,101 @@
+module LastfmM3u
+  require 'lastfm-m3u'
+  require 'pathname'
+
+  class Search < Base
+  end
+
+  class FileSearch < Search
+    attr_accessor :root_dir
+
+    def initialize(root_dir)
+      @root_dir = Pathname root_dir
+      super()
+    end
+
+    def find(query, options={})
+      query_type  = options[:query_type] || :track
+      file_or_id3 = options[:search_type] || :both
+      prefer_flac = options[:prefer_flac] || true
+
+      files = find_unique_files(query, query_type, file_or_id3)
+      if prefer_flac && !(flac_files=trim_non_flac(files)).empty?
+        files = flac_files
+      end
+      $logger.debug "#{query} => #{files}"
+      files
+    end
+
+
+    private
+
+    def find_unique_files(query, query_type, file_or_id3)
+      files = id3_files = []
+      files = find_in_filesystem(query, query_type) if [:both, :file].include? file_or_id3
+      id3_files = find_by_id3(query, query_type) if [:both, :id3].include? file_or_id3
+      (files + id3_files).sort.uniq
+    end
+
+    def find_in_filesystem(name, query_type)
+      if query_type == :artist or query_type == :album
+        find_by_dir(name)
+      else
+        find_by_filename(name)
+      end
+    end
+
+    def find_by_dir(name)
+      found_entries = []
+      Dir.glob("#{root_dir}/**/*").each do |entry|
+        entry = Pathname.new entry
+        found_entries << entry.to_s if entry.directory? and normalize(entry).to_s =~ /.*#{Regexp.escape name}.*/i
+      end
+      found_entries
+    end
+
+    def find_by_filename(name)
+      found_entries = []
+      Dir.glob("#{root_dir}/**/*.{mp3,flac}").each do |entry|
+        begin
+          entry = Pathname.new entry
+          if normalize(entry) =~ /.*#{Regexp.escape name}.*/i
+            $logger.debug "#{name} => #{entry}"
+            found_entries << entry.to_s
+          end
+        rescue ArgumentError => e
+          # for some reason it gets 'invalid byte sequence in UTF-8
+          # even though replacing ascii below with utf-8 causes nothing to be replaced.
+          entry = Pathname entry.to_s.encode('ascii', invalid: :replace, undef: :replace, replace: '??')
+          $logger.warn "#{e.message} => #{entry.relative_path_from(root_dir)}"
+        end
+      end
+      found_entries
+    end
+
+    def find_by_id3(query, query_type)
+      query = CGI.unescapeHTML(query)
+      found_entries = []
+      $logger.debug query
+      Dir.glob("#{root_dir}/**/*.mp3").each do |entry|
+        begin
+          id3 = Mp3InfoExt.new(query, query_type, entry)
+          found_entries << id3.filename if id3.found?
+        rescue Mp3InfoError => e
+          $logger.warn "#{e.message} => #{(Pathname.new entry).relative_path_from(root_dir)}"
+        rescue NoMethodError => e
+          $logger.warn "No tags found => #{(Pathname.new entry).relative_path_from(root_dir)}"
+        end
+      end
+      found_entries
+    end
+
+    def normalize(pathname)
+      pathname.basename.to_s.gsub('-', ' ').gsub('_', ' ').sub(/#{pathname.extname}$/, '')
+    end
+
+    def trim_non_flac(pathnames)
+      pathnames.select{|pn| pn.to_s =~ /\.flac$/}
+    end
+  end
+
+end

data/lib/lastfm-m3u/util.rb

@@ -0,0 +1,19 @@
+module LastfmM3u
+  module Util
+    def self.choose_track(track, track_set)
+      choose do |menu|
+        menu.index        = :letter
+        menu.index_suffix = ") "
+
+        menu.prompt = "For #{track}, which file would you like to use?   ".color(:green)
+
+        track_set.each do |track|
+          menu.choice track do
+            return track
+          end
+        end
+        menu.choice "none" do return nil end
+      end
+    end
+  end
+end

data/lib/lastfm-m3u/version.rb

@@ -0,0 +1,3 @@
+module LastfmM3u
+  VERSION = "0.2.4"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lastfm-m3u
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -107,6 +107,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +274,7 @@ files:
 - lib/lastfm-m3u.rb
 - lib/lastfm-m3u/base.rb
 - lib/lastfm-m3u/lastfm.rb
+- lib/lastfm-m3u/mp3_info_ext.rb
 - lib/lastfm-m3u/search/file_search.rb
 - lib/lastfm-m3u/util.rb
 - lib/lastfm-m3u/version.rb
@@ -284,7 +301,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2601695685005095866
+      hash: 3207334904113421642
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -293,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2601695685005095866
+      hash: 3207334904113421642
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25