Merge pull request #332 from code-corps/331-add-ja_resource

Add ja_resource

Author: joshsmith

circle.yml

@@ -14,7 +14,7 @@ dependencies:
 test:
   override:
     - |
-      if [ ${CIRCLE_PR_USERNAME} ]; then MIX_ENV=test mix test --cover; else MIX_ENV=test mix test --include requires_env --cover; fi
+      if [ ${CIRCLE_PR_USERNAME} ]; then MIX_ENV=test mix coveralls.circle; else MIX_ENV=test mix coveralls.circle --include requires_env; fi
 
   post:
     - mix inch.report

config/config.exs

@@ -52,9 +52,6 @@ config :arc,
   bucket: System.get_env("S3_BUCKET"),
   asset_host: System.get_env("CLOUDFRONT_DOMAIN")
 
-# Configures Segment for analytics
-config :code_corps, :analytics, CodeCorps.Analytics.Segment
-
 config :segment,
   write_key: System.get_env("SEGMENT_WRITE_KEY")
 
@@ -72,6 +69,9 @@ config :sentry,
   included_environments: ~w(prod staging)a,
   use_error_logger: true
 
+config :ja_resource,
+  repo: CodeCorps.Repo
+
 # Import environment specific config. This must remain at the bottom
 # of this file so it overrides the configuration defined above.
 import_config "#{Mix.env}.exs"

config/dev.exs

@@ -46,7 +46,7 @@ config :code_corps, allowed_origins: ["http://localhost:4200"]
 config :guardian, Guardian,
   secret_key: "e62fb6e2746f6b1bf8b5b735ba816c2eae1d5d76e64f18f3fc647e308b0c159e"
 
-config :code_corps, :analytics, CodeCorps.Analytics.InMemory
+config :code_corps, :analytics, CodeCorps.Analytics.InMemoryAPI
 
 config :sentry,
   environment_name: Mix.env || :dev

config/prod.exs

@@ -38,6 +38,9 @@ config :guardian, Guardian,
 # Do not print debug messages in production
 config :logger, level: :info
 
+# Configures Segment for analytics
+config :code_corps, :analytics, CodeCorps.Analytics.SegmentAPI
+
 config :sentry,
   environment_name: Mix.env || :prod
 

config/staging.exs

@@ -37,6 +37,9 @@ config :guardian, Guardian,
 # Do not print debug messages in production
 config :logger, level: :info
 
+# Configures Segment for analytics
+config :code_corps, :analytics, CodeCorps.Analytics.SegmentAPI
+
 config :sentry,
   environment_name: Mix.env || :staging
 

config/test.exs

@@ -28,7 +28,7 @@ config :code_corps, allowed_origins: ["http://localhost:4200"]
 config :guardian, Guardian,
   secret_key: "e62fb6e2746f6b1bf8b5b735ba816c2eae1d5d76e64f18f3fc647e308b0c159e"
 
-config :code_corps, :analytics, CodeCorps.Analytics.InMemory
+config :code_corps, :analytics, CodeCorps.Analytics.InMemoryAPI
 
 config :code_corps, :icon_color_generator, CodeCorps.RandomIconColor.TestGenerator
 

lib/code_corps/analytics/in_memory.ex

@@ -0,0 +1,10 @@
+defmodule CodeCorps.Analytics.InMemoryAPI do
+  @moduledoc """
+  In-memory interface to simulate calling out to the Segment API.
+
+  Each function should have the same signature as `CodeCorps.Analytics.SegmentAPI` and simply return `nil`.
+  """
+
+  def identify(_user_id, _traits), do: nil
+  def track(_user_id, _event_name, _properties), do: nil
+end

lib/code_corps/analytics/in_memory_api.ex

@@ -1,82 +1,115 @@
 defmodule CodeCorps.Analytics.Segment do
