add cms and query modules

Author: Scott Bennett

.tool-versions

@@ -1,2 +1,2 @@
-elixir 1.11.3
-erlang 23.2.3
+elixir 1.14.2-otp-25
+erlang 25.1.2

config/config.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Config
 
 config :ex_sanity,
   file_base: "https://cdn.sanity.io",
@@ -8,4 +8,4 @@ config :ex_sanity,
   version: "xxx",
   endpoint: "xxx"
 
-import_config "#{Mix.env}.exs"
+import_config "#{Mix.env()}.exs"

config/test.exs

@@ -1,4 +1,4 @@
-use Mix.Config
+import Config
 
 config :ex_sanity,
   project_id: "123",

lib/ex_sanity/cms.ex

@@ -0,0 +1,39 @@
+defmodule ExSanity.CMS do
+  @moduledoc """
+  Inspired by Ecto.Repo. Runs queries against the Sanity CMS and returns the
+  result.
+
+  Currently only supports "read" type queries. Create/update queries are on
+  the roadmap.
+  """
+  alias ExSanity.Client
+  alias ExSanity.Query
+
+  def get(query, id) do
+    query_string = Query.build(query, id)
+
+    {:ok, response} = Client.query(query_string)
+
+    [document | _] = response.body["result"]
+
+    document
+  end
+
+  def one(query) do
+    query_string = Query.build(query)
+
+    {:ok, response} = Client.query(query_string)
+
+    [document | _] = response.body["result"]
+
+    document
+  end
+
+  def all(query) do
+    query_string = Query.build(query)
+
+    {:ok, response} = Client.query(query_string)
+
+    response.body["result"]
+  end
+end

lib/ex_sanity/query.ex

