pifi 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e438554830dd34a08a8bbd6c1b50147bd3a57fcd83375ff650ac2e250d13af5
-  data.tar.gz: 5994a88287ab9c58f799cec839f7a2d84d5f2ba849002faba2475769176c6fe0
+  metadata.gz: d5f23359fd7fec0b731f4bcfa9ae43aa2b9beadf4285a0f9712669d467c228bb
+  data.tar.gz: 0f538b70d4ca73e0e4fc0cb311606771619f479e5b9808ff0856f91ad11a88c8
 SHA512:
-  metadata.gz: fcdd705b344569802b03a03cc0447c8c0b2b6b1dbf2256ba01cf659f46ed2efc901537ea02cf02841610d613e584442c047589fc2a2609bb1fb3bd53327ee0ec
-  data.tar.gz: 843cc7461a81904893dfc052451849eedf3aa36197ede2b2f6cc0dba60b97e6df3f697e9941f6b5f2088af3b14bfd0cf5c30f7f434ed5366a764dcfc4c3411a8
+  metadata.gz: 8eef993856b6ed226b168f64b5ec7a630ff64891d8870be6904637280fc1821bda4cd2169fe0822c35f52cf3655881d3e760039a3940b0482a7713499f22333b
+  data.tar.gz: 9ded257c363d169983a99eaa66d500aed7e8daead81af1d96a7f6c406fe024e0c89cd4475f062221b78c3beb607f9404d64186addba7e6fbd7cd83cb16df3dd5

data/README.md

