lyrics_finder 0.0.3.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18fb39d6218af131f95a5f89a8fa9e3e13c60016
-  data.tar.gz: 7b5240100f25a8c0001c19a4427f45853346f785
+  metadata.gz: 24d30590b3b2ea3bca2df02b6f094d6765b567c8
+  data.tar.gz: 9958bc037c98e13ae04be1c389f94b537cbde463
 SHA512:
-  metadata.gz: d7f9660235e0f0d67af718ddb9646f5ebaacee41f1af025be16dffa38af7ff09fb1e6cf743789b471bac74535386424aa818cd140842cface9f904e1cb6f05f0
-  data.tar.gz: e4a45e2bdc8d6c0cb17aa6c25016bf4f1093bacfe4129468774aa5cee818ea0214de95d238bc2bb92c4a1875def4df931eab68d8bc44e4ab3bbd172bff8d7236
+  metadata.gz: 56c43572f530c4beffc7420eb077e008abfd6eb46e30cb185e845da7d763089a30e44e7d3f455efa3783105f5f64cd11101101dd683fe03bff947ba934a46b54
+  data.tar.gz: 9931a17d85fba8980ef222de6d1ed8cc53a2339e389015875b681153d4ecbfc42a31aaf89cc48c259cc813e3cd858fd4272f8e89a6e20dd847ff1bf95dbe14db

data/.gitignore

@@ -21,4 +21,6 @@ tmp
 *.a
 mkmf.log
 
-.idea
+.idea
+
+spec/vcr_cassettes

data/README.md

@@ -44,6 +44,7 @@ You can choose among the following:
 - LyricsWikia (`:lyrics_wikia`)
 - SongLyrics (`:song_lyrics`)
 - AZLyrics (`:azlyrics`)
+- LyricsMania (`:lyrics_mania`)
 
 ## Example
 
@@ -64,6 +65,10 @@ LyricsFinder is also available as a command-line tool.
 
 ## Changelog
 
+v 0.0.4
+
+- Added lyrics mania as a valid website to get your lyrics from.
+
 v 0.0.3
 
 - Wrapped everything into a `Lyrics` module.

data/lib/lyrics_finder.rb

@@ -3,7 +3,7 @@ require_relative 'lyrics_finder/dependencies'
 module Lyrics
   class Finder
     include Contracts
-    PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
+    PROVIDERS_LIST = [:lyrics_wikia, :lyrics_mania, :song_lyrics, :azlyrics]
 
     def initialize(*args)
       @providers = filter_providers(args)
@@ -24,14 +24,12 @@ module Lyrics
         @providers.each do |provider|
           klass = Providers.build_klass(provider)
           url = klass.format_url(song)
-
           data = perform_request(url)
           result = klass.extract_lyric(data) if data
           throw :song_lyric, result unless result.nil?
         end
+        throw :song_lyric, nil # because song cannot be found.
       }
-      # because if it doesn't find anything returns @providers by default
-      song_lyric != @providers ? song_lyric : nil
     end
 
     private

data/lib/lyrics_finder/dependencies.rb

@@ -9,4 +9,5 @@ require_relative 'version'
 require_relative 'providers'
 require_relative 'providers/lyrics_wikia'
 require_relative 'providers/azlyrics'
-require_relative 'providers/song_lyrics'
+require_relative 'providers/song_lyrics'
+require_relative 'providers/lyrics_mania'

data/lib/lyrics_finder/providers/lyrics_mania.rb

@@ -0,0 +1,16 @@
+module Lyrics
+  module Providers::LyricsMania
+    include Contracts
+
+    Contract Lyrics::Song => String
+    def self.format_url(song)
+      song.format_attributes_with_separator!("_")
+      "http://www.lyricsmania.com/#{song.title}_lyrics_#{song.author}.html"
+    end
+
+    Contract Tempfile => Or[Array, nil]
+    def self.extract_lyric(data)
+      Lyrics::Providers.extract_lyrics_at_css_from_data('.lyrics-body', data)
+    end
+  end
+end

data/lib/lyrics_finder/version.rb

@@ -1,3 +1,3 @@
 module LyricsFinder
