Merge pull request #1 from Awea/master

Remove System module and add Settings module
robottokauf3 · Sep 18, 2020 · 432a5f3 · 432a5f3
2 parents 4671bca + efa063a
commit 432a5f3
Show file tree

Hide file tree

Showing 11 changed files with 610 additions and 109 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,7 +14,7 @@ jobs:
       matrix:
         elixir: [1.10.3]
         otp: [22.3.4]
-        meilisearch: [0.11.1, 0.12.0]
+        meilisearch: [0.13.0]
 
     steps:
       - uses: actions/checkout@v2

diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1,2 @@
+elixir 1.10.3
+erlang 22.3.4
diff --git a/README.md b/README.md
@@ -62,7 +62,7 @@ Meilisearch.Search.search("water")
 - [X] Search
 - [X] Updates
 - [X] Keys
-- [ ] Settings
+- [X] Settings
 - [X] System Information
 
 ## Config

diff --git a/lib/meilisearch/http.ex b/lib/meilisearch/http.ex
@@ -60,7 +60,6 @@ defmodule Meilisearch.HTTP do
   end
 
   def process_request_body(""), do: ""
-  def process_request_body(body) when is_binary(body), do: body
   def process_request_body(body), do: Jason.encode!(body)
 
   def process_request_headers(headers) do

