musicbrainz 0.7.1 → 0.7.2

data/.gitignore

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

data/.travis.yml

@@ -1,4 +1,4 @@
 rvm:
-  - 1.8.7
   - 1.9.2
-  - 1.9.3
+  - 1.9.3
+script: "bundle exec rspec"

data/Contributors

@@ -3,3 +3,4 @@ Huge thanks to that people for making this gem better!
 Applicat (https://github.com/Applicat)
 Jens Fahnenbruck (https://github.com/jigfox)
 Sander Nieuwenhuizen (https://github.com/munkius)
+Savater Sebastien (https://github.com/blakink)

data/README.md

@@ -1,17 +1,44 @@
 ## MusicBrainz Web Service wrapper [![Travis CI](https://secure.travis-ci.org/magnolia-fan/musicbrainz.png)](http://travis-ci.org/magnolia-fan/musicbrainz)
 
+### Ruby Version
+**IMPORTANT!**
+
+Ruby version 1.9+ required. No support for 1.8.7 anymore, if you still on 1.8 consider using gem [version 0.5.2](https://github.com/magnolia-fan/musicbrainz/tree/v0.5.2#musicbrainz-web-service-wrapper-) and bundle it like this:
+
+```ruby
+gem 'musicbrainz', '0.5.2'
+```
+
 ### Installation
-```bash
+```
 gem install musicbrainz
 ```
 or add this line to your Gemfile
 ```ruby
-gem "musicbrainz"
+gem 'musicbrainz'
+```
+
+### Configuration
+```ruby
+MusicBrainz.configure do |c|
+  # Application identity (required)
+  c.app_name = "My Music App"
+  c.app_version = "1.0"
+  c.contact = "support@mymusicapp.com"
+
+  # Cache config (optional)
+  c.cache_path = "/tmp/musicbrainz-cache"
+  c.perform_caching = true
+
+  # Querying config (optional)
+  c.query_interval = 1.2 # seconds
+  c.tries_limit = 2
+end
 ```
 
 ### Usage
 ```ruby
-require "musicbrainz"
+require 'musicbrainz'
 
 # Search for artists
 @suggestions = MusicBrainz::Artist.search("Jet")
@@ -22,68 +49,92 @@ require "musicbrainz"
 
 # 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
+### Models
 
 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
+# Class Methods:
+MusicBrainz::Artist.find(id)
+MusicBrainz::Artist.find_by_name(name)
+MusicBrainz::Artist.search(name)
+MusicBrainz::Artist.discography(id)
+
+# Instance Methods:
 @artist.release_groups
+
+# Fields
+{
+  :id         => String,
+  :type       => String,
+  :name       => String,
+  :country    => String,
+  :date_begin => Date,
+  :date_end   => Date,
+  :urls       => Hash
+}
 ```
 
 MusicBrainz::ReleaseGroup
 ```ruby
-@release_group = MusicBrainz::ReleaseGroup.find(mbid)
-@release_group.id
-@release_group.type
-@release_group.title
-@release_group.first_release_date
+# Class Methods
+MusicBrainz::ReleaseGroup.find(id)
+
+# Instance Methods
 @release_group.releases
+
+# Fields
+{
+  :id                 => String,
+  :type               => String,
+  :title              => String,
+  :desc               => String,
+  :first_release_date => Date
+}
 ```
 
 MusicBrainz::Release
 ```ruby
-@release = MusicBrainz::Release.find(mbid)
-@release.id
-@release.title
-@release.status
-@release.date
-@release.country
+# Class Methods
+MusicBrainz::Release.find(id)
+
+# Instance Methods
 @release.tracks
+
+# Fields
+{
+  :id      => String,
+  :title   => String,
+  :status  => String,
+  :format  => String,
+  :date    => Date,
+  :country => String
+}
 ```
 
 MusicBrainz::Track
 ```ruby
-@track = MusicBrainz::Track.find(mbid)
-@track.position
-@track.recording_id
-@track.title
-@track.length
+# Class Methods
+MusicBrainz::Track.find(id)
+
+# Fields
+{
+  :position     => Integer,
+  :recording_id => String,
+  :title        => String,
+  :length       => Integer
+}
 ```
 
 ### Testing
-```bash
-bundle rake spec
+```
+bundle exec rspec
 ```
 
 ### Debug console
-```bash
-bundle rake console
+```
+bundle exec irb -r musicbrainz
 ```
 
 ### Contributing
@@ -91,7 +142,7 @@ bundle rake console
 * 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
+* **Start a feature/bugfix branch (IMPORTANT)**
 * 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.

data/lib/mb.rb

@@ -0,0 +1,2 @@
+require "musicbrainz"
+MB = MusicBrainz

data/lib/musicbrainz.rb

@@ -1,29 +1,34 @@
-# -*- encoding: utf-8 -*-
+require "digest/sha1"
+require "fileutils"
 
-require "open-uri"
-require "socket"
+require "faraday"
 require "nokogiri"
-require "cgi"
 
-module MusicBrainz
-  module Tools; end
-  module Parsers; end
-end
+require "musicbrainz/version"
+require "musicbrainz/deprecated"
+require "musicbrainz/middleware"
+require "musicbrainz/configuration"
 
-require "version"
-require "deprecated"
+require "musicbrainz/client_modules/transparent_proxy"
+require "musicbrainz/client_modules/failsafe_proxy"
+require "musicbrainz/client_modules/caching_proxy"
+require "musicbrainz/client"
 
-require "musicbrainz/base"
-require "musicbrainz/artist"
-require "musicbrainz/release_group"
-require "musicbrainz/release"
-require "musicbrainz/track"
+require "musicbrainz/models/base_model"
+require "musicbrainz/models/artist"
+require "musicbrainz/models/release_group"
+require "musicbrainz/models/release"
+require "musicbrainz/models/track"
 
-require "tools/cache"
-require "tools/proxy"
+require "musicbrainz/bindings/artist"
+require "musicbrainz/bindings/artist_search"
+require "musicbrainz/bindings/artist_release_groups"
+require "musicbrainz/bindings/release_group"
+require "musicbrainz/bindings/release_group_releases"
+require "musicbrainz/bindings/release"
+require "musicbrainz/bindings/release_tracks"
+require "musicbrainz/bindings/track"
 
-require "parsers/base"
-require "parsers/artist"
-require "parsers/release_group"
-require "parsers/release"
-require "parsers/track"
+module MusicBrainz
+  GH_PAGE_URL = "http://git.io/brainz"
+end

data/lib/musicbrainz/bindings/artist.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module MusicBrainz
+  module Bindings
+    module Artist
+      def parse(xml)
+        xml = xml.xpath('./artist') unless xml.xpath('./artist').empty?
+        {
+          id: (xml.attribute('id').value rescue nil),
+          type: (xml.attribute('type').value rescue nil),
+          name: (xml.xpath('./name').text.gsub(/[`’]/, "'") rescue nil),
+          country: (xml.xpath('./country').text rescue nil),
+          date_begin: (xml.xpath('./life-span/begin').text rescue nil),
+          date_end: (xml.xpath('./life-span/end').text rescue nil),
+          urls: (Hash[xml.xpath('./relation-list[@target-type="url"]/relation').map{ |xml|
+            [xml.attribute('type').value.downcase.split(" ").join("_").to_sym, xml.xpath('./target').text]
+          }] rescue {})
+        }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/artist_release_groups.rb

@@ -0,0 +1,13 @@
+module MusicBrainz
+  module Bindings
+    module ArtistReleaseGroups
+      def parse(xml)
+        xml.xpath('./release-group-list/release-group').map do |xml|
+          MusicBrainz::Bindings::ReleaseGroup.parse(xml)
+        end
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/artist_search.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module MusicBrainz
+  module Bindings
+    module ArtistSearch
+      def parse(xml)
+        xml.xpath('./artist-list/artist').map do |xml|
+          {
+            id: (xml.attribute('id').value rescue nil),
+            mbid: (xml.attribute('id').value rescue nil), # Old shit
+            name: (xml.xpath('./name').text.gsub(/[`’]/, "'") rescue nil),
+            sort_name: (xml.xpath('./sort-name').gsub(/[`’]/, "'") rescue nil),
+            type: (xml.attribute('type').value rescue nil),
+            score: (xml.attribute('score').value.to_i rescue nil),
+            desc: (xml.xpath('./disambiguation').value rescue nil),
+            aliases: (xml.xpath('./alias-list/alias').map{ |xml| xml.text } rescue [])
+          } rescue nil
+        end.delete_if{ |item| item.nil? }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/release.rb

@@ -0,0 +1,28 @@
+module MusicBrainz
+  module Bindings
+    module Release
+      def parse(xml)
+        xml = xml.xpath('./release') unless xml.xpath('./release').empty?
+        
+        hash = {
+          id: (xml.attribute('id').value rescue nil),
+          title: (xml.xpath('./title').text rescue nil),
+          status: (xml.xpath('./status').text rescue nil),
+          country: (xml.xpath('./country').text rescue nil),
+          date: (xml.xpath('./date').text rescue nil)
+        }
+        
+        formats = (xml.xpath('./medium-list/medium/format') rescue []).map(&:text)
+        
+        hash[:format] = formats.uniq.map do |format|
+          format_count = formats.select{|f| f == format}.length
+          format_count == 1 ? format : "#{format_count}x#{format}"
+        end.join(' + ')
+        
+        hash
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/release_group.rb

@@ -0,0 +1,18 @@
+module MusicBrainz
+  module Bindings
+    module ReleaseGroup
+      def parse(xml)
+        xml = xml.xpath('./release-group') unless xml.xpath('./release-group').empty?
+        {
+          id: (xml.attribute('id').value rescue nil),
+          type: (xml.attribute('type').value rescue nil),
+          title: (xml.xpath('./title').text rescue nil),
+          desc: (xml.xpath('./disambiguation').text rescue nil),
+          first_release_date: (xml.xpath('./first-release-date').text rescue nil)
+        }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/release_group_releases.rb

@@ -0,0 +1,13 @@
+module MusicBrainz
+  module Bindings
+    module ReleaseGroupReleases
+      def parse(xml)
+        xml.xpath('./release-list/release').map do |xml|
+          MusicBrainz::Bindings::Release.parse(xml)
+        end
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/release_tracks.rb

@@ -0,0 +1,13 @@
+module MusicBrainz
+  module Bindings
+    module ReleaseTracks
+      def parse(xml)
+        xml.xpath('./release/medium-list/medium/track-list/track').map do |xml|
+          MusicBrainz::Bindings::Track.parse(xml)
+        end
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/bindings/track.rb

@@ -0,0 +1,16 @@
+module MusicBrainz
+  module Bindings
+    module Track
+      def parse(xml)
+        {
+          position: (xml.xpath('./position').text rescue nil),
+          recording_id: (xml.xpath('./recording').attribute('id').value rescue nil),
+          title: (xml.xpath('./recording/title').text rescue nil),
+          length: (xml.xpath('./recording/length').text rescue nil)
+        }
+      end
+
+      extend self
+    end
+  end
+end

data/lib/musicbrainz/client.rb

@@ -0,0 +1,72 @@
+module MusicBrainz
+  class Client
+    include ClientModules::TransparentProxy
+    include ClientModules::FailsafeProxy
+    include ClientModules::CachingProxy
+
+    def http
+      @faraday ||= Faraday.new do |f|
+        f.request :url_encoded            # form-encode POST params
+        f.adapter Faraday.default_adapter # make requests with Net::HTTP
+        f.use     MusicBrainz::Middleware # run requests with correct headers
+      end
+    end
+
+    def load(resource, query, params)
+      raise Exception.new("You need to run MusicBrainz.configure before querying") if MusicBrainz.config.nil?
+
+      url = build_url(resource, query)
+      response = get_contents(url)
+
+      return nil if response[:status] != 200
+
+      xml = Nokogiri::XML.parse(response[:body]).remove_namespaces!.xpath('/metadata')
+      data = binding_class_for(params[:binding]).parse(xml)
+
+      if params[:create_model]
+        model_class_for(params[:create_model]).new(data)
+      elsif params[:create_models]
+        models = data.map{ |item| model_class_for(params[:create_models]).new(item) }
+        models.sort!{ |a, b| a.send(params[:sort]) <=> b.send(params[:sort]) } if params[:sort]
+        models
+      else
+        data
+      end
+    end
+
+  private
+
+    def build_url(resource, params)
+      "#{MusicBrainz.config.web_service_url}#{resource.to_s.gsub('_', '-')}" <<
+      ((id = params.delete(:id)) ? "/#{id}?" : "?") <<
+      params.map do |key, value|
+        key = key.to_s.gsub('_', '-')
+        value = if value.is_a?(Array)
+          value.map{ |el| el.to_s.gsub('_', '-') }.join(?+)
+        else
+          value.to_s
+        end
+        [key, value].join(?=)
+      end.join(?&)
+    end
+
+    def binding_class_for(key)
+      MusicBrainz::Bindings.const_get(constantized(key))
+    end
+
+    def model_class_for(key)
+      MusicBrainz.const_get(constantized(key))
+    end
+
+    def constantized(key)
+      key.to_s.split(?_).map(&:capitalize).join.to_sym
+    end
+  end
+
+  module ClientHelper
+    def client
+      @client ||= Client.new
+    end
+  end
+  extend ClientHelper
+end