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

api_base_url/0 returns the Gogs Server REST API url for API requests.

examples

Examples

iex> Gogs.Helpers.api_base_url() "https://gogs-server.fly.dev/api/v1/"

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

get_org_name_from_url/1 extracts the organisation name from a .git url. ssh://git@gogs-server.fly.dev:10022/theorg/myrepo.git

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

get_repo_name_from_url/1 extracts the repository name from a .git url. Feel free to refactor/simplify this function if you want.

@spec local_git_repo(String.t(), String.t()) :: Git.Repository.t()

local_git_repo/2 returns the %Git.Repository{} (struct) for an org and repo on the localhost. This is used by the Git module to perform operations.

@spec local_repo_path(String.t(), String.t()) :: binary()

local_repo_path/2 returns the full system path for the cloned repo on the localhost i.e. the Elixir/Phoenix server that cloned it.

@spec make_url(String.t(), integer() | nil) :: String.t()

make_url/2 constructs the URL based on the supplied git url and TCP port. If the port is set it will be a custom Gogs instance.

examples

Examples

iex> Gogs.Helpers.make_url("gogs-server.fly.dev", "10022") "ssh://git@gogs-server.fly.dev:10022/"

iex> Gogs.Helpers.make_url("github.com") "git@github.com:"

@spec remote_url(String.t(), String.t(), String.t()) :: String.t()

remote_url/3 returns the git remote url.

@spec remote_url_ssh(String.t(), String.t()) :: String.t()

remote_url_ssh/2 returns the remote ssh url for cloning.

@spec temp_dir(String.t() | nil) :: binary()

temp_dir/1 returns the Current Working Directory (CWD). Made this a function in case we want to change the location of the directory later e.g. to a temporary directory.