blue_conductor 0.0.1 → 0.1.0

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 Usage is easy. Call .song_for on the BlueConductor object and pass in a band name and song title.
 
 ```ruby  
-  BlueConductor.song_for('The Dear Hunter', 'The Church and the Dime')
+  BlueConductor.song_for('Van Halen', 'Panama')
 ```
 
 
@@ -30,9 +30,25 @@ Which will return a BlueConductor::Song object containing the following fields
   * `title`
   * `band`
   * `lyrics`
+  * `album`
+
+Calling title or band will return the information that you originally passed in to the BlueConductor. Calling .lyrics will return the lyrics of that song as provided by songlyrics.com. If the lyrics to a song you entered in either do not exist, are not on the songlyrics website or if there was a spelling error, then calling .lyrics will return a string saying 'Sorry we do not have the requested lyrics'. Calling .album will return the album that the song is on.
+
+BlueConductor has a second method called .record_for. Simply pass in the band name and the name of your favorite album and it will return an array of song objects containing the information of each song.
+
+```ruby
+  BlueConductor.record_for('Van Halen', '1984')
+```
+
+Now, this method returns a BlueConductor::Producer objects that has the following fields on it
+
+  * `title`
+  * `band`
+  * `songs`
+  * `image`
   * `error`
 
-Calling title or band will return the information that you originally passed in to the BlueConductor. Calling .lyrics will return the lyrics of that song as provided by azlyrics.com. If the lyrics to a song you entered in either do not exist, are not on the azlyrics website or if there was a spelling error, then calling .lyrics will return a nil object and an error message will be placed in the .error field.
+Title and band are obviously set to the values that you pass in. The .songs field though returns an array of BlueConductor::Song objects each with specific information about each song on the album provided. .image contains the image source of the album art and the error field only contains a string if the album/band you provided is not on songlyrics.com.
 
 ##CLI
 

data/blue_conductor.gemspec

@@ -6,10 +6,10 @@ require "blue_conductor/version"
 Gem::Specification.new do |gem|
   gem.name          = "blue_conductor"
   gem.version       = BlueConductor::VERSION
-  gem.authors       = ["Alex Williams", "Craig Williams"]
+  gem.authors       = ["Alex Williams"]
   gem.email         = ["alexwilliams4@me.com"]
-  gem.description   = %q{Scrapes azLyrics.com for song lyrics}
-  gem.summary       = %q{azlyrics.com scraper}
+  gem.description   = %q{Scrapes songlyrics.com for song lyrics}
+  gem.summary       = %q{songlyrics.com scraper}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)

data/lib/blue_conductor.rb

@@ -1,25 +1,39 @@
 require 'open-uri'
 require 'nokogiri'
+require 'net/http'
 
 require_relative 'blue_conductor/version'
 require_relative 'blue_conductor/band_manager'
-require_relative 'blue_conductor/sanitizer'
-require_relative 'blue_conductor/http/request'
-require_relative 'blue_conductor/http/response'
-require_relative 'blue_conductor/http/url_generator'
+require_relative 'blue_conductor/producer'
 require_relative 'blue_conductor/song'
 
+require_relative 'blue_conductor/http/request'
+
+require_relative 'blue_conductor/http/song/sanitizer'
+require_relative 'blue_conductor/http/song/response'
+require_relative 'blue_conductor/http/song/url_generator'
+
+require_relative 'blue_conductor/http/record/sanitizer'
+require_relative 'blue_conductor/http/record/response'
+require_relative 'blue_conductor/http/record/url_generator'
+
+
 module BlueConductor
   def self.song_for(band, song)
     manager               = BlueConductor::BandManager.new(band, song)
-    manager.url_generator = BlueConductor::HTTP::UrlGenerator
+    manager.url_generator = BlueConductor::HTTP::Song::UrlGenerator
     manager.request       = BlueConductor::HTTP::Request
-    manager.parser        = BlueConductor::HTTP::Response
+    manager.parser        = BlueConductor::HTTP::Song::Response
 
     manager.song!
   end
 
   def self.record_for(band, record_title)
-    # BlueConductor::BandManager.new(band, song).record!
+    producer               = BlueConductor::Producer.new(band, record_title)
+    producer.url_generator = BlueConductor::HTTP::Record::UrlGenerator
+    producer.request       = BlueConductor::HTTP::Request
+    producer.parser        = BlueConductor::HTTP::Record::Response
+
+    producer.record!
   end
 end

data/lib/blue_conductor/band_manager.rb

@@ -1,12 +1,12 @@
 module BlueConductor
   class BandManager
-    attr_reader :band, :song, :data, :error
+    attr_reader :band, :song, :data, :album
     attr_accessor :url_generator, :request, :parser
 
     def initialize(band, song)
       @band = band
       @song = song
-      @error = ''
+      @album = ''
       @data = ''
     end
 
