musicfix 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12ba6b8750f8ba21d9d439843de08a22a590ff65
-  data.tar.gz: ef0cf64ea385518284eab1dfc85a0d77f43b5367
+  metadata.gz: 5b01d3bf3f2c2fc81008328a152fdf80a191041d
+  data.tar.gz: 66e75cc847b3e4d355ef3d37d8e76748b1a597ca
 SHA512:
-  metadata.gz: 86728467e24e4099e13b080d8f3127151939c53bcf234d05e334c195f69f4849c86c4b4c676d99ff72088330acea8e7946575c1f051fd6db3c9fe49938441676
-  data.tar.gz: 3d17efef7167e023755bb0d1a87a4545eaa01602bee11ad59531382a11619c5ac2e69dd739d915047a7f029d3a3e5dd129ddee79b8293e6df57878d56a1605cb
+  metadata.gz: ed3f4f00107c13f7d86d0f2b90646dfa5e2af129361719f0e10104c7a0fca9380c6534307741fa4ff944935703f503a10200f828b7fab4a6473adec1ae13f454
+  data.tar.gz: 3a3a4ace3d9e9b0c5a0b0b8d36da4da7bdb33604e30db9e6319e04eacbaba6bdc2ab36e803ec77541b699edacc300ee15359e96462104f4a173cc719aa64f71c

data/CHANGELOG

@@ -1,3 +1,8 @@
+## 0.2.0
+* Fix zero padding in numbering and filename order.
+* Switch to HTTPS and use Discogs Auth through user tokens.
+* Get images only through the API as intended.
+
 ## 0.1.7
 * Fix http requests to work with the current API.
 * All stdout output is valid YAML.

data/README

@@ -68,7 +68,7 @@ containing:
 Furthermore, templates are used for the naming of music files, the
 cover artwork image and the release metadata file.  The defaults are:
 
-    track: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{d}#{fn}-#{fa}-#{ft}.#{x}"'
+    track: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{fd}#{n}-#{fa}-#{ft}.#{x}"'
     image: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover.jpg"'
     rdata: '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_release.yaml"'
 
@@ -93,24 +93,27 @@ Only for track naming:
 
     [f]a: track artist
     [f]t: track title
-    [f]n: track number, may have letters (vinyls)
-    d: disc number
-    tn: track number counter
+    [f]d: disc number or side letter for vinyls
+    n: track number, zero padded
     x: file extension in lowercase
 
 Only for image and rdata naming:
 
     zz: zeros that match d + n width
 
+Only for image naming:
 
-# Some test releases
+    i: the index in the list
 
-  * Sound, The (2) – From The Lions Mouth: 377432
-  * Various – Return Of The Banshee: 127565
-  * Harold Budd & Brian Eno – The Pearl: 699395
-  * Dead Souls Rising – Clepsydre 1993-1999: 1212954
-  * Metro Decay – Υπέρβαση: 1766242
-  * Dispossessed, The (2) – Sister Mary: 1965566
-  * Einstürzende Neubauten – Strategies Against Architecture IV: 2506503
-  * David Bowie – The Man Who Sold The World: 484622
-  * Various – Some Bizzare Album: 1381202
+
+# Cover artwork support
+
+From March 2015 and onwards cover artwork images are resources restricted
+to authenticated clients.  The easiest way to do this and the one supported
+by musicfix is to create a Discogs account and generate a personal access
+token from the developers settings.  Add the token in `~/.musicfixrc` like
+this:
+
+    token: abcxyz123456
+
+You'll get no cover artwork without adding your personal access token.

data/bin/musicfix

@@ -9,7 +9,7 @@ require 'taglib'
 require 'yaml'
 
 # Headers
-Ver = '0.1.7'
+Ver = '0.2.0'
 Homepage = 'http://git.2f30.org/musicfix/'
 Headers = {'User-Agent' => "musicfix/#{Ver} +#{Homepage}"}
 
@@ -25,8 +25,8 @@ def mkartist al
 end
 
 # Convert "3" to (nil, "03")
