RSS feed for sources (#110)

* Add media streaming (#108)

* [WIP] set up streaming route

* Added UUID to sources and media items

* Added media preview to MI show page

* Added plug to strip file extensions

* [VERY WIP] basic podcast RSS setup

* [WIP] got basic podcast RSS working

* [WIP] more expanding on RSS

* Comment

* [WIP] Working on refactoring feed

* Added UUID backfill to a migration

* [WIP] Moar refactoring

* [WIP] Adding UI for getting RSS feed

* Many tests

* Added conditional routing for feed URLs

* Removed the need for url_base to be set

* Updated preset name

* Rendered certain fields HTML-safe; Added logging to confirm range request support

* Fixed incorrect scheme issue

* Updated env var

* Updated other UI to use dropdown

* removed commented code

* Generate rss feeds (#123)

* Added plug to strip file extensions

* [VERY WIP] basic podcast RSS setup

* [WIP] got basic podcast RSS working

* [WIP] more expanding on RSS

* [WIP] Working on refactoring feed

* Added UUID backfill to a migration

* [WIP] Moar refactoring

* [WIP] Adding UI for getting RSS feed

* Many tests

* Added conditional routing for feed URLs

* Removed the need for url_base to be set

* Updated preset name

* Rendered certain fields HTML-safe; Added logging to confirm range request support

* Fixed incorrect scheme issue

* Updated env var

* Updated other UI to use dropdown

* removed commented code

* docs

* Added unique index to UUID fields

test/pinchflat_web/controllers/media_item_controller_test.exs

@@ -66,6 +66,147 @@ defmodule PinchflatWeb.MediaItemControllerTest do
     end
   end
 
+  describe "streaming media" do
+    test "returns 404 if the media isn't found", %{conn: conn} do
+      media_item = media_item_fixture()
+      conn = get(conn, ~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.status == 404
+    end
+
+    test "automatically sets the content type", %{conn: conn} do
+      media_item = media_item_with_attachments()
+      conn = get(conn, ~p"/media/#{media_item.uuid}/stream")
+
+      assert {"content-type", "video/mp4; charset=utf-8"} in conn.resp_headers
+    end
+
+    test "sets the content length", %{conn: conn} do
+      media_item = media_item_with_attachments()
+      filesize = File.stat!(media_item.media_filepath).size
+
+      conn = get(conn, ~p"/media/#{media_item.uuid}/stream")
+
+      assert {"content-length", to_string(filesize)} in conn.resp_headers
+    end
+  end
+
+  describe "streaming media when range is valid" do
+    setup do
+      media_item = media_item_with_attachments()
+
+      %{media_item: media_item}
+    end
+
+    test "sets the correct status and headers", %{conn: conn, media_item: media_item} do
+      filesize = File.stat!(media_item.media_filepath).size
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=0-100")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.status == 206
+      assert {"content-range", "bytes 0-100/#{filesize}"} in conn.resp_headers
+      assert {"content-length", "101"} in conn.resp_headers
+    end
+
+    test "streams the specified range", %{conn: conn, media_item: media_item} do
+      conn =
+        conn
+        |> put_req_header("range", "bytes=0-100")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert byte_size(conn.resp_body) == 101
+    end
+
+    test "supports range offsets", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+      expected = String.slice(contents, 100..200)
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=100-200")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.resp_body == expected
+    end
+
+    test "returns as expected if the requested range is larger than the file", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+      filesize = File.stat!(media_item.media_filepath).size
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=0-#{filesize * 10}")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.resp_body == contents
+      assert {"content-range", "bytes 0-#{filesize - 1}/#{filesize}"} in conn.resp_headers
+      assert {"content-length", to_string(filesize)} in conn.resp_headers
+    end
+
+    test "supports endless ranges", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=0-")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.resp_body == contents
+    end
+
+    test "supports endless ranges with offsets", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+      {_, expected} = String.split_at(contents, 100)
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=100-")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.resp_body == expected
+    end
+  end
+
+  describe "streaming media when range is invalid or not present" do
+    setup do
+      media_item = media_item_with_attachments()
+
+      %{media_item: media_item}
+    end
+
+    test "sets the correct status and headers", %{conn: conn, media_item: media_item} do
+      filesize = File.stat!(media_item.media_filepath).size
+
+      conn = get(conn, ~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.status == 200
+      assert {"content-length", to_string(filesize)} in conn.resp_headers
+    end
+
+    test "streams the entire file", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+
+      conn = get(conn, ~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.resp_body == contents
+    end
+
+    test "doesn't blow up if the range header is invalid", %{conn: conn, media_item: media_item} do
+      contents = File.read!(media_item.media_filepath)
+
+      conn =
+        conn
+        |> put_req_header("range", "bytes=-")
+        |> get(~p"/media/#{media_item.uuid}/stream")
+
+      assert conn.status == 200
+      assert conn.resp_body == contents
+    end
+  end
+
   defp create_media_item(_) do
     media_item = media_item_fixture()
     %{media_item: media_item}

test/pinchflat_web/controllers/podcast_controller_test.exs

@@ -0,0 +1,38 @@
+defmodule PinchflatWeb.PodcastControllerTest do
+  use PinchflatWeb.ConnCase
+
+  import Pinchflat.SourcesFixtures
+
+  describe "rss_feed" do
+    test "renders the XML document", %{conn: conn} do
+      source = source_fixture()
+
+      conn = get(conn, ~p"/sources/#{source.uuid}/feed" <> ".xml")
+
+      assert conn.status == 200
+      assert {"content-type", "application/rss+xml; charset=utf-8"} in conn.resp_headers
+      assert {"content-disposition", "inline"} in conn.resp_headers
+    end
+  end
+
+  describe "feed_image" do
+    test "returns a feed image if one can be found", %{conn: conn} do
+      source = source_with_metadata_attachments()
+
+      conn = get(conn, ~p"/sources/#{source.uuid}/feed_image" <> ".jpg")
+
+      assert conn.status == 200
+      assert {"content-type", "image/jpeg; charset=utf-8"} in conn.resp_headers
+      assert conn.resp_body == File.read!(source.metadata.poster_filepath)
+    end
+
+    test "returns 404 if an image cannot be found", %{conn: conn} do
+      source = source_fixture()
+
+      conn = get(conn, ~p"/sources/#{source.uuid}/feed_image" <> ".jpg")
+
+      assert conn.status == 404
+      assert conn.resp_body == "Image not found"
+    end
+  end
+end

test/pinchflat_web/routing_test.exs

@@ -1,6 +1,8 @@
 defmodule PinchflatWeb.RoutingTest do
   use PinchflatWeb.ConnCase
 
+  import Pinchflat.SourcesFixtures
+
   describe "basic_auth plug" do
     setup do
       old_username = Application.get_env(:pinchflat, :basic_auth_username)
@@ -54,4 +56,53 @@ defmodule PinchflatWeb.RoutingTest do
       assert conn.status == 200
     end
   end
+
+  describe "maybe_basic_auth plug" do
+    setup do
+      old_username = Application.get_env(:pinchflat, :basic_auth_username)
+      old_password = Application.get_env(:pinchflat, :basic_auth_password)
+      old_expose_feed_endpoints = Application.get_env(:pinchflat, :expose_feed_endpoints)
+
+      source = source_fixture()
+
+      on_exit(fn ->
+        Application.put_env(:pinchflat, :basic_auth_username, old_username)
+        Application.put_env(:pinchflat, :basic_auth_password, old_password)
+        Application.put_env(:pinchflat, :expose_feed_endpoints, old_expose_feed_endpoints)
+      end)
+
+      {:ok, source: source}
+    end
+
+    test "uses basic auth when expose_feed_endpoints is false", %{source: source} do
+      Application.put_env(:pinchflat, :basic_auth_username, "user")
+      Application.put_env(:pinchflat, :basic_auth_password, "pass")
+      Application.put_env(:pinchflat, :expose_feed_endpoints, false)
+
+      conn = get(build_conn(), "/sources/#{source.uuid}/feed")
+
+      assert conn.status == 401
+      assert {"www-authenticate", "Basic realm=\"Pinchflat\""} in conn.resp_headers
+    end
+
+    test "does not use basic auth when expose_feed_endpoints is true", %{source: source} do
+      Application.put_env(:pinchflat, :basic_auth_username, "user")
+      Application.put_env(:pinchflat, :basic_auth_password, "pass")
+      Application.put_env(:pinchflat, :expose_feed_endpoints, true)
+
+      conn = get(build_conn(), "/sources/#{source.uuid}/feed")
+
+      assert conn.status == 200
+    end
+
+    test "does not use basic auth when username/password aren't set", %{source: source} do
+      Application.put_env(:pinchflat, :basic_auth_username, nil)
+      Application.put_env(:pinchflat, :basic_auth_password, nil)
+      Application.put_env(:pinchflat, :expose_feed_endpoints, false)
+
+      conn = get(build_conn(), "/sources/#{source.uuid}/feed")
+
+      assert conn.status == 200
+    end
+  end
 end