Gogs (gogs v0.2.0)
Documentation for Gogs.
This package is an Elixir interface to our Gogs Server.
It contains all functions we need to create repositories,
clone, add data to files, commit, push and diff.
Some of these functions use Git and others use the REST API.
We would obviously prefer if everything was one or the other,
but sadly, some things cannot be done via Git or REST
so we have adopted a "hybrid" approach.
The functions in this file are defined in the order that we are using them. So they tell a story. If you are reading this and prefer to order them alphabetically or some other way, please share by opening an issue: github.com/dwyl/gogs/issues
Link to this section Summary
Functions
clone/1 clones a remote git repository based on git_repo_url
returns the path of the local copy of the repository.
delete/1 accepts a single argument url;
the url for the repository to be deleted.
get_repo_name_from_url/1 extracts the repository name from a .git url.
Feel free to refactor/simplify this function if you want.
inject_poison/0 injects a TestDouble of HTTPoison in Test
so that we don't have duplicate mock in consuming apps.
see: github.com/dwyl/elixir-auth-google/issues/35
local_repo_path/1 returns the full system path for the cloned repo
on the localhost i.e. the Elixir/Phoenix server that cloned it.
parse_body_response/1 parses the response returned by the Gogs Server
so your app can use the resulting JSON.
post/2 accepts two arguments: url and params.
Makes an HTTP POST request to the specified url
passing in the params as the request body.
Auth Headers and Content-Type are implicit.
remote_repo_create/3 accepts 3 arguments: org_name, repo_name & private.
It creates a repo on the remote Gogs instance as defined
by the environment variable GOGS_URL.
For convenience it assumes that you only have one Gogs instance.
If you have more or different requirements, please share!
remote_repo_delete/2 accepts two arguments: org_name and repo_name.
It deletes the repo on the remote Gogs instance as defined
by the environment variable GOGS_URL.
returns the remote url for cloning
Link to this section Functions
clone(git_repo_url)
clone/1 clones a remote git repository based on git_repo_url
returns the path of the local copy of the repository.
delete(url)
delete/1 accepts a single argument url;
the url for the repository to be deleted.
get_repo_name_from_url(url)
get_repo_name_from_url/1 extracts the repository name from a .git url.
Feel free to refactor/simplify this function if you want.
inject_poison()
inject_poison/0 injects a TestDouble of HTTPoison in Test
so that we don't have duplicate mock in consuming apps.
see: github.com/dwyl/elixir-auth-google/issues/35
local_repo_path(repo)
local_repo_path/1 returns the full system path for the cloned repo
on the localhost i.e. the Elixir/Phoenix server that cloned it.
parse_body_response(arg)
parse_body_response/1 parses the response returned by the Gogs Server
so your app can use the resulting JSON.
post(url, params \\ %{})
post/2 accepts two arguments: url and params.
Makes an HTTP POST request to the specified url
passing in the params as the request body.
Auth Headers and Content-Type are implicit.
remote_repo_create(org_name, repo_name, private \\ false)
remote_repo_create/3 accepts 3 arguments: org_name, repo_name & private.
It creates a repo on the remote Gogs instance as defined
by the environment variable GOGS_URL.
For convenience it assumes that you only have one Gogs instance.
If you have more or different requirements, please share!
remote_repo_delete(org_name, repo_name)
remote_repo_delete/2 accepts two arguments: org_name and repo_name.
It deletes the repo on the remote Gogs instance as defined
by the environment variable GOGS_URL.
remote_url(base_url, org, repo)
returns the remote url for cloning