-# Convert "A" to (nil, "A1")
-# Convert "A3" to (nil, "A3")
+# Convert "A" to ("A", "1")
+# Convert "A3" to ("A", "3")
 # Convert "2.3" to ("2", "03")
 # Convert "2.03" to ("2", "03")
 # Convert "CD2-3" to ("2", "03")
@@ -39,8 +39,10 @@ def mkdiscnum pos
     else
         d = d.gsub /\D/, ''
     end
-    if n.match /[A-Z]/
-        n = n.ljust(2, '1')
+    parts = n.match /([A-Z])([0-9]*)/
+    if parts then
+        d = parts[1]
+        n = parts[2] != "" && parts[2] || "1"
     else
         n = n.rjust(2, '0')
     end
@@ -48,11 +50,16 @@ def mkdiscnum pos
 end
 
 # Add wordings for symbols
-syms = {"≠" => "not equals"}
+syms = {"≠" => "not equals",
+        "Χ" => "x",
+        "★" => "blackstar",
+        "•" => ""}
 Stringex::Localization.store_translations :en, :transliterations, syms
 
 # Convert to lowercase ASCII without punctuation
 # Convert "Jean-Michel Jarre" to "jean_michel_jarre"
+# Convert "Aaah...!" to "aaah"
+# Convert "Ruh / Spirit" to "ruh_spirit"
 def mkname n
     # These may be in track titles like "(7'' Version)"
     n = n.gsub '12"', '12 inch'
@@ -65,17 +72,20 @@ def mkname n
     n = n.gsub "7''", "7 inch"
     n = n.gsub "7'", "7 inch"
     n = n.gsub " & ", " and "
+    n = n.gsub '.', ' '
+    n = n.gsub '/', ' '
     # Transliterate
     n.to_url.gsub '-', '_'
 end
 
 # Get cover artwork
-def getimgurl rel
+def getimages rel
     return nil unless rel['images']
-    img = rel['images'].select {|i| i['type'] == 'primary'}.first ||
-          rel['images'].first
-    img['uri'].gsub! 'api.discogs.com/images/R-90', 's.pixogs.com/image/R'
-    img['uri'].gsub! 'api.discogs.com/images/', 's.pixogs.com/image/'
+    imgs = []
+    rel['images'].each do |img|
+        imgs << img['uri']
+    end
+    imgs
 end
 
 # Construct position list from tracks filter
@@ -98,57 +108,69 @@ def mkposlist tracks
     pl.flatten
 end
 
+# Formats we care about and their abbreviations
+# http://www.discogs.com/search/#more_facets_format_exact
+# Ignore "Vinyl" in favor of "LP"/"EP"/'7"'/'10"'/'12"' descriptions
+# Ignore "File" in favor of "MP3"/"WAV"/"FLAC" descriptions
+# Avoid too generic descriptions such as "Album"
+# Avoid too specific descriptions such as "Green", "Gatefold"
+@ft = {
+    'CD' => 'CD',
+    'CDr' => 'CDr',
+    'LP' => 'LP',
+    'EP' => 'EP',
+    'Cassette' => 'Cass',
+    '12"' => '12inch',
+    '10"' => '10inch',
+    '7"' => '7inch',
+    'Mini-Album' => 'Mini',
+    'Maxi-Single' => 'Maxi',
+    'Picture Disc' => 'Pic',
+    'Flexi-disc' => 'Flexi',
+    'Promo' => 'Promo',
+    'Reissue' => 'RE',
+    'Remastered' => 'RM',
+    'Remaster' => 'RM',
+    'Repress' => 'RP',
+    'Mispress' => 'MP',
+    'Test Pressing' => 'TP',
+    'Enhanced' => 'Enh',
+    'Digipak ' => 'Dig',
+    'Box Set' => 'Box',
+    'Limited Edition' => 'Ltd',
+    'Club Edition' => 'Club',
+    'Compilation' => 'Comp',
+    'Sampler' => 'Smplr',
+    'Numbered' => 'Num',
+    'Unofficial Release' => 'Unofficial',
+    'Single Sided' => 'S/Sided',
+    'MP3' => 'MP3',
+    'AAC' => 'AAC',
+    'FLAC' => 'FLAC',
+    'WAV' => 'WAV',
+}
+
 # Make a sane format string also using format description
 def mkformat format
     f = []
