bbc-radio-names 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae07d3a046271886666167da2d96711e68053bd2
+  data.tar.gz: 1ce2a9e960aff7655c75448f907190116d338dd6
+SHA512:
+  metadata.gz: b07f19eed15cfee62f6f2c32006975ced0653ae30fc131f9e7df3da6ea6921c0511837d90401f95fc52082782eedb0f45a512aff043de3d45918473aa191d9b7
+  data.tar.gz: 1a1802b224bedb7c295e8b001535b0ccd9561c02b831b178ad36bc8847dd63369e38f62c62cad7fed96e66c83b8385ebcfac490702f5fb7993fdc47e875c140f

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bbc-radio-names.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Max Lehmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# BBC Network Names
+
+This gem was created to aid in the testing of the BBC Radio websites, but it is made available to all who might find uses for it. 
+
+## 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).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bbc-radio-names.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bbc-radio-names/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bbc-radio-names'
+  spec.version       = BbcRadioNames::VERSION
+  spec.authors       = ['BBC Sounds']
+  spec.email         = ['anthony.kaluuma@bbc.co.uk']
+
+  spec.summary       = 'A gem for working with BBC Radio Networks'
+  spec.description   = '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.'
+  spec.homepage      = 'https://github.com/bbc/bbc-radio-names'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bbc-radio-names"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bbc-radio-names/version.rb

@@ -0,0 +1,4 @@
+# Version number for the current BbcNetworkNames module
+module BbcRadioNames
+  VERSION = '1.0.0'
+end

data/lib/bbc-radio-names.rb

