Merge pull request #31 from hergetto/development

[Chore]: Release v0.2.0

Author: dustessavdh

.github/workflows/dependencies-reusable.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ inputs.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Elixir
         uses: erlef/setup-beam@v1.16.0

.github/workflows/linting-reusable.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ inputs.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Elixir
         uses: erlef/setup-beam@v1.16.0

.github/workflows/pr-title-checker.yml

@@ -11,7 +11,7 @@ jobs:
     name: Check title of PR
     runs-on: ubuntu-latest
     steps:
-      - uses: thehanimo/pr-title-checker@v1.4.0
+      - uses: thehanimo/pr-title-checker@v1.4.1
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           pass_on_octokit_error: false

.github/workflows/publish-to-hex-reusable.yml

@@ -29,7 +29,7 @@ jobs:
     runs-on: ${{ inputs.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Elixir
         uses: erlef/setup-beam@v1.16.0

.github/workflows/static-code-analysis-reusable.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ inputs.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Elixir
         uses: erlef/setup-beam@v1.16.0

.github/workflows/unit-test-reusable.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ${{ inputs.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Elixir
         uses: erlef/setup-beam@v1.16.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.2.0 (2024-01-30)
+
+- Add support to use options on translate ([#26](https://github.com/hergetto/deepl_ex/pull/26))
+
 ## v0.1.1 (2023-08-22)
 
 - Automatically determine the tier based on the api key ([#12](https://github.com/hergetto/deepl_ex/pull/12))

lib/deepl.ex

@@ -5,15 +5,19 @@ defmodule DeeplEx.DeepL do
   def translate(client, %{
         source_language: source_language,
         target_language: target_language,
-        text: text
+        text: text,
+        options: options
       }) do
-    Tesla.post(client, "/translate", %{
-      text: [
-        text
-      ],
-      source_lang: parse_language(source_language),
-      target_lang: parse_language(target_language)
-    })
+    content =
+      Map.merge(options, %{
+        text: [
+          text
+        ],
+        source_lang: parse_language(source_language),
+        target_lang: parse_language(target_language)
+      })
+
+    Tesla.post(client, "/translate", content)
   end
 
   def client(api_key, tier) do

lib/deepl_ex.ex

@@ -6,11 +6,14 @@ defmodule DeeplEx do
   alias DeeplEx.Configuration
   alias DeeplEx.DeepL
   alias DeeplEx.LanguageValidator
+  alias DeeplEx.OptionsValidator
 
   @doc """
   This function translates the given text from the given source language, to the given target language.
   It either returns `{:ok, translation}` or `{:error, error}`.
 
+  See `DeeplEx.LanguageValidator` and `DeeplEx.OptionsValidator` for more information about the allowed values.
+
   ## Example with correct input
 
 
@@ -26,28 +29,42 @@ defmodule DeeplEx do
     iex> DeeplEx.translate("Hoje vou comer.", :ZZ, :EN)
     {:error, :invalid_language_specification}
     ```
+    
+  ## Example when using options
+
+    ```elixir
+    iex> DeeplEx.translate("Hello, how are you?", :EN, :PT_BR, %{formality: "less"})
+    {:ok, "Olá, cara, como você está?"}
+    ```
   """
   def translate(
         text,
         source_language,
-        target_language
+        target_language,
+        options \\ %{}
       )
       when is_atom(source_language) and is_atom(target_language) and is_binary(text) do
     with {:valid_source_language?, true} <-
            LanguageValidator.valid_source_language?(source_language),
          {:valid_target_language?, true} <-
            LanguageValidator.valid_target_language?(target_language),
+         {:valid_options?, true} <-
+           OptionsValidator.valid_options?(options),
          {:ok, api_key} = Configuration.api_key(),
          tier = Configuration.tier(api_key),
          client <- DeepL.client(api_key, tier),
          {:ok, %{body: %{"translations" => [%{"text" => translation}]}}} <-
            DeepL.translate(client, %{
              source_language: source_language,
              target_language: target_language,
-             text: text
+             text: text,
+             options: options
            }) do
       {:ok, translation}
     else
+      {:ok, %{status: 400, body: %{"message" => message}}} ->
+        {:error, message}
+
       error ->
         error_response(error)
     end
@@ -57,5 +74,9 @@ defmodule DeeplEx do
        when error in [:valid_source_language?, :valid_target_language?],
        do: {:error, :invalid_language_specification}
 
+  defp error_response({error, _})
+       when error == :valid_options?,
+       do: {:error, :invalid_options_specification}
+
   defp error_response(error), do: error
 end

lib/helpers/options_validator.ex

@@ -0,0 +1,35 @@
+defmodule DeeplEx.OptionsValidator do
+  @moduledoc """
+  This module is responsible for validating the options for translate that are supplied.
+  """
+
+  @valid_options [
+    :split_sentences,
+    :preserve_formatting,
+    :formality,
+    :glossary_id,
+    :tag_handling,
+    :outline_detection,
+    :non_splitting_tags,
+    :splitting_tags,
+    :ignore_tags
+  ]
+
+  @doc false
+  def valid_options?(options) when is_map(options) do
+    options_keys = Map.keys(options)
+
+    case options_keys -- @valid_options do
+      [] -> {:valid_options?, true}
+      _ -> {:valid_options?, false}
+    end
+  end
+
+  @doc false
+  def valid_options?(_), do: {:valid_options?, false}
+
+  @doc """
+  Returns a list containing the valid options for translate
+  """
+  def valid_options, do: @valid_options
+end