Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 1.41 KB

README.md

File metadata and controls

35 lines (19 loc) · 1.41 KB

Overhear

Overhear is a Ruby gem for the ListenBrainz Web API. It lets you get/submit data from/to the API easily and quickly.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add overhear

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install overhear

Usage

To interact with the ListenBrainz Web API, you need a user token. Fetch one from your account settings page. Create a user client with:

client = UserClient.new("<token>")

UserClient#listen_count - Return the total listen count for a user

UserClient#now_playing - Return the currently playing song for a user. Returns nil if no song currently playing.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/voxsecundus/overhear.