From ac1eb372a48ea7aa06f7c3ea07f4475a8178a0a9 Mon Sep 17 00:00:00 2001 From: Mikko Ahlroth Date: Sun, 25 Feb 2018 10:41:34 +0200 Subject: [PATCH] Rename files to fit project --- README.md | 4 ++-- lib/router.ex | 6 +++--- lib/triggerer.ex | 14 +++++++------- lib/triggerer/application.ex | 6 +++--- mix.exs | 4 ++-- test/triggerer_test.exs | 4 ++-- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e41868a..cac59c7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Triggerer +# GitLabPushTriggerer -Triggerer is a small application that triggers execution of scripts when given endpoints are hit +GitLabPushTriggerer is a small application that triggers execution of scripts when given endpoints are hit with GET requests. It contains no permissions handling, no authentication, no request limiting. So these must be handled in some other way, like with an Nginx reverse proxy. diff --git a/lib/router.ex b/lib/router.ex index 410cc07..259e382 100644 --- a/lib/router.ex +++ b/lib/router.ex @@ -1,4 +1,4 @@ -defmodule Triggerer.Router do +defmodule GitLabPushTriggerer.Router do @moduledoc """ Router dispatching requests to the correct handlers. """ @@ -13,7 +13,7 @@ defmodule Triggerer.Router do paths = quote do - Triggerer.get_envs() + GitLabPushTriggerer.get_envs() end match "/:path" do @@ -22,7 +22,7 @@ defmodule Triggerer.Router do route_not_found(conn) script -> - case Triggerer.run(script) do + case GitLabPushTriggerer.run(script) do :ok -> send_resp(conn, 200, "OK") diff --git a/lib/triggerer.ex b/lib/triggerer.ex index 637e5c1..3418e2d 100644 --- a/lib/triggerer.ex +++ b/lib/triggerer.ex @@ -1,4 +1,4 @@ -defmodule Triggerer do +defmodule GitLabPushTriggerer do require Logger @doc """ @@ -9,13 +9,13 @@ defmodule Triggerer do In these examples, sample env is given as argument. If no argument is given, system env is used. - iex> Triggerer.get_envs(%{"TRIGGERER_FOO" => "./test.sh"}) + iex> GitLabPushTriggerer.get_envs(%{"TRIGGERER_FOO" => "./test.sh"}) %{"foo" => "./test.sh"} - iex> Triggerer.get_envs(%{}) + iex> GitLabPushTriggerer.get_envs(%{}) %{} - iex> Triggerer.get_envs(%{"WRONG_FORMAT" => "no", "TRIGGERER_BAR_" => "baz", "TRIGGERER_" => "no", "TRIGGERER_GO_WILD" => "/bin/true"}) + iex> GitLabPushTriggerer.get_envs(%{"WRONG_FORMAT" => "no", "TRIGGERER_BAR_" => "baz", "TRIGGERER_" => "no", "TRIGGERER_GO_WILD" => "/bin/true"}) %{"bar-" => "baz", "go-wild" => "/bin/true"} """ @spec get_envs(%{optional(String.t()) => String.t()}) :: map @@ -40,13 +40,13 @@ defmodule Triggerer do ## Examples - iex> Triggerer.transform_path("YKSI_KAKSI") + iex> GitLabPushTriggerer.transform_path("YKSI_KAKSI") "yksi-kaksi" - iex> Triggerer.transform_path("FOO") + iex> GitLabPushTriggerer.transform_path("FOO") "foo" - iex> Triggerer.transform_path("ÄNKYRÄ_KÖNKYRÄ_") + iex> GitLabPushTriggerer.transform_path("ÄNKYRÄ_KÖNKYRÄ_") "änkyrä-könkyrä-" """ @spec transform_path(String.t()) :: String.t() diff --git a/lib/triggerer/application.ex b/lib/triggerer/application.ex index 09185d1..59782a4 100644 --- a/lib/triggerer/application.ex +++ b/lib/triggerer/application.ex @@ -1,4 +1,4 @@ -defmodule Triggerer.Application do +defmodule GitLabPushTriggerer.Application do # See https://hexdocs.pm/elixir/Application.html # for more information on OTP Applications @moduledoc false @@ -16,7 +16,7 @@ defmodule Triggerer.Application do children = [ Plug.Adapters.Cowboy.child_spec( :http, - Triggerer.Router, + GitLabPushTriggerer.Router, [], port: port ) @@ -24,7 +24,7 @@ defmodule Triggerer.Application do # See https://hexdocs.pm/elixir/Supervisor.html # for other strategies and supported options - opts = [strategy: :one_for_one, name: Triggerer.Supervisor] + opts = [strategy: :one_for_one, name: GitLabPushTriggerer.Supervisor] Supervisor.start_link(children, opts) end end diff --git a/mix.exs b/mix.exs index 722ecea..c701295 100644 --- a/mix.exs +++ b/mix.exs @@ -1,4 +1,4 @@ -defmodule Triggerer.MixProject do +defmodule GitLabPushTriggerer.MixProject do use Mix.Project def project do @@ -15,7 +15,7 @@ defmodule Triggerer.MixProject do def application do [ extra_applications: [:logger], - mod: {Triggerer.Application, []} + mod: {GitLabPushTriggerer.Application, []} ] end diff --git a/test/triggerer_test.exs b/test/triggerer_test.exs index 87ce97b..36826fe 100644 --- a/test/triggerer_test.exs +++ b/test/triggerer_test.exs @@ -1,4 +1,4 @@ -defmodule TriggererTest do +defmodule GitLabPushTriggererTest do use ExUnit.Case - doctest Triggerer + doctest GitLabPushTriggerer end