Thin Notion API Begins!!!

Author: Erik Guzman

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -0,0 +1,27 @@
+# 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").
+thin_notion_api-*.tar
+
+
+# Temporary files for e.g. tests
+/tmp

README.md

@@ -0,0 +1,31 @@
+# ThinNotionApi
+
+**TODO: Add description**
+
+TODO:
+
+- Need to start adding tests
+- List database query param support
+- Query database with options
+- Support all Page object actions
+- Support all Block actions
+- Support all User actions
+- Support Search
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `thin_notion_api` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:thin_notion_api, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at [https://hexdocs.pm/thin_notion_api](https://hexdocs.pm/thin_notion_api).
+

config/config.exs

@@ -0,0 +1,4 @@
+use Mix.Config
+
+config :thin_notion_api, :api_key, System.get_env("NOTION_API_KEY")
+config :thin_notion_api, :notion_version, System.get_env("NOTION_VERSION")

lib/thin_notion_api.ex

@@ -0,0 +1,20 @@
+defmodule ThinNotionApi do
+  @moduledoc """
+  Documentation for `ThinNotionApi`.
+
+  A thin wrapper for the Notion API
+  """
+
+  @doc """
+  Hello world.
+
+  ## Examples
+
+      iex> ThinNotionApi.hello()
+      :world
+
+  """
+  def hello do
+    :world
+  end
+end

lib/thin_notion_api/base.ex

@@ -0,0 +1,36 @@
+defmodule ThinNotionApi.Base do
+  @moduledoc false
+
+  alias ThinNotionApi.Parser
+  import ThinNotionApi.Utils
+
+  @base_url "https://api.notion.com/v1"
+
+  def get(path_arg, query_params \\ %{}) do
+    path_arg
+    |> build_url(query_params)
+    |> HTTPoison.get(request_headers())
+    |> Parser.parse()
+  end
+
+  def post(path_arg, body \\ %{}) do
+    json_body = Jason.encode!(body)
+    IO.puts(json_body)
+    path_arg
+    |> build_url()
+    |> HTTPoison.post(json_body, post_request_headers())
+    |> Parser.parse()
+  end
+
+  defp build_url(path_arg, query_params \\ %{}) do
+    query_params = process_params(query_params)
+
+    "#{@base_url}/#{path_arg}?#{URI.encode_query(query_params)}"
+  end
+
+  defp process_params(params) do
+    %{}
+    |> Map.merge(params)
+    |> Map.delete(:__struct__)
+  end
+end

lib/thin_notion_api/databases.ex

@@ -0,0 +1,188 @@
+defmodule ThinNotionApi.Databases do
+  import ThinNotionApi.Base
+
+  @doc """
+  Retrieves a Database object using the ID specified.
+
+  ## Examples
+
+      iex> ThinNotionApi.Databases.retrieve_database(database_id)
+      {:ok,
+      %{
+        "created_time" => "2021-06-11T20:34:00.000Z",
+        "id" => "a4ef92b2-a798-4bae-8211-4817678cd2f4",
+        "last_edited_time" => "2021-07-16T20:44:00.000Z",
+        "object" => "database",
+        "parent" => %{
+          "page_id" => "9b4a624d-5a18-482a-b218-7e54166edda7",
+          "type" => "page_id"
+        },
+        "properties" => %{
+          "Name" => %{"id" => "title", "title" => %{}, "type" => "title"},
+          "Tags" => %{
+            "id" => "@Tnd",
+            "multi_select" => %{"options" => []},
+            "type" => "multi_select"
+          }
+        },
+        "title" => [
+          %{
+            "annotations" => %{
+              "bold" => false,
+              "code" => false,
+              "color" => "default",
+              "italic" => false,
+              "strikethrough" => false,
+              "underline" => false
+            },
+            "href" => nil,
+            "plain_text" => "Test Database",
+            "text" => %{"content" => "Test Database", "link" => nil},
+            "type" => "text"
+          }
+        ]
+      }}
+  """
+  def retrieve_database(database_id) do
+    get("databases/" <> database_id)
+  end
+
+  @doc """
+  List all Databases shared with the authenticated integration. The response may contain fewer than page_size of results.
+
+  > Use search pages for more details.
+
+  > This endpoint is no longer recommended, use search instead. This endpoint will only return explicitly shared pages, while search will also return child pages within explicitly shared pages. This endpoint's results cannot be filtered, while search can be used to match on page title.
+
+  ## Examples:
+      iex> ThinNotionApi.Databases.list_databases(query_params)
+
+  """
+  def list_databases(query_params \\ %{}) do
+    get("databases", query_params)
+  end
+
+  @doc """
+  Gets a list of Pages contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the request. The response may contain fewer than page_size of results.
+
+  ## Examples:
+      iex> ThinNotionApi.Databases.query_database(database_id)
+      {:ok,
+        %{
+          "has_more" => false,
+          "next_cursor" => nil,
+          "object" => "list",
+          "results" => [
+            %{
+              "archived" => false,
+              "created_time" => "2021-06-11T20:34:00.000Z",
+              "id" => "0a8f7171-00b7-4f7e-a0b5-155f006186bb",
+              "last_edited_time" => "2021-07-16T21:04:00.000Z",
+              "object" => "page",
+              "parent" => %{
+                "database_id" => "a4ef92b2-a798-4bae-8211-4817678cd2f4",
+                "type" => "database_id"
+              },
+              "properties" => %{
+                "Name" => %{
+                  "id" => "title",
+                  "title" => [
+                    %{
+                      "annotations" => %{
+                        "bold" => false,
+                        "code" => false,
+                        "color" => "default",
+                        "italic" => false,
+                        "strikethrough" => false,
+                        "underline" => false
+                      },
+                      "href" => nil,
+                      "plain_text" => "Hello World",
+                      "text" => %{"content" => "Hello World", "link" => nil},
+                      "type" => "text"
+                    }
+                  ],
+                  "type" => "title"
+                }
+              },
+              "url" => "https://www.notion.so/Hello-World-0a8f717100b74f7ea0b5155f006186bb"
+            },
+            ...
+          ]
+        }
+      }
+
+      iex> ThinNotionApi.Databases.query_database("a4ef92b2a7984bae82114817678cd2f4", %{ "page_size" => 1})
+      {:ok,
+        %{
+          "has_more" => true,
+          "next_cursor" => "700b4e34-697c-4fad-b97d-d9741d1fbaeb",
+          "object" => "list",
+          "results" => [
+            %{
+              "archived" => false,
+              "created_time" => "2021-06-11T20:34:00.000Z",
+              "id" => "0a8f7171-00b7-4f7e-a0b5-155f006186bb",
+              "last_edited_time" => "2021-07-16T21:04:00.000Z",
+              "object" => "page",
+              "parent" => %{
+                "database_id" => "a4ef92b2-a798-4bae-8211-4817678cd2f4",
+                "type" => "database_id"
+              },
+              "properties" => %{
+                "Name" => %{
+                  "id" => "title",
+                  "title" => [
+                    %{
+                      "annotations" => %{
+                        "bold" => false,
+                        "code" => false,
+                        "color" => "default",
+                        "italic" => false,
+                        "strikethrough" => false,
+                        "underline" => false
+                      },
+                      "href" => nil,
+                      "plain_text" => "Hello World",
+                      "text" => %{"content" => "Hello World", "link" => nil},
+                      "type" => "text"
+                    }
+                  ],
+                  "type" => "title"
+                }
+              },
+              "url" => "https://www.notion.so/Hello-World-0a8f717100b74f7ea0b5155f006186bb"
+            }
+          ]
+        }}
+  """
+  def query_database(database_id, body_params \\ %{}) do
+    post("databases/" <> database_id <> "/query", body_params)
+  end
+
+  @spec create_database(any, any, any) :: any
+  def create_database(parent_id, title, properties \\ %{
+    Name: %{
+      title: %{}
+    },
+  }) do
+    body_params = %{
+      parent: %{
+        type: "page_id",
+        page_id: parent_id
+      },
+      title: [
+        %{
+            type: "text",
+            text: %{
+                content: title,
+                link: nil
+            }
+        }
+      ],
+      properties: properties
+    }
+
+    post("databases", body_params)
+  end
+end

lib/thin_notion_api/parser.ex

@@ -0,0 +1,29 @@
+defmodule ThinNotionApi.Parser do
+  @moduledoc """
+  Generic parser to parse api response
+  """
+
+  @type status_code :: integer
+  @type headers :: map
+  @type response ::
+          {:ok, struct}
+          | {:error, map, status_code}
+          | any
+
+  @doc """
+  Parses the response from API calls
+  """
+  @spec parse(tuple) :: response
+  def parse({:ok, %HTTPoison.Response{body: body, headers: _, status_code: status}})
+      when status in [200, 201],
+      do: {:ok, parse_response_body(body)}
+
+  def parse({:error, %HTTPoison.Error{id: _, reason: reason}}), do: {:error, %{reason: reason}}
+
+  def parse({:ok, %HTTPoison.Response{body: body, headers: _, status_code: status}}),
+    do: {:error, parse_response_body(body), status}
+
+  def parse(response), do: response
+
+  defp parse_response_body(body), do: Jason.decode!(body)
+end

lib/thin_notion_api/utils.ex

@@ -0,0 +1,14 @@
+defmodule ThinNotionApi.Utils do
+  @moduledoc false
+
+  def api_key, do: Application.get_env(:thin_notion_api, :api_key)
+
+  def notion_version,
+    do: Application.get_env(:thin_notion_api, :notion_version, "2021-05-13")
+
+  def auth_header, do: [{"Authorization", "Bearer " <> api_key()}]
+  def version_header, do: [{"Notion-Version", notion_version()}]
+  def content_header, do: [{"Content-Type", "application/json"}]
+  def request_headers, do: version_header() ++ auth_header()
+  def post_request_headers, do: version_header() ++ auth_header() ++ content_header()
+end

mix.exs

@@ -0,0 +1,30 @@
+defmodule ThinNotionApi.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :thin_notion_api,
+      version: "0.1.0",
+      elixir: "~> 1.11",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
+      {:httpoison, "~> 1.8"},
+      {:jason, "~> 1.2"}
+    ]
+  end
+end