Packages

fluminus

1.3.2
2.2.9 2.2.8 2.2.7 2.2.6 2.2.5 2.2.4 2.2.3 2.2.2 2.2.1 2.2.0 2.1.5 2.1.4 2.1.3 2.1.2 2.1.1 2.1.0 2.0.3 2.0.2 2.0.1 2.0.0 1.4.3 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.0 1.1.1 1.1.0 1.0.0 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.3 0.1.2 0.1.1 0.1.0 0.0.1

A library for the reverse-engineered LumiNUS API (https://luminus.nus.edu.sg)

HexDocs

Current section

Files

Jump to
Readme
44 Versions
6 Dependencies
Dependants
Files
Activity
fluminus lib fluminus util.ex
Raw

lib/fluminus/util.ex 

defmodule Fluminus.Util do

  @moduledoc """

  A collection of common methods in Fluminus.

  """



  alias Fluminus.HTTPClient



  @doc """

  Sanitises filename according to Unix standard.

  """

  @spec sanitise_filename(String.t()) :: String.t()

  def sanitise_filename(name) when is_binary(name) do

    # According to http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html:

    # The bytes composing the name shall not contain the <NUL> or <slash> characters

    String.replace(name, ~r|[/\0]|, "-")

  end



  @doc """

  Downloads the given url to a destination path generated by the provided function.



  This function will return `{:error, :exists}` if the file already exists.

  """

  @spec download((() -> {:ok, String.t()} | {:error, any()}), Path.t(), bool()) :: :ok | {:error, :exists | any()}

  def download(f, destination, verbose) when is_function(f) do

    with {:exists?, false} <- {:exists?, File.exists?(destination)},

         {:ok, url} <- f.(),

         :ok <- HTTPClient.download(%HTTPClient{}, url, destination, false, [], verbose) do

      :ok

    else

      {:exists?, true} -> {:error, :exists}

      {:error, reason} -> {:error, reason}

    end

  end

end