Add basic tests

Author: sheharyarn

lib/safeurl.ex

@@ -64,7 +64,7 @@ defmodule SafeURL do
   If the URL is safe, this function returns the `HTTPoison` result directly; otherwise, `{:error, :restricted}`.
   """
   def get(url, options \\ [], headers \\ [], httpoison_options \\ []) do
-    if validate_url(url, options) do
+    if allowed?(url, options) do
       HTTPoison.get(url, headers, httpoison_options)
     else
       {:error, :restricted}
@@ -78,7 +78,7 @@ defmodule SafeURL do
 
   Returns `true` if the URL meets the requirements, `false` otherwise.
   """
-  def validate_url(url, options \\ []) do
+  def allowed?(url, options \\ []) do
     blacklist_private = Keyword.get(options, :blacklist_private, true)
     blacklist = Keyword.get(options, :blacklist, [])
     whitelist = Keyword.get(options, :whitelist, [])

test/safeurl_test.exs

@@ -1,8 +1,46 @@
-defmodule SafeurlTest do
+defmodule SafeURLTest do
   use ExUnit.Case
-  doctest Safeurl
 
-  test "greets the world" do
-    assert Safeurl.hello() == :world
+  # setup_all do
+  #   global_whitelist = ["10.0.0.0/24"]
+  #   global_blacklist = ["8.8.0.0/16"]
+
+  #   Application.put_env(:safeurl, :whitelist, global_whitelist)
+  # end
+
+  describe "#allowed?" do
+    test "returns true for only allowed schemes" do
+      assert SafeURL.allowed?("http://includesecurity.com")
+      assert SafeURL.allowed?("https://includesecurity.com")
+      refute SafeURL.allowed?("ftp://includesecurity.com")
+
+      assert SafeURL.allowed?("ftp://includesecurity.com", schemes: ~w[ftp])
+      refute SafeURL.allowed?("http://includesecurity.com", schemes: ~w[ftp])
+    end
+
+    test "returns false for reserved ranges" do
+      refute SafeURL.allowed?("http://0.0.0.0/")
+      refute SafeURL.allowed?("http://10.0.0.1/")
+      refute SafeURL.allowed?("http://127.0.0.1/")
+      refute SafeURL.allowed?("http://169.254.9.1/")
+      refute SafeURL.allowed?("http://192.168.1.1/")
+    end
+
+    test "allows blacklisting custom IP ranges" do
+      opts = [blacklist: ["5.5.0.0/16", "100.0.0.0/24"]]
+
+      assert SafeURL.allowed?("http://includesecurity.com", opts)
+      assert SafeURL.allowed?("http://3.3.3.3", opts)
+      refute SafeURL.allowed?("http://5.5.5.5", opts)
+      refute SafeURL.allowed?("http://100.0.0.50", opts)
+    end
+
+    test "only allows whitelist when present" do
+      opts = [whitelist: ["10.0.0.0/24"]]
+
+      assert SafeURL.allowed?("http://10.0.0.1/", opts)
+      refute SafeURL.allowed?("http://72.254.45.178", opts)
+      refute SafeURL.allowed?("https://includesecurity.com", opts)
+    end
   end
 end