Ruby ActiveRecord models for the MusicBrainz database.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

ActiveMusicbrainz

ActiveRecord models for the MusicBrainz database.

Installation

Add this line to your application's Gemfile:

gem 'active_musicbrainz'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_musicbrainz

Usage

Require ActiveMusicbrainz and initialize the database (if you are inside a rails app, you can skip the following lines):

require 'active_musicbrainz'
ActiveRecord::Base.establish_connection(YAML.load_file('path/to/config.yml'))

Some models are hardcoded, others are dynamically generated based on existing tables. You can initialize all those models with the following line:

ActiveMusicbrainz.init

The init method should be called after establishing a database connection since the library needs to read all the database tables. If you are inside a rails project you could put the code above in config/initializers/active_musicbrainz.rb.

If you want to establish a different database connection for the ActiveMusicbrainz tables you can call the establish_connection method on ActiveMusicbrainz::Module::Base instead of ActiveRecord::Base:

ActiveMusicbrainz::Model::Base.establish_connection(YAML.load_file('path/to/config.yml'))

Now under the ActiveMusicbrainz::Model module, you have one model for each MusicBrainz table. Here some examples:

artist = ActiveMusicbrainz::Model::Artist.by_gid '9a709693-b4f8-4da9-8cc1-038c911a61be'
 => #<ActiveMusicbrainz::Model::Artist id: 24146, gid: "9a709693-b4f8-4da9-8cc1-038c911a61be", name: 143497, sort_name: 143497, begin_date_year: 1976, begin_date_month: 3, begin_date_day: 30, end_date_year: nil, end_date_month: nil, end_date_day: nil, type: 1, area: 221, gender: 1, comment: "UK electro artist Simon Green", edits_pending: 0, last_updated: "2013-05-13 11:00:09", ended: false, begin_area: nil, end_area: nil>

artist.name
 => "Bonobo"

artist.release_groups.first.type
 => #<ActiveMusicbrainz::Model::ReleaseGroupPrimaryType id: 1, name: "Album">

artist.release_groups.each{|r| puts r.name }
  Black Sands
  Dial 'M' for Monkey
  Scuba EP
  Flutter
  Pick Up
  Terrapin
  Eyesdown
  ...

artist.release_groups.first.releases.first.mediums
 => [#<ActiveMusicbrainz::Model::Medium id: 654199, release: 654199, position: 1, format: 1, name: nil, edits_pending: 0, last_updated: "2012-01-15 13:46:18", track_count: 12>]

artist.release_groups.first.releases.first.mediums.first.tracks.each{|t| puts t.name}
  Prelude
  Kiara
  Kong
  Eyesdown
  ...

artist.release_groups.first.releases.first.mediums.first.format
 => #<ActiveMusicbrainz::Model::MediumFormat id: 1, name: "CD", parent: nil, child_order: 0, year: 1982, has_discids: true>

Author

Andrea Franz - http://gravityblast.com

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request