+  @moduledoc """
+  Provides analytics tracking for Segment.com with an interface for making [`identify`](https://github.com/stueccles/analytics-elixir#identify) and [`track`](https://github.com/stueccles/analytics-elixir#track) calls via the [`analytics-elixir` package](https://github.com/stueccles/analytics-elixir).
+
+  You can read more about [`identify`](https://segment.com/docs/spec/identify/) and [`track`](https://segment.com/docs/spec/track/) in [Segment's documentation](https://segment.com/docs/).
+
+  By default, in `dev` and `test` envrionments, this module will use `CodeCorps.Analytics.InMemoryAPI` which does not make a request to Segment's REST API.
+
+  In `prod` and `staging` environments, the module will use `CodeCorps.Analytics.SegmentAPI` which _will_ make requests to Segment's REST API.
+
+  In your `config/prod.exs` you might set this like so:
+
+  ```elixir
+  config :code_corps, :analytics, CodeCorps.Analytics.SegmentAPI
+  ```
+  """
+
   alias CodeCorps.Comment
   alias CodeCorps.OrganizationMembership
   alias CodeCorps.Task
   alias CodeCorps.User
   alias CodeCorps.UserCategory
   alias CodeCorps.UserRole
   alias CodeCorps.UserSkill
+  alias Ecto.Changeset
 
-  def identify(user = %User{}) do
-    Segment.Analytics.identify(user.id, traits(user))
-  end
+  @api Application.get_env(:code_corps, :analytics)
 
-  def track(conn, :added, user_category = %UserCategory{}) do
-    conn |> do_track("Added User Category", properties(user_category))
-  end
-  def track(conn, :added, user_role = %UserRole{}) do
-    conn |> do_track("Added User Role", properties(user_role))
-  end
-  def track(conn, :added, user_skill = %UserSkill{}) do
-    conn |> do_track("Added User Skill", properties(user_skill))
-  end
-  def track(conn, :created, comment = %Comment{}) do
-    conn |> do_track("Created Comment", properties(comment))
-  end
-  def track(conn, :created, organization_membership = %OrganizationMembership{role: "pending"}) do
-    conn |> do_track("Requested Organization Membership", properties(organization_membership))
-  end
-  def track(conn, :created, organization_membership = %OrganizationMembership{}) do
-    conn |> do_track("Created Organization Membership", properties(organization_membership))
-  end
-  def track(conn, :created, task = %Task{}) do
-    conn |> do_track("Created Task", properties(task))
-  end
-  def track(conn, :edited, comment = %Comment{}) do
-    conn |> do_track("Edited Comment", properties(comment))
-  end
-  def track(conn, :edited, task = %Task{}) do
-    conn |> do_track("Edited Task", properties(task))
-  end
-  def track(conn, :removed, user_category = %UserCategory{}) do
-    conn |> do_track("Removed User Category", properties(user_category))
-  end
-  def track(conn, :removed, user_role = %UserRole{}) do
-    conn |> do_track("Removed User Role", properties(user_role))
-  end
-  def track(conn, :removed, user_skill = %UserSkill{}) do
-    conn |> do_track("Removed User Skill", properties(user_skill))
-  end
-  def track(conn, _event, _struct) do
-    conn # return conn without event to track
+  @actions_without_properties [:updated_profile, :signed_in, :signed_out, :signed_up]
+
+  @doc """
+  Uses the action on the record to determine the event name that should be passed in for the `track` call.
+  """
+  @spec get_event_name(atom, struct) :: String.t
+  def get_event_name(action, _) when action in @actions_without_properties do
+    friendly_action_name(action)
+  end
+  def get_event_name(:created, %OrganizationMembership{}), do: "Requested Organization Membership"
+  def get_event_name(:edited, %OrganizationMembership{}), do: "Approved Organization Membership"
+  def get_event_name(:created, %UserCategory{}), do: "Added User Category"
+  def get_event_name(:created, %UserSkill{}), do: "Added User Skill"
+  def get_event_name(:created, %UserRole{}), do: "Added User Role"
+  def get_event_name(action, model) do
+    [friendly_action_name(action), friendly_model_name(model)] |> Enum.join(" ")
   end
 
-  def track(conn, :updated_profile) do
-    conn |> do_track("Updated Profile")
+  @doc """
+  Calls `identify` in the configured API module.
+  """
+  @spec identify(User.t) :: any
+  def identify(user = %User{}) do
+    @api.identify(user.id, traits(user))
   end
