songstats-api

Songstats::Api

The Songstats API Gem is a lightweight tool for developers to interact with the Songstats REST API. With this gem, you can integrate Songstats' music data into your Ruby applications, making it easy to access information about tracks, artists, and more.

To experiment with that code, run bin/console for an interactive prompt.

Installation

Add this line to your application's Gemfile:

gem 'songstats-api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install songstats-api

Usage

To use this gem ensure that SONGSTATS_API_KEY is set as an env variarble.

To use Songstats:Api::Charts ensure SONGSTATS_CHARTS_API_KEY is set as an env variable. This is billed differently than other endpoints so it needs its own api key.

This is a wrapper around Song Stats API - you can find their docs here.

Artist

    artist = Songstats::Api::Artist.new
    artist.search "elton john", {"limit": "1"}
    artist.info "22wbnEMDvgVIAGdFeek6ET"

Track

    track = Songstats::Api::Track.new
    track.search "rocket man", {"limit": "1"}
    track.info "12341234"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/songtradr/songstats-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the Songstats::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.