Project

songkickr

0.04
No release in over 3 years
Low commit activity in last 3 years
A Ruby wrapper around the Songkick API. Visit www.songkick.com/developer for documentation on the Songkick API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 0
>= 0
~> 10.3.0
~> 4.1.0
>= 3.5.0
~> 3.0.0
~> 2.9.0
~> 1.8.0

Runtime

>= 0.5.0
 Project Readme

songkickr¶ ↑

<img src=“https://travis-ci.org/jrmehle/songkickr.png?branch=master” alt=“Build Status” />

A Ruby wrapper around the Songkick API. Visit www.songkick.com/developer for documentation on the Songkick API.

Install Instructions¶ ↑

gem install songkickr

or if your environment requires

sudo gem install songkickr

Usage Instructions¶ ↑

require 'songkickr'
remote = Songkickr::Remote.new API_KEY

Then call one of the remote methods such as events, users_events(username), or concert_setlists(event_id)

Get an artists events by artist name:

results = remote.events('Iron Maiden')

Get an artists events by artist name and filter to only festivals:

results = remote.events(artist_name: 'Metallica', type: 'festival')

Get a users events by username:

results = remote.users_events('jrmehle')

Get a the setlists of a concert by event ID:

results = remote.concert_setlists(2680726)

Use SSL so that your API key is not sent in the clear:

Songkickr::Remote.base_uri 'https://api.songkick.com/api/3.0'

More: As of v0.4.0 songkickr supports all of Songkick’s APIs. Check the RDocs for the Songkickr::RemoteApi classes.

Note on Patches/Pull Requests¶ ↑

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Commit and please do not mess with version or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request against the develop branch.

Releasing a new version¶ ↑

  1. Update the changelog with the new release information (‘git changelog –tag <version> && cat CHANGELOG.md`)

  2. Build the new release locally for testing (‘gem build songkickr.gemspec`)

  3. Tag the release (‘git tag <version>`) – version should follow semantic versioning (ex. v0.1.1)

  4. Publish the release to RubyGems (‘gem signin && gem push songkickr-0.0.0.gem`)

Copyright © 2010-2025 Jared Mehle. See LICENSE for details.

Contributors¶ ↑

Thanks to Andrew Chen, Akshay Dodeja, Tomasz Stachewicz, Dave Knapik, Matt Ruzicka, Alex Beregszaszi, and Github user bibliotechy for submitting code and pull requests.

A special thank you to Jon Nunemaker for httparty which is used extensively within this gem and for the twitter gem as inspiration.