-  def track(conn, :signed_in) do
-    conn |> do_track("Signed In")
+
+  @doc """
+  Calls `track` in the configured API module.
+
+  Receives either an `:ok` or `:error` tuple from an attempted `Ecto.Repo` operation.
+  """
+  @spec track({:ok, Ecto.Schema.t} | {:error, Ecto.Changeset.t}, atom, Plug.Conn.t) :: any
+  def track({:ok, record}, action, %Plug.Conn{} = conn) when action in @actions_without_properties do
+    action_name = get_event_name(action, record)
+    do_track(conn, action_name)
+
+    {:ok, record}
   end
-  def track(conn, :signed_out) do
-    conn |> do_track("Signed Out")
+  def track({:ok, record}, action, %Plug.Conn{} = conn) do
+    action_name = get_event_name(action, record)
+    do_track(conn, action_name, properties(record))
+
+    {:ok, record}
   end
-  def track(conn, :signed_up) do
-    conn |> do_track("Signed Up")
+  def track({:error, %Changeset{} = changeset}, _action, _conn), do: {:error, changeset}
+  def track({:error, errors}, :deleted, _conn), do: {:error, errors}
+
+  @doc """
+  Calls `track` with the "Signed In" event in the configured API module.
+  """
+  @spec track_sign_in(Plug.Conn.t) :: any
+  def track_sign_in(conn), do: conn |> do_track("Signed In")
+
+  defp friendly_action_name(:deleted), do: "Removed"
+  defp friendly_action_name(action) do
+    action
+    |> Atom.to_string
+    |> String.split("_")
+    |> Enum.map(&String.capitalize/1)
+    |> Enum.join(" ")
   end
-  def track(conn, _event) do
-    conn # return conn without event to track
+
+  defp friendly_model_name(model) do
+    model.__struct__
+    |> Module.split
+    |> List.last
+    |> Macro.underscore
+    |> String.split("_")
+    |> Enum.map(&String.capitalize/1)
+    |> Enum.join(" ")
   end
 
   defp do_track(conn, event_name, properties) do
-    Segment.Analytics.track(conn.assigns[:current_user].id, event_name, properties)
+    @api.track(conn.assigns[:current_user].id, event_name, properties)
     conn
   end
+
   defp do_track(conn, event_name) do
-    Segment.Analytics.track(conn.assigns[:current_user].id, event_name, %{})
+    @api.track(conn.assigns[:current_user].id, event_name, %{})
     conn
   end
 
   defp properties(comment = %Comment{}) do
+    comment = comment |> CodeCorps.Repo.preload(:task)
     %{
       comment_id: comment.id,
       task: comment.task.title,
@@ -86,6 +119,7 @@ defmodule CodeCorps.Analytics.Segment do
     }
   end
   defp properties(organization_membership = %OrganizationMembership{}) do
+    organization_membership = organization_membership |> CodeCorps.Repo.preload(:organization)
     %{
       organization: organization_membership.organization.name,
       organization_id: organization_membership.organization.id
@@ -100,18 +134,21 @@ defmodule CodeCorps.Analytics.Segment do
     }
   end
   defp properties(user_category = %UserCategory{}) do
+    user_category = user_category |> CodeCorps.Repo.preload(:category)
     %{
       category: user_category.category.name,
       category_id: user_category.category.id
     }
   end
   defp properties(user_role = %UserRole{}) do
+    user_role = user_role |> CodeCorps.Repo.preload(:role)
     %{
       role: user_role.role.name,
       role_id: user_role.role.id
     }
   end
   defp properties(user_skill = %UserSkill{}) do
+    user_skill = user_skill |> CodeCorps.Repo.preload(:skill)
     %{
       skill: user_skill.skill.title,
       skill_id: user_skill.skill.id

lib/code_corps/analytics/segment.ex

@@ -0,0 +1,13 @@
+defmodule CodeCorps.Analytics.SegmentAPI do
+  @moduledoc """
+  Interface to the Segment API through the [`analytics-elixir` package](https://github.com/stueccles/analytics-elixir).
+  """
+
+  def identify(user_id, traits) do
+    Segment.Analytics.identify(user_id, traits)
+  end
+
+  def track(user_id, event_name, properties) do
+    Segment.Analytics.track(user_id, event_name, properties)
+  end
+end