Contents

# Intown

A gem to consume the Bandsintown 2.0 API.  Supports finding artists by name, MusicBrainz ID, & Facebook Page Id.  Supports returning events by artist & optional date range.

## Installation

Add this line to your application's Gemfile:

    gem 'intown'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install intown

## Usage

Set your "app_id" configuration before making any calls.  In a Rails app, this would go in `config/initializers/intown.rb`.

```ruby
Intown.configure do |config|
  config.app_id = <YOUR APP ID HERE>
end
```

### Fetching an artist

```ruby
Intown::Artist.fetch(params)
```

Params should be one of the following:

```ruby
{:name => "Radiohead"}
{:mbid => "<band's MusicBrainz ID>"}
{:fbid => "<band's Facebook page ID>"}
```

Returns an object that responds to the API attributes in the [Bandsintown API documentation](http://www.bandsintown.com/api/responses#artist-json)

Returns nil if the band cannot be found.

### Fetching events for an artist

```ruby
Intown::Event.list(params)
```

Params should identify the artist to search for (see above).  Params may also include one of the following date options:

```ruby
{:upcoming => true}        # default: only returns future events
{:all => true}             # returns all events for this artist
{:date => 3.days.from_now} # returns all events on the specified date
{:from => 3.days.ago, :to => 5.days.from_now } # returns all events in the date range (inclusive)
```

Returns an object that responds to the API attributes in the [Bandsintown API documentation](http://www.bandsintown.com/api/responses#event-json)

Returns nil if the band does not exist.


## 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. Write Tests
5. Push to the branch (`git push origin my-new-feature`)
6. Create new Pull Request

## License

This code is provided under the MIT license.  See LICENSE.txt for more details.

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
intown-0.2	README.md
intown-0.1.6	README.md
intown-0.1.5	README.md
intown-0.1.4	README.md
intown-0.1.3	README.md
intown-0.1.2	README.md
intown-0.1.1	README.md
intown-0.1.0	README.md