gmusic 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tower He
+
+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.rdoc

@@ -0,0 +1,28 @@
+= GMusic
+
+GMusic provides APIs to search songs from http://music.g.cn. There are three query conditions supported by GMusic, which are title, artist and album of a song. GMusic delivers query requests to Google and collects the search result returned from Google. 
+
+== SYNOPSIS:
+
+  require 'gmusic'
+
+  result = GMusic.search(:title => 'heal the world', :artist => 'michael jackson')
+
+  puts result.class
+  # => Array 
+  
+  result.first.keys
+  # => [:artist, :album, :format, :size, :url, :id, :lyrics, :title]
+
+== REQUIREMENTS:
+
+* jeweler (1.4.0) http://technicalpickles.github.com/jeweler
+* hpricot (0.8.2) http://github.com/whymirror/hpricot
+
+== INSTALL:
+
+  gem install gmusic
+
+== COPYRIGHT:
+
+Copyright (c) 2010 Tower He. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gmusic"
+    gem.summary = %Q{Search songs from http://music.g.cn}
+    gem.description = %Q{gmusic provides APIs to search songs from http://music.g.cn. There are three query conditions supported by gmusic, which are title, artist and album of a song. gmusic delivers query requests to Google and collects the search result returned from Google. }
+    gem.email = "towerhe@gmail.com"
+    gem.homepage = "http://github.com/towerhe/gmusic"
+    gem.authors = ["Tower He"]
+    gem.add_dependency "hpricot", ">=0.8.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+
+    gem.files = FileList['lib/**/*.rb', 'spec/**/*.rb', '[A-Z]*'].to_a
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gmusic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/gmusic.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'hpricot'
+require 'open-uri'
+
+require 'gmusic/parser'
+
+module GMusic
+  class << self
+    VALID_CONDITIONS = [ :title, :artist ]
+
+    SEARCH_URL_TEMPLATE = %Q(http://www.google.cn/music/search?q=%s&aq=f)
+    DOWNLOAD_INFO_URL_TEMPLATE = %Q(http://www.google.cn/music/top100/musicdownload?id=%s)
+    LYRICS_URL_TEMPLATE = %Q(http://www.google.cn/music/top100/lyrics?id=%s)
+
+
+    def search(conditions)
+      validate_conditions(conditions)
+      query = construct_query(conditions)
+      songs = SongListParser.parse(SEARCH_URL_TEMPLATE % query)
+      
+      matched = []
+      songs.each do |song|
+        if matched?(song, conditions)
+          song.merge!(DownloadInfoParser.parse(DOWNLOAD_INFO_URL_TEMPLATE % song[:id]))
+          song.merge!(LyricsParser.parse(LYRICS_URL_TEMPLATE % song[:id])) 
+          matched << song
+        end
+      end
+      matched
+    end
+
+    private 
+    def validate_conditions(conditions)
+      raise_argument_error if conditions.empty? or (conditions.keys & VALID_CONDITIONS).empty?
+    end
+
+    def construct_query(conditions)
+      query = ''
+      VALID_CONDITIONS.each do |c|
+        query << (query.empty? ? '' : '+') << "\"#{conditions[c]}\"" if conditions.has_key? c
+      end
+      URI.escape query
+    end
+
+    def raise_argument_error
+      raise ArgumentError.new('must specify at least one condition')
+    end
+
+    def matched?(result, conditions)
+      if conditions.has_key?(:title) and not result[:title].downcase.eql?(conditions[:title].downcase)
+        return false
+      end
+      if conditions.has_key?(:artist) and not result[:artist].downcase.include?(conditions[:artist].downcase)
+        return false
+      end
+      return true
+    end
+  end
+end

data/lib/gmusic/parser.rb

@@ -0,0 +1,53 @@
+module GMusic
+  module SongListParser
+    class << self
+      def parse url
+        songs = []
+        doc = Hpricot(open(url))
+        (doc/'#song_list > tr').each do |tr|
+          begin
+            song = {}
+            id = tr.attributes["id"].gsub(/row/, '')
+            next if id.include?('snippetRow')
+            song.merge!({ :id => id })
+            song.merge!({ :title => (tr/'td.Title > a > b').first.inner_html })
+            song.merge!({ :artist => (tr/'td.Artist > a').first.inner_html })
+            song.merge!({ :album => (tr/'td.Album > a').first.inner_html })
+            songs << song
+          rescue
+          end
+        end
+        songs
+      end
+    end
+  end
+
+  module LyricsParser
+    class << self
+      def parse url
+        doc = Hpricot(open(url))
+        begin
+          { :lyrics => (doc/'#lyrics').first.inner_html }
+        rescue
+          nil
+        end
+      end
+    end
+  end
+
+  module DownloadInfoParser
+    class << self
+      def parse url
+        result = {}
+        doc = Hpricot(open(url))
+        begin
+          result.merge!({ :size => (doc/'tr.meta-data-tr > td.td-size').first.inner_html })
+          result.merge!({ :format => (doc/'tr.meta-data-tr > td.td-format').first.inner_html })
+          result.merge!({ :url => (doc/'div.download > a').first.attributes['href'] })
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/spec/gmusic_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Gmusic" do
+  it "should raise ArgumentError if the argument 'conditions' is empty" do
+    lambda { GMusic.search({}) }.should raise_error ArgumentError
+  end
+
+  it "should raise ArgumentError if there is no valid condition specified" do
+    lambda { GMusic.search(:invalid => 'test') }.should raise_error ArgumentError
+  end
+
+  it "should return an empty array if nothing is matched" do
+    GMusic::SongListParser.should_receive(:parse).and_return([])
+    GMusic.search(:title => 'inexistence').empty?.should be_true
+  end
+
+  it "should only return the full matched item" do
+    parsed = GMusic::SongListParser.parse path_of('g-search-alreadygone.html')
+    dowload_info = GMusic::DownloadInfoParser.parse path_of('g-download.html')
+    lyrics = GMusic::LyricsParser.parse path_of('g-lyrics.html')
+
+    GMusic::SongListParser.should_receive(:parse).and_return(parsed)
+    GMusic::DownloadInfoParser.should_receive(:parse).and_return(dowload_info)
+    GMusic::LyricsParser.should_receive(:parse).and_return(lyrics)
+    songs = GMusic.search(:title => 'already gone', :artist => 'kelly clarkson')
+    
+    songs.size.should == 1
+  end
+
+  it "should return 5 full matched items" do
+    parsed = GMusic::SongListParser.parse path_of('g-search-thankyou.html')
+    dowload_info = GMusic::DownloadInfoParser.parse path_of('g-download.html')
+    lyrics = GMusic::LyricsParser.parse path_of('g-lyrics.html')
+    
+    GMusic::SongListParser.should_receive(:parse).and_return(parsed)
+    GMusic::DownloadInfoParser.should_receive(:parse).exactly(5).times.and_return(dowload_info)
+    GMusic::LyricsParser.should_receive(:parse).exactly(5).times.and_return(lyrics)
+
+    songs = GMusic.search(:title => 'thank you', :artist => 'dido')
+    
+    songs.size.should == 5 
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module GMusic
+  describe SongListParser do
+    it "should return an empty array if no record has been found" do
+      songs = SongListParser.parse path_of('g-empty.html')
+      songs.empty?.should be_true
+    end
+
+    it "should parse all the songs with id, title, artist and album" do
+      songs = SongListParser.parse path_of('g-search-thankyou.html')
+
+      songs.should be_instance_of(Array)
+      songs.size.should == 20
+
+      songs.each do |s|
+        s.has_key?(:id).should be_true
+        s.has_key?(:title).should be_true
+        s.has_key?(:artist).should be_true
+        s.has_key?(:album).should be_true
+      end
+    end
+  end
+
+  describe LyricsParser do
+    it "should return nil if no record has been found" do
+      result = LyricsParser.parse path_of('g-empty.html')
+      result.should be_nil
+    end
+
+    it "should parse the lyrics" do
+      lyrics = <<-LYRICS
+歌手:
+&#20975;&#33673; &#20811;&#33713;&#20811;&#26862;(Kelly Clarkson)
+<br>
+专辑:&nbsp;
+All I Ever Wanted
+<br>
+公司：
+RCA&#21809;&#29255;(&#32034;&#23612;BMG)
+<br>
+<br>
+Remember all the things we wanted<br> Now all our memories, they&#39;re haunted<br> We were always meant to say goodbye<br> Even with our fists held high<br> It never would&#39;ve worked out right<br> We were never meant for do or die<br> I didn&#39;t want us to burn out<br> I didn&#39;t come here to hold you<br> Now I can&#39;t stop<br> I want you to know that it doesn&#39;t matter<br> Where we take this road<br> Someone&#39;s gotta go<br> And I want you to know<br> You couldn&#39;t have loved me better<br> But I want you to move on<br> So I&#39;m already gone<br> Looking at you makes it harder<br> But I know that you&#39;ll find another<br> That doesn&#39;t always make you want to cry<br> Started with a perfect kiss<br> Then we could feel the poison set in<br> Perfect couldn&#39;t keep this love alive<br> You know that I love you so<br> I love you enough to let you go<br> I want you to know that it doesn&#39;t matter<br> Where we take this road<br> Someone&#39;s gotta go<br> And I want you to know<br> You couldn&#39;t have loved me better<br> But I want you to move on<br> So I&#39;m already gone<br> I&#39;m already gone, already gone<br> You can&#39;t make it feel right<br> When you know that it&#39;s wrong<br> I&#39;m already gone, already gone<br> There&#39;s no moving on<br> So I&#39;m already gone<br> Remember all the things we wanted<br> Now all our memories, they&#39;re haunted<br> We were always meant to say goodbye<br> I want you to know that it doesn&#39;t matter<br> Where we take this road<br> Someone&#39;s gotta go<br> And I want you to know<br> You couldn&#39;t have loved me better<br> But I want you to move on<br> So I&#39;m already gone<br> I&#39;m already gone, already gone<br> You can&#39;t make it feel right<br> When you know that it&#39;s wrong<br> I&#39;m already gone, already gone<br> There&#39;s no moving on<br> So I&#39;m already gone<br>
+LYRICS
+
+      result = LyricsParser.parse path_of('g-lyrics.html')
+
+      result[:lyrics].should == lyrics.strip.gsub(/<br>/, '<br />')
+    end
+  end
+
+  describe DownloadInfoParser do
+    it "should return nil if no record has been found" do
+      result = DownloadInfoParser.parse path_of('g-empty.html')
+      result.should be_nil
+    end
+
+    it "should parse the download link" do
+      result = DownloadInfoParser.parse path_of('g-download.html')
+
+      result[:size].should == '6.7&nbsp;MB'
+      result[:format].should == 'MP3'
+      # &amp; is decoded to &
+      result[:url].should == '/music/top100/url?q=http%3A%2F%2Ffile3.top100.cn%2F201002182021%2F6606E229A301A32E3EFEDD028337EA8C%2FSpecial_120398%2FAlready%2520Gone.mp3&ct=rdl&cad=dl&ei=uTB9S5CgOZjssQK5t5X8AQ&sig=9BD4F31BB70F31BAB6AD4AECA3C5200D'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gmusic'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+def path_of(file)
+  File.join(File.dirname(__FILE__), file)
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: gmusic
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tower He
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-22 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+description: "gmusic provides APIs to search songs from http://music.g.cn. There are three query conditions supported by gmusic, which are title, artist and album of a song. gmusic delivers query requests to Google and collects the search result returned from Google. "
+email: towerhe@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/gmusic.rb
+- lib/gmusic/parser.rb
+- spec/gmusic_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/towerhe/gmusic
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Search songs from http://music.g.cn
+test_files: 
+- spec/gmusic_spec.rb
+- spec/parser_spec.rb
+- spec/spec_helper.rb