Contents

# BBC Radio Names

[![Gem Version](https://badge.fury.io/rb/bbc-radio-names.svg)](https://badge.fury.io/rb/bbc-radio-names)

A gem for working with BBC Radio Networks, this gem exposes network names, IDs and url keys and is intended as a single, up to date, source of truth

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'bbc-radio-names'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install bbc-radio-names

## Usage

### List all networks
```ruby
BbcRadioNames.list_networks
```
Returns an array of the official names of all the BBC networks.

### Look up a network key
```ruby
BbcRadioNames.get_network_key('BBC Radio Kent')
```
Returns the BBC ID of the network supplied, in this example "bbc_radio_kent"

### Look up a network ID
```ruby
BbcRadioNames.get_network_id('BBC Radio Kent')
```
Returns the BBC ID of the network supplied, in this example "radiokent"

### Get a random network name
```ruby
BbcRadioNames.random_network_name('nationals')
```
Returns a network name of the specified type. Options are 'nationals', 'nations' or 'locals'. If no argument is supplied it will randomise the type it returns.

## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
bbc-radio-names-1.1.1	README.md