-    # Ignore in favor of LP/EP/7"/10"/12" descriptions
-    unless format['name'] == "Vinyl"
-        f << format['name']
+    formats = []
+    if format['name'] then
+        formats << format['name']
     end
-    if format['descriptions']
-        # Too general
-        format['descriptions'].delete "Album"
-        unless format['descriptions'].empty?
-            f << format['descriptions'].first
-        end
+    if format['descriptions'] then
+        formats += format['descriptions']
+    end
+    formats.each do |d|
+        f << d if @ft.keys.include? d
     end
     f.join ' '
 end
 
 # Shorten certain common words that appear in format strings
 def mkshort n
-    ft = {
-        'Cassette' => 'Cass',
-        '12"' => '12inch',
-        '10"' => '10inch',
-        '7"' => '7inch',
-        'Mini-Album' => 'MiniAlbum',
-        'Maxi-Single' => 'Maxi',
-        'Picture Disc' => 'Pic',
-        'Flexi-disc' => 'Flexi',
-        'Reissue' => 'RE',
-        'Remastered' => 'RM',
-        'Remaster' => 'RM',
-        'Repress' => 'RP',
-        'Mispress' => 'MP',
-        'Test Pressing' => 'TP',
-        'Enhanced' => 'Enh',
-        'Digipak ' => 'Dig',
-        'Box Set' => 'Box',
-        'Limited Edition' => 'Ltd',
-        'Club Edition' => 'Club',
-        'Compilation' => 'Comp',
-        'Sampler' => 'Smplr',
-        'Numbered' => 'Num',
-        'Unofficial Release' => 'Unofficial',
-        'Single Sided' => 'S/Sided',
-        'File MP3' => 'MP3',
-        'File FLAC' => 'FLAC',
-        'File WAV' => 'WAV',
-    }
     # Note that prefix substitution is broken
