implement remote_read_raw/4 for #21

Author: nelsonic

lib/gogs.ex

@@ -17,7 +17,7 @@ defmodule Gogs do
 
   @api_base_url GogsHelpers.api_base_url()
   @mock Application.compile_env(:gogs, :mock)
-  Logger.info("config :gogs, mock: #{to_string(@mock)}")
+  Logger.debug("config :gogs, mock: #{to_string(@mock)}")
   @git (@mock && Gogs.GitMock) || Git
 
   @doc """
@@ -59,6 +59,29 @@ defmodule Gogs do
     GogsHttp.delete(url)
   end
 
+  @doc """
+  `remote_read_file/3` reads a file from the remote repo.
+  Accepts 4 arguments: `org_name`, `repo_name`, `file_name` and `branch_name`.
+  The 4<sup>th</sup> argument is *optional* and defaults to `"master"` 
+  (the default branch for a repo hosted on `Gogs`).
+  Makes a `GET` request to the remote `Gogs` instance as defined 
+  by the environment variable `GOGS_URL`.
+  Returns `{:ok, %HTTPoison.Response{ body: response_body}}`
+  Uses REST API Endpoint:
+  ```sh
+  GET /repos/:username/:reponame/raw/:branchname/:path
+  ```
+  Ref: https://github.com/gogs/docs-api/blob/master/Repositories/Contents.md#get-contents
+  """
+  @spec remote_read_raw(String.t(), String.t(), String.t(), String.t()) :: {:ok, map} | {:error, any}
+  def remote_read_raw(org_name, repo_name, file_name, branch_name \\ "master") do
+    url = @api_base_url <> "repos/#{org_name}/#{repo_name}/raw/#{branch_name}/#{file_name}"
+    Logger.debug("Gogs.remote_read_file: #{url}")
+    GogsHttp.get_raw(url)
+
+  end
+
+
   @doc """
   `clone/1` clones a remote git repository based on `git_repo_url`
   returns the path of the _local_ copy of the repository.

lib/http.ex

@@ -33,7 +33,7 @@ defmodule GogsHttp do
   def parse_body_response({:error, err}), do: {:error, err}
 
   def parse_body_response({:ok, response}) do
-    # Logger.debug(response)
+    # Logger.debug(response) # very noisy!
     body = Map.get(response, :body)
     if body == nil || byte_size(body) == 0 do
       Logger.warning("GogsHttp.parse_body_response: response body is nil!")
@@ -53,11 +53,26 @@ defmodule GogsHttp do
   """
   @spec get(String.t()) :: {:ok, map} | {:error, any}
   def get(url) do
-    Logger.info("GogsHttp.get #{url}")
+    Logger.debug("GogsHttp.get #{url}")
     inject_poison().get(url, @headers)
     |> parse_body_response()
   end
 
+  @doc """
+  `get_raw/1` as it's name suggests gets the raw data
+  (expects the reponse to be plaintext not JSON)
+  accepts one argument: `url` the REST API endpoint. 
+  Makes an `HTTP GET` request to the specified `url`.
+  Auth Headers and Content-Type are implicit.
+  returns `{:ok, map}`
+  """
+  @spec get_raw(String.t()) :: {:ok, map} | {:error, any}
+  def get_raw(url) do
+    Logger.debug("GogsHttp.get_raw #{url}")
+    headers = [{"Authorization", "token #{@access_token}"}]
+    inject_poison().get(url, headers)
+  end
+
   @doc """
   `post/2` accepts two arguments: `url` and `params`. 
   Makes an `HTTP POST` request to the specified `url`
@@ -66,7 +81,7 @@ defmodule GogsHttp do
   """
   @spec post(String.t(), map) :: {:ok, map} | {:error, any}
   def post(url, params \\ %{}) do
-    Logger.info("GogsHttp.post #{url}")
+    Logger.debug("GogsHttp.post #{url}")
     body = Jason.encode!(params)
     inject_poison().post(url, body, @headers)
     |> parse_body_response()
@@ -78,7 +93,7 @@ defmodule GogsHttp do
   """
   @spec delete(String.t()) :: {:ok, map} | {:error, any}
   def delete(url) do
-    Logger.info("GogsHttp.delete #{url}")
+    Logger.debug("GogsHttp.delete #{url}")
     inject_poison().delete(url <> "?token=#{@access_token}")
     |> parse_body_response()
   end

lib/httpoison_mock.ex

@@ -56,17 +56,28 @@ defmodule Gogs.HTTPoisonMock do
     })
   end
 
+  @raw_response {:ok, %HTTPoison.Response{
+    body: "# public-repo\n\nplease don't update this. the tests read it.",
+    status_code: 200
+  }}
+
   @doc """
   `get/2` mocks the HTTPoison.get/2 function when parameters match test vars.
   Feel free refactor this if you can make it pretty. 
   """
   def get(url, _headers) do
     Logger.debug("Gogs.HTTPoisonMock.get/2 #{url}")
-    repo_name = GogsHelpers.get_repo_name_from_url(url)
-    response_body = 
-      make_repo_create_post_response_body(repo_name)
-      |> Jason.encode!()
-    {:ok, %{body: response_body}}
+    case String.contains?(url, "/raw/") do
+      true ->
+        @raw_response
+      false ->
+        Logger.debug("Gogs.HTTPoisonMock.get/2 #{url}")
+        repo_name = GogsHelpers.get_repo_name_from_url(url)
+        response_body = 
+          make_repo_create_post_response_body(repo_name)
+          |> Jason.encode!()
+        {:ok, %{body: response_body}}
+    end
   end
 
   @doc """

mix.exs

@@ -6,7 +6,7 @@ defmodule Gogs.MixProject do
   def project do
     [
       app: :gogs,
-      version: "0.6.0",
+      version: "0.7.0",
       elixir: @elixir_requirement,
       start_permanent: Mix.env() == :prod,
       deps: deps(),

test/gogs_test.exs

@@ -43,6 +43,17 @@ defmodule GogsTest do
     Gogs.remote_repo_delete(org_name, repo_name)    
   end
 
+  test "remote_read_raw/3 retrieves the contents of the README.md file" do
+    org_name = "myorg"
+    repo_name = "public-repo"
+    file_name = "README.md"
+    {:ok, %HTTPoison.Response{ body: response_body}} = 
+      Gogs.remote_read_raw(org_name, repo_name, file_name)
+    IO.inspect(response_body)
+    expected = "# public-repo\n\nplease don't update this. the tests read it."
+    assert expected == response_body
+  end
+
   test "Gogs.clone clones a known remote repository Gogs on Fly.io" do
     org = "nelsonic"
     repo = "public-repo"