@@ -0,0 +1,117 @@
+defmodule ExSanity.Query do
+  @moduledoc false
+  defstruct types: [], preloads: [], filters: [], projections: [], orderings: [], slice: ""
+
+  def from(type) when is_atom(type) do
+    %__MODULE__{
+      types: [type]
+    }
+  end
+
+  def from(types) do
+    %__MODULE__{
+      types: types
+    }
+  end
+
+  def select(query, fields) do
+    %{query | projections: query.projections ++ fields}
+  end
+
+  def filter(query, filter) do
+    %{query | filters: query.filters ++ [filter]}
+  end
+
+  def preload(query, preloads) do
+    %{query | preloads: preloads}
+  end
+
+  def order(query, order) do
+    %{query | orderings: query.orderings ++ [order]}
+  end
+
+  def slice(query, slice) do
+    %{query | slice: slice}
+  end
+
+  def build(query, id) do
+    query = filter(query, ~s(_id == "#{id}"))
+    build(query)
+  end
+
+  def build(%{types: types, filters: [], orderings: [], slice: "", projections: [], preloads: []}) do
+    ~s(*[#{build_types(types)}])
+  end
+
+  def build(%{types: "*", filters: filters}) do
+    ~s(*[#{build_filters(filters)}])
+  end
+
+  def build(%{
+        types: types,
+        filters: filters,
+        orderings: [],
+        slice: "",
+        projections: [],
+        preloads: []
+      }) do
+    ~s(*[#{build_types(types)}#{build_filters(filters)}])
+  end
+
+  def build(%{
+        types: types,
+        filters: filters,
+        orderings: orderings,
+        slice: slice,
+        projections: [],
+        preloads: []
+      }) do
+    ~s(*[#{build_types(types)}#{build_filters(filters)}]#{build_orderings(orderings)}#{build_slice(slice)})
+  end
+
+  def build(query) do
+    ~s(*[#{build_types(query.types)}#{build_filters(query.filters)}]#{build_orderings(query.orderings)}#{build_slice(query.slice)}{#{build_projections(query.projections)}#{build_preloads(query.preloads)}})
+  end
+
+  defp build_types("*"), do: ""
+
+  defp build_types([type]) do
+    ~s(_type == "#{type}")
+  end
+
+  defp build_types(types) do
+    ~s(_type in ["#{Enum.join(types, "\", \"")}"])
+  end
+
+  defp build_filters([filter]) do
+    ~s(#{filter})
+  end
+
+  defp build_filters(filters) do
+    Enum.reduce(filters, "", fn filter, acc ->
+      acc <> ~s( && #{filter})
+    end)
+  end
+
+  defp build_projections(projections) do
+    Enum.join(projections, ", ")
+  end
+
+  defp build_preloads(preloads) do
+    Enum.reduce(preloads, "", fn preload, acc ->
+      acc <> ~s(, #{Atom.to_string(preload)}[]->)
+    end)
+  end
+
+  defp build_orderings(orderings) do
+    Enum.reduce(orderings, "", fn {field, direction}, acc ->
+      acc <> ~s( | order(#{field} #{Atom.to_string(direction)}\))
+    end)
+  end
+
+  defp build_slice(""), do: ""
+
+  defp build_slice(slice) do
+    ~s([#{slice}])
+  end
+end

mix.exs

@@ -5,7 +5,7 @@ defmodule ExSanity.MixProject do
     [
       app: :ex_sanity,
       version: "0.1.0",
-      elixir: "~> 1.11",
+      elixir: "~> 1.14.2",
       start_permanent: Mix.env() == :prod,
       deps: deps()
     ]
@@ -24,7 +24,8 @@ defmodule ExSanity.MixProject do
       {:jason, ">= 1.1.0"},
       {:httpoison, ">= 1.8.0"},
       {:phoenix_html, ">= 2.14.2"},
-      {:mix_test_watch, "~> 1.0", only: [:dev, :test], runtime: false}
+      {:mix_test_watch, "~> 1.0", only: [:dev, :test], runtime: false},
+      {:credo, "~> 1.7", only: [:dev, :test], runtime: false}
     ]
   end
 end

mix.lock

@@ -1,5 +1,7 @@
 %{
+  "bunt": {:hex, :bunt, "0.2.1", "e2d4792f7bc0ced7583ab54922808919518d0e57ee162901a16a1b6664ef3b14", [:mix], [], "hexpm", "a330bfb4245239787b15005e66ae6845c9cd524a288f0d141c148b02603777a5"},
   "certifi": {:hex, :certifi, "2.6.1", "dbab8e5e155a0763eea978c913ca280a6b544bfa115633fa20249c3d396d9493", [:rebar3], [], "hexpm", "524c97b4991b3849dd5c17a631223896272c6b0af446778ba4675a1dff53bb7e"},
+  "credo": {:hex, :credo, "1.7.0", "6119bee47272e85995598ee04f2ebbed3e947678dee048d10b5feca139435f75", [:mix], [{:bunt, "~> 0.2.1", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "6839fcf63d1f0d1c0f450abc8564a57c43d644077ab96f2934563e68b8a769d7"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},
   "hackney": {:hex, :hackney, "1.17.4", "99da4674592504d3fb0cfef0db84c3ba02b4508bae2dff8c0108baa0d6e0977c", [:rebar3], [{:certifi, "~>2.6.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~>6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~>1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~>1.1", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.3.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~>1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~>0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "de16ff4996556c8548d512f4dbe22dd58a587bf3332e7fd362430a7ef3986b16"},
   "httpoison": {:hex, :httpoison, "1.8.0", "6b85dea15820b7804ef607ff78406ab449dd78bed923a49c7160e1886e987a3d", [:mix], [{:hackney, "~> 1.17", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm", "28089eaa98cf90c66265b6b5ad87c59a3729bea2e74e9d08f9b51eb9729b3c3a"},

test/ex_sanity/query_test.exs

@@ -0,0 +1,105 @@
+defmodule ExSanity.QueryTest do
+  use ExUnit.Case, async: true
+
+  import ExSanity.Query
+
+  describe "from/1" do
+    test "sets document type" do
+      query = from(:foo)
+
+      assert query.types == [:foo]
+    end
+  end
+
+  describe "select/2" do
+    test "sets projections" do
+      query =
+        from(:foo)
+        |> select([:bar])
+
+      assert query.projections == [:bar]
+    end
+  end
+
+  describe "Sanity Examples" do
+    test "Filters" do
+      assert from("*") |> build() == ~s(*[])
+      assert from(:movie) |> build() == ~s(*[_type == "movie"])
+      assert from("*") |> build("abc.123") == ~s(*[_id == "abc.123"])
+      assert from([:movie, :person]) |> build() == ~s(*[_type in ["movie", "person"]])
+
+      assert from(:movie)
+             |> filter("popularity > 15")
+             |> filter("releaseDate > \"2016-04-25\"")
+             |> build() ==
+               ~s(*[_type == "movie" && popularity > 15 && releaseDate > "2016-04-25"])
+
+      # May need to wait on "OR" filters
+      # assert from(:movie)
+      #        |> filter("popularity > 15")
+      #        |> or_filter("releaseDate > \"2016-04-25\"")
+      #        |> build() ==
+      #          ~s(*[_type == "movie" && (popularity > 15 || releaseDate > "2016-04-25"\)])
+
+      # *[popularity < 15] // less than
+      # *[popularity > 15] // greater than
+      # *[popularity <= 15] // less than or equal
+      # *[popularity >= 15] // greater than or equal
+      # *[popularity == 15]
+      # *[releaseDate != "2016-04-27"] // not equal
+      # *[!(releaseDate == "2016-04-27")] // not equal
+      # *[!(releaseDate != "2016-04-27")] // even equal via double negatives "not not equal"
+      # *[dateTime(_updatedAt) > dateTime('2018-04-20T20:43:31Z')] // Use zulu-time when comparing datetimes to strings
+      # *[dateTime(_updatedAt) > dateTime(now()) - 60*60*24*7] // Updated within the past week
+      # *[name < "Baker"] // Records whose name precedes "Baker" alphabetically
+      # *[awardWinner == true] // match boolean
+      # *[awardWinner] // true if awardWinner == true
+      # *[!awardWinner] // true if awardWinner == false
+      # *[defined(awardWinner)] // has been assigned an award winner status (any kind of value)
+      # *[!defined(awardWinner)] // has not been assigned an award winner status (any kind of value)
+      # *[title == "Aliens"]
+      # *[title in ["Aliens", "Interstellar", "Passengers"]]
+      # *[_id in path("a.b.c.*")] // _id matches a.b.c.d but not a.b.c.d.e
+      # *[_id in path("a.b.c.**")] // _id matches a.b.c.d, and also a.b.c.d.e.f.g, but not a.b.x.1
+      # *[!(_id in path("drafts.**"))] // _id matches anything that is not under the drafts-path
+      # *["yolo" in tags] // documents that have the string "yolo" in the array "tags"
+      # *[status in ["completed", "archived"]] // the string field status is either == "completed" or "archived"
+      # *["person_sigourney-weaver" in castMembers[].person._ref] // Any document having a castMember referencing sigourney as its person
+      # *[slug.current == "some-slug"] // nested properties
+      # *[count((categories[]->slug.current)[@ in ["action", "thriller"]]) > 0] // documents that reference categories with slugs of "action" or "thriller"
+      # *[count((categories[]->slug.current)[@ in ["action", "thriller"]]) == 2]
+    end
+
+    test "ordering and slicing" do
+      assert from(:movie)
+             |> order({:_createdAt, :asc})
+             |> build() == ~s(*[_type == "movie"] | order(_createdAt asc\))
+
+      assert from(:movie)
+             |> order({:releaseDate, :desc})
+             |> order({:_createdAt, :asc})
+             |> build() ==
+               ~s(*[_type == "movie"] | order(releaseDate desc\) | order(_createdAt asc\))
+
+      # FUTURE: support mixed ordering
+      # *[_type == "todo"] | order(priority desc, _updatedAt desc) 
+
+      assert from(:movie)
+             |> order({:_createdAt, :asc})
+             |> slice("0")
+             |> build() == ~s(*[_type == "movie"] | order(_createdAt asc\)[0])
+
+      # *[_type == "movie"] | order(_createdAt desc)[0]
+
+      # *[_type == "movie"] | order(_createdAt asc)[0..9]
+
+      # *[_type == "movie"][0..9] | order(_createdAt asc)
+
+      # *[_type == "movie"] | order(_createdAt asc) [$start..$end]
+
+      # *[_type == "movie"] | order(title asc)
+
+      # *[_type == "movie"] | order(lower(title) asc)
+    end
+  end
+end