/spotify-search

A simple library for searching spotify for obscure titles.

Primary LanguageRubyMIT LicenseMIT

Spotify-search

This is a simple gem that allows for searching of Spotify's web-api, given an artist and song name.

Installation

Add this line to your application's Gemfile:

gem 'spotify-search'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install spotify-search

Usage

The searcher requires a client id and client secret, which can be passed into the initialization function.

SpotifySearch::Searcher.new("client-id-abcd","client-secret-1234")

The client id and secret args are optional - if you have SPOTIFY_CLIENT_ID and SPOTIFY_CLIENT_SECRET defined in your environment, the Searcher class will use them.

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/[USERNAME]/spotify-search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

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