lyrics_finder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc26dd72ab5b067f0b65825a0cf201814d78c435
-  data.tar.gz: 193e8cccb5a6017c1e6a064744bd24ab52763cda
+  metadata.gz: 57cc0f1e4ad122a9fde9703f7a422db906bda1b2
+  data.tar.gz: ec34c7b3f0598f39dcd1073bfb42d086df8cc629
 SHA512:
-  metadata.gz: 979ecf3aa994a3091e79c9821d6fecc227f7286da1a728b6f314db0215971df116ec02bc3c63dc719989ca20f945b79c69953a181eb9b7483a9ff4aa98433071
-  data.tar.gz: 65747552f08a99b6e3935fdb7bffa1060fd1d99ff492cc7a0b8473d5a3ebba4f30e04f15c0f8ffbb9d852ad0844116a38f06307f31a9eb62fd6a5f65488d1c42
+  metadata.gz: 04d13064bd6d959785a314df9fa1943aa6b77c9d22887040addb62014ca7fa82311d3c6d78b7321ace0e24500e495f247d1354a0f8a341ca8f767197ae51b98e
+  data.tar.gz: f5c787f0727f686cafaf6611b6208a29d8d72c6ef262e8a2d9e10ac624eb17134e0dbe79bfef04ebdf4e824f29feca7c21419d1a6afc9aeba160b3a21e106200

data/README.md

@@ -1,4 +1,4 @@
-# LyricsFinder [![Build Status](https://travis-ci.org/dnlR/lyrics_finder.svg?branch=master)](https://travis-ci.org/dnlR/lyrics_finder) [![Coverage Status](https://img.shields.io/coveralls/dnlR/lyrics_finder.svg)](https://coveralls.io/r/dnlR/lyrics_finder?branch=master) [![endorse](https://api.coderwall.com/dnlr/endorsecount.png)](https://coderwall.com/dnlr)
+# LyricsFinder [![Gem Version](https://badge.fury.io/rb/lyrics_finder.svg)](http://badge.fury.io/rb/lyrics_finder) [![Build Status](https://travis-ci.org/dnlR/lyrics_finder.svg?branch=master)](https://travis-ci.org/dnlR/lyrics_finder) [![Coverage Status](https://img.shields.io/coveralls/dnlR/lyrics_finder.svg)](https://coveralls.io/r/dnlR/lyrics_finder?branch=master) [![endorse](https://api.coderwall.com/dnlr/endorsecount.png)](https://coderwall.com/dnlr)
 
 Simple library to search for song lyrics 
 
@@ -18,28 +18,28 @@ Or install it yourself as:
 
 ## Hello World!
 
-Create an instance of `LyricsFinder::Fetcher`:
+Create an instance of `Finder`:
 
 ```ruby
-  fetcher = LyricsFinder::Fetcher.new
+  finder = Finder.new
 ```
 
 You can specify which websites are you going to get the lyrics from:
 
 ```ruby
-  fetcher = LyricsFinder::Fetcher.new(:song_lyrics, :azlyrics)
+  finder = Finder.new(:song_lyrics, :azlyrics)
 ```
 
 You can choose among the following:
 
-- LyricsWikia
-- SongLyrics
-- AZLyrics
+- LyricsWikia (`:lyrics_wikia`)
+- SongLyrics (`:song_lyrics`)
+- AZLyrics (`:azlyrics`)
 
-And search passing the author and the song title as parameters to `Fetcher#search`:
+And search passing the author and the song title as parameters to `Finder#search`:
 
 ```ruby
-  fetcher.search 'idina menzel', 'let it go'
+  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.
 
@@ -49,8 +49,8 @@ In your ruby apps:
 ```ruby
   require 'lyrics_finder'
   
