1
0
Fork 0
musicbrainz/README.rdoc

71 lines
1.9 KiB
Plaintext
Raw Normal View History

2011-09-13 12:18:07 +00:00
= MusicBrainz Web Service wrapper {<img src="https://secure.travis-ci.org/magnolia-fan/musicbrainz.png"/>}[http://travis-ci.org/magnolia-fan/musicbrainz]
2011-07-17 23:46:18 +00:00
2011-07-18 03:02:37 +00:00
=== Installation
2011-07-17 23:46:18 +00:00
2011-07-18 03:02:37 +00:00
gem install musicbrainz
=== Usage
require 'musicbrainz'
2011-09-13 11:00:33 +00:00
@kasabian = MusicBrainz::Artist.find('69b39eab-6577-46a4-a9f5-817839092033')
2011-07-18 03:02:37 +00:00
@empire_tracks = @kasabian.release_groups[8].releases.first.tracks
=== Future
It should work all like ActiveRecord models.
=== Api
MusicBrainzArtist
2011-09-13 11:00:33 +00:00
@artist = MusicBrainz::Artist.find(mbid)
@artist.id
@artist.type
@artist.name
@artist.country
@artist.date_begin
@artist.date_end
@artist.release_groups
2011-07-18 03:02:37 +00:00
MusicBrainzReleaseGroup
2011-09-13 11:00:33 +00:00
@release_group = MusicBrainz::ReleaseGroup.find(mbid)
@release_group.id
@release_group.type
@release_group.title
@release_group.first_release_date
@release_group.releases
2011-07-18 03:02:37 +00:00
MusicBrainzRelease
2011-09-13 11:00:33 +00:00
@release = MusicBrainz::Release.find(mbid)
@release.id
@release.title
@release.status
@release.date
@release.country
@release.tracks
2011-07-18 03:02:37 +00:00
MusicBrainzTrack
2011-09-13 11:00:33 +00:00
@track = MusicBrainz::Track.find(mbid)
@track.position
@track.recording_id
@track.title
@track.length
2011-07-18 03:02:37 +00:00
=== Contributing
2011-07-17 23:46:18 +00:00
* 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.
2011-07-18 03:02:37 +00:00
=== Copyright
2011-07-17 23:46:18 +00:00
2011-07-18 03:02:37 +00:00
Copyright (c) 2011 Gregory Eremin. See LICENSE.txt for further details.