1
0
Fork 0
musicbrainz.org Ruby client
Go to file
Sander Nieuwenhuizen 88c4128d82 Fixed failing spec 2012-09-05 21:15:59 +02:00
lib Removing unnecessery self reference 2012-07-09 02:50:07 +04:00
spec Fixed failing spec 2012-09-05 21:15:59 +02:00
.gitignore Gem is rewrapped with Bundler instead of Jeweler. All tests are using RSpec. Reorganized lib structure. Tests are fixed. 2012-07-04 17:10:47 +04:00
.rspec Gem is rewrapped with Bundler instead of Jeweler. All tests are using RSpec. Reorganized lib structure. Tests are fixed. 2012-07-04 17:10:47 +04:00
.travis.yml Fixing ruby encoding 2011-11-15 19:20:21 +04:00
Contributors Thanks 2012-07-04 18:27:23 +04:00
Gemfile Gem is rewrapped with Bundler instead of Jeweler. All tests are using RSpec. Reorganized lib structure. Tests are fixed. 2012-07-04 17:10:47 +04:00
LICENSE Gem is rewrapped with Bundler instead of Jeweler. All tests are using RSpec. Reorganized lib structure. Tests are fixed. 2012-07-04 17:10:47 +04:00
README.md Version bump, updated readme 2012-07-09 02:45:54 +04:00
Rakefile Refactoring Artist model 2012-07-08 23:46:09 +04:00
musicbrainz.gemspec Version bump, updated readme 2012-07-09 02:45:54 +04:00

README.md

MusicBrainz Web Service wrapper Travis CI

Installation

gem install musicbrainz

or add this line to your Gemfile

gem "musicbrainz"

Usage

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

@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

@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

@release = MusicBrainz::Release.find(mbid)
@release.id
@release.title
@release.status
@release.date
@release.country
@release.tracks

MusicBrainz::Track

@track = MusicBrainz::Track.find(mbid)
@track.position
@track.recording_id
@track.title
@track.length

Testing

bundle rake spec

Debug console

bundle rake console

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 (c) 2011 Gregory Eremin. See LICENSE for further details.