@@ -14,11 +14,8 @@ module BlueConductor
       url   = url_generator.generate(self)
       html  = request.fetch(url)
 
-      if html
-        @data = parser.parse(html)
-      else
-        @error = 'The band/song does not exist || there was a spelling error'
-      end
+      @data = parser.data(html)
+      @album = parser.album(html)
 
       BlueConductor::Song.new(self)
     end

data/lib/blue_conductor/http/record/response.rb

@@ -0,0 +1,19 @@
+module BlueConductor
+  module HTTP
+    module Record
+      class Response
+
+        def self.parse(html)
+          doc = Nokogiri::HTML(html)
+          doc.css('.rightcol .tracklist td a').map(&:text)
+        end
+
+        def self.parse_image(html)
+          doc = Nokogiri::HTML(html)
+          doc.css('.leftcol img')[0]['src']
+        end
+      end
+    end
+  end
+end
+

data/lib/blue_conductor/http/record/sanitizer.rb

@@ -0,0 +1,25 @@
+module BlueConductor
+  module HTTP
+    module Record
+      class Sanitizer
+        UNWANTED_CHARS = %r([^a-zA-Z0-9])
+
+        attr_reader :band, :title
+
+        def initialize(producer)
+          @band = producer.band
+          @title = producer.title
+        end
+
+        def clean
+          @band = strip(@band)
+          @title = strip(@title)
+        end
+
+        def strip(str)
+          str.downcase.gsub(UNWANTED_CHARS, "-")
+        end
+      end
+    end
+  end
+end

data/lib/blue_conductor/http/record/url_generator.rb

@@ -0,0 +1,16 @@
+module BlueConductor
+  module HTTP
+    module Record
+      class UrlGenerator
+        BASE_URI = "http://www.songlyrics.com/"
+
+        def self.generate(producer)
+          sanitizer = BlueConductor::HTTP::Record::Sanitizer.new(producer)
+          sanitizer.clean
+
+          "#{BASE_URI}#{sanitizer.band}/#{sanitizer.title}/"
+        end
+      end
+    end
+  end
+end

data/lib/blue_conductor/http/request.rb

@@ -3,12 +3,18 @@ module BlueConductor
     class Request
 
       def self.fetch(url)
-        begin
-          open(url)
-        rescue OpenURI::HTTPError
-          nil
+        response = Net::HTTP.get_response(URI.parse(url))
+
+        if response.code == '301'
+          parse(response['location'])
+        else
+          parse(url)
         end
       end
+
+      def self.parse(location)
+        Net::HTTP.get(URI.parse(location))
+      end
     end
   end
 end

data/lib/blue_conductor/http/song/response.rb

@@ -0,0 +1,22 @@
+module BlueConductor
+  module HTTP
+    module Song
+      class Response
+
+        def self.data(html)
+          doc = Nokogiri::HTML(html)
+          doc.css('p#songLyricsDiv').text
+        end
+
+        def self.album(html)
+          doc = Nokogiri::HTML(html)
+          begin
+            doc.css('div.pagetitle a')[1].text
+          rescue
+            'Album Missing'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/blue_conductor/http/song/sanitizer.rb

@@ -0,0 +1,25 @@
+module BlueConductor
+  module HTTP
+    module Song
+      class Sanitizer
+        UNWANTED_CHARS = %r([^a-zA-Z0-9])
+
+        attr_reader :band, :song
+
+        def initialize(manager)
+          @band = manager.band
+          @song = manager.song
+        end
+
+        def clean
+          @band = strip(@band)
+          @song = strip(@song)
+        end
+
+        def strip(str)
+          str.downcase.gsub(UNWANTED_CHARS, "-")
+        end
+      end
+    end
+  end
+end

data/lib/blue_conductor/http/song/url_generator.rb

@@ -0,0 +1,16 @@
+module BlueConductor
+  module HTTP
+    module Song
+      class UrlGenerator
+        BASE_URI = "http://www.songlyrics.com/"
+
+        def self.generate(manager)
+          sanitizer = BlueConductor::HTTP::Song::Sanitizer.new(manager)
+          sanitizer.clean
+
+          "#{BASE_URI}#{sanitizer.band}/#{sanitizer.song}-lyrics/"
+        end
+      end
+    end
+  end
+end

data/lib/blue_conductor/producer.rb

@@ -0,0 +1,32 @@
+module BlueConductor
+  class Producer
+    attr_reader :band, :title, :songs, :image, :error
+    attr_accessor :url_generator, :request, :parser
+
+    def initialize(band, record_title)
+      @band = band
+      @title = record_title
+      @songs = nil
+      @image = ''
+      @error = ''
+    end
+
+    def record!
+      url       = url_generator.generate(self)
+      html      = request.fetch(url)
+      tracklist = parser.parse(html)
+
+      if tracklist.nil? || tracklist.empty?
+        @error = 'The album requested is not available || there was a spelling error'
+      else
+        @image = parser.parse_image(html)
+
+        @songs = tracklist.map do |song|
+          BlueConductor.song_for(@band, song)
+        end
+      end
+
+      self
+    end
+  end
+end