-  VERSION = "0.0.3.1"
+  VERSION = "0.0.4"
 end

data/spec/lyrics_finder/lyrics_finder_spec.rb

@@ -95,24 +95,22 @@ describe Lyrics::Finder do
       end
     end
 
-    # unfortunately lyrics mania doesn't return 404 if it does not find the song
-    # it just redirect to the root url www.lyricsmania.com
-    # describe 'using LyricsMania as the provider' do
-    #   before :each do
-    #     @finder = Lyrics::Finder.new(:lyrics_mania)
-    #     VCR.use_cassette 'LyricsMania 200 search' do
-    #       @song = @finder.search("american authors", "best day of my life")
-    #     end
-    #   end
-    #
-    #   it 'returns an instance of Array' do
-    #     expect(@song.class).to eq Array
-    #   end
-    #
-    #   it 'returns the desired song' do
-    #     expect(@song).to eq LyricsManiaSampleSongs::BEST_DAY_OF_MY_LIFE
-    #   end
-    # end
+    describe 'using LyricsMania as the provider' do
+      before :each do
+        @finder = Lyrics::Finder.new(:lyrics_mania)
+        VCR.use_cassette 'LyricsMania 200 search' do
+          @song = @finder.search("american authors", "best day of my life")
+        end
+      end
+
+      it 'returns an instance of Array' do
+        expect(@song.class).to eq Array
+      end
+
+      it 'returns the desired song' do
+        expect(@song).to eq LyricsManiaSampleSongs::BEST_DAY_OF_MY_LIFE
+      end
+    end
 
     describe 'with a song that cannot be found' do
       before :each do

data/spec/lyrics_finder/providers/azlyrics_spec.rb

@@ -11,5 +11,17 @@ describe Lyrics::Providers::Azlyrics do
       end
     end
   end
-  # '.extract_lyric' happy path already tested in lyrics_finder_spec.rb
+
+  describe '.extract_lyric' do
+    # with valid data it's already tested in lyrics_finder_spec.rb
+    context 'with invalid data' do
+      let(:klass) { Lyrics::Providers::Azlyrics }
+
+      it 'raises a ContractError Exception' do
+        expect{
+          klass.extract_lyric(3.14)
+        }.to raise_error ContractError
+      end
+    end
+  end
 end

data/spec/lyrics_finder/providers/lyrics_mania_spec.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+describe Lyrics::Providers::LyricsMania do
+  describe '.format_url' do
+    context 'with valid author and title' do
+      let(:klass) { Lyrics::Providers::LyricsMania }
+      let(:song) { Lyrics::Song.new("amêricàn authors", "best day of my life") }
+      let(:valid_url) { "http://www.lyricsmania.com/best_day_of_my_life_lyrics_american_authors.html" }
+
+      it 'returns a properly formatted url' do
+        expect(klass.format_url(song)).to eq valid_url
+      end
+    end
+  end
+
+  describe '.extract_lyric' do
+    # with valid data it's already tested in lyrics_finder_spec.rb
+    context 'with invalid data' do
+      let(:klass) { Lyrics::Providers::LyricsMania }
+
+      it 'raises a ContractError Exception' do
+        expect{
+          klass.extract_lyric({})
+        }.to raise_error ContractError
+      end
+    end
+  end
+end

data/spec/lyrics_finder/providers/song_lyrics_spec.rb

@@ -11,5 +11,17 @@ describe Lyrics::Providers::SongLyrics do
       end
     end
   end
-  # '.extract_lyric' happy path already tested in lyrics_finder_spec.rb
+
+  describe '.extract_lyric' do
+    # with valid data it's already tested in lyrics_finder_spec.rb
+    context 'with invalid data' do
+      let(:klass) { Lyrics::Providers::SongLyrics }
+
+      it 'raises a ContractError Exception' do
+        expect{
+          klass.extract_lyric([])
+        }.to raise_error ContractError
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -7,4 +7,5 @@ require 'lyrics_finder'
 require_relative 'support/vcr_setup'
 require_relative 'support/lyrics_wikia_sample_songs'
 require_relative 'support/azlyrics_sample_songs'
