Polish docs

Author: Alex Martsinovich

lib/safeurl/httpoison.ex

@@ -1,35 +1,33 @@
 if Code.ensure_loaded?(HTTPoison) do
   defmodule SafeURL.HTTPoison do
+    @moduledoc since: "1.0.0"
     @moduledoc """
     A utility module that should be a drop-in replacement for `HTTPoison`. Only
     supports `get/3`.
     """
 
+    @doc since: "1.0.0"
     @doc """
     Validate a URL and execute a GET request using `HTTPoison`.
 
     If the URL is safe, this function will execute the request using
     `HTTPoison`, returning the result directly. Otherwise, it will
-    return `{:error, :restricted}`.
+    return error.
 
     `headers` and `options` will be passed directly to
-    `HTTPoison` when the request is executed. This function will
-    raise if `HTTPoison` if not available.
+    `HTTPoison` when the request is executed.
 
     ## Examples
 
         iex> SafeURL.HTTPoison.get("https://10.0.0.1/ssrf.txt")
-        {:error, :restricted}
+        {:error, :unsafe_reserved}
 
         iex> SafeURL.HTTPoison.get("https://google.com/")
         {:ok, %HTTPoison.Response{...}}
 
-        iex> SafeURL.HTTPoison.get("https://google.com/", schemes: ~w[ftp])
-        {:error, :restricted}
-
     """
     @spec get(binary(), HTTPoison.headers(), Keyword.t()) ::
-            {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()} | {:error, :restricted}
+            {:ok, HTTPoison.Response.t()} | {:error, HTTPoison.Error.t()} | {:error, SafeURL.error()} | {:error, :restricted}
     def get(url, headers \\ [], options \\ []) do
       with :ok <- SafeURL.validate(url) do
         HTTPoison.get(url, headers, options)

lib/safeurl/safeurl.ex

@@ -85,7 +85,7 @@ defmodule SafeURL do
       :ok
 
       iex> SafeURL.validate("https://app.service/", blocklist: ~w[170.0.0.0/24])
-      {:error, :restricted}
+      {:error, :unsafe_blocklist}
 
   """
 
@@ -161,7 +161,7 @@ defmodule SafeURL do
       :ok
 
       iex> SafeURL.validate("http://10.0.0.1/")
-      {:error, :restricted}
+      {:error, :unsafe_reserved}
 
       iex> SafeURL.validate("http://10.0.0.1/", allowlist: ~w[10.0.0.0/8])
       :ok
@@ -171,7 +171,7 @@ defmodule SafeURL do
   See [`Options`](#module-options) section above.
 
   """
-  @spec validate(binary(), Keyword.t()) :: :ok | {:error, error() | :restricted}
+  @spec validate(binary(), Keyword.t()) :: :ok | {:error, error()} | {:error, :restricted}
   def validate(url, opts \\ []) do
     uri = URI.parse(url)
     opts = build_options(opts)

lib/safeurl/tesla_middleware.ex

@@ -1,12 +1,13 @@
 if Code.ensure_loaded?(Tesla) do
   defmodule SafeURL.TeslaMiddleware do
+    @moduledoc since: "1.0.0"
     @moduledoc """
     Tesla middleware for validating URLs.
 
     ## Examples
 
         iex> Tesla.client([SafeURL.TeslaMiddleware]) |> Tesla.get("http://localhost/")
-        {:error, :restricted}
+        {:error, :unsafe_reserved}
     """
     @behaviour Tesla.Middleware