lyricfy 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lyricfy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Javier Hidalgo
+
+MIT License
+
+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,56 @@
+# Lyricfy
+
+Song Lyrics for your Ruby apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lyricfy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lyricfy
+
+## Usage
+
+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'
+    puts lyric.body.join('\n')
+
+The <code>Lyricfy::Fetcher#search</code> method returns an OpenStruct object with the following methods:
+
+- artist
+- song
+- body
+
+Where artist is the artist name, song is the song title and body is an Array of the lyric paragraphs.
+
+### How does it work?
+
+Under the hood, this library fetch the songs lyrics by scraping some websites called "Providers". The currently supported providers are:
+
+- [Wikia](http://lyrics.wikia.com/Lyrics_Wiki)
+- [MetroLyrics](http://www.metrolyrics.com/)
+
+By default this gem will recursively search for the lyric on each of the providers, if the lyric is not found it will return nil. You can also tell Lyricfy to only use the provider(s) that you want.
+
+    fetcher = Lyricfy::Fetcher.new(:metro_lyrics)
+    lyric = fetcher.search 'Coldplay', 'Viva la vida'
+    puts lyric.body.join('\n')
+
+In this case Lyricfy will look for the lyric only on [MetroLyrics](http://www.metrolyrics.com/).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb', 'test/providers/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/lib/lyricfy/lyric_provider.rb

@@ -0,0 +1,17 @@
+module Lyricfy
+  class LyricProvider
+    attr_accessor :base_url, :url, :parameters
+
+    def initialize(parameters = {})
+      self.parameters = parameters
+    end
+
+    def search
+      begin
+        data = open(self.url)
+      rescue OpenURI::HTTPError
+        nil
+      end
+    end
+  end
+end

data/lib/lyricfy/providers/metro_lyrics.rb

@@ -0,0 +1,32 @@
+module Lyricfy
+  class MetroLyrics < Lyricfy::LyricProvider
+    include URIHelper
+
+    def initialize(parameters)
+      super(parameters)
+      self.base_url = "http://m.metrolyrics.com/"
+      self.url = URI.escape(self.base_url + format_parameters)
+    end
+
+    def search
+      if data =  super
+        html = Nokogiri::HTML(data)
+        container = html.css('p.lyricsbody').first || html.css('p.gnlyricsbody').first
+        elements = container.children.to_a
+        paragraphs = elements.select { |ele| ele.text? }
+        paragraphs.map! { |paragraph| paragraph.text.strip.chomp if paragraph.text != "\n" }.reject! { |ele| ele.empty? }
+      end
+    end
+
+    private
+    def prepare_parameter(parameter)
+      parameter.downcase.split(' ').map { |w| w.gsub(/\W/, '') }.join('-')
+    end
+
+    def format_parameters
+      artist_name = prepare_parameter(self.parameters[:artist_name])
+      song_name = prepare_parameter(self.parameters[:song_name])
+      "#{song_name}-lyrics-#{artist_name}"
+    end
+  end
+end

data/lib/lyricfy/providers/wikia.rb

@@ -0,0 +1,28 @@
+module Lyricfy
+  class Wikia < Lyricfy::LyricProvider
+    include URIHelper
+
+    def initialize(parameters)
+      super(parameters)
+      self.base_url = "http://lyrics.wikia.com/"
+      self.url = URI.escape(self.base_url + format_parameters)
+    end
+
+    def search
+      if data = super
+        html = Nokogiri::HTML(data)
+        container = html.css('div.lyricbox').first
+        elements = container.children.to_a
+        paragraphs = elements.select { |ele| ele.text? }
+        paragraphs.map! { |paragraph| paragraph.text.strip.chomp if paragraph.text != "\n" }.reject! { |ele| ele.nil? }
+      end
+    end
+
+    private
+    def format_parameters
+      artist_name = tilde_to_vocal(self.parameters[:artist_name]).gsub(" ", "_")
+      song_name = tilde_to_vocal(self.parameters[:song_name]).gsub(" ", "_")
+      "#{artist_name}:#{song_name}"
+    end
+  end
+end

data/lib/lyricfy/uri_helper.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+module Lyricfy
+  module URIHelper
+    def tilde_to_vocal(string)
+      string.split('').map do |c|
+        case c
+            when "á" then "a"
+            when "é" then "e"
+            when "í" then "i"
+            when "ó" then "o"
+            when "ú" then "u"
+            else c
+        end
+      end.join('')
+    end
+  end
+end

data/lib/lyricfy/version.rb

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

data/lib/lyricfy.rb

@@ -0,0 +1,42 @@
+require 'ostruct'
+require "open-uri"
+require "nokogiri"
+require_relative "lyricfy/version"
+require_relative "lyricfy/uri_helper"
+require_relative "lyricfy/lyric_provider"
+require_relative "lyricfy/providers/wikia"
+require_relative "lyricfy/providers/metro_lyrics"
+
+module Lyricfy
+  class Fetcher
+    attr_reader :providers
+
+    def initialize(*args)
+      @providers = {
+        wikia: Wikia,
+        metro_lyrics: MetroLyrics
+      }
+
+      if !args.empty?
+        passed_providers = {}
+        args.each do |provider|
+          raise Exception if !@providers.has_key?(provider)
+          passed_providers[provider] = @providers[provider]
+        end
+        @providers = passed_providers
+      end
+    end
+
+    def search(artist, song)
+      result = nil
+      @providers.each_pair do |provider, klass|
+        fetcher = klass.new(artist_name: artist, song_name: song)
+
+        if lyric_body = fetcher.search
+          result =  OpenStruct.new(artist: artist, song: song, body: lyric_body)
+        end
+      end
+      result
+    end
+  end
+end

data/lyricfy.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lyricfy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "lyricfy"
+  gem.version       = Lyricfy::VERSION
+  gem.authors       = ["Javier Hidalgo"]
+  gem.email         = ["hola@soyjavierhidalgo.com"]
+  gem.description   = %q{Song Lyrics for your Ruby apps}
+  gem.summary       = %q{Lyricfy lets you get song lyrics that you can use on your apps}
+  gem.homepage      = "https://github.com/javichito/lyricfy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "nokogiri", [">= 1.3.3"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock", ["1.8.0"]
+  gem.add_development_dependency "vcr", ["~> 2.4.0"]
+end