karaoke 0.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activesupport"
+gem "terminal-notifier"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Douwe Maan
+
+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,76 @@
+# karaoke
+
+A Ruby library for easily finding the lyrics to your favorite songs.
+
+## Installation
+
+```sh
+gem install karaoke
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "karaoke"
+```
+
+## Usage
+
+```ruby
+require "karaoke"
+
+# To find the lyrics to a song, simply search for it:
+song = Karaoke.search("Armin van Buuren - This Is What It Feels Like")
+# Be as creative as you want, karaoke usually knows what you're looking for:
+song = Karaoke.search("This Is What It Feels Like - Armin van Buuren")
+song = Karaoke.search("This Is What It Feels Like by Armin van Buuren")
+song = Karaoke.search("Song by Armin van Buuren with vocals by Trevor Guthrie")
+
+# This will return a Song object containing the following information:
+song.artist # => "Armin van Buuren"
+song.title  # => "This Is What It Feels Like"
+song.lyrics # => "Nobody here knocking at my door\n" and so on.
+
+# If you're only interested in the lyrics, save a couple of keystrokes:
+lyrics = Karaoke.lyrics("Armin van Buuren - This Is What It Feels Like") 
+# => "Nobody here knocking at my door\n" and so on.
+
+# Behind the scenes, karaoke searches Google to find results on any of these sites:
+# (Rap)Genius, MetroLyrics, Lyricsfreak, AZLyrics, DirectLyrics and LyricsMania
+# Next, karaoke reads the lyrics from the highest ranked Google search result.
+
+# If, for whatever reason, you want access to all of the found lyrics
+# instead of just the highest ranked one, use `Karaoke::Search` directly:
+Karaoke::Search.new("Armin van Buuren - This Is What It Feels Like").results
+# => [
+#   #<Karaoke::Song::Azlyrics:0x007fef3a080b98>, 
+#   #<Karaoke::Song::MetroLyrics:0x007fef3c01c9c0>, 
+#   #<Karaoke::Song::Genius:0x007fef3a0cf900>, 
+#   #<Karaoke::Song::LyricsMania:0x007fef3a0d1a98>
+# ]
+```
+
+## Examples
+Check out the [`examples/`](examples) folder for an example that I actually use myself.
+
+## License
+Copyright (c) 2014 Douwe Maan
+
+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/Rakefile

@@ -0,0 +1,17 @@
+require "rspec/core/rake_task"
+
+spec = Gem::Specification.load("karaoke.gemspec")
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Build the .gem file"
+task :build do
+  system "gem build #{spec.name}.gemspec"
+end
+
+desc "Push the .gem file to rubygems.org"
+task release: :build do
+  system "gem push #{spec.name}-#{spec.version}.gem"
+end

data/lib/karaoke.rb

@@ -0,0 +1,16 @@
+require "karaoke/version"
+require "karaoke/search"
+
+module Karaoke
+  class << self
+    def search(query)
+      Search.new(query).results.first
+    end
+
+    def lyrics(query)
+      song = search(query)
+
+      song && song.lyrics
+    end
+  end
+end

data/lib/karaoke/search.rb

@@ -0,0 +1,33 @@
+require "google-search"
+
+require "karaoke/song"
+
+module Karaoke
+  class Search
+    attr_reader :query
+
+    def initialize(query)
+      @query = query
+    end
+
+    def search_query
+      "#{self.query} lyrics"
+    end
+
+    def results
+      @results ||= begin
+        song_results = []
+
+        search_results = Google::Search::Web.new(query: search_query)
+        search_results.each do |result|
+          klass = Song.song_type_for(result.uri)
+          next unless klass
+
+          song_results << klass.new(result.uri)
+        end
+
+        song_results
+      end
+    end
+  end
+end

data/lib/karaoke/song.rb

@@ -0,0 +1,23 @@
+module Karaoke
+  module Song
+    class << self
+      @@services = []
+      
+      def register_song_type(song_type)
+        @@services |= [song_type]
+      end
+
+      def song_type_for(lyrics_uri)
+        @@services.find { |song_type| song_type.matches?(lyrics_uri) }
+      end
+    end
+  end
+end
+
+require "karaoke/song/genius"
+require "karaoke/song/metro_lyrics"
+require "karaoke/song/lyricsfreak"
+# require "karaoke/song/lyricsmode"
+require "karaoke/song/azlyrics"
+require "karaoke/song/directlyrics"
+require "karaoke/song/lyrics_mania"

data/lib/karaoke/song/azlyrics.rb

