lyricfy 0.0.2 → 0.1.0

data/README.md

@@ -24,20 +24,25 @@ Or install it yourself as:
 You need to create an instance of the <code>Lyricfy::Fetcher</code> class and send the <code>#search</code> message with the artist name and song title respectively. The following example shows the most basic usage.
 
     fetcher = Lyricfy::Fetcher.new
-    lyric = fetcher.search 'Coldplay', 'Viva la vida'
-    lyric.body.each { |line| puts line }
+    song = fetcher.search 'Coldplay', 'Viva la vida'
+    puts song.body # prints lyrics separated by '\n'
+
+You can also pass a custom separator to the <code>#body</code> method. For example:
+
+    lyrics.body("<br>") # returns a String with the song lyrics separated by a <br> tag
 
-The <code>Lyricfy::Fetcher#search</code> method returns an OpenStruct object with the following methods:
+The <code>Lyricfy::Fetcher#search</code> method returns a <code>Lyricfy::Song</code> object with the following methods:
 
-- artist
-- song
+- title
+- author
+- lines
 - body
 
-Where artist is the artist name, song is the song title and body is an Array of the lyric paragraphs.
+Where title is the song title, author is the song artist, lines is an Array of the lyric paragraphs and body returns a String with the song lyrics separated with <code>\n</code> by default.
 
 ### How does it work?
 
-Under the hood, this library fetch the songs lyrics by scraping some websites called "Providers". The currently supported providers are:
+Under the hood, this library fetch the song lyrics by scraping some websites called "Providers". The currently supported providers are:
 
 - [Wikia](http://lyrics.wikia.com/Lyrics_Wiki)
 - [MetroLyrics](http://www.metrolyrics.com/)
@@ -46,7 +51,7 @@ By default this gem will recursively search for the lyric on each of the provide
 
     fetcher = Lyricfy::Fetcher.new(:metro_lyrics)
     lyric = fetcher.search 'Coldplay', 'Viva la vida'
-    lyric.body.each { |line| puts line }
+    puts lyric.body
 
 In this case Lyricfy will look for the lyric only on [MetroLyrics](http://www.metrolyrics.com/).
 

data/lib/lyricfy.rb

@@ -3,6 +3,7 @@ require "open-uri"
 require "nokogiri"
 require_relative "lyricfy/version"
 require_relative "lyricfy/uri_helper"
+require_relative "lyricfy/song"
 require_relative "lyricfy/lyric_provider"
 require_relative "lyricfy/providers/wikia"
 require_relative "lyricfy/providers/metro_lyrics"
@@ -17,7 +18,7 @@ module Lyricfy
         metro_lyrics: MetroLyrics
       }
 
-      if !args.empty?
+      unless args.empty?
         passed_providers = {}
         args.each do |provider|
           raise Exception unless @providers.has_key?(provider)
@@ -28,16 +29,21 @@ module Lyricfy
     end
 
     def search(artist, song)
-      result = nil
-      @providers.each_pair do |provider, klass|
-        fetcher = klass.new(artist_name: artist, song_name: song)
+      key = [artist.downcase, song.downcase]
+      @cached_search ||= {}
 
-        if lyric_body = fetcher.search
-          result =  OpenStruct.new(artist: artist, song: song, body: lyric_body)
-          break
+      @cached_search.fetch(key) do
+        result = nil
+        @providers.each_pair do |provider, klass|
+          fetcher = klass.new(artist_name: artist, song_name: song)
+
+          if lyric_body = fetcher.search
+            result =  Lyricfy::Song.new(song, artist, lyric_body)
+            break
+          end
         end
+        @cached_search[key] = result
       end
-      result
     end
   end
 end

data/lib/lyricfy/song.rb

@@ -0,0 +1,15 @@
+module Lyricfy
+  class Song
+    attr_accessor :title, :author, :lines
+
+    def initialize(title, author, lines)
+      self.title  = title
+      self.author = author
+      self.lines  = lines
+    end
+
+    def body(separator = '\n')
+      lines.join(separator)
+    end
+  end
+end

data/lib/lyricfy/version.rb

@@ -1,3 +1,3 @@
 module Lyricfy
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/lyricfy_test.rb

@@ -42,6 +42,17 @@ describe Lyricfy::Fetcher do
           end
         end
       end
+
+      describe "lyric found" do
+        it "should return lyrics" do
+          fetcher = Lyricfy::Fetcher.new :metro_lyrics
+          VCR.use_cassette('metro_lyrics_200') do
+            result = fetcher.search('2pac', 'Life Goes On')
+            result.lines.must_be_instance_of Array
+            result.body.must_include 'Life as a baller'
+          end
+        end
+      end
     end
   end
-end
+end

data/test/song_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe Lyricfy::Song do
+  before do
+    @song = Lyricfy::Song.new 'Yellow', 'Coldplay', ['Look at the stars', 'Look how they shine for you']
+  end
+
+  [
+    :title,
+    :author,
+    :lines
+  ].each do |param|
+    it "should respond to #{param}" do
+      @song.must_respond_to param
+    end
+  end
+
+  describe "#body" do
+    describe "with param" do
+      it "should use injected separator" do
+        @song.body("<br>").must_equal "Look at the stars<br>Look how they shine for you"
+      end
+    end
+
+    describe "with no params" do
+      it "should use default separator" do
+        @song.body.must_equal "Look at the stars\\nLook how they shine for you"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyricfy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -92,6 +92,7 @@ files:
 - lib/lyricfy/lyric_provider.rb
 - lib/lyricfy/providers/metro_lyrics.rb
 - lib/lyricfy/providers/wikia.rb
+- lib/lyricfy/song.rb
 - lib/lyricfy/uri_helper.rb
 - lib/lyricfy/version.rb
 - lyricfy.gemspec
@@ -102,6 +103,7 @@ files:
 - test/lyricfy_test.rb
 - test/providers/metro_lyrics_test.rb
 - test/providers/wikia_test.rb
+- test/song_test.rb
 - test/test_helper.rb
 homepage: https://github.com/javichito/lyricfy
 licenses: []
@@ -117,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3084054243031445109
+      hash: -733643063558142876
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -126,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3084054243031445109
+      hash: -733643063558142876
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -141,4 +143,5 @@ test_files:
 - test/lyricfy_test.rb
 - test/providers/metro_lyrics_test.rb
 - test/providers/wikia_test.rb
+- test/song_test.rb
 - test/test_helper.rb