Better organization of Websocket modules

lib/server/websocket/channel/server.ex

@@ -85,7 +85,7 @@ channel Helix.Server.Websocket.Channel.Server do
   - storage_id: Specify which storage the file should be downloaded to. Defaults
     to the main storage.
 
-  Returns: RenderedProcess.t
+  Returns: :ok
 
   Errors:
   - "file_not_found": Requested file to be downloaded was not found
@@ -161,7 +161,7 @@ channel Helix.Server.Websocket.Channel.Server do
   - storage_id: Specify which storage the file should be downloaded to. Defaults
     to the main storage.
 
-  Returns: RenderedProcess.t
+  Returns: :ok
 
   Errors:
   - "pftp_must_be_local": PFTP operations must happen at the local socket.
@@ -205,7 +205,7 @@ channel Helix.Server.Websocket.Channel.Server do
   Note that all bruteforce attacks must originate from a server owned by the
   entity starting the attack.
 
-  Returns: RenderedProcess.t
+  Returns: :ok
 
   Errors:
   - "cracker_not_found" - Player attempting the attack does not have a valid

lib/software/public/index.ex

@@ -53,6 +53,8 @@ defmodule Helix.Software.Public.Index do
     end)
   end
 
+  @spec render_file(File.t) ::
+    rendered_index_file
   def render_file(file = %File{}) do
     %{
       file_id: to_string(file.file_id),

lib/websocket/request/relay.ex

@@ -0,0 +1,27 @@
+defmodule Helix.Websocket.Request.Relay do
+  @moduledoc """
+  `RequestRelay` is a struct intended to be relayed all the way from the Request
+  to the Public to the ActionFlow, so it can be used by `Helix.Event` to
+  identify the `request_id` and create a meaningful stacktrace.
+  """
+
+  defstruct [:request_id]
+
+  @type t :: t_of_type(binary)
+
+  @type t_of_type(type) ::
+  %__MODULE__{
+    request_id: type
+  }
+
+  @spec new(map) ::
+  t
+  | t_of_type(nil)
+  def new(%{"request_id" => request_id}) when is_binary(request_id) do
+    %__MODULE__{
+      request_id: request_id
+    }
+  end
+  def new(_),
+    do: %__MODULE__{}
+end

lib/websocket/request.ex → lib/websocket/request/request.ex

@@ -115,33 +115,4 @@ defmodule Helix.Websocket.Request do
 
     end
   end
-
-end
-
-defmodule Helix.Websocket.Request.Relay do
-  @moduledoc """
-  `RequestRelay` is a struct intended to be relayed all the way from the Request
-  to the Public to the ActionFlow, so it can be used by `Helix.Event` to
-  identify the `request_id` and create a meaningful stacktrace.
-  """
-
-  defstruct [:request_id]
-
-  @type t :: t_of_type(binary)
-
-  @type t_of_type(type) ::
-    %__MODULE__{
-      request_id: type
-    }
-
-  @spec new(map) ::
-    t
-    | t_of_type(nil)
-  def new(%{"request_id" => request_id}) when is_binary(request_id) do
-    %__MODULE__{
-      request_id: request_id
-    }
-  end
-  def new(_),
-    do: %__MODULE__{}
 end