View Source Migrating from 0.3 to 1.0

Replace SafeURL.get/4 with SafeURL.HTTPoison.get/3

SafeURL.get/4 has been replaced with SafeURL.HTTPoison.get/3. It is now a drop-in replacement for HTTPoison.get/3 and thus does not support passing SafeURL options through function arguments.

Account for new error messages or use :detailed_error option

SafeURL.validate/2 now returns a more specific error by default:

iex> SafeURL.validate("http://localhost")
{:error, :unsafe_reserved}
iex> SafeURL.validate("http://google.com", schemes: [:https])
{:error, :unsafe_scheme}

You can use the :detailed_error configuration option to restore the previous behavior and get the generic {:error, :restricted} error:

iex> SafeURL.validate("http://localhost", detailed_error: false)
{:error, :restricted}
iex> Application.put_env(:safeurl, :detailed_error, false)
:ok
iex> SafeURL.validate("http://localhost")
{:error, :restricted}

Change modules implementing SafeURL.DNSResolver behaviour

If you have a module that implements SafeURL.DNSResolver behaviour, note that DNSResolver.resolve/1 signature has changed. Specifically, the ok tuple should now always return a list of IPs. A single IP is not a valid return type:

# DNS is the default implementation
iex> DNS.resolve("wikipedia.org")
{:ok, [{198, 35, 26, 96}]}