diff --git a/lib/meilisearch/settings.ex b/lib/meilisearch/settings.ex
@@ -0,0 +1,363 @@
+defmodule Meilisearch.Settings do
+  @moduledoc """
+  Collection of functions used to manage settings.
+
+  [MeiliSearch Documentation - Settings](https://docs.meilisearch.com/references/settings.html)
+  """
+
+  alias Meilisearch.HTTP
+
+  @doc """
+  Get settings.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get("meilisearch_test")
+      {:ok,
+      %{
+        "rankingRules" => [
+          "typo",
+          "words",
+          "proximity",
+          "attribute",
+          "wordsPosition",
+          "exactness"
+        ],
+        "attributesForFaceting" => [],
+        "displayedAttributes" => ["*"],
+        "distinctAttribute" => "id",
+        "searchableAttributes" => ["*"],
+        "stopWords" => [],
+        "synonyms" => %{}
+      }}
+  """
+  @spec get(String.t()) :: HTTP.response()
+  def get(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings")
+  end
+
+  @doc """
+  Update settings.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update("meilisearch_test", %{synonyms: %{alien: ["ufo"]}})
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update(String.t(), any()) :: HTTP.response()
+  def update(index_uid, settings \\ %{}) do
+    HTTP.post_request("indexes/#{index_uid}/settings", settings)
+  end
+
+  @doc """
+  Reset settings.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset(String.t()) :: HTTP.response()
+  def reset(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings")
+  end
+
+  @doc """
+  Get synonyms.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_synonyms("meilisearch_test")
+      {:ok, %{}}
+  """
+  @spec get_synonyms(String.t()) :: HTTP.response()
+  def get_synonyms(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/synonyms")
+  end
+
+  @doc """
+  Update synonyms.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_synonyms("meilisearch_test", %{alien: ["ufo"]})
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_synonyms(String.t(), any()) :: HTTP.response()
+  def update_synonyms(index_uid, synonyms) do
+    HTTP.post_request("indexes/#{index_uid}/settings/synonyms", synonyms)
+  end
+
+  @doc """
+  Reset synonyms.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_synonyms("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_synonyms(String.t()) :: HTTP.response()
+  def reset_synonyms(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/synonyms")
+  end
+
+  @doc """
+  Get stop-words.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_stop_words("meilisearch_test")
+      {:ok, []}
+  """
+  @spec get_stop_words(String.t()) :: HTTP.response()
+  def get_stop_words(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/stop-words")
+  end
+
+  @doc """
+  Update stop-words.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_stop_words("meilisearch_test", ["the", "of", "to"])
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_stop_words(String.t(), list(String.t())) :: HTTP.response()
+  def update_stop_words(index_uid, stop_words) do
+    HTTP.post_request("indexes/#{index_uid}/settings/stop-words", stop_words)
+  end
+
+  @doc """
+  Reset stop-words.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_stop_words("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_stop_words(String.t()) :: HTTP.response()
+  def reset_stop_words(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/stop-words")
+  end
+
+  @doc """
+  Get ranking rules.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_ranking_rules("meilisearch_test")
+      {:ok,
+        ["typo",
+        "words",
+        "proximity",
+        "attribute",
+        "wordsPosition",
+        "exactness"
+        ]
+      }
+  """
+  @spec get_ranking_rules(String.t()) :: HTTP.response()
+  def get_ranking_rules(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/ranking-rules")
+  end
+
+  @doc """
+  Update ranking rules.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_ranking_rules(
+        "meilisearch_test",
+        ["typo", "words", "proximity", "attribute"]
+      )
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_ranking_rules(String.t(), list(String.t())) :: HTTP.response()
+  def update_ranking_rules(index_uid, ranking_rules) do
+    HTTP.post_request("indexes/#{index_uid}/settings/ranking-rules", ranking_rules)
+  end
+
+  @doc """
+  Reset ranking rules.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_ranking_rules("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_ranking_rules(String.t()) :: HTTP.response()
+  def reset_ranking_rules(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/ranking-rules")
+  end
+
+  @doc """
+  Get attributes for faceting.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_attributes_for_faceting("meilisearch_test")
+      {:ok, []}
+  """
+  @spec get_attributes_for_faceting(String.t()) :: HTTP.response()
+  def get_attributes_for_faceting(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/attributes-for-faceting")
+  end
+
+  @doc """
+  Update attributes for faceting.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_attributes_for_faceting(
+        "meilisearch_test",
+        ["title"]
+      )
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_attributes_for_faceting(String.t(), list(String.t())) :: HTTP.response()
+  def update_attributes_for_faceting(index_uid, attributes_for_faceting) do
+    HTTP.post_request(
+      "indexes/#{index_uid}/settings/attributes-for-faceting",
+      attributes_for_faceting
+    )
+  end
+
+  @doc """
+  Reset attributes for faceting.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_attributes_for_faceting("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_attributes_for_faceting(String.t()) :: HTTP.response()
+  def reset_attributes_for_faceting(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/attributes-for-faceting")
+  end
+
+  @doc """
+  Get distinct attribute.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_distinct_attribute("meilisearch_test")
+      {:ok, "id"}
+  """
+  @spec get_distinct_attribute(String.t()) :: HTTP.response()
+  def get_distinct_attribute(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/distinct-attribute")
+  end
+
+  @doc """
+  Update distinct attribute.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_distinct_attribute("meilisearch_test", "id")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_distinct_attribute(String.t(), String.t()) :: HTTP.response()
+  def update_distinct_attribute(index_uid, distinct_attribute) do
+    HTTP.post_request(
+      "indexes/#{index_uid}/settings/distinct-attribute",
+      distinct_attribute
+    )
+  end
+
+  @doc """
+  Reset distinct attribute.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_distinct_attribute("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_distinct_attribute(String.t()) :: HTTP.response()
+  def reset_distinct_attribute(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/distinct-attribute")
+  end
+
+  @doc """
+  Get searchable attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_searchable_attributes("meilisearch_test")
+      {:ok, ["*"]}
+  """
+  @spec get_searchable_attributes(String.t()) :: HTTP.response()
+  def get_searchable_attributes(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/searchable-attributes")
+  end
+
+  @doc """
+  Update searchable attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_searchable_attributes("meilisearch_test", ["title"])
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_searchable_attributes(String.t(), list(String.t())) :: HTTP.response()
+  def update_searchable_attributes(index_uid, searchable_attributes) do
+    HTTP.post_request(
+      "indexes/#{index_uid}/settings/searchable-attributes",
+      searchable_attributes
+    )
+  end
+
+  @doc """
+  Reset searchable attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_searchable_attributes("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_searchable_attributes(String.t()) :: HTTP.response()
+  def reset_searchable_attributes(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/searchable-attributes")
+  end
+
+  @doc """
+  Get displayed attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.get_displayed_attributes("meilisearch_test")
+      {:ok, ["*"]}
+  """
+  @spec get_displayed_attributes(String.t()) :: HTTP.response()
+  def get_displayed_attributes(index_uid) do
+    HTTP.get_request("indexes/#{index_uid}/settings/displayed-attributes")
+  end
+
+  @doc """
+  Update displayed attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.update_displayed_attributes("meilisearch_test", ["title"])
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec update_displayed_attributes(String.t(), list(String.t())) :: HTTP.response()
+  def update_displayed_attributes(index_uid, displayed_attributes) do
+    HTTP.post_request(
+      "indexes/#{index_uid}/settings/displayed-attributes",
+      displayed_attributes
+    )
+  end
+
+  @doc """
+  Reset displayed attributes.
+
+  ## Example
+
+      iex> Meilisearch.Settings.reset_displayed_attributes("meilisearch_test")
+      {:ok, %{"updateId" => 1}}
+  """
+  @spec reset_displayed_attributes(String.t()) :: HTTP.response()
+  def reset_displayed_attributes(index_uid) do
+    HTTP.delete_request("indexes/#{index_uid}/settings/displayed-attributes")
+  end
+end