Feat/error logs (#16)

* added list of tasks to achieve

* update deps

* update elixir version in CI/CD pipeline

* update todo with branch push checks

* underscores separation of large numbers

* update elixir version and deps

* add basic module  docs

* remove IO.inspect call

* check if list is empty rather than traversing list for length

* revert empty list code

* duration tests

* add mime type tests

* use logger instread of inspect, remove todos

* replace list length check with Enum.empty

* replace list length check with !Enum.empty?

* numbers readability fix by using underscores on large numbers

* iucn parser replaced case with multiclause function and added test

* replace map and join with map_join

* fix multiple spec issues where map() must be inside a list

lib/plantnet/parser.ex

@@ -33,7 +33,7 @@ defmodule PlantIdDiscordBot.PlantNet.Parser do
   @doc """
   Parses the response from the PlantNet API into a map.
   """
-  @spec parse(String.t()) :: map()
+  @spec parse(String.t()) :: String.t()
   def parse(response) do
     response
     |> to_map!()
@@ -85,7 +85,7 @@ defmodule PlantIdDiscordBot.PlantNet.Parser do
     "My best guess is **#{best_guess_name}** with a confidence of **#{score}%**.#{get_common_names(best_result)}\n\nSpecies info from plant databases:\n[GBIF](<#{best_result["gbif_url"]}>) | [PFAF](<#{best_result["pfaf_url"]}>) | [POWO](<#{best_result["powo_url"]}>)#{if best_result_iucn_category, do: "\n\nConservation status: #{iucn_parser(best_result_iucn_category)}"}#{get_alternatives(other_results)}"
   end
 
-  @spec generate_gbif_url(map()) :: map()
+  @spec generate_gbif_url([map()]) :: [map()]
   defp generate_gbif_url(data) do
     Enum.map(data, fn result ->
       gbif_id = result["gbif"]["id"]
@@ -93,7 +93,7 @@ defmodule PlantIdDiscordBot.PlantNet.Parser do
     end)
   end
 
-  @spec generate_pfaf_url(map()) :: map()
+  @spec generate_pfaf_url([map()]) :: [map()]
   defp generate_pfaf_url(data) do
     Enum.map(data, fn result ->
       pfaf_slug = String.replace(result["species"]["scientificNameWithoutAuthor"], " ", "+")
@@ -104,7 +104,7 @@ defmodule PlantIdDiscordBot.PlantNet.Parser do
     end)
   end
 
-  @spec generate_powo_url(map()) :: map()
+  @spec generate_powo_url([map()]) :: [map()]
   defp generate_powo_url(data) do
     Enum.map(data, fn result ->
       powo_id = result["powo"]["id"]
@@ -123,29 +123,40 @@ defmodule PlantIdDiscordBot.PlantNet.Parser do
   end
 
   @spec iucn_parser(String.t()) :: String.t()
-  defp iucn_parser(abbreviation) do
-    case abbreviation do
-      "DD" -> "Data Deficient"
-      "LC" -> "Least Concern"
-      "NT" -> "Near Threatened"
-      "VU" -> "Vulnerable"
-      "EN" -> "Endangered"
-      "CR" -> "Critically Endangered"
-      "EW" -> "Extinct in the Wild"
-      "EX" -> "Extinct"
-      "NE" -> "Not Evaluated"
-      _ -> "Unknown"
-    end
-  end
+  def iucn_parser("DD"), do: "Data Deficient"
+  def iucn_parser("LC"), do: "Least Concern"
+  def iucn_parser("NT"), do: "Near Threatened"
+  def iucn_parser("VU"), do: "Vulnerable"
+  def iucn_parser("EN"), do: "Endangered"
+  def iucn_parser("CR"), do: "Critically Endangered"
+  def iucn_parser("EW"), do: "Extinct in the Wild"
+  def iucn_parser("EX"), do: "Extinct"
+  def iucn_parser("NE"), do: "Not Evaluated"
+  def iucn_parser(_), do: "Unknown"
 
   @spec get_alternatives(map()) :: String.t()
   defp get_alternatives(data) do
-    if length(data) > 0 do
+    if !Enum.empty?(data) do
       alternatives =
-        Enum.map(data, & &1["species"]["scientificNameWithoutAuthor"])
-        |> Enum.join(", ")
+        Enum.map_join(data, ", ", & &1["species"]["scientificNameWithoutAuthor"])
 
       "\n\nAlternatives include **#{alternatives}**."
     end
+
+    # if !Enum.empty?(data) do
+    #   alternatives =
+    #     Enum.map(data, & &1["species"]["scientificNameWithoutAuthor"])
+    #     |> Enum.join(", ")
+
+    #   "\n\nAlternatives include **#{alternatives}**."
+    # end
+
+    # if length(data) > 0 do
+    #   alternatives =
+    #     Enum.map(data, & &1["species"]["scientificNameWithoutAuthor"])
+    #     |> Enum.join(", ")
+
+    #   "\n\nAlternatives include **#{alternatives}**."
+    # end
   end
 end