First commit

Author: nkezhaya

.formatter.exs

@@ -0,0 +1,4 @@
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
+  locals_without_parens: [plug: 1, plug: 2]
+]

.gitignore

@@ -0,0 +1,25 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+posthog-*.tar
+
+config

LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2020 White Paper Clip, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,39 @@
+# Posthog
+
+This library provides an HTTP client for Posthog.
+
+## Installation
+
+The package can be installed by adding `posthog` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:posthog, "~> 0.1"}
+  ]
+end
+```
+
+## Configuration
+
+```elixir
+config :posthog,
+  api_url: "http://posthog.example.com",
+  api_key: "..."
+```
+
+Optionally, you can pass in a `:json_library` key. The default JSON parser is Jason.
+
+## Usage
+
+Capturing events:
+
+```elixir
+Posthog.capture("login", distinct_id: user.id)
+```
+
+Capturing multiple events:
+
+```elixir
+Posthog.batch([{"login", [distinct_id: user.id], nil}])
+```

lib/posthog.ex

@@ -0,0 +1,34 @@
+defmodule Posthog do
+  @moduledoc """
+  This module provides an Elixir HTTP client for Posthog.
+
+  Example config:
+
+      config :posthog,
+        api_url: "http://posthog.example.com",
+        api_key: "..."
+
+  Optionally, you can pass in a `:json_library` key. The default JSON parser
+  is Jason.
+  """
+
+  @doc """
+  Sends a capture event. `distinct_id` is the only required parameter.
+
+  ## Examples
+
+      iex> Posthog.capture("login", distinct_id: user.id)
+      :ok
+      iex> Posthog.capture("login", [distinct_id: user.id], DateTime.utc_now())
+      :ok
+
+  """
+  @typep result() :: {:ok, term()} | {:error, term()}
+  @typep timestamp() :: DateTime.t() | NaiveDateTime.t() | String.t() | nil
+
+  @spec capture(atom() | String.t(), keyword() | map(), timestamp()) :: result()
+  defdelegate capture(event, params, timestamp \\ nil), to: Posthog.Client
+
+  @spec batch(list(tuple())) :: result()
+  defdelegate batch(events), to: Posthog.Client
+end

lib/posthog/client.ex

@@ -0,0 +1,99 @@
+defmodule Posthog.Client do
+  @moduledoc false
+
+  def capture(event, params, timestamp) when is_bitstring(event) or is_atom(event) do
+    body = build_event(event, params, timestamp)
+
+    post!("/capture", body)
+  end
+
+  def batch(events) when is_list(events) do
+    body =
+      for {event, params, timestamp} <- events do
+        build_event(event, params, timestamp)
+      end
+
+    body = %{batch: body}
+
+    post!("/capture", body)
+  end
+
+  defp build_event(event, properties, timestamp) do
+    %{event: to_string(event), properties: Map.new(properties), timestamp: timestamp}
+  end
+
+  defp post!(path, %{} = body) do
+    body =
+      body
+      |> Map.put(:api_key, api_key())
+      |> json_library().encode!()
+
+    api_url()
+    |> URI.merge(path)
+    |> URI.to_string()
+    |> :hackney.post([{"Content-Type", "application/json"}], body)
+    |> handle()
+  end
+
+  @spec handle(tuple()) :: {:ok, term()} | {:error, term()}
+  defp handle({:ok, status, _headers, _ref} = resp) when div(status, 100) == 2 do
+    {:ok, to_response(resp)}
+  end
+
+  defp handle({:ok, _status, _headers, _ref} = resp) do
+    {:error, to_response(resp)}
+  end
+
+  defp handle({:error, _} = result) do
+    result
+  end
+
+  defp to_response({_, status, headers, ref}) do
+    response = %{status: status, headers: headers, body: nil}
+
+    with {:ok, body} <- :hackney.body(ref),
+         {:ok, json} <- json_library().decode(body) do
+      %{response | body: json}
+    else
+      _ -> response
+    end
+  end
+
+  defp api_url() do
+    case Application.get_env(:posthog, :api_url) do
+      url when is_bitstring(url) ->
+        url
+
+      term ->
+        raise """
+        Expected a string API URL, got: #{inspect(term)}. Set a
+        URL and key in your config:
+
+            config :posthog,
+              api_url: "https://posthog.example.com",
+              api_key: "my-key"
+        """
+    end
+  end
+
+  defp api_key() do
+    case Application.get_env(:posthog, :api_key) do
+      key when is_bitstring(key) ->
+        key
+
+      term ->
+        raise """
+        Expected a string API key, got: #{inspect(term)}. Set a
+        URL and key in your config:
+
+            config :posthog,
+              api_url: "https://posthog.example.com",
+              api_key: "my-key"
+        """
+    end
+  end
+
+  defp json_library() do
+    Application.get_env(:posthog, :json_library, Jason)
+  end
+end

mix.exs

@@ -0,0 +1,43 @@
+defmodule Posthog.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :posthog,
+      version: "0.1.0",
+      elixir: "~> 1.8",
+      start_permanent: Mix.env() == :prod,
+      deps: deps(),
+      description: description(),
+      package: package()
+    ]
+  end
+
+  def application do
+    []
+  end
+
+  defp description do
+    """
+    Elixir HTTP client for Posthog.
+    """
+  end
+
+  defp package do
+    [
+      name: :posthog,
+      files: ["lib", "mix.exs", "README.md", "LICENSE"],
+      maintainers: ["Nick Kezhaya"],
+      licenses: ["MIT"],
+      links: %{"GitHub" => "https://github.com/whitepaperclip/posthog"}
+    ]
+  end
+
+  defp deps do
+    [
+      {:hackney, "~> 1.10"},
+      {:jason, "~> 1.2", optional: true},
+      {:ex_doc, ">= 0.0.0", only: [:doc]}
+    ]
+  end
+end

mix.lock

@@ -0,0 +1,18 @@
+%{
+  "certifi": {:hex, :certifi, "2.5.2", "b7cfeae9d2ed395695dd8201c57a2d019c0c43ecaf8b8bcb9320b40d6662f340", [:rebar3], [{:parse_trans, "~>3.3", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm", "3b3b5f36493004ac3455966991eaf6e768ce9884693d9968055aeeeb1e575040"},
+  "earmark": {:hex, :earmark, "1.4.5", "62ffd3bd7722fb7a7b1ecd2419ea0b458c356e7168c1f5d65caf09b4fbdd13c8", [:mix], [], "hexpm", "b7d0e6263d83dc27141a523467799a685965bf8b13b6743413f19a7079843f4f"},
+  "ex_doc": {:hex, :ex_doc, "0.22.1", "9bb6d51508778193a4ea90fa16eac47f8b67934f33f8271d5e1edec2dc0eee4c", [:mix], [{:earmark, "~> 1.4.0", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "d957de1b75cb9f78d3ee17820733dc4460114d8b1e11f7ee4fd6546e69b1db60"},
+  "hackney": {:hex, :hackney, "1.16.0", "5096ac8e823e3a441477b2d187e30dd3fff1a82991a806b2003845ce72ce2d84", [:rebar3], [{:certifi, "2.5.2", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "6.0.1", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.0", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.6", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm", "3bf0bebbd5d3092a3543b783bf065165fa5d3ad4b899b836810e513064134e18"},
+  "idna": {:hex, :idna, "6.0.1", "1d038fb2e7668ce41fbf681d2c45902e52b3cb9e9c77b55334353b222c2ee50c", [:rebar3], [{:unicode_util_compat, "0.5.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "a02c8a1c4fd601215bb0b0324c8a6986749f807ce35f25449ec9e69758708122"},
+  "jason": {:hex, :jason, "1.2.1", "12b22825e22f468c02eb3e4b9985f3d0cb8dc40b9bd704730efa11abd2708c44", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "b659b8571deedf60f79c5a608e15414085fa141344e2716fbd6988a084b5f993"},
+  "makeup": {:hex, :makeup, "1.0.2", "0b9f7bfb7a88bed961341b359bc2cc1b233517af891ba4890ec5a580ffe738b4", [:mix], [{:nimble_parsec, "~> 0.5", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "43833299231c6a6983afc75a34e43eeba638521d5527ff89809fa6372424fd7e"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.14.1", "4f0e96847c63c17841d42c08107405a005a2680eb9c7ccadfd757bd31dabccfb", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "f2438b1a80eaec9ede832b5c41cd4f373b38fd7aa33e3b22d9db79e640cbde11"},
+  "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
+  "mime": {:hex, :mime, "1.3.1", "30ce04ab3175b6ad0bdce0035cba77bba68b813d523d1aac73d9781b4d193cf8", [:mix], [], "hexpm", "6cbe761d6a0ca5a31a0931bf4c63204bceb64538e664a8ecf784a9a6f3b875f1"},
+  "mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
+  "nimble_parsec": {:hex, :nimble_parsec, "0.6.0", "32111b3bf39137144abd7ba1cce0914533b2d16ef35e8abc5ec8be6122944263", [:mix], [], "hexpm", "27eac315a94909d4dc68bc07a4a83e06c8379237c5ea528a9acff4ca1c873c52"},
+  "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm", "17ef63abde837ad30680ea7f857dd9e7ced9476cdd7b0394432af4bfc241b960"},
+  "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.6", "cf344f5692c82d2cd7554f5ec8fd961548d4fd09e7d22f5b62482e5aeaebd4b0", [:make, :mix, :rebar3], [], "hexpm", "bdb0d2471f453c88ff3908e7686f86f9be327d065cc1ec16fa4540197ea04680"},
+  "tesla": {:hex, :tesla, "1.3.3", "26ae98627af5c406584aa6755ab5fc96315d70d69a24dd7f8369cfcb75094a45", [:mix], [{:castore, "~> 0.1", [hex: :castore, repo: "hexpm", optional: true]}, {:exjsx, ">= 3.0.0", [hex: :exjsx, repo: "hexpm", optional: true]}, {:fuse, "~> 2.4", [hex: :fuse, repo: "hexpm", optional: true]}, {:gun, "~> 1.3", [hex: :gun, repo: "hexpm", optional: true]}, {:hackney, "~> 1.6", [hex: :hackney, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4.0", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.0", [hex: :mint, repo: "hexpm", optional: true]}, {:poison, ">= 1.0.0", [hex: :poison, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4", [hex: :telemetry, repo: "hexpm", optional: true]}], "hexpm", "2648f1c276102f9250299e0b7b57f3071c67827349d9173f34c281756a1b124c"},
+  "unicode_util_compat": {:hex, :unicode_util_compat, "0.5.0", "8516502659002cec19e244ebd90d312183064be95025a319a6c7e89f4bccd65b", [:rebar3], [], "hexpm", "d48d002e15f5cc105a696cf2f1bbb3fc72b4b770a184d8420c8db20da2674b38"},
+}

test/posthog_test.exs

@@ -0,0 +1,8 @@
+defmodule PosthogTest do
+  use ExUnit.Case
+  doctest Posthog
+
+  test "greets the world" do
+    assert Posthog.hello() == :world
+  end
+end

test/test_helper.exs

@@ -0,0 +1 @@
+ExUnit.start()