lyrics_finder 0.0.2 → 0.0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57cc0f1e4ad122a9fde9703f7a422db906bda1b2
-  data.tar.gz: ec34c7b3f0598f39dcd1073bfb42d086df8cc629
+  metadata.gz: 18fb39d6218af131f95a5f89a8fa9e3e13c60016
+  data.tar.gz: 7b5240100f25a8c0001c19a4427f45853346f785
 SHA512:
-  metadata.gz: 04d13064bd6d959785a314df9fa1943aa6b77c9d22887040addb62014ca7fa82311d3c6d78b7321ace0e24500e495f247d1354a0f8a341ca8f767197ae51b98e
-  data.tar.gz: f5c787f0727f686cafaf6611b6208a29d8d72c6ef262e8a2d9e10ac624eb17134e0dbe79bfef04ebdf4e824f29feca7c21419d1a6afc9aeba160b3a21e106200
+  metadata.gz: d7f9660235e0f0d67af718ddb9646f5ebaacee41f1af025be16dffa38af7ff09fb1e6cf743789b471bac74535386424aa818cd140842cface9f904e1cb6f05f0
+  data.tar.gz: e4a45e2bdc8d6c0cb17aa6c25016bf4f1093bacfe4129468774aa5cee818ea0214de95d238bc2bb92c4a1875def4df931eab68d8bc44e4ab3bbd172bff8d7236

data/README.md

@@ -18,16 +18,25 @@ Or install it yourself as:
 
 ## Hello World!
 
-Create an instance of `Finder`:
+Create an instance of `Lyrics::Finder`:
 
 ```ruby
-  finder = Finder.new
+  finder = Lyrics::Finder.new
 ```
 
-You can specify which websites are you going to get the lyrics from:
+And search passing the author and the song title as parameters to `Lyrics::Finder#search`:
 
 ```ruby
-  finder = Finder.new(:song_lyrics, :azlyrics)
+  finder.search 'idina menzel', 'let it go'
+```
+Which will return and array with all the verses of the song as strings, or `nil` if the song cannot be found.
+
+### Customizing the search
+
+You can specify which websites do you want to get the lyrics from (all by default):
+
+```ruby
+  finder = Lyrics::Finder.new(:song_lyrics, :azlyrics)
 ```
 
 You can choose among the following:
@@ -36,20 +45,13 @@ You can choose among the following:
 - SongLyrics (`:song_lyrics`)
 - AZLyrics (`:azlyrics`)
 
-And search passing the author and the song title as parameters to `Finder#search`:
-
-```ruby
-  finder.search 'idina menzel', 'let it go'
-```
-Which will return and array with all the verses of the song as strings, or `nil` if it cannot found the song in any of the websites.
-
 ## Example
 
 In your ruby apps:
 ```ruby
   require 'lyrics_finder'
   
-  finder = Finder.new
+  finder = Lyrics::Finder.new
   @song = finder.search 'idina menzel', 'let it go'
   puts @song
 ```
@@ -62,6 +64,10 @@ LyricsFinder is also available as a command-line tool.
 
 ## Changelog
 
+v 0.0.3
+
+- Wrapped everything into a `Lyrics` module.
+
 v 0.0.2
 
 - Changed the app interface `LyricsFinder::Fetcher` is now `Finder`.