-    ftre = /(#{ft.keys.join('|')})/
-    n.gsub(ftre, ft)
+    ftre = /(#{@ft.keys.join('|')})/
+    n.gsub(ftre, @ft)
 end
 
 # Return single item if array is full of duplicates
@@ -185,10 +207,11 @@ end
 # Default configuration
 cfg = {}
 cfg['mdir'] = '~/music'
-cfg['track'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{d}#{fn}-#{fa}-#{ft}.#{x}"'
-cfg['image'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover.jpg"'
+cfg['track'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{fd}#{n}-#{fa}-#{ft}.#{x}"'
+cfg['image'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_cover#{i}.jpg"'
 cfg['rdata'] = '"#{mdir}/#{fba}-#{my}-#{fb}-#{fv}/#{zz}-#{fba}-#{fb}_release.yaml"'
 #cfg['after'] = '"mpc update #{fba}-#{my}-#{fb}-#{fv}"'
+cfg['nimg'] = 1
 
 # User configuration overrides
 cfgpath = File.expand_path('~/.musicfixrc')
@@ -197,6 +220,12 @@ if File.exists? cfgpath
     cfg.merge! new
 end
 
+# Authentication option
+urlopts = ''
+if cfg['token'] then
+    urlopts = "?token=#{cfg['token']}"
+end
+
 # Expand music directory
 cfg['mdir'] = File.expand_path cfg['mdir']
 
@@ -214,7 +243,7 @@ end
 
 unless cmd == 'dump' then
     # Supported formats
-    fmtre = /mp3|ogg|m4a|mpc|flac|wv/i
+    fmtre = /mp3|ogg|m4a|mpc|flac|wv|wav|aiff/i
     # Construct file list
     fl = Dir['*'].select {|f| File.extname(f).match fmtre}.sort
     if fl.empty? then
@@ -262,7 +291,7 @@ elsif cmd == 'tags' then
     rel['genre'] = []
     rel['format'] = nil
     rel['comment'] = []
-    rel['imgurl'] = nil
+    rel['images'] = nil
     rel['tracklist'] = []
     # Populate tracklist
     fl.each do |fname|
@@ -300,10 +329,10 @@ elsif cmd == 'tags' then
 else
     # Get release data from Discogs
     STDERR.puts "Getting release data from Discogs..."
-    r = YAML.load(open("http://api.discogs.com/releases/#{relid}",
+    r = YAML.load(open("https://api.discogs.com/releases/#{relid}#{urlopts}",
         Headers))
     mr = if r['master_id'] then
-        YAML.load(open("http://api.discogs.com/masters/#{r['master_id']}",
+        YAML.load(open("https://api.discogs.com/masters/#{r['master_id']}#{urlopts}",
             Headers))
     end
     # Tracklist can contain dummy header tracks, strip them
@@ -337,7 +366,8 @@ else
     if tracks then
         rel['comment'] += ", tracks: #{tracks}"
     end
-    rel['imgurl'] = getimgurl r
+    imgs = getimages(r)
+    rel['images'] = if imgs then imgs.first(cfg['nimg']) end
     rel['tracklist'] = []
     # Populate tracklist
     tl.each do |s|
@@ -393,6 +423,21 @@ if tl.length != fl.length then
     exit unless res == 'y'
 end
 
+# First pass decides zero padding and file numbering
+zpad_disc = 0
+zpad_num = 0
+tl.each do |trk|
+    disc, num = mkdiscnum trk['pos'].to_s
+    if zpad_disc < disc.length then zpad_disc = disc.length end
+    if zpad_num < num.length then zpad_num = num.length end
+    trk['disc'] = disc
+    trk['num'] = num
+end
+tl.each do |trk|
+    trk['disc'] = trk['disc'].rjust(zpad_disc, '0')
+    trk['num'] = trk['num'].rjust(zpad_num, '0')
+end
+
 # Loop over the music files and
 #   1. Copy them over with proper names
 #   2. Fix the tags on the new files
@@ -402,11 +447,12 @@ fl.each do |ofname|
     trk = tl[tn - 1]
     # Use track artist for compilations, fallback to release
     a = trk['artist'] || rel['artist']
-    d, n = mkdiscnum trk['pos'].to_s
     t = trk['title']
     fa = mkname a
     ft = mkname t
-    fn = mkname n
+    d = trk['disc']
+    n = trk['num']
+    fd = mkname d
     x = File.extname(ofname).delete('.').downcase
     nfname = eval cfg['track']
     # Add filename to track descriptor
@@ -429,22 +475,44 @@ fl.each do |ofname|
 end
 
 # Also save the first image of the artwork
-zz = '0' * (mkdiscnum tl.last['pos'].to_s).join.length
-imgname = eval cfg['image']
-if rel['imgurl'] then
-    STDERR.puts "Save image to #{imgname}"
-    unless fake
-        img = open(rel['imgurl'], Headers).read
-        File.open(imgname, 'wb').write img
+zz = '0' * (tl.first['disc'] + tl.first['num']).length
+if rel['images'] then
+    relimgs = []
+    rel['images'].each_with_index do |imgurl, idx|
+        pad = rel['images'].length.to_s.length
+        i = idx.to_s.rjust(pad, '0')
+        if rel['images'].length == 1
+            i = ''
+        end
+        # The variable i can be used in the image template
+        imgname = eval cfg['image']
+        STDERR.puts "Save image to #{imgname}"
+        unless fake
+            # Relative path or URL
+            if File.exists? imgurl
+                img = open(imgurl).read
+            else
+                img = open(imgurl, Headers).read
+            end
+            File.open(imgname, 'wb').write img
+            # Update to local relative path now
+            relimgs << (File.basename imgname)
+        end
     end
+    rel['images'] = relimgs
 end
 # Also save the release file for future use
 relfile = eval cfg['rdata']
 STDERR.puts "Save rdata to #{relfile}"
 unless fake
-    # Sort tracklist in filename order and delete filenames
+    # Sort tracklist in filename order
     rel['tracklist'].sort_by! {|s| s['file']}
-    rel['tracklist'].each {|s| s.delete 'file'}
+    # Delete temporary data
+    rel['tracklist'].each do |s|
+        s.delete 'file'
+        s.delete 'disc'
+        s.delete 'num'
+    end
     File.open(relfile, 'w') do |f|
         f.puts rel.to_yaml
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: musicfix
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Lazaros Koromilas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stringex
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Music file renamer and tagger that uses Discogs.com