Adapter for Radiooooo private API.
For music exploration purposes only 🧐
It turned out that 95% of all functionality doesn't even require an account (I'm not even talking about premium one), so here we go.
Install the gem and add to Gemfile:
bundle add radio5
Or install it manually:
gem install radio5
Create a client:
client = Radio5::Client.new
You can pass additional HTTP configration if needed:
client = Radio5::Client.new(
open_timeout: 30, # default: 10
read_timeout: 30, # default: 10
write_timeout: 30, # default: 10
proxy_url: "http://user:pass@123.4.56.178:80", # default: nil
max_retries: 5, # for network errors, default: 3
debug_output: $stdout # default: nil
)
To get random track:
client.random_track
# => {
# id: "655f7bb24b0d722a021a2cf2",
# uuid: <uuid>,
# artist: "Kaye Ballard",
# title: "In Other Words (Fly Me to the Moon)",
# album: "In Other Words / Lazy Afternoon",
# year: "1954",
# label: "Decca",
# songwriter: "Bart Howard",
# length: 133,
# info: "It is the original recording of Fly me to the moon !",
# cover_url: {
# thumb: "https://asset.radiooooo.com/cover/USA/1950/thumb/<uuid>_1.jpg",
# small: "https://asset.radiooooo.com/cover/USA/1950/small/<uuid>_1.jpg",
# medium: "https://asset.radiooooo.com/cover/USA/1950/medium/<uuid>_1.jpg",
# large: "https://asset.radiooooo.com/cover/USA/1950/large/<uuid>_1.jpg",
# },
# audio: {
# mpeg: {
# url: "https://radiooooo-track.b-cdn.net/USA/1950/<uuid>.mp3?token=<token>&expires=1704717060",
# expires_at: 2024-01-08 12:31:00 UTC
# },
# ogg: {
# url: "https://radiooooo-track.b-cdn.net/USA/1950/<uuid>.ogg?token=<token>&expires=1704717060",
# expires_at: 2024-01-08 12:31:00 UTC
# }
# },
# decade: 1950,
# mood: :slow,
# country: "USA",
# like_count: 3,
# created_at: nil,
# created_by: "655ec7fce03fdc024c70f698"
# }
#
# NOTES:
# - `created_at` - always nil here (API limitations), available via `#track` if needed
# - `created_by` - `id` of user who uploaded this track
To get random track using additional filters:
# with country
client.random_track(country: "FRA")
# with decade(s)
client.random_track(decades: [1960, 2000])
# with mood(s)
client.random_track(moods: [:slow, :weird])
# with everything together
client.random_track(country: "SWE", decades: [1940, 1980, 2010], moods: [:slow, :fast])
# in case no tracks match the filters
client.random_track(country: "KN1", decades: [1940], moods: [:weird])
# => nil
To get information about specific track using its id:
client.track("655f7bb24b0d722a021a2cf2")
# => {
# ...
# created_at: 2023-11-23 16:20:02.283 UTC
# }
#
# output is exactly the same as from `#random_track`, but `created_at` is now filled
OK, what input parameters are available?
# countries
client.countries
# => {
# "AFG" => {name: "Afganistan", exist: true, rank: nil},
# "CBE" => {name: "Belgian Congo", exist: false, rank: nil},
# "FRA" => {name: "France", exist: true, rank: 2},
# ...
# }
#
# NOTES:
# - `exist` - "is it still around" flag
# - `rank` - subjective ranking provided by the website, only 10 countries have it
# decades
client.decades
# => [1900, 1910, 1920, ..., 2010, 2020]
# moods
client.moods
# => [:fast, :slow, :weird]
#
# NOTE: all 3 moods are used in `#random_track` and `#island_track` by default
It's also possible to get all valid country/ moods combinations for specific decade in advance:
# grouped by country
client.countries_for_decade(1960)
# => {
# "THA" => [:fast, :slow, :weird],
# "TWN" => [:fast, :slow, :weird],
# "EST" => [:fast, :slow],
# "ALB" => [:fast, :slow],
# "NZL" => [:fast, :slow],
# ...
# }
# grouped by mood
client.countries_for_decade(1960, group_by: :mood)
# => {
# slow: ["FRA", "THA", "ALB", "GRC", "IRL", ...],
# fast: ["THA", "TWN", "EST", "ALB", "NZL", ...],
# weird: ["AZE", "POL", "IRN", "YUG", "DAH", ...]
# }
Islands work as a kind of thematic collections.
To get a list of all islands:
client.islands
# => [{
# id: "5d330a3e06fb03d8872a3316",
# uuid: <uuid>,
# api_id: <api_id>,
# name: "Intimacy",
# info: "To get Laid. Slow to start. Fast to go further. Weird when nothing works.",
# category: "thematic",
# favourite_count: 1,
# play_count: 783339,
# rank: 17,
# icon_url: "https://asset.radiooooo.com/island/icon/<uuid>_2.svg",
# splash_url: "https://asset.radiooooo.com/island/splash/<uuid>_13.svg",
# marker_url: "https://asset.radiooooo.com/island/marker/<uuid>_9.svg",
# enabled: true,
# free: false,
# on_map: false,
# random: false,
# play_mode: "RANDOM",
# created_at: 2016-02-12 16:31:00 UTC,
# created_by: "5d3306de06fb03d8871fd119",
# updated_at: 2023-02-17 15:54:09.806 UTC,
# updated_by: "5d3306de06fb03d8871fd119"
# }, ...]
#
# NOTES:
# - `api_id` - have no idea where it is used
# - `rank` - 1..160, not unique, can be nil
# - `enabled` - is it searchable via web app, doesn't matter in our case ^^
# - `free` - do you need premium account to listen to it, doesn't matter ^^
# - `on_map` - is it displayed on a global map currently
# - `random` - there is only one playlist with `true` and it's called "Shuffle";
# basically the same as `#random_track` with no filters
# - `play_mode` - it is somehow used in a web app
# - `created_by` - `id` of user who created this island
# - `updated_by` - ...and who updated it last time
To get random track from selected island:
client.island_track(island_id: "5d330a3e06fb03d8872a3316")
# it's also possible to specify moods
client.island_track(island_id: "5d330a3e06fb03d8872a3316", moods: [:fast, :weird])
To get information about specific user using its id:
client.user("5d3306de06fb03d8871fd138")
# => {
# id: "5d3306de06fb03d8871fd138",
# uuid: <uuid>,
# name: "Paul Charmant-Kabil",
# info: "Dreamseeker",
# country: "FRA",
# rank: 9188,
# image_url: {
# icon: "https://asset.radiooooo.com/user/1409/icon/<uuid>_3.jpg",
# thumb: "https://asset.radiooooo.com/user/1409/thumb/<uuid>_3.jpg",
# small: "https://asset.radiooooo.com/user/1409/small/<uuid>_3.jpg",
# medium: "https://asset.radiooooo.com/user/1409/medium/<uuid>_3.jpg",
# large: "https://asset.radiooooo.com/user/1409/large/<uuid>_3.jpg"
# },
# birthday: {
# time: 1981-01-31 23:01:01 UTC,
# year_normalized: 1981
# },
# created_at: 2014-09-30 18:58:32 UTC
# }
#
# NOTES:
# - `rank` - is not unique
# - `birthday`:
# - `time` - original time from API, it is always around the first day of January or
# the last day of December, with a strange hour offset around midnight, so
# it looks like the only real value here is the year
# - `year_normalized` - de-offset'ed year
To get user followers or followings counts:
client.user_follow_counts("5d3306de06fb03d8871fd138")
# => {
# followings: 17,
# followers: 866
# }
To get list of user followers:
# all followers will be returned by default
client.user_followers("5d3306de06fb03d8871fd138")
# => [{
# id: "5f8f175051430765bd5c1b08",
# name: "Philart",
# country: "FRA",
# rank: 25,
# image_url: {
# icon: "https://asset.radiooooo.com/user/2010/icon/<uuid>_1.jpg",
# thumb: "https://asset.radiooooo.com/user/2010/thumb/<uuid>_1.jpg",
# small: "https://asset.radiooooo.com/user/2010/small/<uuid>_1.jpg",
# medium: "https://asset.radiooooo.com/user/2010/medium/<uuid>_1.jpg",
# large: "https://asset.radiooooo.com/user/2010/large/<uuid>_1.jpg"
# },
# created_at: 2020-10-20 16:58:56.819 UTC
# }, ...]
# it's also possible to specify size/page
client.user_followers("5d3306de06fb03d8871fd138", size: 1, page: 5)
# => [{...}]
To get list of user followings:
# all followings will be returned by default
client.user_followings("5d3306de06fb03d8871fd138")
# => [{
# id: "640ab0cebf47667afdbf9edb",
# name: "Cap Jones",
# country: "USA",
# rank: 5,
# image_url: {
# icon: "https://asset.radiooooo.com/user/2303/icon/<uuid>_1.jpg",
# thumb: "https://asset.radiooooo.com/user/2303/thumb/<uuid>_1.jpg",
# small: "https://asset.radiooooo.com/user/2303/small/<uuid>_1.jpg",
# medium: "https://asset.radiooooo.com/user/2303/medium/<uuid>_1.jpg",
# large: "https://asset.radiooooo.com/user/2303/large/<uuid>_1.jpg"
# },
# created_at: 2023-03-10 04:23:42.87 UTC
# }, ...]
# it's also possible to specify size/page
client.user_followings("5d3306de06fb03d8871fd138", size: 1, page: 5)
# => [{...}]
You can find examples of usage here.
There is just a couple of features that require login (free or premium account):
#track_history - list of tracks you "listened" via #random_track or #island_track (free)user[:followed] flag - indicates whether or not you follow this user (free)#user_liked_tracks - list of tracks which user really vibed to (free)#random_track (premium)Currently auth is in a WIP state.
bin/setup # install deps
bin/console # interactive prompt to play around
rake spec # run tests!
rake spec:no_vcr # run tests with VCR cassettes disabled!
rake rubocop # lint code!
rake rubocop:md # lint docs!
sudo rm -rf / # just kidding ^^
Bug reports and pull requests are welcome on GitHub at https://github.com/ocvit/radio5.
The gem is available as open source under the terms of the MIT License.
FAQs
Unknown package
We found that radio5 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.