@@ -78,4 +84,8 @@ v 0.0.1
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request
+
+## Credits
+
+Inspired by [Lyricfy](https://github.com/javichito/Lyricfy).

data/bin/lyricsfinder

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require 'lyrics_finder/cli'
-CLI.start
+Lyrics::CLI.start

data/lib/lyrics_finder/cli.rb

@@ -1,12 +1,14 @@
 require 'thor'
 require 'lyrics_finder'
 
-class CLI < Thor
-  desc 'search -a Author -t Song Title', 'Search the lyrics for the specified author and title'
-  method_option 'author', :aliases => '-a', :type => :string
-  method_option 'title', :aliases => '-t', :type => :string
-  def search
-    finder = Finder.new
-    puts finder.search(options[:author], options[:title])
+module Lyrics
+  class CLI < Thor
+    desc 'search -a Author -t Song Title', 'Search the lyrics for the specified author and title'
+    method_option 'author', :aliases => '-a', :type => :string
+    method_option 'title', :aliases => '-t', :type => :string
+    def search
+      finder = Lyrics::Finder.new
+      puts finder.search(options[:author], options[:title])
+    end
   end
 end

data/lib/lyrics_finder/providers/azlyrics.rb

@@ -1,14 +1,16 @@
-module Providers::Azlyrics
-  include Contracts
+module Lyrics
+  module Providers::Azlyrics
+    include Contracts
 
-  Contract Song => String
-  def self.format_url(song)
-    song.format_attributes_with_separator!("")
-    "http://www.azlyrics.com/lyrics/#{song.author}/#{song.title}.html"
-  end
+    Contract Lyrics::Song => String
+    def self.format_url(song)
+      song.format_attributes_with_separator!("")
+      "http://www.azlyrics.com/lyrics/#{song.author}/#{song.title}.html"
+    end
 
-  Contract Tempfile => Or[Array, nil]
-  def self.extract_lyric(data)
-    Providers.extract_lyrics_at_css_from_data('div:nth-child(7)', data)
+    Contract Tempfile => Or[Array, nil]
+    def self.extract_lyric(data)
+      Lyrics::Providers.extract_lyrics_at_css_from_data('div:nth-child(7)', data)
+    end
   end
 end

data/lib/lyrics_finder/providers/lyrics_wikia.rb

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

data/lib/lyrics_finder/providers/song_lyrics.rb

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

data/lib/lyrics_finder/providers.rb

@@ -1,21 +1,23 @@
 require_relative 'song'
 
-module Providers
-  include Contracts
+module Lyrics
+  module Providers
+    include Contracts
 
-  Contract Symbol => Module
-  def self.build_klass(provider)
-    klass = "Providers::" + provider.to_s.camelize
-    klass.constantize
-  end
+    Contract Symbol => Module
+    def self.build_klass(provider)
+      klass = "Lyrics::Providers::" + provider.to_s.camelize
+      klass.constantize
+    end
 
-  def self.extract_lyrics_at_css_from_data(css_element, data)
-    html = Nokogiri::HTML(data)
-    lyrics_container = html.css(css_element).first
-    unless lyrics_container.nil?
-      elements = lyrics_container.children.to_a
-      phrases = elements.select { |el| el.text? && el.text != "\n" && !el.blank? }
-      phrases.map! { |element| element.text.strip }
+    def self.extract_lyrics_at_css_from_data(css_element, data)
+      html = Nokogiri::HTML(data)
+      lyrics_container = html.css(css_element).first
+      unless lyrics_container.nil?
+        elements = lyrics_container.children.to_a
+        phrases = elements.select { |el| el.text? && el.text != "\n" && !el.blank? }
+        phrases.map! { |element| element.text.strip }
+      end
     end
   end
 end

data/lib/lyrics_finder/song.rb

@@ -1,21 +1,23 @@
-class Song
-  attr_accessor :author, :title
+module Lyrics
+  class Song
+    attr_accessor :author, :title
 
-  def initialize(author, title)
-    @author = author
-    @title = title
-  end
+    def initialize(author, title)
+      @author = author
+      @title = title
+    end
 
-  def self.valid?(val)
-    val.is_a?(Song) && !val.author.blank? && !val.title.blank?
-  end
+    def self.valid?(val)
+      val.is_a?(Song) && !val.author.blank? && !val.title.blank?
+    end
 
-  def self.to_s
-    "a valid author and song title please"
-  end
+    def self.to_s
+      "a valid author and song title please"
+    end
 
-  def format_attributes_with_separator!(separator)
-    self.author = I18n.transliterate(@author.strip.gsub(" ", separator))
-    self.title = I18n.transliterate(@title.strip.gsub(" ", separator))
+    def format_attributes_with_separator!(separator)
+      self.author = I18n.transliterate(@author.strip.gsub(" ", separator))
+      self.title = I18n.transliterate(@title.strip.gsub(" ", separator))
+    end
   end
 end

data/lib/lyrics_finder/version.rb

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

data/lib/lyrics_finder.rb

@@ -1,53 +1,55 @@
 require_relative 'lyrics_finder/dependencies'
 
-class Finder
-  include Contracts
-  PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
+module Lyrics
+  class Finder
+    include Contracts
+    PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
 
-  def initialize(*args)
-    @providers = filter_providers(args)
-  end
-
-  def selected_providers
-    @providers
-  end
+    def initialize(*args)
+      @providers = filter_providers(args)
+    end
 
-  def search(author, title)
-    song = Song.new(author, title)
-    perform_search(song)
-  end
+    def selected_providers
+      @providers
+    end
 
-  Contract Song => Or[Array, nil]
-  def perform_search(song)
-    song_lyric = catch(:song_lyric) {
-      @providers.each do |provider|
-        klass = Providers.build_klass(provider)
-        url = klass.format_url(song)
+    def search(author, title)
+      song = Song.new(author, title)
+      perform_search(song)
+    end
 
-        data = perform_request(url)
-        result = klass.extract_lyric(data) if data
-        throw :song_lyric, result unless result.nil?
-      end
-    }
-    # because if it doesn't find anything returns @providers by default
-    song_lyric != @providers ? song_lyric : nil
-  end
+    Contract Lyrics::Song => Or[Array, nil]
+    def perform_search(song)
+      song_lyric = catch(:song_lyric) {
+        @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
+      }
+      # because if it doesn't find anything returns @providers by default
+      song_lyric != @providers ? song_lyric : nil
+    end
 
-  private
+    private
 
-  def filter_providers(providers)
-    valid_providers = []
-    providers.each do |provider|
-      valid_providers << provider if PROVIDERS_LIST.include?(provider)
+    def filter_providers(providers)
+      valid_providers = []
+      providers.each do |provider|
+        valid_providers << provider if PROVIDERS_LIST.include?(provider)
+      end
+      valid_providers.any? ? valid_providers : PROVIDERS_LIST
     end
-    valid_providers.any? ? valid_providers : PROVIDERS_LIST
-  end
 
-  def perform_request(url)
-    begin
-      open(url)
-    rescue Exception => ex
-      # puts "ERROR: " + ex.message
+    def perform_request(url)
+      begin
+        open(url)
+      rescue Exception => ex
+        # puts "ERROR: " + ex.message
+      end
     end
   end
 end

data/spec/lyrics_finder/lyrics_finder_spec.rb

@@ -1,16 +1,16 @@
-describe Finder do
+describe Lyrics::Finder do
   describe 'sets @providers properly on initialization' do
     context 'without specifying providers' do
-      let(:finder) { Finder.new }
+      let(:finder) { Lyrics::Finder.new }
 
       it 'sets @providers to default PROVIDERS_LIST' do
-        expect(finder.selected_providers).to eq Finder::PROVIDERS_LIST
+        expect(finder.selected_providers).to eq Lyrics::Finder::PROVIDERS_LIST
       end
     end
 
     context 'specifying providers' do
       context 'some providers are invalid' do
-        let(:finder) { Finder.new(:lyrics_wikia, :bad_songs) }
+        let(:finder) { Lyrics::Finder.new(:lyrics_wikia, :bad_songs) }
         
         it 'filters invalid providers' do
           expect(finder.selected_providers).to match_array [:lyrics_wikia]
@@ -18,10 +18,10 @@ describe Finder do
       end
 
       context 'all providers are invalid' do
-        let(:finder) { Finder.new(:bad_songs, :invalid_songs) }
+        let(:finder) { Lyrics::Finder.new(:bad_songs, :invalid_songs) }
         
         it 'sets @providers to default PROVIDERS_LIST' do
-          expect(finder.selected_providers).to eq Finder::PROVIDERS_LIST
+          expect(finder.selected_providers).to eq Lyrics::Finder::PROVIDERS_LIST
         end
       end
     end
@@ -31,7 +31,7 @@ describe Finder do
     describe 'using LyricsWikia as the provider' do
       context 'with a song that can be found' do
         before :each do
-          @finder = Finder.new(:lyrics_wikia)
+          @finder = Lyrics::Finder.new(:lyrics_wikia)
           VCR.use_cassette 'LyricsWikia 200 search' do
             @song = @finder.search("american authors", "best day of my life")
           end
@@ -49,7 +49,7 @@ describe Finder do
       # Searching for a song that exist but it's not yet on this website.
       context 'with a song that cannot be found' do
         before :each do
-          @finder = Finder.new(:lyrics_wikia)
+          @finder = Lyrics::Finder.new(:lyrics_wikia)
           VCR.use_cassette 'LyricsWikia Song does not exist search' do
             @song = @finder.search("arctic monkeys", "do i wanna know")
           end
@@ -63,7 +63,7 @@ describe Finder do
 
     describe 'using Azlyrics as the provider' do
       before :each do
-        @finder = Finder.new(:azlyrics)
+        @finder = Lyrics::Finder.new(:azlyrics)
         VCR.use_cassette 'Azlyrics 200 search' do
           @song = @finder.search("american authors", "best day of my life")
         end
@@ -80,7 +80,7 @@ describe Finder do
 
     describe 'using SongLyrics as the provider' do
       before :each do
-        @finder = Finder.new(:song_lyrics)
+        @finder = Lyrics::Finder.new(:song_lyrics)
         VCR.use_cassette 'SongLyrics 200 search' do
           @song = @finder.search("american authors", "best day of my life")
         end
@@ -99,7 +99,7 @@ describe Finder do
     # it just redirect to the root url www.lyricsmania.com
     # describe 'using LyricsMania as the provider' do
     #   before :each do
-    #     @finder = Finder.new(:lyrics_mania)
+    #     @finder = Lyrics::Finder.new(:lyrics_mania)
     #     VCR.use_cassette 'LyricsMania 200 search' do
     #       @song = @finder.search("american authors", "best day of my life")
     #     end
@@ -116,7 +116,7 @@ describe Finder do
 
     describe 'with a song that cannot be found' do
       before :each do
-        @finder = Finder.new
+        @finder = Lyrics::Finder.new
         VCR.use_cassette 'Nonexistent Song 404 search' do
           @song = @finder.search("the foobar band", "rubynation")
         end
@@ -128,7 +128,7 @@ describe Finder do
     end
 
     describe 'with invalid parameters' do
-      let(:finder) { Finder.new }
+      let(:finder) { Lyrics::Finder.new }
 
       it 'fails with ContractError' do
         expect{

data/spec/lyrics_finder/providers/azlyrics_spec.rb

@@ -1,9 +1,9 @@
 # encoding: UTF-8
-describe Providers::Azlyrics do
+describe Lyrics::Providers::Azlyrics do
   describe '.format_url' do
     context 'with valid author and title' do
-      let(:klass) { Providers::Azlyrics }
-      let(:song) { Song.new("amêricàn authors", "best day of my life") }
+      let(:klass) { Lyrics::Providers::Azlyrics }
+      let(:song) { Lyrics::Song.new("amêricàn authors", "best day of my life") }
       let(:valid_url) { "http://www.azlyrics.com/lyrics/americanauthors/bestdayofmylife.html" }
 
       it 'returns a properly formatted url' do

data/spec/lyrics_finder/providers/lyrics_wikia_spec.rb

@@ -1,9 +1,9 @@
 # encoding: UTF-8
-describe Providers::LyricsWikia do
+describe Lyrics::Providers::LyricsWikia do
   describe '.format_url' do
     context 'with valid author and title' do
-      let(:klass) { Providers::LyricsWikia }
-      let(:song) { Song.new("amëricán authòrs", "best day of my life") }
+      let(:klass) { Lyrics::Providers::LyricsWikia }
+      let(:song) { Lyrics::Song.new("amëricán authòrs", "best day of my life") }
       let(:valid_url) { "http://lyrics.wikia.com/american_authors:best_day_of_my_life" }
 
       it 'returns a properly formatted url' do
@@ -12,7 +12,7 @@ describe Providers::LyricsWikia do
     end
 
     context 'with invalid author or title' do
-      let(:klass) { Providers::LyricsWikia }
+      let(:klass) { Lyrics::Providers::LyricsWikia }
 
       it 'with non-string arguments raises a ContractError Exception' do
         expect{
@@ -31,7 +31,7 @@ describe Providers::LyricsWikia do
   describe '.extract_lyric' do
     # with valid data it's already tested in lyrics_finder_spec.rb
     context 'with invalid data' do
-      let(:klass) { Providers::LyricsWikia }
+      let(:klass) { Lyrics::Providers::LyricsWikia }
 
       it 'raises a ContractError Exception' do
         expect{

data/spec/lyrics_finder/providers/song_lyrics_spec.rb

@@ -1,9 +1,9 @@
 # encoding: UTF-8
-describe Providers::SongLyrics do
+describe Lyrics::Providers::SongLyrics do
   describe '.format_url' do
     context 'with valid author and title' do
-      let(:klass) { Providers::SongLyrics}
-      let(:song) { Song.new("amêricàn authors", "best day of my life") }
+      let(:klass) { Lyrics::Providers::SongLyrics}
+      let(:song) { Lyrics::Song.new("amêricàn authors", "best day of my life") }
       let(:valid_url) { "http://www.songlyrics.com/american-authors/best-day-of-my-life-lyrics/" }
 
       it 'returns a properly formatted url' do

data/spec/lyrics_finder/providers_spec.rb

@@ -1,17 +1,17 @@
-describe Providers do
+describe Lyrics::Providers do
   describe '.build_klass' do
     context 'with valid arguments' do
-      let(:klass) { Providers::LyricsWikia }
+      let(:klass) { Lyrics::Providers::LyricsWikia }
 
       it 'builds the correct class' do
-        expect(Providers.build_klass(:lyrics_wikia)).to eq klass
+        expect(Lyrics::Providers.build_klass(:lyrics_wikia)).to eq klass
       end
     end
 
     context 'with invalid arguments' do
       it 'raises a ContractError Exception' do
         expect{
-          Providers.build_klass("klass")
+          Lyrics::Providers.build_klass("klass")
         }.to raise_error ContractError
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lyrics_finder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.1
 platform: ruby
 authors:
 - Daniel Romero
@@ -216,11 +216,6 @@ files:
 - spec/support/lyrics_wikia_sample_songs.rb
 - spec/support/song_lyrics_sample_songs.rb
 - spec/support/vcr_setup.rb
-- spec/vcr_cassettes/Azlyrics_200_search.yml
-- spec/vcr_cassettes/LyricsWikia_200_search.yml
-- spec/vcr_cassettes/LyricsWikia_Song_does_not_exist_search.yml
-- spec/vcr_cassettes/Nonexistent_Song_404_search.yml
-- spec/vcr_cassettes/SongLyrics_200_search.yml
 homepage: https://github.com/dnlR/lyrics_finder
 licenses:
 - MIT
@@ -256,8 +251,3 @@ test_files:
 - spec/support/lyrics_wikia_sample_songs.rb
 - spec/support/song_lyrics_sample_songs.rb
 - spec/support/vcr_setup.rb
-- spec/vcr_cassettes/Azlyrics_200_search.yml
-- spec/vcr_cassettes/LyricsWikia_200_search.yml
-- spec/vcr_cassettes/LyricsWikia_Song_does_not_exist_search.yml
-- spec/vcr_cassettes/Nonexistent_Song_404_search.yml
-- spec/vcr_cassettes/SongLyrics_200_search.yml