@@ -5,7 +5,6 @@ PiFi Radio: A MPD web client to listen to radio
 ## Table of contents
 
 - [Meet PiFi Radio](#meet-pifi-radio)
-  - [What is PiFi Radio](#what-is-pifi-radio)
   - [Some features](#some-features)
   - [Demo](#demo)
 - [Installation](#installation)
@@ -17,53 +16,32 @@ PiFi Radio: A MPD web client to listen to radio
 
 ## Meet PiFi Radio
 
-### What is PiFi Radio
+PiFi Radio is a MPD web client to listen to radio.
 
-PiFi Radio is a minimalist MPD web client to listen to radio. In other words, it makes your Raspberry Pi play Internet radio, while you control from any device, such as your phone.
+If you have no idea what this means... You install it on a device such as the Raspberry Pi or even your computer. Actually anything with a speaker. Then, you open your browser from anywhere (e.g. your phone) and it will play your favorite radio stations.
 
-As PiFi is just an interface for MPD, it has some advantages compared to other solutions, e.g. bluetooth or AirPlay. For example, the radio playback is completely independent from your phone. You can take calls, play videos, go to an area with poor WiFi signal, or even turn off your phone. Your Pi will still continue to play the radio you picked.
+PiFi is an interface for MPD, so it has some advantages compared to other solutions, e.g. bluetooth or AirPlay. One of them is that the playback is completely independent from your phone. So you can continue to use it normally, play a video, lose connection or even turn it off, and your Pi will still continue to play the radio.
 
 [I started this project in early 2017. At that time, I wanted to configure Raspbian so my parents could listen to radio with ease, but couldn't find any good solution to it.](https://rafaelc.org/blog/the-motivation-for-pifi-radio/)
 
-Some of the goals of PiFi Radio were the following:
 
-- Easy for my parents to use.
-
-- Simple, straight-forward interface. Do the few things they need and in a clear way.
-
-- As fool-proof as possible. Don't show unnecessary options, minimize user interaction and try to predict what they want.
-
-- Display both available and current stations clearly. No URLs or weird names.
-
-- Multi-platform, targeting primarily mobile phones.
-
-- In local language.
-
-### Some features
-
-Although PiFi tries to be minimal, there are some neat features, such as:
-
-- Radios can be organized in categories, if you wish.
-
-- You can select some radios to be offered only to certain IPs. A use case for this is if there are tons of stations that only you listen and you don't want to pollute everyone else's list.
+## Some features
 
+- Responsive interface for phones, tablets and desktops.
+- Display stations clearly. No URLs or weird names.
+- Easily search your radios.
+- Themes.
+- Straight-forward beautiful interface. Minimalist yet taking advantage of screen space for important information and controls.
+- Centralized list of stations. You get the same radios on every device.
+- Make some radios to be offered only to certain IPs. A use case for this is if there are tons of stations that only you listen and you don't want to pollute everyone else's list.
+- Organize your radios by categories.
 - Streaming URLs can be pasted directly from your web browser. Useful if you want to listen to a radio that was not previously added to the list.
-
-- If by mistake you choose the same station that is currently playing, the playback just continues normally.
-
-- Multiple people can use it at the same time.
-
-- It can be conveniently added to your phone home screen.
-
-- The app has two views [(playback controls and stations list)](#demo), and tries to show each one smartly so you tap less. For example, when you open PiFi and MPD is idle, the list of radios is shown, because you probably want to pick a station.
-
-- Besides radio, it has the "Random" button, that I added by request. Tapping it plays all the music in your MPD library in shuffle mode. To skip the current song, just press it again. That's the only library function available on the app. Think of that as a bonus, as library support is an after-thought on PiFi, and not its main purpose. [You can disable this button in the configuration.](#pifi-configuration)
-
-- PiFi is currently available in a few languages, and it's easy to translate to more.
+- Multi-language.
+- Usable by multiple people at the same time.
 
 ## Demo
 
-![Video demo](docs/demo.gif)
+Coming soon.
 
 ## Installation
 
@@ -72,7 +50,7 @@ While PiFi was imagined for the Pi, it should run on any computer with Ruby and
 Install it with:
 
 ```
-$ sudo gem install pifi --no-ri --no-rdoc
+$ sudo gem install pifi --no-document
 ```
 
 Place a list of streams at `/etc/pifi/streams.json`:
@@ -124,16 +102,15 @@ It's now completely optional to have a configuration file for PiFi. You only nee
 
 The path is `/etc/pifi/config.json` and these are the options:
 
-| Key             | Default                  | Description                                                                                                       |
-| --------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |
-| `mpd_host`      | `127.0.0.1`              | MPD host.                                                                                                         |
-| `mpd_port`      | `6600`                   | MPD port.                                                                                                         |
-| `mpd_password`  | `""` (none)              | MPD password.                                                                                                     |
-| `streams_path`  | `/etc/pifi/streams.json` | Path to the JSON file containing the streams.                                                                     |
+| Key                 | Default                  | Description                                                                                                       |
+| ------------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |
+| `mpd_host`          | `127.0.0.1`              | MPD host.                                                                                                         |
+| `mpd_port`          | `6600`                   | MPD port.                                                                                                         |
+| `mpd_password`      | `""` (none)              | MPD password.                                                                                                     |
+| `streams_path`      | `/etc/pifi/streams.json` | Path to the JSON file containing the streams.                                                                     |
 | `streams_path_priv` | `""` (none)              | Path to JSON file containing additional streams. These will be shown only to the devices listed on `special_ips`. |
-| `special_ips`   | `""` (none)              | The IPs of the devices to show additional streams.                                                                |
-| `play_local`    | `false`                  | Set it to `true` if you want PiFi to play songs from your local library. This shows the "Random" button.          |
-| `serve_static`  | `true`                   | If we should serve static resources. Set it to `false` if your web server is already doing it.                    |
+| `special_ips`       | `""` (none)              | The IPs of the devices to show additional streams.                                                                |
+| `serve_static`      | `true`                   | If we should serve static resources. Set it to `false` if your web server is already doing it.                    |
 
 If you want to change any of these options, download the sample file and edit it to your needs:
 

data/config.ru

@@ -2,3 +2,4 @@ require "pifi"
 
 map("/") { run PiFi::IndexController }
 map("/api/player") { run PiFi::PlayerController }
+map("/api/streams") { run PiFi::StreamsController }

data/lib/pifi.rb

@@ -1,2 +1,3 @@
 require "pifi/controllers/index_controller"
 require "pifi/controllers/player_controller"
+require "pifi/controllers/streams_controller"

data/lib/pifi/controllers/application_controller.rb

@@ -1,16 +1,18 @@
 require "pifi/lib/config_getter"
-require "pifi/lib/streams_getter"
+require "pifi/lib/streams"
 require "sinatra/base"
 
 module PiFi
   class ApplicationController < Sinatra::Base
     set ConfigGetter.new.config
-    set :streams, StreamsGetter.new(settings.streams_path, settings.streams_path_priv).streams
-
+    set :streams, Streams.new(settings.streams_path, settings.streams_path_priv)
     set :root, File.expand_path("../../", __FILE__)
 
     configure :production do
       set :static, settings.serve_static
     end
+    configure :development do
+      before { response.headers["Access-Control-Allow-Origin"] = "*" }
+    end
   end
 end

data/lib/pifi/controllers/index_controller.rb

@@ -1,5 +1,4 @@
 require "pifi/controllers/application_controller"
-require "pifi/lib/lang_chooser"
 
 module PiFi
   class IndexController < ApplicationController
@@ -8,26 +7,12 @@ module PiFi
       settings.production? ? title : "[#{settings.environment.capitalize}] #{title}"
     end
 
-    def special_ip?
-      # Try to get remote IP if behind reverse-proxy
-      ip = env["HTTP_X_FORWARDED_FOR"] || request.ip
-      settings.special_ips.include?(ip)
-    end
-
-    def streams_set
-      special_ip? ? settings.streams[:all] : settings.streams[:pub]
-    end
-
-    def lang
-      LangChooser.new(env["HTTP_ACCEPT_LANGUAGE"]).lang
-    end
-
     def play_local?
       settings.play_local
     end
 
     get "/" do
-      erb :index
+      send_file File.join(settings.public_folder, 'index.html')
     end
   end
 end

data/lib/pifi/controllers/player_controller.rb

@@ -9,7 +9,7 @@ module PiFi
       @@player
     end
 
-    @@player = Player.new(settings.streams[:all],
+    @@player = Player.new(settings.streams.all,
                           host = settings.mpd_host,
                           port = settings.mpd_port,
                           password = settings.mpd_password)

data/lib/pifi/controllers/streams_controller.rb

@@ -0,0 +1,20 @@
+require "pifi/controllers/application_controller"
+
+module PiFi
+  class StreamsController < ApplicationController
+    get "/" do
+      content_type :json
+      streams_set.transform_values { |v| v.empty? }.to_json
+    end
+
+    def special_ip?
+      # Try to get remote IP if behind reverse-proxy
+      ip = env["HTTP_X_FORWARDED_FOR"] || request.ip
+      settings.special_ips.include?(ip)
+    end
+
+    def streams_set
+      special_ip? ? settings.streams.all : settings.streams.pub
+    end
+  end
+end

data/lib/pifi/lib/{streams_getter.rb → streams.rb}

@@ -1,7 +1,7 @@
 require "pifi/lib/utils"
 
 module PiFi
-  class StreamsGetter
+  class Streams
     include Utils
 
     def initialize(path_pub, path_priv="")
@@ -10,19 +10,18 @@ module PiFi
       check_paths
     end
 
-    def streams
-      @streams ||= parse_streams
+    def all
+      @all ||= pub.merge(priv)
     end
 
+    def pub
+      @pub ||= file_to_hash(@path_pub)
+    end
 
     private
 
-    def parse_streams
-      pub = file_to_hash(@path_pub)
-      priv = @path_priv.empty? ? {} : file_to_hash(@path_priv)
-      all = pub.merge(priv)
-
-      {pub: pub, all: all}
+    def priv
+      @priv ||= @path_priv.empty? ? {} : file_to_hash(@path_priv)
     end
 
     def check_paths

data/lib/pifi/public/asset-manifest.json

@@ -0,0 +1,26 @@
+{
+  "files": {
+    "main.css": "/static/css/main.a50e54d2.chunk.css",
+    "main.js": "/static/js/main.54482466.chunk.js",
+    "main.js.map": "/static/js/main.54482466.chunk.js.map",
+    "runtime-main.js": "/static/js/runtime-main.f04a0f25.js",
+    "runtime-main.js.map": "/static/js/runtime-main.f04a0f25.js.map",
+    "static/css/2.5dbdccff.chunk.css": "/static/css/2.5dbdccff.chunk.css",
+    "static/js/2.2b057ab5.chunk.js": "/static/js/2.2b057ab5.chunk.js",
+    "static/js/2.2b057ab5.chunk.js.map": "/static/js/2.2b057ab5.chunk.js.map",
+    "index.html": "/index.html",
+    "precache-manifest.c6c8e4145c1ed2fcfcefd9d025331f85.js": "/precache-manifest.c6c8e4145c1ed2fcfcefd9d025331f85.js",
+    "service-worker.js": "/service-worker.js",
+    "static/css/2.5dbdccff.chunk.css.map": "/static/css/2.5dbdccff.chunk.css.map",
+    "static/css/main.a50e54d2.chunk.css.map": "/static/css/main.a50e54d2.chunk.css.map",
+    "static/js/2.2b057ab5.chunk.js.LICENSE": "/static/js/2.2b057ab5.chunk.js.LICENSE",
+    "static/media/player.scss": "/static/media/logo.91554ce9.svg"
+  },
+  "entrypoints": [
+    "static/js/runtime-main.f04a0f25.js",
+    "static/css/2.5dbdccff.chunk.css",
+    "static/js/2.2b057ab5.chunk.js",
+    "static/css/main.a50e54d2.chunk.css",
+    "static/js/main.54482466.chunk.js"
+  ]
+}

data/lib/pifi/public/browserconfig.xml

@@ -3,7 +3,7 @@
     <msapplication>
         <tile>
             <square150x150logo src="/mstile-150x150.png"/>
-            <TileColor>#da532c</TileColor>
+            <TileColor>#2b5797</TileColor>
         </tile>
     </msapplication>
 </browserconfig>

data/lib/pifi/public/index.html

@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><link rel="icon" href="/favicon.ico"/><meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="description" content="MPD web client to listen to radio"/><link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"><link rel="manifest" href="/manifest.json"><link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5"><meta name="apple-mobile-web-app-title" content="PiFi Radio"><meta name="application-name" content="PiFi Radio"><meta name="msapplication-TileColor" content="#2b5797"><meta name="theme-color" content="#375a7f"><title>PiFi Radio</title><link href="" rel="stylesheet" title="theme"><link href="/static/css/2.5dbdccff.chunk.css" rel="stylesheet"><link href="/static/css/main.a50e54d2.chunk.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="root"></div><script>!function(l){function e(e){for(var r,t,n=e[0],o=e[1],u=e[2],f=0,i=[];f<n.length;f++)t=n[f],Object.prototype.hasOwnProperty.call(a,t)&&a[t]&&i.push(a[t][0]),a[t]=0;for(r in o)Object.prototype.hasOwnProperty.call(o,r)&&(l[r]=o[r]);for(s&&s(e);i.length;)i.shift()();return c.push.apply(c,u||[]),p()}function p(){for(var e,r=0;r<c.length;r++){for(var t=c[r],n=!0,o=1;o<t.length;o++){var u=t[o];0!==a[u]&&(n=!1)}n&&(c.splice(r--,1),e=f(f.s=t[0]))}return e}var t={},a={1:0},c=[];function f(e){if(t[e])return t[e].exports;var r=t[e]={i:e,l:!1,exports:{}};return l[e].call(r.exports,r,r.exports,f),r.l=!0,r.exports}f.m=l,f.c=t,f.d=function(e,r,t){f.o(e,r)||Object.defineProperty(e,r,{enumerable:!0,get:t})},f.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.t=function(r,e){if(1&e&&(r=f(r)),8&e)return r;if(4&e&&"object"==typeof r&&r&&r.__esModule)return r;var t=Object.create(null);if(f.r(t),Object.defineProperty(t,"default",{enumerable:!0,value:r}),2&e&&"string"!=typeof r)for(var n in r)f.d(t,n,function(e){return r[e]}.bind(null,n));return t},f.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return f.d(r,"a",r),r},f.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},f.p="/";var r=this.webpackJsonppifi_frontend=this.webpackJsonppifi_frontend||[],n=r.push.bind(r);r.push=e,r=r.slice();for(var o=0;o<r.length;o++)e(r[o]);var s=n;p()}([])</script><script src="/static/js/2.2b057ab5.chunk.js"></script><script src="/static/js/main.54482466.chunk.js"></script></body></html>

data/lib/pifi/public/locales/en/translation.json

@@ -0,0 +1,19 @@
+{
+  "errorNetwork": "Not connected to PiFi server",
+  "errorUnexpected": "An unexpected error occurred.",
+  "errorNotFound": "The stream was not found.",
+  "errorForbidden": "Error. Check your MPD password.",
+  "disconnectedMPD": "Not connected to MPD",
+  "close": "Close",
+  "search": "Search...",
+  "playing": "Playing",
+  "stopped": "Stopped",
+  "tunning": "Tunning...",
+  "noStreams": "No stations available.",
+  "language": "Language",
+  "theme": "Theme",
+  "settings": "Settings",
+  "playURL": "Play URL",
+  "tryingURL": "Trying to play URL...",
+  "volume": "Volume"
+}

data/lib/pifi/public/locales/fr-FR/translation.json

@@ -0,0 +1,7 @@
+{
+  "errorNetwork": "Pas de connexion",
+  "disconnectedMPD": "Déconnecté de MPD",
+  "playing": "Lecture",
+  "stopped": "Arrêté",
+  "tunning": "Mise en tampon…"
+}

data/lib/pifi/public/locales/nl-NL/translation.json

@@ -0,0 +1,7 @@
+{
+  "errorNetwork": "Geen verbinding",
+  "disconnectedMPD": "Niet verbonden met MPD",
+  "playing": "Aan het afspelen",
+  "stopped": "Gestopt",
+  "tunning": "Bezig met verbinden..."
+}

data/lib/pifi/public/locales/pt-BR/translation.json

@@ -0,0 +1,19 @@
+{
+  "errorNetwork": "Sem conexão ao servidor PiFi",
+  "errorUnexpected": "Um erro inesperado ocorreu.",
+  "errorNotFound": "Não foi possível encontrar o stream.",
+  "errorForbidden": "Erro. Verifique sua senha do MPD.",
+  "disconnectedMPD": "Sem conexão ao MPD",
+  "close": "Fechar",
+  "search": "Buscar...",
+  "playing": "Tocando",
+  "stopped": "Parado",
+  "tunning": "Sintonizando...",
+  "noStreams": "Não há rádios disponíveis.",
+  "language": "Idioma",
+  "theme": "Tema",
+  "settings": "Ajustes",
+  "playURL": "Tocar URL",
+  "tryingURL": "Tentando tocar URL...",
+  "volume": "Volume"
+}

data/lib/pifi/public/manifest.json

@@ -0,0 +1,19 @@
+{
+  "name": "PiFi Radio",
+  "short_name": "PiFi Radio",
+  "icons": [
+    {
+      "src": "/android-chrome-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "/android-chrome-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ],
+  "theme_color": "#375a7f",
+  "background_color": "#222222",
+  "display": "standalone"
+}

data/lib/pifi/public/precache-manifest.c6c8e4145c1ed2fcfcefd9d025331f85.js

@@ -0,0 +1,34 @@
+self.__precacheManifest = (self.__precacheManifest || []).concat([
+  {
+    "revision": "ddb46863b2b7f72ccfb1c141a6f582f6",
+    "url": "/index.html"
+  },
+  {
+    "revision": "f14520e468b4efcc311e",
+    "url": "/static/css/2.5dbdccff.chunk.css"
+  },
+  {
+    "revision": "5923c39aa02f7c4872e0",
+    "url": "/static/css/main.a50e54d2.chunk.css"
+  },
+  {
+    "revision": "f14520e468b4efcc311e",
+    "url": "/static/js/2.2b057ab5.chunk.js"
+  },
+  {
+    "revision": "19a6755ca1e5087f391e80db627b30f5",
+    "url": "/static/js/2.2b057ab5.chunk.js.LICENSE"
+  },
+  {
+    "revision": "5923c39aa02f7c4872e0",
+    "url": "/static/js/main.54482466.chunk.js"
+  },
+  {
+    "revision": "92793784c9eb98d269de",
+    "url": "/static/js/runtime-main.f04a0f25.js"
+  },
+  {
+    "revision": "91554ce9192c677ea07ca4d90d14ff42",
+    "url": "/static/media/logo.91554ce9.svg"
+  }
+]);

data/lib/pifi/public/robots.txt

@@ -0,0 +1,2 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *