musicbrainz 0.5.2 → 0.6.0

data/.gitignore

@@ -0,0 +1,8 @@
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+tmp
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,15 +1,2 @@
-source "http://rubygems.org"
-
-group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.4"
-  gem "rcov", ">= 0"
-  gem "rdoc", ">= 0"
-  gem "shoulda"
-  
-  gem "rspec"
-  gem "vcr"
-  gem "webmock"
-end
-
-gem "nokogiri", ">= 0"
+source :rubygems
+gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,6 @@
-Copyright (c) 2011 magnolia-fan
+Copyright (c) 2012 Gregory Eremin
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+## MusicBrainz Web Service wrapper [![Travis CI](https://secure.travis-ci.org/magnolia-fan/musicbrainz.png)](http://travis-ci.org/magnolia-fan/musicbrainz)
+
+### Installation
+```bash
+gem install musicbrainz
+```
+### Usage
+```ruby
+require 'musicbrainz'
+
+# Search for artists
+@suggestions = MusicBrainz::Artist.search('Jet')
+
+# Find artist by name or mbid
+@foo_fighters = MusicBrainz::Artist.find_by_name('Foo Fighters')
+@kasabian = MusicBrainz::Artist.find('69b39eab-6577-46a4-a9f5-817839092033')
+
+# Use them like ActiveRecord models
+@empire_tracks = @kasabian.release_groups[8].releases.first.tracks
+
+# Setting a cache path enables caching of requests
+MusicBrainz::Tools::Cache.cache_path = "tmp/cache"
+
+# Configuring request interval
+MusicBrainz::Tools::Proxy.query_interval = 1.2 # seconds
+```
+
+### Api
+
+MusicBrainz::Artist
+```ruby
+@artists = MusicBrainz::Artist.search(query)
+@artist = MusicBrainz::Artist.find_by_name(name)
+@artist = MusicBrainz::Artist.find(mbid)
+@artist.id
+@artist.type
+@artist.name
+@artist.country
+@artist.date_begin
+@artist.date_end
+@artist.release_groups
+```
+
+MusicBrainz::ReleaseGroup
+```ruby
+@release_group = MusicBrainz::ReleaseGroup.find(mbid)
+@release_group.id
+@release_group.type
+@release_group.title
+@release_group.first_release_date
+@release_group.releases
+```
+
+MusicBrainz::Release
+```ruby
+@release = MusicBrainz::Release.find(mbid)
+@release.id
+@release.title
+@release.status
+@release.date
+@release.country
+@release.tracks
+```
+
+MusicBrainz::Track
+```ruby
+@track = MusicBrainz::Track.find(mbid)
+@track.position
+@track.recording_id
+@track.title
+@track.length
+```
+
+### Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2011 Gregory Eremin. See [LICENSE](https://raw.github.com/magnolia-fan/musicbrainz/master/LICENSE) for further details.

data/Rakefile

