chg: [sender] support for supervisor and some doc

Author: gallypette

README.md

@@ -19,7 +19,58 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_do
 and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
 be found at <https://hexdocs.pm/ex_d4>.
 
-# Test
+## Usage
+First, create Exd4 map:
+```elixir
+d4_connection = %Exd4{
+  destination: {192, 168, 0, 1},
+  port: 4443,
+  uuid: "b5062e1f-beef-45a0-dead-2557d6e70ef6",
+  type: 3,
+  version: 1,
+  snaplen: 4096,
+  key: "toto" 
+  }
+```
+
+Then the Sender can be run by itself:
+```elixir
+pry(2)> {:ok, pid} = Sender.start_link(d4_connection: d4_connection)
+{:ok, #PID<0.267.0>}
+# one can also define a name
+pry(3)> {:ok, pid} = Sender.start_link([d4_connection: d4_connection, name: :d4sender])
+{:ok, #PID<0.275.0>}
+```
+Or under a supervisor:
+```elixir
+def start(_type, _args) do
+  children = [
+    {Sender,
+     d4_connection: %Exd4{
+       destination: {192, 168, 0, 1},
+       uuid: "b5062e1f-674e-45a0-9c30-2557d6e70ef8"
+     },
+     name: :d4_sender}
+  ]
+  opts = [strategy: :one_for_one, name: MyApp.Supervisor]
+  Supervisor.start_link(children, opts)
+end
+```
+
+Then, we can send packets using `send`:
+```elixir
+pry(2)> {:ok} = Sender.send(pid, "{\"this\": \"is my test\"}\n")
+
+14:44:38.813 [debug] Sent payload to d4 server.
+{:ok}
+#using a name if defined on creation, or launched under the supervisor
+pry(3)> {:ok} = Sender.send(:d4sender, "toto\n")
+
+14:46:55.494 [debug] Sent payload to d4 server.
+{:ok}
+```
+
+## Test
 D4 server with the following registered sensors:
 `b5062e1f-674e-45a0-9c30-2557d6e70ef5`
 `b5062e1f-674e-45a0-9c30-2557d6e70ef6`

lib/sender.ex

@@ -1,15 +1,58 @@
 defmodule Sender do
+  @moduledoc """
+  Provides access to a d4 server
+  It should be supervised since it will terminate after reaching max retries
+  TODO ^^
+  """
   @behaviour :gen_statem
 
   require Logger
 
   defstruct [:d4_connection, :socket, callers: []]
 
+  @type option :: {:d4_connection, Exd4.t()}
+
+  @typedoc """
+  Current state of the server:
+   - `:disconnected` - not connected to the d4 server
+   - `:connected` - connected to the d4 server
+  """
+  @type state :: :disconnected | :connected
+
+  @doc """
+  Returns the default Child Specification for this Server for use in Supervisors.
+  You can override this with `Supervisor.child_spec/2` as required.
+  """
+  # @spec child_spec([option()]) :: Supervisor.child_spec()
+  def child_spec(options) do
+    %{
+      id: __MODULE__,
+      start: {__MODULE__, :start_link, [options]},
+      type: :worker,
+      restart: :permanent,
+      shutdown: 500,
+      strategy: :one_for_one
+    }
+  end
+
   ## Public API
 
+  @doc """
+  Starts a new Server.
+  See `t:option/0` for further details.
+  """
+  @spec start_link([option()]) :: :gen_statem.start_ret()
   def start_link(opts) do
+    {name, opts} = Keyword.pop(opts, :name)
     d4_connection = Keyword.fetch!(opts, :d4_connection)
-    :gen_statem.start_link(__MODULE__, d4_connection, [])
+
+    case name do
+      nil -> :gen_statem.start_link(__MODULE__, d4_connection, [])
+      name when is_atom(name) -> :gen_statem.start_link({:local, name}, __MODULE__, d4_connection, [])
+      {:global, _} -> :gen_statem.start_link(name, __MODULE__, d4_connection, [])
+      {:via, _, _} -> :gen_statem.start_link(name, __MODULE__, d4_connection, [])
+      {:local, _} -> :gen_statem.start_link(name, __MODULE__, d4_connection, [])
+    end
   end
 
   def send(pid, payload) do

mix.lock

@@ -3,6 +3,7 @@
   "earmark_parser": {:hex, :earmark_parser, "1.4.31", "a93921cdc6b9b869f519213d5bc79d9e218ba768d7270d46fdcf1c01bacff9e2", [:mix], [], "hexpm", "317d367ee0335ef037a87e46c91a2269fef6306413f731e8ec11fc45a7efd059"},
   "ecto": {:hex, :ecto, "3.9.4", "3ee68e25dbe0c36f980f1ba5dd41ee0d3eb0873bccae8aeaf1a2647242bffa35", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "de5f988c142a3aa4ec18b85a4ec34a2390b65b24f02385c1144252ff6ff8ee75"},
   "ex_doc": {:hex, :ex_doc, "0.29.2", "dfa97532ba66910b2a3016a4bbd796f41a86fc71dd5227e96f4c8581fdf0fdf0", [:mix], [{:earmark_parser, "~> 1.4.19", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "6b5d7139eda18a753e3250e27e4a929f8d2c880dd0d460cb9986305dea3e03af"},
+  "json": {:hex, :json, "1.4.1", "8648f04a9439765ad449bc56a3ff7d8b11dd44ff08ffcdefc4329f7c93843dfa", [:mix], [], "hexpm", "9abf218dbe4ea4fcb875e087d5f904ef263d012ee5ed21d46e9dbca63f053d16"},
   "makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.16.0", "f8c570a0d33f8039513fbccaf7108c5d750f47d8defd44088371191b76492b0b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "28b2cbdc13960a46ae9a8858c4bebdec3c9a6d7b4b9e7f4ed1502f8159f338e7"},
   "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},

test/sender_test.exs

@@ -68,7 +68,6 @@ defmodule SenderTest do
     assert {:error, :disconnected} = Sender.get_status(pid)
   end
 
-  @tag :debug
   test "D4 metaheaders type" do
      d4_connection = %Exd4{
       destination: Exd4.d4_ip(),
@@ -86,5 +85,6 @@ defmodule SenderTest do
     assert {:ok} = Sender.get_status(pid)
     assert {:ok} = Sender.send(pid, "{\"this\": \"is my test\"}\n")
     assert {:ok} = Sender.send(pid, "{\"this\": \"is my another test\"}\n")
+
   end
 end