Add /github-connect route and action

npendery · begedin · commit d21f8b4f16aa · 2017-05-02T10:32:17.000+02:00
- adds route
- adds user controller action
- adds api docs for action

Action
- calls placeholder method in github module
- responds with user if ok
- responds with 422 if code param is bad
- responds with 500 if something else goes wrong
diff --git a/blueprint/api.apib b/blueprint/api.apib
@@ -2265,6 +2265,32 @@ This endpoint handles the User resources for Code Corps.
 
     + Attributes (Record Not Found Response)
 
+### Connect user to GitHub [POST /github_connect]
+
+This endpoint allows a user to connect their CodeCorps account to their respective GitHub account.
+
++ Request
+
+    + Attributes
+
+      + code (string) - Client generated code for authenication when sending request to GitHub.
+
+    + Headers
+
+            Accept: application/vnd.api+json
+
++ Response 201 (application/vnd.api+json; charset=utf-8)
+
+    + Attributes (User Response)
+
++ Response 401 (application/vnd.api+json; charset=utf-8)
+
+    + Attributes (JSON Web Token Invalid Response)
+
++ Response 422 (application/vnd.api+json; charset=utf-8)
+
+    + Attributes (Unprocessable Entity Response)
+
 ### Check email availability [GET /users/email_available?email={email}]
 
 This endpoint allows you to check whether an email is valid (by checking simply for presence of the `@` symbol) and whether the email is not already registered.
diff --git a/lib/code_corps/github.ex b/lib/code_corps/github.ex
@@ -2,9 +2,14 @@ defmodule CodeCorps.Github do
 
   alias CodeCorps.{User, Repo}
 
+  @doc """
+  Temporary function until the actual behavior is implemented.
+  """
+  def connect(user, _code), do: {:ok, user}
+
   def associate(user, params) do
     user
     |> User.github_associate_changeset(params)
     |> Repo.update()
   end
-end
+end
diff --git a/test/controllers/user_controller_test.exs b/test/controllers/user_controller_test.exs
@@ -242,13 +242,34 @@ defmodule CodeCorps.UserControllerTest do
     end
   end
 
+  describe "github_connect" do
+    test "return the user when current user connects successfully", %{conn: conn} do
+      user = insert(:user)
+
+      code = %{"code" => "client generated code"}
+
+      path = user_path(conn, :github_connect, code)
+
+      json = conn |> authenticate(user) |> post(path) |> json_response(200)
+
+      assert json["data"]["id"] |> String.to_integer == user.id
+    end
+
+    test "return unauthenticated error code when no current user", %{conn: conn} do
+      code = %{"code" => "client generated code"}
+
+      path = user_path(conn, :github_connect, code)
+
+      conn |> post(path) |> json_response(401)
+    end
+  end
+
   describe "email_available" do
     test "returns valid and available when email is valid and available", %{conn: conn} do
       resp = get conn, user_path(conn, :email_available, %{email: "available@mail.com"})
       json = json_response(resp, 200)
       assert json["available"]
       assert json["valid"]
-
     end
 
     test "returns valid but inavailable when email is valid but taken", %{conn: conn} do
diff --git a/web/controllers/user_controller.ex b/web/controllers/user_controller.ex
@@ -6,6 +6,7 @@ defmodule CodeCorps.UserController do
 
   alias CodeCorps.User
   alias CodeCorps.Services.UserService
+  alias CodeCorps.Github
 
   plug :load_and_authorize_resource, model: User, only: [:update]
   plug JaResource
@@ -34,6 +35,23 @@ defmodule CodeCorps.UserController do
     end
   end
 
+  def github_connect(conn, code) do
+    current_user = Guardian.Plug.current_resource(conn)
+    with {:ok, user} <- Github.connect(current_user, code)
+    do
+      conn |> render(:show, data: user)
+    else
+      {:error, %Ecto.Changeset{} = changeset} ->
+        conn
+        |> put_status(:unprocessable_entity)
+        |> render(CodeCorps.ChangesetView, "error.json-api", changeset: changeset)
+      {:error, _error} ->
+        conn
+        |> put_status(:internal_server_error)
+        |> render(CodeCorps.ErrorView, "500.json-api")
+    end
+  end
+
   def email_available(conn, %{"email" => email}) do
     hash = User.check_email_availability(email)
     conn |> json(hash)
diff --git a/web/router.ex b/web/router.ex
@@ -63,6 +63,7 @@ defmodule CodeCorps.Router do
     resources "/categories", CategoryController, only: [:create, :update]
     resources "/comments", CommentController, only: [:create, :update]
     resources "/donation-goals", DonationGoalController, only: [:create, :update, :delete]
+    post "/github-connect", UserController, :github_connect
     resources "/organizations", OrganizationController, only: [:create, :update]
     post "/password/reset", PasswordResetController, :reset_password
     resources "/previews", PreviewController, only: [:create]