@@ -0,0 +1,39 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class Azlyrics < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("azlyrics.com")
+      end
+
+      def artist
+        return @artist if defined?(@artist)
+
+        @artist = data.match(/ArtistName = "([^"]+)";/)[1]
+      end
+
+      def title
+        return @title if defined?(@title)
+
+        @title = data.match(/SongName = "([^"]+)";/)[1]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css("div[style='margin-left:10px;margin-right:10px;']").first
+        return @lyrics = nil unless el
+
+        el.css("i").each { |i_el| i_el.replace(i_el.inner_html) }
+
+        lyrics = clean_html(el.inner_html)
+        lyrics.gsub!("<!-- start of lyrics -->", "")
+        lyrics.gsub!("<!-- end of lyrics -->", "")
+        @lyrics = lyrics
+      end
+    end
+
+    register_song_type Azlyrics
+  end
+end

data/lib/karaoke/song/base.rb

@@ -0,0 +1,56 @@
+require "net/http"
+require "uri"
+require "nokogiri"
+
+module Karaoke
+  module Song
+    class Base
+      attr_reader :lyrics_url
+
+      def initialize(lyrics_url)
+        @lyrics_url = lyrics_url
+      end
+
+      def artist
+        raise NotImplementedError.new("The Song::Base subclass needs to override the #artist method.")
+      end
+
+      def title
+        raise NotImplementedError.new("The Song::Base subclass needs to override the #title method.")
+      end
+
+      def lyrics
+        raise NotImplementedError.new("The Song::Base subclass needs to override the #lyrics method.")
+      end
+
+      private
+        def data
+          @data ||= begin
+            redirects = 0
+            begin
+              raise "Too many redirects" if redirects == 5
+
+              uri         = URI.parse(@lyrics_url)
+              connection  = Net::HTTP.new(uri.host, uri.port)
+              connection.use_ssl = uri.is_a?(URI::HTTPS)
+              
+              request = Net::HTTP::Get.new(uri.request_uri)
+              response = connection.request(request)
+
+              redirects += 1
+            end while response.is_a?(Net::HTTPRedirection) && @lyrics_url = response["location"]
+
+            response.body
+          end
+        end
+
+        def document
+          @document ||= Nokogiri::HTML::Document.parse(data)
+        end
+
+        def clean_html(html)
+          html.gsub(/[\t\n\r]/, "").gsub("<br>", "\n")
+        end
+    end
+  end
+end

data/lib/karaoke/song/directlyrics.rb

@@ -0,0 +1,48 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class Directlyrics < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("directlyrics.com")
+      end
+
+      def artist
+        return @artist if defined?(@artist)
+
+        el = document.css(".breadcrumb a[href$='-artist.html']").first ||
+          document.css("#hd-bar a[href$='-artist.html']").first
+          
+        return @artist = nil unless el
+
+        @artist = el.text
+      end
+
+      def title
+        return @title if defined?(@title)
+
+        el = document.css(".hd h1").first || document.css("#hd h1").first
+        return @title = nil unless el
+
+        @title = el.text.match("^[^-]+- (.+?) lyrics$")[1]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css(".lyrics p").first || begin
+          lyrics_class = data.match(/\$\('\.([a-z0-9]+)'\)\.addClass\('lyrics'\);/)[1]
+          document.css("[class='#{lyrics_class}'] p").first
+        end
+
+        return @lyrics = nil unless el
+
+        el.css("ins").remove
+
+        @lyrics = clean_html(el.inner_html)
+      end
+    end
+
+    register_song_type Directlyrics
+  end
+end

data/lib/karaoke/song/genius.rb

@@ -0,0 +1,37 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class Genius < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("genius.com") # Matches new *.genius.com URLs as well as rapgenius.com.
+      end
+
+      def artist
+        @artist ||= tracking_data["Primary Artist"] || tracking_data["Primary Arist"]
+      end 
+
+      def title
+        @title ||= tracking_data["Title"]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css(".lyrics p").first
+        return @lyrics = nil unless el
+
+        el.css("a").each { |a_el| a_el.replace(a_el.inner_html) }
+
+        @lyrics = clean_html(el.inner_html)
+      end
+
+      private
+        def tracking_data
+          @tracking_data ||= JSON.parse(data.match("var TRACKING_DATA = (\{.+?\})")[1])
+        end
+    end
+
+    register_song_type Genius
+  end
+end

data/lib/karaoke/song/lyrics_mania.rb

@@ -0,0 +1,37 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class LyricsMania < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("lyricsmania.com")
+      end
+
+      def artist
+        return @artist if defined?(@artist)
+
+        @artist = data.match(/cf_page_artist = "([^"]+)";/)[1]
+      end
+
+      def title
+        return @title if defined?(@title)
+
+        @title = data.match(/cf_page_song = "([^"]+)";/)[1]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css(".lyrics-body").first
+        return @lyrics = nil unless el
+
+        el.css("div").remove
+        el.css("strong").remove
+
+        @lyrics = clean_html(el.inner_html)
+      end
+    end
+
+    register_song_type LyricsMania
+  end
+end