@@ -0,0 +1,274 @@
+require 'bbc-radio-names/version'
+
+# Access to BBC Radio network names and information
+module BbcRadioNames
+  NATIONALS = {
+    'BBC Radio 1' => {
+      bbc_key: 'radio1',
+      bbc_id: 'bbc_radio_one'
+    },
+    'BBC Radio 1Xtra' => {
+      bbc_key: '1xtra',
+      bbc_id: 'bbc_1xtra'
+    },
+    'BBC Radio 2' => {
+      bbc_key: 'radio2',
+      bbc_id: 'bbc_radio_two'
+    },
+    'BBC Radio 3' => {
+      bbc_key: 'radio3',
+      bbc_id: 'bbc_radio_three'
+    },
+    'BBC Radio 4' => {
+      bbc_key: 'radio4',
+      bbc_id: 'bbc_radio_four'
+    },
+    'BBC Radio 4 Extra' => {
+      bbc_key: 'radio4extra',
+      bbc_id: 'bbc_radio_four_extra'
+    },
+    'BBC Radio 5 Live' => {
+      bbc_key: '5live',
+      bbc_id: 'bbc_radio_five_live'
+    },
+    'BBC Radio 5 Live Sports Extra' => {
+      bbc_key: '5livesportsextra',
+      bbc_id: 'bbc_radio_five_live_sports_extra'
+    },
+    'BBC Radio 6 Music' => {
+      bbc_key: '6music',
+      bbc_id: 'bbc_6music'
+    },
+    'BBC Asian Network' => {
+      bbc_key: 'asiannetwork',
+      bbc_id: 'bbc_asian_network'
+    },
+    'BBC World Service' => {
+      bbc_key: 'worldserviceradio',
+      bbc_id: 'bbc_world_service'
+    }
+  }
+
+  NATIONS = {
+    'BBC Radio Scotland' => {
+      bbc_key: 'radioscotland',
+      bbc_id: 'bbc_radio_scotland'
+    },
+    'BBC Radio Nan Gaidheal' => {
+      bbc_key: 'radionangaidheal',
+      bbc_id: 'bbc_radio_nan_gaidheal'
+    },
+    'BBC Radio Ulster' => {
+      bbc_key: 'radioulster',
+      bbc_id: 'bbc_radio_ulster'
+    },
+    'BBC Radio Foyle' => {
+      bbc_key: 'radiofoyle',
+      bbc_id: 'bbc_radio_foyle'
+    },
+    'BBC Radio Wales' => {
+      bbc_key: 'radiowales',
+      bbc_id: 'bbc_radio_wales'
+    },
+    'BBC Radio Cymru' => {
+      bbc_key: 'radiocymru',
+      bbc_id: 'bbc_radio_cymru'
+    }
+  }
+
+  LOCALS = {
+    'BBC Radio Berkshire' => {
+      bbc_key: 'radioberkshire',
+      bbc_id: 'bbc_radio_berkshire'
+    },
+    'BBC Radio Bristol' => {
+      bbc_key: 'radiobristol',
+      bbc_id: 'bbc_radio_bristol'
+    },
+    'BBC Radio Cambridgeshire' => {
+      bbc_key: 'radiocambridgeshire',
+      bbc_id: 'bbc_radio_cambridge'
+    },
+    'BBC Radio Cornwall' => {
+      bbc_key: 'radiocornwall',
+      bbc_id: 'bbc_radio_cornwall'
+    },
+    'BBC Coventry & Warwickshire' => {
+      bbc_key: 'bbccoventryandwarwickshire',
+      bbc_id: 'bbc_radio_coventry_warwickshire'
+    },
+    'BBC Radio Cumbria' => {
+      bbc_key: 'radiocumbria',
+      bbc_id: 'bbc_radio_cumbria'
+    },
+    'BBC Radio Derby' => {
+      bbc_key: 'radioderby',
+      bbc_id: 'bbc_radio_derby'
+    },
+    'BBC Radio Devon' => {
+      bbc_key: 'radiodevon',
+      bbc_id: 'bbc_radio_devon'
+    },
+    'BBC Essex' => {
+      bbc_key: 'bbcessex',
+      bbc_id: 'bbc_radio_essex'
+    },
+    'BBC Radio Gloucestershire' => {
+      bbc_key: 'radiogloucestershire',
+      bbc_id: 'bbc_radio_gloucestershire'
+    },
+    'BBC Radio Guernsey' => {
+      bbc_key: 'radioguernsey',
+      bbc_id: 'bbc_radio_guernsey'
+    },
+    'BBC Hereford & Worcester' => {
+      bbc_key: 'bbcherefordandworcester',
+      bbc_id: 'bbc_radio_hereford_worcester'
+    },
+    'BBC Radio Humberside' => {
+      bbc_key: 'radiohumberside',
+      bbc_id: 'bbc_radio_humberside'
+    },
+    'BBC Radio Jersey' => {
+      bbc_key: 'radiojersey',
+      bbc_id: 'bbc_radio_jersey'
+    },
+    'BBC Radio Kent' => {
+      bbc_key: 'radiokent',
+      bbc_id: 'bbc_radio_kent'
+    },
+    'BBC Radio Lancashire' => {
+      bbc_key: 'radiolancashire',
+      bbc_id: 'bbc_radio_lancashire'
+    },
+    'BBC Radio Leeds' => {
+      bbc_key: 'radioleeds',
+      bbc_id: 'bbc_radio_leeds'
+    },
+    'BBC Radio Leicester' => {
+      bbc_key: 'radioleicester',
+      bbc_id: 'bbc_radio_leicester'
+    },
+    'BBC Radio Lincolnshire' => {
+      bbc_key: 'radiolincolnshire',
+      bbc_id: 'bbc_radio_lincolnshire'
+    },
+    'BBC Radio London' => {
+      bbc_key: 'radiolondon',
+      bbc_id: 'bbc_london'
+    },
+    'BBC Radio Manchester' => {
+      bbc_key: 'radiomanchester',
+      bbc_id: 'bbc_radio_manchester'
+    },
+    'BBC Radio Merseyside' => {
+      bbc_key: 'radiomerseyside',
+      bbc_id: 'bbc_radio_merseyside'
+    },
+    'BBC Newcastle' => {
+      bbc_key: 'bbcnewcastle',
+      bbc_id: 'bbc_radio_newcastle'
+    },
+    'BBC Radio Norfolk' => {
+      bbc_key: 'radionorfolk',
+      bbc_id: 'bbc_radio_norfolk'
+    },
+    'BBC Radio Northampton' => {
+      bbc_key: 'radionorthampton',
+      bbc_id: 'bbc_radio_northampton'
+    },
+    'BBC Radio Nottingham' => {
+      bbc_key: 'radionottingham',
+      bbc_id: 'bbc_radio_nottingham'
+    },
+    'BBC Radio Oxford' => {
+      bbc_key: 'radiooxford',
+      bbc_id: 'bbc_radio_oxford'
+    },
+    'BBC Radio Sheffield' => {
+      bbc_key: 'radiosheffield',
+      bbc_id: 'bbc_radio_sheffield'
+    },
+    'BBC Radio Shropshire' => {
+      bbc_key: 'radioshropshire',
+      bbc_id: 'bbc_radio_shropshire'
+    },
+    'BBC Radio Solent' => {
+      bbc_key: 'radiosolent',
+      bbc_id: 'bbc_radio_solent'
+    },
+    'BBC Somerset' => {
+      bbc_key: 'bbcsomerset',
+      bbc_id: 'bbc_radio_somerset_sound'
+    },
+    'BBC Radio Stoke' => {
+      bbc_key: 'radiostoke',
+      bbc_id: 'bbc_radio_stoke'
+    },
+    'BBC Radio Suffolk' => {
+      bbc_key: 'radiosuffolk',
+      bbc_id: 'bbc_radio_suffolk'
+    },
+    'BBC Surrey' => {
+      bbc_key: 'bbcsurrey',
+      bbc_id: 'bbc_radio_surrey'
+    },
+    'BBC Sussex' => {
+      bbc_key: 'bbcsussex',
+      bbc_id: 'bbc_radio_sussex'
+    },
+    'BBC Tees' => {
+      bbc_key: 'bbctees',
+      bbc_id: 'bbc_tees'
+    },
+    'BBC Three Counties Radio' => {
+      bbc_key: 'threecountiesradio',
+      bbc_id: 'bbc_three_counties_radio'
+    },
+    'BBC Wiltshire' => {
+      bbc_key: 'bbcwiltshire',
+      bbc_id: 'bbc_radio_wiltshire'
+    },
+    'BBC WM 95.6' => {
+      bbc_key: 'wm',
+      bbc_id: 'bbc_wm'
+    },
+    'BBC Radio York' => {
+      bbc_key: 'radioyork',
+      bbc_id: 'bbc_radio_york'
+    }
+  }
+
+  ALL_NETWORKS = NATIONALS.merge(NATIONS).merge(LOCALS)
+
+  NETWORK_TYPES = {
+    'nationals' => NATIONALS,
+    'nations' => NATIONS,
+    'locals' => LOCALS
+  }
+
+  # Looks up a network key by network name
+  def self.get_network_key(network_name)
+    ALL_NETWORKS[network_name][:bbc_key]
+  end
+
+  # Looks up a network ID by network name
+  def self.get_network_id(network_name)
+    ALL_NETWORKS[network_name][:bbc_id]
+  end
+
+  # Returns an array of all networks' user friendly names
+  def self.list_networks
+    ALL_NETWORKS.keys
+  end
+
+  # Returns a random network name
+  def self.random_network_name(type = 'all_networks')
+    if type == 'all_networks'
+      network_type = NETWORK_TYPES.keys.sample
+      NETWORK_TYPES[network_type].keys.sample
+    else
+      NETWORK_TYPES[type].keys.sample
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: bbc-radio-names
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- BBC Sounds
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 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.
+email:
+- anthony.kaluuma@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbc-radio-names.gemspec
+- bin/console
+- bin/setup
+- lib/bbc-radio-names.rb
+- lib/bbc-radio-names/version.rb
+homepage: https://github.com/bbc/bbc-radio-names
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A gem for working with BBC Radio Networks
+test_files: []