mp3lyrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 653d2e2af1835374a3c2d0487ab791b307dcb8c2cc0d5cacd5206ff1e4cacd9c
+  data.tar.gz: 76091b679f8465982f3bb83df1a418d94967161f93b5fcf6603db4fdc9601b72
+SHA512:
+  metadata.gz: 610dc8c9d0a03e04c4357bf1dd541f2eddd2a684411bc2f7f07af21ec5d25d309ed673be0d650c769a685e5e306a0e3773a11d447ad23ec641f3e73ae7d46497
+  data.tar.gz: 9367bb514a4cc5997619345c3527b7d6dcbfe56484d53a0a20b9a489d84b4ef571249a949656fdab1f2f825612af34e06ee8ff69c4362cef70fa80e828788fe9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Tim Brust
+
+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,86 @@
+# MP3Lyrics
+[![Ruby](https://github.com/timbru31/mp3lyrics/workflows/Ruby/badge.svg)](https://github.com/timbru31/mp3lyrics/actions?query=workflow%3ARuby)
+
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/timbru31/mp3lyrics.svg)](https://codeclimate.com/github/timbru31/mp3lyrics/coverage)
+![Code Climate](https://img.shields.io/codeclimate/maintainability/timbru31/mp3lyrics.svg)
+[![Known Vulnerabilities](https://snyk.io/test/github/timbru31/mp3lyrics/badge.svg)](https://snyk.io/test/github/timbru31/mp3lyrics)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=timbru31/mp3lyrics)](https://dependabot.com)
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
+
+### Still in Alpha, ugly and WIP :)
+
+## Info
+
+MP3Lyrics is a tool written in Ruby (currently only CLI) to download song lyrics from [LyricWiki](https://lyrics.fandom.com/wiki/LyricWikim), [MetroLyrics](http://metrolyrics.com), [AZLyrics](https://www.azlyrics.com) and [Genius](https://genius.com).
+The lyrics are added to the mp3 file via the [USLT (Unsynchronised lyric/text transcription)](http://id3.org/id3v2.4.0-frames) tag (with the power of [ruby-mp3info](https://github.com/moumar/ruby-mp3info)).
+
+## Motivation
+
+#### Why Ruby?
+
+Because I wanted to try another language than Java.
+
+#### Why are you not using the LyricWiki API?
+
+~~Although they have got a pretty neat [REST API](http://api.wikia.com/wiki/LyricWiki_API/REST) the lyrics can't be fully retrieved, most likely due to licensing issues.~~
+They no longer offer an API since January 2016.
+
+#### Why are you not using musiXmatch API?
+
+Simply because they charge me (the developer) for retrieving the lyrics.
+
+#### Why are you not using MetroLyrics API?
+
+I don't have an API key (yet).
+
+#### Why are you not using Genius API?
+
+They do not offer fetching lyrics via the API (yet).
+
+#### Why not iTunes Lyrics Adder, Lyrics for iTunes, iSongText, Get Lyrical, ...?
+
+Either they were tied to iTunes and ugly DLL libraries, outdated/inactive, closed source or not cross platform. I'm mainly developing on my MacBook and my iTunes library is on my Windows system. I need something that works anywhere.
+
+By dropping the need (and support) of iTunes running somewhere in the background, the tool is more lightweight.
+
+## Dependencies
+
+1. Bundler
+2. Nokogiri for HTML parsing
+3. mp3info as a MP3 library
+4. require_all for easier requiring of the wiki_api folder
+5. For testing purposes you should install rubocop, rake, minitest and optionally coverage reporters for CodeClimate
+
+## Installation
+
+
+```shell
+gem install bundler
+bundle install
+```
+
+## Usage
+
+```shell
+./mp3lyrics.rb <dir> [-override true/false] [-use lyricwiki/genius/metrolyrics/azlyrics]
+```
+**dir** is the folder with your music, it's iterated recursively.  
+**override** is a boolean toggle to override existing lyrics (defaults to *false*).  
+**use** is a specific wiki to be used to download lyrics (all wikis are used by default).
+
+## Tests
+
+To execute the tests run
+```shell
+bundle exec rake
+```
+
+## Future plans // ToDo
+
+- ~~Add support to other lyrics sites when 404 is returned from LyricWiki~~
+- GUI for easier usage (maybe)
+- Add test cases, see [#1](https://github.com/timbru31/mp3lyrics/issues/1)
+
+---
+Built by (c) Tim Brust and contributors. Released under the MIT license.

data/bin/mp3lyrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mp3lyrics'

data/lib/mp3lyrics.rb

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'mp3info'
+require 'require_all'
+
+require_all './lib/wiki/'
+
+def to_b(string)
+  !(string =~ /^(true|t|yes|y|1)$/i).nil?
+end
+
+def usage_message(override_options, use_options)
+  'Usage: ./mp3lyrics.rb <dir> [-override ' + override_options.join('/') + '] [-use ' + use_options.join('/') + ']'
+end
+
+override_options = [true, false]
+use_options = %w[lyricwiki genius metrolyrics azlyrics]
+
+if ARGV.length.even? ||
+   ARGV.count('-override') > 1 ||
+   ARGV.count('-use') > 1
+  # If there is an even number of arguments (includes no arguments)
+  # or a flag has been used more than once
+  puts usage_message(override_options, use_options)
+  exit
+end
+
+dir = ARGV[0]
+override = false
+wiki_to_use = nil
+
+i = 1
+while i < ARGV.length
+  if ARGV[i] == '-override'
+    if override_options.include?(to_b(ARGV[i + 1]))
+      override = to_b(ARGV[i + 1])
+    else
+      # If the argument after the override flag is invalid
+      puts usage_message(override_options, use_options)
+      exit
+    end
+  elsif ARGV[i] == '-use'
+    if use_options.include?(ARGV[i + 1])
+      wiki_to_use = ARGV[i + 1]
+    else
+      # If the argument after the use flag is invalid
+      puts usage_message(override_options, use_options)
+      exit
+    end
+  else
+    # If the argument is not a valid flag
+    puts usage_message(override_options, use_options)
+    exit
+  end
+  i += 2
+end
+
+puts "
+                  Welcome to
+  __  __ _____ ____  _                _
+ |  \\\/  |  __ \\___ \\| |              (_)
+ | \\  \/ | |__) |__) | |    _   _ _ __ _  ___ ___
+ | |\\/| |  ___\/|__ <| |   | | | | \'__| |\/ __\/ __|
+ | |  | | |    ___) | |___| |_| | |  | | (__\\__ \\
+ |_|  |_|_|   |____\/|______\\__, |_|  |_|\\___|___\/
+                            __\/ |
+                           |___\/
+
+The current working directory is #{dir}
+Overriding existing lyrics is #{override}"
+puts "Specific wiki to use is #{wiki_to_use}" unless wiki_to_use.nil?
+puts "\n\r"
+
+wiki = Wiki.new
+files = Dir.glob("#{dir}/**/*")
+files.each do |file|
+  filename = File.extname(file)
+  next unless filename == '.mp3'
+
+  Mp3Info.open(file) do |mp3|
+    artist = mp3.tag.artist || mp3.tag1.artist || mp3.tag2.artist
+    title = mp3.tag.title || mp3.tag1.title || mp3.tag2.title
+    if artist.nil? || title.nil?
+      puts "Skipping song because title or artist is not set...\n\r"
+      next
+    end
+    puts "Fetching lyrics for #{artist} - #{title}"
+    # Either no tag is set, the mp3 file has no USLT tag or we override anyway
+    if !mp3.hastag2? || (mp3.hastag2? && !mp3.tag2.key?('USLT')) || override
+      lyrics = nil
+      lyrics = LyricWiki.new.get_lyrics(artist, title) if wiki_to_use.nil? || wiki_to_use == 'lyricwiki'
+      if wiki_to_use.nil? || wiki_to_use == 'genius'
+        lyrics = Genius.new.get_lyrics(artist, title) if lyrics.nil?
+      end
+      if wiki_to_use.nil? || wiki_to_use == 'metrolyrics'
+        lyrics = MetroLyrics.new.get_lyrics(artist, title) if lyrics.nil?
+      end
+      if wiki_to_use.nil? || wiki_to_use == 'azlyrics'
+        lyrics = AZLyrics.new.get_lyrics(artist, title) if lyrics.nil?
+      end
+      if lyrics.nil?
+        puts "Did not find any lyrics\n\r"
+      else
+        puts "Lyrics found\n\r"
+        wiki.set_lyrics(mp3, lyrics)
+      end
+    else
+      puts "Skipping #{artist} - #{title} because lyrics are already set"
+    end
+  end
+end

data/lib/wiki/azlyrics.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative './wiki'
+
+# Fetches the lyrics from AZLyrics.com
+# Lyrics are stored accessed via the URL schema https://www.azlyrics.com/lyrics/ARTIST/SONG.html
+# They are inside /html/body/div[2]/div/div[2]/div[5], sadly no class to access.
+# There are hidden comments, which need to be removed.
+class AZLyrics < Wiki
+  def get_lyrics(artist, song, limit = 10)
+    artist = artist.delete(' ').parameterize
+    song = song.delete(' ').parameterize
+
+    res = fetch("https://www.azlyrics.com/lyrics/#{artist.downcase}/#{song.downcase}.html", limit)
+    return nil unless res.is_a? Net::HTTPSuccess
+
+    lyrics = Nokogiri::HTML(res.body).xpath('/html/body/div[2]/div/div[2]/div[5]')
+    prettify_lyrics(lyrics)
+  end
+
+  def prettify_lyrics(lyrics)
+    lyrics.search('.//comment()').remove
+    lyrics.inner_html.gsub('<br>', "\r").delete("\n").sub("\r\r", '')
+  end
+end

data/lib/wiki/genius.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative './wiki'
+
+# Fetches the lyrics from Genius (formerly known as Rap Genius)
+# Lyrics are stored accessed via the URL schema https://genius.com/ARTIST-SONG-lyrics
+# They are inside //div[@class="lyrics"]//p[1], a lyrics element with the class "lyrics"
+# It seems that this element was added by Angular.js
+# Inside the p in the lyrics div they are in a tags
+class Genius < Wiki
+  def get_lyrics(artist, song, limit = 10)
+    artist = artist.tr(' ', '-').parameterize
+    song = song.tr(' ', '-').parameterize
+
+    res = fetch("https://genius.com/#{artist.downcase}-#{song.downcase}-lyrics", limit)
+    return nil unless res.is_a? Net::HTTPSuccess
+
+    lyrics = Nokogiri::HTML(res.body).xpath('//div[@class="lyrics"]//p[1]')
+    lyrics.inner_html.gsub('<br>', "\r").gsub(%r{</?[^>]+>}, '').delete("\n")
+  end
+end

data/lib/wiki/lyricwiki.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './wiki'
+
+# Fetches the lyrics from LyricWiki
+# Lyrics are stored accessed via the URL schema https://lyrics.fandom.com/wiki/ARTIST:SONG
+# They are inside //div[@class="lyricbox"], a div with the class "lyricbox"
+# There are hidden comments and script tags, that needs to be removed.
+class LyricWiki < Wiki
+  def get_lyrics(artist, song, limit = 10)
+    artist = artist.tr(' ', '_')
+    song = song.tr(' ', '_')
+
+    res = fetch("https://lyrics.fandom.com/wiki/#{artist}:#{song}", limit)
+    return nil unless res.is_a? Net::HTTPSuccess
+
+    lyrics = Nokogiri::HTML(res.body).xpath('//div[@class="lyricbox"]')
+    prettify_lyrics(lyrics)
+  end
+
+  def prettify_lyrics(lyrics)
+    lyrics.search('//script').remove
+    lyrics.search('.//comment()').remove
+    lyrics.inner_html.gsub('<br>', "\r").gsub(%r{</?[^>]+>}, '').delete("\n")
+  end
+end

data/lib/wiki/metrolyrics.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './wiki'
+
+# Fetches the lyrics from MetroLyrics
+# Lyrics are stored accessed via the URL schema https://www.metrolyrics.com/SONG-lyrics-ARTIST
+# They are inside //*[@id="lyrics-body-text"]
+# There are hidden comments and script tags, that needs to be removed.
+class MetroLyrics < Wiki
+  def get_lyrics(artist, song, limit = 10)
+    artist = artist.tr(' ', '-').parameterize
+    song = song.tr(' ', '-').parameterize
+
+    res = fetch("https://www.metrolyrics.com/#{song.downcase}-lyrics-#{artist.downcase}.html", limit)
+    return nil unless res.is_a? Net::HTTPSuccess
+
+    lyrics = Nokogiri::HTML(res.body).xpath('//*[@id="lyrics-body-text"]')
+    lyrics.search('.driver-photos').remove
+    lyrics.search('.driver-related').remove
+    prettify_lyrics(lyrics.inner_html)
+  end
+
+  def prettify_lyrics(lyrics)
+    lyrics = lyrics.gsub('<br>', "\r")
+    lyrics = lyrics.gsub("</p>\n<p class=\"verse\">", "\r")
+    lyrics = lyrics.gsub(%r{</?[^>]+>}, '')
+    lyrics = lyrics.delete("\t")
+    lyrics.delete("\n")
+  end
+end

data/lib/wiki/wiki.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'net/http'
+require 'nokogiri'
+
+# Base class to fetch different lyrics sites
+class Wiki
+  def fetch(uri_str, limit = 10)
+    raise ArgumentError, 'The wiki site is redirecting too much, aborting...' if limit.zero?
+
+    uri = prepare_url(uri_str)
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      req = Net::HTTP::Get.new(uri.path)
+      begin
+        http.request(req)
+      rescue EOFError
+        fetch(uri_str, limit - 1)
+      end
+    end
+    case response
+    when Net::HTTPRedirection
+      fetch(response['location'], limit - 1)
+    else
+      response
+    end
+  end
+
+  def set_lyrics(mp3, lyrics)
+    mp3.tag2.USLT = lyrics
+  end
+
+  def prepare_url(uri_str)
+    uri_str.gsub!('%EF%BB%BF', '') # fix BOM
+    URI.parse(uri_str)
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: mp3lyrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Brust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-04-28 00:00:00.000000000 Z
+dependencies: []
+description: CLI for mp3 lyrics fetching. Uses ruby-mp3info and fetches different
+  lyric wikis
+email: github@timbrust.de
+executables:
+- mp3lyrics
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/mp3lyrics
+- lib/mp3lyrics.rb
+- lib/wiki/azlyrics.rb
+- lib/wiki/genius.rb
+- lib/wiki/lyricwiki.rb
+- lib/wiki/metrolyrics.rb
+- lib/wiki/wiki.rb
+homepage: https://github.com/timbru31/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: CLI for mp3 lyrics fetching
+test_files: []