data/lib/blue_conductor/song.rb

@@ -1,12 +1,12 @@
 module BlueConductor
   class Song
-    attr_accessor :title, :band, :lyrics, :error
+    attr_accessor :title, :band, :album, :lyrics
 
     def initialize(manager)
       @title  = manager.song
       @band   = manager.band
+      @album  = manager.album
       @lyrics = manager.data
-      @error = manager.error
     end
   end
 end

data/lib/blue_conductor/version.rb

@@ -1,3 +1,3 @@
 module BlueConductor
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lyric

@@ -15,6 +15,7 @@ track = BlueConductor.song_for(band, song)
 puts '*'*100
 puts "Band: #{track.band}"
 puts "Title: #{track.title}"
+puts "Album: #{track.album}"
 puts "Lyrics:"
 puts '-'*100
 puts track.lyrics

data/spec/blue_conductor/band_manager_spec.rb

@@ -3,21 +3,20 @@ require 'spec_helper'
 describe BlueConductor::BandManager do
   subject { BlueConductor::BandManager.new(band, song) }
 
-  let(:band) { 'The Dear Hunter' }
-  let(:song) { 'Red Hands' }
-  let(:data) { "Even if you never strayed from me\nI'd question your fidelity" }
-  let(:manager_mock) { mock(band: band, song: song, data: data) }
-  let(:song_object) { BlueConductor::Song.new(manager_mock) }
+  let(:band) { 'Van Halen' }
+  let(:song) { 'Unchained' }
+  let(:data) { "Change, nothin' stays the same" }
+  let(:album) { 'Fair Warning' }
 
   before do
-    subject.url_generator = BlueConductor::HTTP::UrlGenerator
+    subject.url_generator = BlueConductor::HTTP::Song::UrlGenerator
     subject.request       = BlueConductor::HTTP::Request
-    subject.parser        = BlueConductor::HTTP::Response
+    subject.parser        = BlueConductor::HTTP::Song::Response
   end
 
   describe '.new' do
     it 'creates an instance of itself' do
-      subject.band.should == band
+     subject.band.should == band
       subject.song.should == song
     end
   end
@@ -31,6 +30,7 @@ describe BlueConductor::BandManager do
 
         @track.title.should == song
         @track.band.should == band
+        @track.album.should == album
         @track.lyrics.should =~ /#{data}/
       end
     end
@@ -44,7 +44,8 @@ describe BlueConductor::BandManager do
           @track = subject.song!
         end
 
-        @track.error.should =~ /does not exist/
+        @track.lyrics.should =~ /Sorry, we have no/
+        @track.album.should =~ /Album Missing/
         @track.title.should == song
         @track.band.should == band
       end

data/spec/blue_conductor/producer_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe BlueConductor::Producer do
+  subject { BlueConductor::Producer.new(band, record) }
+
+  let(:band)           { 'Van Halen' }
+  let(:record)         { 'Fair Warning' }
+  let(:track_list)     { ['Dirty Movies', 'Hear About It Later', 'One Foot Out The Door', 
+                          'Push Comes to Shove', "Sinner's Swing", 'So This Is Love?', 
+                          'Sunday Afternoon In The Park', 'Unchained', 'Mean Street'
+                         ]}
+
+  before do
+    subject.url_generator  = BlueConductor::HTTP::Record::UrlGenerator
+    subject.request        = BlueConductor::HTTP::Request
+    subject.parser         = BlueConductor::HTTP::Record::Response
+  end
+
+  describe '.new' do
+    it 'creates an instance of itself' do
+     subject.band.should == band
+      subject.title.should == record
+    end
+  end
+
+  describe '#record' do
+    context 'when the band and record are valid' do
+      it 'returns an array of songs' do
+        VCR.use_cassette 'full_album' do
+          @record = subject.record!
+        end
+
+        @record.songs.map(&:title).should == track_list
+        @record.image.should == 'http://cdn1.songlyricscom.netdna-cdn.com/album_covers/202/van-halen-fair-warning/van-halen-6832-fair-warning.jpg'
+      end
+    end
+
+    context 'when the band and record are invalid' do
+
+      let(:band)   { 'asdf' }
+      let(:record) { 'asdf'}
+
+      it 'raises an error' do
+        VCR.use_cassette 'invalid_album' do
+          @record = subject.record!
+        end
+
+          @record.error.should == 'The album requested is not available || there was a spelling error'
+          @record.band.should == band
+          @record.title.should == record
+          @record.songs.should == nil
+          @record.image.should == ''
+      end
+    end
+  end
+end