-require_relative 'support/song_lyrics_sample_songs'
+require_relative 'support/song_lyrics_sample_songs'
+require_relative 'support/lyrics_mania_sample_songs'

data/spec/support/lyrics_mania_sample_songs.rb

@@ -0,0 +1,52 @@
+module LyricsManiaSampleSongs
+  BEST_DAY_OF_MY_LIFE = ["Wo-o-o-o-o-oh Wooh",
+                         "I had a dream so big and loud",
+                         "I jumped so high I touched the clouds",
+                         "Wo-o-o-o-o-oh",
+                         "Wo-o-o-o-o-oh",
+                         "I stretched my hands out to the sky",
+                         "We danced with monsters through the night",
+                         "Wo-o-o-o-o-oh",
+                         "Wo-o-o-o-o-oh",
+                         "I'm never gonna look back",
+                         "Woah, I'm never gonna give it up",
+                         "No, please don't wake me now",
+                         "Oo-o-o-o-oo",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "Oo-o-o-o-oo",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "I howled at the moon with friends",
+                         "And then the sun came crashing in",
+                         "Wo-o-o-o-o-oh",
+                         "Wo-o-o-o-o-oh",
+                         "But all the possibilities",
+                         "No limits just epiphanies",
+                         "Wo-o-o-o-o-oh",
+                         "Wo-o-o-o-o-oh",
+                         "I'm never gonna look back",
+                         "Woah, I'm never gonna give it up",
+                         "No, just don't wake me now",
+                         "Oo-o-o-o-oo",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "Oo-o-o-o-oo",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "I hear it calling outside my window",
+                         "I feel it in my soul (soul)",
+                         "The stars were burning so bright",
+                         "The sun was out 'til midnight",
+                         "I say we lose control (control)",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "Oo-o-o-o-o",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife",
+                         "This is gonna be, this is gonna be, this is gonna be",
+                         "The best day of my life",
+                         "Everything is looking up, everybody up now",
+                         "This is gonna be the best day of my life",
+                         "My li-i-i-i-i-ife"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lyrics_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.3.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Daniel Romero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - lib/lyrics_finder/dependencies.rb
 - lib/lyrics_finder/providers.rb
 - lib/lyrics_finder/providers/azlyrics.rb
+- lib/lyrics_finder/providers/lyrics_mania.rb
 - lib/lyrics_finder/providers/lyrics_wikia.rb
 - lib/lyrics_finder/providers/song_lyrics.rb
 - lib/lyrics_finder/song.rb
@@ -208,11 +209,13 @@ files:
 - lyrics_finder.gemspec
 - spec/lyrics_finder/lyrics_finder_spec.rb
 - spec/lyrics_finder/providers/azlyrics_spec.rb
+- spec/lyrics_finder/providers/lyrics_mania_spec.rb
 - spec/lyrics_finder/providers/lyrics_wikia_spec.rb
 - spec/lyrics_finder/providers/song_lyrics_spec.rb
 - spec/lyrics_finder/providers_spec.rb
 - spec/spec_helper.rb
 - spec/support/azlyrics_sample_songs.rb
+- spec/support/lyrics_mania_sample_songs.rb
 - spec/support/lyrics_wikia_sample_songs.rb
 - spec/support/song_lyrics_sample_songs.rb
 - spec/support/vcr_setup.rb
@@ -243,11 +246,13 @@ summary: Solution for finding song lyrics
 test_files:
 - spec/lyrics_finder/lyrics_finder_spec.rb
 - spec/lyrics_finder/providers/azlyrics_spec.rb
+- spec/lyrics_finder/providers/lyrics_mania_spec.rb
 - spec/lyrics_finder/providers/lyrics_wikia_spec.rb
 - spec/lyrics_finder/providers/song_lyrics_spec.rb
 - spec/lyrics_finder/providers_spec.rb
 - spec/spec_helper.rb
 - spec/support/azlyrics_sample_songs.rb
+- spec/support/lyrics_mania_sample_songs.rb
 - spec/support/lyrics_wikia_sample_songs.rb
 - spec/support/song_lyrics_sample_songs.rb
 - spec/support/vcr_setup.rb