@@ -1,53 +1,8 @@
-# encoding: utf-8
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+RSpec::Core::RakeTask.new("spec")
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "musicbrainz"
-  gem.homepage = "http://github.com/magnolia-fan/musicbrainz"
-  gem.license = "MIT"
-  gem.summary = %Q{MusicBrainz Web Service wrapper}
-  gem.description = %Q{MusicBrainz Web Service wrapper with ActiveRecord-style models}
-  gem.email = "magnolia_fan@me.com"
-  gem.authors = ["Gregory Eremin"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
-task :default => :test
-
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "musicbrainz #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec
+task :test => :spec

data/lib/deprecated.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+module MusicBrainz
+  def self.query_interval=(sec)
+    MusicBrainz::Tools::Proxy.query_interval = sec
+    puts "WARNING! MusicBrainz.query_interval is deprecated. Use MusicBrainz::Tools::Proxy.query_interval"
+  end
+
+  def self.cache_path=(path)
+    MusicBrainz::Tools::Cache.cache_path = path
+    puts "WARNING! MusicBrainz.cache_path is deprecated. Use MusicBrainz::Tools::Cache.cache_path"
+  end
+end

data/lib/musicbrainz.rb

@@ -1,11 +1,20 @@
+# -*- encoding: utf-8 -*-
 require "open-uri"
 require "socket"
 require "nokogiri"
 require "cgi"
 
-require "models/music_brainz"
-require "models/music_brainz/base"
-require "models/music_brainz/artist"
-require "models/music_brainz/release_group"
-require "models/music_brainz/release"
-require "models/music_brainz/track"
+require "version"
+
+module MusicBrainz
+  autoload :Base, "musicbrainz/base"
+  autoload :Artist, "musicbrainz/artist"
+  autoload :ReleaseGroup, "musicbrainz/release_group"
+  autoload :Release, "musicbrainz/release"
+  autoload :Track, "musicbrainz/track"
+
+  module Tools
+    autoload :Cache, "tools/cache"
+    autoload :Proxy, "tools/proxy"
+  end
+end

data/lib/{models/music_brainz → musicbrainz}/artist.rb

@@ -1,26 +1,26 @@
-# encoding: UTF-8
+# -*- encoding: utf-8 -*-
 
 module MusicBrainz
   class Artist < MusicBrainz::Base
     attr_accessor :id, :type, :name, :country, :date_begin, :date_end, :urls
     @release_groups
-  
+
     def release_groups
       if @release_groups.nil? and not self.id.nil?
         @release_groups = []
-        Nokogiri::XML(MusicBrainz.load(:release_group, :artist => self.id)).css('release-group').each do |rg|
+        Nokogiri::XML(self.class.load(:release_group, :artist => self.id)).css('release-group').each do |rg|
           @release_groups << MusicBrainz::ReleaseGroup.parse_xml(rg)
         end
       end
       @release_groups.sort{ |a, b| a.first_release_date <=> b.first_release_date }
     end
-  
+
     def self.find mbid
-      res = MusicBrainz.load :artist, :id => mbid, :inc => [:url_rels]
+      res = self.load :artist, :id => mbid, :inc => [:url_rels]
       return nil if res.nil?
       @artist = self.parse_xml(Nokogiri::XML(res))
     end
-  
+
     def self.parse_xml xml
       @artist = MusicBrainz::Artist.new
       @artist.id = self.safe_get_attr(xml, 'artist', 'id')
@@ -35,21 +35,21 @@ module MusicBrainz
       end
       @artist
     end
-    
+
     def self.discography mbid
       artist = self.find(mbid)
       artist.release_groups.each {|rg| rg.releases.each {|r| r.tracks } }
       artist
     end
-    
+
     def self.find_by_name name
       matches = self.search name
       matches.length.zero? ? nil : self.find(matches.first[:mbid])
     end
-    
+
     def self.search name
       artists = []
-      xml = Nokogiri::XML(MusicBrainz.load(:artist, :query => CGI.escape(name).gsub(/\!/, '\!') + '~', :limit => 50))
+      xml = Nokogiri::XML(self.load(:artist, :query => CGI.escape(name).gsub(/\!/, '\!') + '~', :limit => 50))
       xml.css('artist-list > artist').each do |a|
         artist = {
           :name => a.first_element_child.text.gsub(/[`’]/, "'"),
@@ -60,7 +60,13 @@ module MusicBrainz
           :mbid => self.safe_get_attr(a, nil, 'id')
         }
         aliases = a.css('alias-list > alias').map{ |item| item.text }
-        if aliases.include? name
+        if artist[:name] == name
+          artist[:weight] += 100
+        elsif artist[:name].downcase == name.downcase
+          artist[:weight] += 50
+        elsif artist[:name].downcase.gsub(/\s/, '') == name.downcase.gsub(/\s/, '')
+          artist[:weight] += 25
+        elsif aliases.include? name
           artist[:weight] += 20
         elsif aliases.map{ |item| item.downcase }.include? name.downcase
           artist[:weight] += 10

data/lib/{models/music_brainz → musicbrainz}/base.rb

@@ -1,12 +1,17 @@
+# -*- encoding: utf-8 -*-
 module MusicBrainz
   class Base
-    def self.safe_get_attr xml, path, name
+    def self.safe_get_attr(xml, path, name)
       node = path.nil? ? xml : (xml.css(path).first unless xml.css(path).empty?)
       node.attr(name) unless node.nil? or node.attr(name).nil?
     end
-    
-    def self.safe_get_value xml, path
+
+    def self.safe_get_value(xml, path)
       xml.css(path).first.text unless xml.css(path).empty?
     end
+
+    def self.load(*args)
+      MusicBrainz::Tools::Proxy.load(*args)
+    end
   end
 end

data/lib/{models/music_brainz → musicbrainz}/release.rb

@@ -1,23 +1,24 @@
+# -*- encoding: utf-8 -*-
 module MusicBrainz
   class Release < MusicBrainz::Base
     attr_accessor :id, :title, :status, :format, :date, :country
     @tracks
-  
+
     def tracks
       if @tracks.nil? and not self.id.nil?
         @tracks = []
-        Nokogiri::XML(MusicBrainz.load(:release, :id => self.id, :inc => [:recordings, :media], :limit => 100)).css('medium-list > medium > track-list > track').each do |r|
+        Nokogiri::XML(self.class.load(:release, :id => self.id, :inc => [:recordings, :media], :limit => 100)).css('medium-list > medium > track-list > track').each do |r|
           @tracks << MusicBrainz::Track.parse_xml(r)
         end
       end
       @tracks.sort{ |a, b| a.position <=> b.position }
     end
-  
+
     def self.find mbid
-      xml = Nokogiri::XML(MusicBrainz.load(:release, :id => mbid, :inc => [:media])).css('release').first
+      xml = Nokogiri::XML(self.load(:release, :id => mbid, :inc => [:media])).css('release').first
       self.parse_xml(xml) unless xml.nil?
     end
-  
+
     def self.parse_xml xml
       @release = MusicBrainz::Release.new
       @release.id = self.safe_get_attr(xml, nil, 'id')

data/lib/{models/music_brainz → musicbrainz}/release_group.rb

@@ -1,23 +1,24 @@
+# -*- encoding: utf-8 -*-
 module MusicBrainz
   class ReleaseGroup < MusicBrainz::Base
     attr_accessor :id, :type, :title, :disambiguation, :first_release_date
     @releases
-  
+
     def releases
       if @releases.nil? and not self.id.nil?
         @releases = []
-        Nokogiri::XML(MusicBrainz.load(:release, :release_group => self.id, :inc => [:media], :limit => 100)).css('release').each do |r|
+        Nokogiri::XML(self.class.load(:release, :release_group => self.id, :inc => [:media], :limit => 100)).css('release').each do |r|
           @releases << MusicBrainz::Release.parse_xml(r)
         end
       end
       @releases.sort{ |a, b| a.date <=> b.date }
     end
-  
+
     def self.find mbid
-      xml = Nokogiri::XML(MusicBrainz.load(:release_group, :id => mbid)).css('release-group').first
+      xml = Nokogiri::XML(self.load(:release_group, :id => mbid)).css('release-group').first
       self.parse_xml(xml) unless xml.nil?
     end
-  
+
     def self.parse_xml xml
       @release_group = MusicBrainz::ReleaseGroup.new
       @release_group.id = self.safe_get_attr(xml, nil, 'id')

data/lib/{models/music_brainz → musicbrainz}/track.rb

@@ -1,12 +1,13 @@
+# -*- encoding: utf-8 -*-
 module MusicBrainz
   class Track < MusicBrainz::Base
     attr_accessor :position, :recording_id, :title, :length
-  
+
     def self.find mbid
-      xml = Nokogiri::XML(MusicBrainz.load(:recording, :id => mbid))
+      xml = Nokogiri::XML(self.load(:recording, :id => mbid))
       self.parse_xml(xml) unless xml.nil?
     end
-  
+
     def self.parse_xml xml
       @track = MusicBrainz::Track.new
       @track.position = self.safe_get_value(xml, 'position').to_i

data/lib/tools/cache.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+module MusicBrainz
+  module Tools
+    class Cache
+      @@cache_path = nil
+
+      def self.cache_path=(path)
+        @@cache_path = path
+      end
+
+      def self.cache_path
+        @@cache_path
+      end
+
+      def self.clear_cache
+        FileUtils.rm_r(@@cache_path) if @@cache_path && File.exist?(@@cache_path)
+      end
+
+      def self.cache_contents(url)
+        response = nil
+        url_parts = url.split('/')
+        file_name = url_parts.pop
+        directory = url_parts.pop
+        file_path = @@cache_path ? "#{@@cache_path}/#{directory}/#{file_name}" : nil
+
+        if file_path && File.exist?(file_path)
+          response = File.open(file_path).gets
+        else
+          response = yield
+
+          unless response.nil? or file_path.nil?
+            FileUtils.mkdir_p file_path.split('/')[0..-2].join('/')
+            file = File.new(file_path, 'w')
+            file.puts(response.gets) # .force_encoding('UTF-8')
+            file.chmod(0755)
+            file.close
+            response.rewind
+          end
+        end
+
+        response
+      end
+    end
+  end
+end