data/lib/karaoke/song/lyricsfreak.rb

@@ -0,0 +1,40 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class Lyricsfreak < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("lyricsfreak.com")
+      end
+
+      def artist
+        return @artist if defined?(@artist)
+
+        el = document.css(%Q{a[data-tracking='\["Meta","Lyrics","ArtistName"\]']}).first
+        return @artist = nil unless el
+
+        @artist = el.text
+      end
+
+      def title
+        return @title if defined?(@title)
+
+        el = document.css(".song-info-panel h1").first
+        return @title = nil unless el
+
+        @title = el.text.match("^(.+?) Lyrics$")[1]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css("#content_h").first
+        return @lyrics = nil unless el
+
+        @lyrics = clean_html(el.inner_html)
+      end
+    end
+
+    register_song_type Lyricsfreak
+  end
+end

data/lib/karaoke/song/lyricsmode.rb

@@ -0,0 +1,42 @@
+require "karaoke/song/base"
+
+# Doesn't work, because Lyricsmode blocks access from bots with 403 Forbidden.
+
+module Karaoke
+  module Song
+    class Lyricsmode < Base
+      def self.matches?(lyrics_url)
+        URI.parse(lyrics_url).host.end_with?("lyricsmode.com")
+      end
+
+      def artist
+        return @artist if defined?(@artist)
+
+        el = document.css(%Q{a[data-tracking='\["Meta","Lyrics","ArtistName"\]']}).first
+        return @artist = nil unless el
+
+        @artist = el.text
+      end
+
+      def title
+        return @title if defined?(@title)
+
+        el = document.css("h1.song_name").first
+        return @title = nil unless el
+
+        @title = el.text.trim.match("^(.+?) Lyrics$")[1]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css(".meaning_inside_frame").first
+        return @lyrics = nil unless el
+
+        @lyrics = clean_html(el.inner_html)
+      end
+    end
+
+    register_song_type Lyricsmode
+  end
+end

data/lib/karaoke/song/metro_lyrics.rb

@@ -0,0 +1,41 @@
+require "karaoke/song/base"
+
+module Karaoke
+  module Song
+    class MetroLyrics < Base
+      def self.matches?(lyrics_url)
+        uri = URI.parse(lyrics_url)
+
+        uri.host.end_with?("metrolyrics.com") && !uri.path.end_with?("-lyrics.html")
+      end
+
+      def artist
+        @artist ||= tracking_data["musicArtistName"]
+      end 
+
+      def title
+        @title ||= tracking_data["musicSongTitle"]
+      end
+
+      def lyrics
+        return @lyrics if defined?(@lyrics)
+
+        el = document.css("#lyrics-body-text").first
+        return @lyrics = nil unless el
+
+        lyrics = clean_html(el.inner_html)
+        lyrics.gsub!("</p><p class=\"verse\">", "\n\n")
+        lyrics.gsub!("<p class=\"verse\">", "")
+        lyrics.gsub!("</p>", "")
+        @lyrics = lyrics
+      end
+
+      private
+        def tracking_data
+          @tracking_data ||= JSON.parse(data.match("var utag_data=(\{.+?\})")[1])
+        end
+    end
+
+    register_song_type MetroLyrics
+  end
+end

data/lib/karaoke/version.rb

@@ -0,0 +1,3 @@
+module Karaoke
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rspec"
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+require "karaoke"

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: karaoke
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Douwe Maan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70358367183500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70358367183500
+- !ruby/object:Gem::Dependency
+  name: google-search
+  requirement: &70358367183080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70358367183080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70358367182660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70358367182660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70358367182060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70358367182060
+description: A Ruby library for easily finding the lyrics to your favorite songs
+email: douwe@selenight.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/karaoke/search.rb
+- lib/karaoke/song/azlyrics.rb
+- lib/karaoke/song/base.rb
+- lib/karaoke/song/directlyrics.rb
+- lib/karaoke/song/genius.rb
+- lib/karaoke/song/lyrics_mania.rb
+- lib/karaoke/song/lyricsfreak.rb
+- lib/karaoke/song/lyricsmode.rb
+- lib/karaoke/song/metro_lyrics.rb
+- lib/karaoke/song.rb
+- lib/karaoke/version.rb
+- lib/karaoke.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+- spec/spec_helper.rb
+homepage: https://github.com/DouweM/karaoke
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1283531912695341570
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1283531912695341570
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Find lyrics to your favorite songs
+test_files:
+- spec/spec_helper.rb