Merge pull request #1054 from code-corps/add-intercom-user-hash

Add Intercom user hash

Author: joshsmith

.env.example

@@ -7,6 +7,7 @@ export CLOUDFRONT_DOMAIN=
 export GITHUB_APP_CLIENT_ID=
 export GITHUB_APP_CLIENT_SECRET=
 export GITHUB_APP_PEM=
+export INTERCOM_IDENTITY_SECRET_KEY=
 export POSTMARK_API_KEY=
 export S3_BUCKET=
 export SEGMENT_WRITE_KEY=

config/config.exs

@@ -50,6 +50,9 @@ config :ex_aws, :code_corps,
 config :code_corps,
   asset_host: System.get_env("CLOUDFRONT_DOMAIN")
 
+config :code_corps,
+  intercom_identity_secret_key: System.get_env("INTERCOM_IDENTITY_SECRET_KEY")
+
 config :segment,
   write_key: System.get_env("SEGMENT_WRITE_KEY")
 

lib/code_corps_web/views/user_view.ex

@@ -13,8 +13,8 @@ defmodule CodeCorpsWeb.UserView do
 
   attributes [
     :biography, :cloudinary_public_id, :email, :first_name,
-    :github_avatar_url, :github_id, :github_username, :inserted_at,
-    :last_name, :name, :photo_large_url, :photo_thumb_url,
+    :github_avatar_url, :github_id, :github_username, :intercom_user_hash,
+    :inserted_at, :last_name, :name, :photo_large_url, :photo_thumb_url,
     :sign_up_context, :state, :state_transition, :twitter, :username,
     :website, :updated_at
   ]
@@ -45,6 +45,19 @@ defmodule CodeCorpsWeb.UserView do
   end
   def email(_user, _conn), do: ""
 
+  @intercom_secret_key Application.get_env(:code_corps, :intercom_identity_secret_key) || "RANDOM_KEY"
+
+  def intercom_user_hash(%{id: id}, _conn) when is_number(id) do
+    id |> Integer.to_string |> do_intercom_user_hash
+  end
+  # def intercom_user_hash(_user, _conn), do: nil
+
+  defp do_intercom_user_hash(id_string) do
+    :crypto.hmac(:sha256, @intercom_secret_key, id_string)
+    |> Base.encode16
+    |> String.downcase
+  end
+
   @doc """
   Returns the user's full name when both first and last name are present.
   Returns the only user's first name or last name when the other is missing,
@@ -53,6 +66,7 @@ defmodule CodeCorpsWeb.UserView do
   def name(%{first_name: first_name, last_name: last_name}, _conn) do
     "#{first_name} #{last_name}" |> String.trim |> normalize_name
   end
+
   defp normalize_name(name) when name in ["", nil], do: nil
   defp normalize_name(name), do: name
 end

test/lib/code_corps_web/views/user_view_test.exs

@@ -1,6 +1,7 @@
 defmodule CodeCorpsWeb.UserViewTest do
   use CodeCorpsWeb.ViewCase
 
+  alias CodeCorpsWeb.UserView
   alias Phoenix.ConnTest
   alias Plug.Conn
 
@@ -17,8 +18,9 @@ defmodule CodeCorpsWeb.UserViewTest do
     project_user = insert(:project_user, user: user)
 
     host = Application.get_env(:code_corps, :asset_host)
+    intercom_user_hash = UserView.intercom_user_hash(user, %Plug.Conn{})
 
-    rendered_json = render(CodeCorpsWeb.UserView, "show.json-api", data: user)
+    rendered_json = render(UserView, "show.json-api", data: user)
 
     expected_json = %{
       "data" => %{
@@ -33,6 +35,7 @@ defmodule CodeCorpsWeb.UserViewTest do
           "github-id" => 123,
           "github-username" => "githubuser",
           "inserted-at" => user.inserted_at,
+          "intercom-user-hash" => intercom_user_hash,
           "last-name" => "Last",
           "name" => "First Last",
           "photo-large-url" => "#{host}/icons/user_default_large_blue.png",
@@ -102,7 +105,7 @@ defmodule CodeCorpsWeb.UserViewTest do
       ConnTest.build_conn()
       |> Conn.assign(:current_user, user)
 
-    rendered_json = render(CodeCorpsWeb.UserView, "show.json-api", data: user, conn: conn)
+    rendered_json = render(UserView, "show.json-api", data: user, conn: conn)
     assert rendered_json["data"]["attributes"]["email"] == user.email
   end
 
@@ -114,7 +117,7 @@ defmodule CodeCorpsWeb.UserViewTest do
       ConnTest.build_conn()
       |> Conn.assign(:current_user, auth_user)
 
-    rendered_json = render(CodeCorpsWeb.UserView, "show.json-api", data: users, conn: conn)
+    rendered_json = render(UserView, "show.json-api", data: users, conn: conn)
 
     emails =
       rendered_json["data"]
@@ -126,29 +129,29 @@ defmodule CodeCorpsWeb.UserViewTest do
   end
 
   test "renders first and last name as name" do
-    user = build(:user, first_name: "First", last_name: "Last")
+    user = build(:user, id: 1, first_name: "First", last_name: "Last")
 
     assert render_user_json(user)["data"]["attributes"]["name"] == "First Last"
   end
 
   test "renders first name only as name" do
-    user = build(:user, first_name: "", last_name: "Last")
+    user = build(:user, id: 1, first_name: "", last_name: "Last")
 
     assert render_user_json(user)["data"]["attributes"]["name"] == "Last"
   end
 
   test "renders last name only as name" do
-    user = build(:user, first_name: "First", last_name: "")
+    user = build(:user, id: 1, first_name: "First", last_name: "")
 
     assert render_user_json(user)["data"]["attributes"]["name"] == "First"
   end
 
   test "renders nil name if first or last name blank" do
-    user = build(:user, first_name: "", last_name: "")
+    user = build(:user, id: 1, first_name: "", last_name: "")
 
     assert render_user_json(user)["data"]["attributes"]["name"] == nil
 
-    user = build(:user, first_name: nil, last_name: nil)
+    user = build(:user, id: 1, first_name: nil, last_name: nil)
 
     assert render_user_json(user)["data"]["attributes"]["name"] == nil
   end
@@ -158,6 +161,6 @@ defmodule CodeCorpsWeb.UserViewTest do
       ConnTest.build_conn()
       |> Conn.assign(:current_user, user)
 
-    render(CodeCorpsWeb.UserView, "show.json-api", data: user, conn: conn)
+    render(UserView, "show.json-api", data: user, conn: conn)
   end
 end