-  fetcher = LyricsFinder::Fetcher.new
-  @song = fetcher.search 'idina menzel', 'let it go'
+  finder = Finder.new
+  @song = finder.search 'idina menzel', 'let it go'
   puts @song
 ```
     
@@ -62,9 +62,15 @@ LyricsFinder is also available as a command-line tool.
 
 ## Changelog
 
+v 0.0.2
+
+- Changed the app interface `LyricsFinder::Fetcher` is now `Finder`.
+- Now using [Contracts](https://github.com/egonSchiele/contracts.ruby).
+- Simplified providers code.
+
 v 0.0.1
 
-- Initial release
+- Initial release.
 
 ## Contributing
 
@@ -72,8 +78,4 @@ 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
-
-## Credits
-
-Inspired by [Lyricfy](https://github.com/javichito/Lyricfy).
+5. Create a new Pull Request

data/bin/lyricsfinder

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

data/lib/lyrics_finder/cli.rb

@@ -1,14 +1,12 @@
 require 'thor'
 require 'lyrics_finder'
 
-module LyricsFinder
-  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
-      fetcher = LyricsFinder::Fetcher.new
-      puts fetcher.search(options[:author], options[:title])
-    end
+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])
   end
 end

data/lib/lyrics_finder/dependencies.rb

@@ -4,7 +4,6 @@ require 'active_support/core_ext'
 require 'i18n'
 I18n.enforce_available_locales = false
 require 'contracts'
-include Contracts
 
 require_relative 'version'
 require_relative 'providers'

data/lib/lyrics_finder/providers/azlyrics.rb

@@ -1,19 +1,14 @@
-module LyricsFinder::Providers::Azlyrics
-  def format_url(author, title)
-    author = I18n.transliterate(author.strip.gsub(" ", ""))
-    title = I18n.transliterate(title.strip.gsub(" ", ""))
-    "http://www.azlyrics.com/lyrics/#{author}/#{title}.html"
+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
-  module_function :format_url
 
-  def extract_lyric(data)
-    html = Nokogiri::HTML(data)
-    lyrics_container = html.css('div:nth-child(7)').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
+  Contract Tempfile => Or[Array, nil]
+  def self.extract_lyric(data)
+    Providers.extract_lyrics_at_css_from_data('div:nth-child(7)', data)
   end
-  module_function :extract_lyric
 end

data/lib/lyrics_finder/providers/lyrics_wikia.rb

@@ -1,23 +1,14 @@
-module LyricsFinder::Providers::LyricsWikia
-  #Contract lambda { |a, s| !a.blank? && !s.blank? } => String
-  Contract String, String => String
-  def format_url(author, title)
-    author = I18n.transliterate(author.strip.gsub(" ", "_"))
-    title = I18n.transliterate(title.strip.gsub(" ", "_"))
-    "http://lyrics.wikia.com/#{author}:#{title}"
+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
-  module_function :format_url
 
-  #Contract lambda { |x| x.is_a? Tempfile } => Module
-  Contract lambda { |x| x.is_a? Tempfile } => Array
-  def extract_lyric(data)
-    html = Nokogiri::HTML(data)
-    lyrics_container = html.css('.lyricbox').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
+  Contract Tempfile => Or[Array, nil]
+  def self.extract_lyric(data)
+    Providers.extract_lyrics_at_css_from_data('.lyricbox', data)
   end
-  module_function :extract_lyric
 end

data/lib/lyrics_finder/providers/song_lyrics.rb

@@ -1,19 +1,14 @@
-module LyricsFinder::Providers::SongLyrics
-  def format_url(author, title)
-    author = I18n.transliterate(author.strip.gsub(" ", "-"))
-    title = I18n.transliterate(title.strip.gsub(" ", "-"))
-    "http://www.songlyrics.com/#{author}/#{title}-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
-  module_function :format_url
 
-  def extract_lyric(data)
-    html = Nokogiri::HTML(data)
-    lyrics_container = html.css('#songLyricsDiv').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
+  Contract Tempfile => Or[Array, nil]
+  def self.extract_lyric(data)
+    Providers.extract_lyrics_at_css_from_data('#songLyricsDiv', data)
   end
-  module_function :extract_lyric
 end

data/lib/lyrics_finder/providers.rb

@@ -1,8 +1,21 @@
-module LyricsFinder::Providers
+require_relative 'song'
+
+module Providers
+  include Contracts
+
   Contract Symbol => Module
-  def build_klass(provider)
-    klass = "LyricsFinder::Providers::" + provider.to_s.camelize
+  def self.build_klass(provider)
+    klass = "Providers::" + provider.to_s.camelize
     klass.constantize
   end
-  module_function :build_klass
+
+  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

data/lib/lyrics_finder/song.rb

@@ -0,0 +1,21 @@
+class Song
+  attr_accessor :author, :title
+
+  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.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))
+  end
+end

data/lib/lyrics_finder/version.rb

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

data/lib/lyrics_finder.rb

@@ -1,53 +1,53 @@
 require_relative 'lyrics_finder/dependencies'
 
-module LyricsFinder
-  class Fetcher
-    PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
-    UsageError = Class.new(StandardError)
-    attr_reader :providers
-
-    def initialize(*args)
-      @providers = filter_providers(args)
-    end
+class Finder
+  include Contracts
+  PROVIDERS_LIST = [:lyrics_wikia, :song_lyrics, :azlyrics]
 
-    def search(author, title)
-      validate_song_data(author, title)
-      song_lyric = catch(:song_lyric) {
-        @providers.each do |provider|
-          klass = Providers.build_klass(provider)
-          url = klass.format_url(author, title)
-
-          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
+  def initialize(*args)
+    @providers = filter_providers(args)
+  end
 
-    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
+  def selected_providers
+    @providers
+  end
+
+  def search(author, title)
+    song = Song.new(author, title)
+    perform_search(song)
+  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 validate_song_data(author, title)
-      if author.blank? || title.blank?
-        fail UsageError, "You must supply a valid author and title"
+        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
+
+  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
 
-    def perform_request(url)
-      begin
-        open(url)
-      rescue Exception => ex
-        # puts "ERROR: " + ex.message
-      end
+  def perform_request(url)
+    begin
+      open(url)
+    rescue Exception => ex
+      # puts "ERROR: " + ex.message
     end
   end
 end

data/lyrics_finder.gemspec

@@ -22,14 +22,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
 
   spec.add_development_dependency 'rspec', '~> 2.14.0'
-  spec.add_development_dependency 'rspec-nc', '0.0.6'
-  spec.add_development_dependency 'vcr', '2.9.2'
-  spec.add_development_dependency 'webmock', '1.18.0'
-  spec.add_development_dependency 'coveralls', '0.7.0'
+  spec.add_development_dependency 'rspec-nc', '~> 0.0.6'
+  spec.add_development_dependency 'vcr', '~> 2.9.2'
+  spec.add_development_dependency 'webmock', '~> 1.18.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7.0'
 
-  spec.add_dependency 'nokogiri', '1.6.1'
-  spec.add_dependency 'activesupport', '4.1.1'
-  spec.add_dependency 'i18n', '0.6.9'
+  spec.add_dependency 'nokogiri', '~> 1.6.1'
+  spec.add_dependency 'activesupport', '~> 4.1.1'
+  spec.add_dependency 'i18n', '~> 0.6.9'
   spec.add_dependency 'contracts', '0.4'
-  spec.add_dependency 'thor', '0.19.1'
+  spec.add_dependency 'thor', '~> 0.19.1'
 end

data/spec/{lyrics_finder_spec.rb → lyrics_finder/lyrics_finder_spec.rb}

@@ -1,27 +1,27 @@
-describe LyricsFinder::Fetcher do
+describe Finder do
   describe 'sets @providers properly on initialization' do
     context 'without specifying providers' do
-      let(:fetcher) { LyricsFinder::Fetcher.new }
+      let(:finder) { Finder.new }
 
       it 'sets @providers to default PROVIDERS_LIST' do
-        expect(fetcher.providers).to eq LyricsFinder::Fetcher::PROVIDERS_LIST
+        expect(finder.selected_providers).to eq Finder::PROVIDERS_LIST
       end
     end
 
     context 'specifying providers' do
       context 'some providers are invalid' do
-        let(:fetcher) { LyricsFinder::Fetcher.new(:lyrics_wikia, :bad_songs) }
+        let(:finder) { Finder.new(:lyrics_wikia, :bad_songs) }
         
         it 'filters invalid providers' do
-          expect(fetcher.providers).to match_array [:lyrics_wikia]
+          expect(finder.selected_providers).to match_array [:lyrics_wikia]
         end
       end
 
       context 'all providers are invalid' do
-        let(:fetcher) { LyricsFinder::Fetcher.new(:bad_songs, :invalid_songs) }
+        let(:finder) { Finder.new(:bad_songs, :invalid_songs) }
         
         it 'sets @providers to default PROVIDERS_LIST' do
-          expect(fetcher.providers).to eq LyricsFinder::Fetcher::PROVIDERS_LIST
+          expect(finder.selected_providers).to eq Finder::PROVIDERS_LIST
         end
       end
     end
@@ -31,9 +31,9 @@ describe LyricsFinder::Fetcher do
     describe 'using LyricsWikia as the provider' do
       context 'with a song that can be found' do
         before :each do
-          @fetcher = LyricsFinder::Fetcher.new(:lyrics_wikia)
+          @finder = Finder.new(:lyrics_wikia)
           VCR.use_cassette 'LyricsWikia 200 search' do
-            @song = @fetcher.search("american authors", "best day of my life")
+            @song = @finder.search("american authors", "best day of my life")
           end
         end
 
@@ -49,9 +49,9 @@ describe LyricsFinder::Fetcher 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
-          @fetcher = LyricsFinder::Fetcher.new(:lyrics_wikia)
+          @finder = Finder.new(:lyrics_wikia)
           VCR.use_cassette 'LyricsWikia Song does not exist search' do
-            @song = @fetcher.search("arctic monkeys", "do i wanna know")
+            @song = @finder.search("arctic monkeys", "do i wanna know")
           end
         end
 
@@ -63,9 +63,9 @@ describe LyricsFinder::Fetcher do
 
     describe 'using Azlyrics as the provider' do
       before :each do
-        @fetcher = LyricsFinder::Fetcher.new(:azlyrics)
+        @finder = Finder.new(:azlyrics)
         VCR.use_cassette 'Azlyrics 200 search' do
-          @song = @fetcher.search("american authors", "best day of my life")
+          @song = @finder.search("american authors", "best day of my life")
         end
       end
 
@@ -80,9 +80,9 @@ describe LyricsFinder::Fetcher do
 
     describe 'using SongLyrics as the provider' do
       before :each do
-        @fetcher = LyricsFinder::Fetcher.new(:song_lyrics)
+        @finder = Finder.new(:song_lyrics)
         VCR.use_cassette 'SongLyrics 200 search' do
-          @song = @fetcher.search("american authors", "best day of my life")
+          @song = @finder.search("american authors", "best day of my life")
         end
       end
 
@@ -99,9 +99,9 @@ describe LyricsFinder::Fetcher do
     # it just redirect to the root url www.lyricsmania.com
     # describe 'using LyricsMania as the provider' do
     #   before :each do
-    #     @fetcher = LyricsFinder::Fetcher.new(:lyrics_mania)
+    #     @finder = Finder.new(:lyrics_mania)
     #     VCR.use_cassette 'LyricsMania 200 search' do
-    #       @song = @fetcher.search("american authors", "best day of my life")
+    #       @song = @finder.search("american authors", "best day of my life")
     #     end
     #   end
     #
@@ -116,9 +116,9 @@ describe LyricsFinder::Fetcher do
 
     describe 'with a song that cannot be found' do
       before :each do
-        @fetcher = LyricsFinder::Fetcher.new
+        @finder = Finder.new
         VCR.use_cassette 'Nonexistent Song 404 search' do
-          @song = @fetcher.search("the foobar band", "rubynation")
+          @song = @finder.search("the foobar band", "rubynation")
         end
       end
 
@@ -128,13 +128,12 @@ describe LyricsFinder::Fetcher do
     end
 
     describe 'with invalid parameters' do
-      let(:fetcher) { LyricsFinder::Fetcher.new }
+      let(:finder) { Finder.new }
 
-      it 'fails with UsageError' do
+      it 'fails with ContractError' do
         expect{
-          fetcher.search("", "")
-        }.to raise_error( LyricsFinder::Fetcher::UsageError,
-                          "You must supply a valid author and title")
+          finder.search("","")
+        }.to raise_error ContractError
       end
     end
   end # '#search'