defmodule Glific.Clients do
@moduledoc """
Wrapper module that allows us to invoke organization specific callback functions to
tweak the way the system handles things. This allows clients to override functionality
in a similar manner to plugins wordpress.
At some point we will move this to a more extensible scheme, which is as yet undetermined
"""
alias Glific.{
Contacts.Contact,
Flows.Action,
Triggers.Trigger
}
@dev %{
id: 1,
name: "Glific",
gcs_file_name: Glific.Clients.Tap,
blocked?: Glific.Clients.Stir,
broadcast: Glific.Clients.Weunlearn,
webhook: Glific.Clients.Tap,
daily_tasks: Glific.Clients.DigitalGreen,
trigger_condition: Glific.Clients.ArogyaWorld
}
@sol %{
id: 1,
name: "Slam Out Loud",
gcs_file_name: Glific.Clients.Sol,
webhook: Glific.Clients.Sol
}
@avanti %{
id: 10,
name: "Avanti Fellows",
webhook: Glific.Clients.Avanti
}
@tap %{
id: 12,
name: "The Apprentice Project",
gcs_file_name: Glific.Clients.Tap,
webhook: Glific.Clients.Tap
}
@stir %{
id: 13,
name: "STiR Education",
webhook: Glific.Clients.Stir,
gcs_file_name: Glific.Clients.Stir
# blocked?: Glific.Clients.Stir
}
@lahilms %{
id: 14,
name: "Lend A Hand India",
webhook: Glific.Clients.Lahi,
gcs_file_name: Glific.Clients.Lahi
}
@reap_benefit %{
id: 15,
name: "Reap Benefit",
webhook: Glific.Clients.ReapBenefit
# gcs_file_name: Glific.Clients.ReapBenefit
}
@mukkamaar %{
id: 18,
name: "MukkaMaar",
webhook: Glific.Clients.MukkaMaar
}
@balajanaagraha %{
id: 27,
name: "BalaJanaagraha",
webhook: Glific.Clients.Balajanaagraha
}
@digital_green %{
id: 31,
name: "DigitalGreen",
webhook: Glific.Clients.DigitalGreen,
daily_tasks: Glific.Clients.DigitalGreen
}
# Currently we need same functionality
# on both DG platforms.
@digitalgreen_ryss %{
id: 68,
name: "Digitalgreen RYSS",
webhook: Glific.Clients.DigitalGreen,
daily_tasks: Glific.Clients.DigitalGreen
}
@nayi_disha %{
id: 22,
name: "Nayi Disha",
webhook: Glific.Clients.NayiDisha
}
@arogyaworld %{
id: 56,
name: "Arogya World",
webhook: Glific.Clients.ArogyaWorld,
daily_tasks: Glific.Clients.ArogyaWorld,
weekly_tasks: Glific.Clients.ArogyaWorld,
trigger_condition: Glific.Clients.ArogyaWorld,
hourly_tasks: Glific.Clients.ArogyaWorld
}
@bandhu %{
id: 28,
name: "Bandhu",
webhook: Glific.Clients.Bandhu
}
@kef %{
id: 70,
name: "Key Education Foundation",
gcs_file_name: Glific.Clients.KEF,
webhook: Glific.Clients.KEF
}
@pehlayaksharfoundation %{
id: 88,
name: "Pehlay Akshar Foundation",
webhook: Glific.Clients.PehlayAkshar
}
@sunosunao %{
id: 93,
name: "Suno Sunao",
webhook: Glific.Clients.SunoSunao
}
@digitalgreen_jh %{
id: 105,
name: "DigitalGreen Jharkhand",
webhook: Glific.Clients.DigitalGreenJharkhand
}
@quest_afeqc %{
id: 106,
name: "Quest Alliance AFEQC",
webhook: Glific.Clients.QuestAlliance
}
@quest_tcec %{
id: 47,
name: "Quest Alliance TCEC",
webhook: Glific.Clients.QuestAlliance
}
@quest_alliance %{
id: 30,
name: "Quest Alliance",
webhook: Glific.Clients.QuestAlliance
}
@oblf %{
id: 109,
name: "OBLF",
webhook: Glific.Clients.Oblf
}
## we should move this also to databases.
@plugins %{
@sol[:id] => @sol,
@avanti[:id] => @avanti,
@lahilms[:id] => @lahilms,
@reap_benefit[:id] => @reap_benefit,
@mukkamaar[:id] => @mukkamaar,
@stir[:id] => @stir,
@tap[:id] => @tap,
@balajanaagraha[:id] => @balajanaagraha,
@digital_green[:id] => @digital_green,
@nayi_disha[:id] => @nayi_disha,
@arogyaworld[:id] => @arogyaworld,
@bandhu[:id] => @bandhu,
@digitalgreen_ryss[:id] => @digitalgreen_ryss,
@kef[:id] => @kef,
@pehlayaksharfoundation[:id] => @pehlayaksharfoundation,
@sunosunao[:id] => @sunosunao,
@digitalgreen_jh[:id] => @digitalgreen_jh,
@quest_afeqc[:id] => @quest_afeqc,
@quest_tcec[:id] => @quest_tcec,
@quest_alliance[:id] => @quest_alliance,
@oblf[:id] => @oblf
}
@spec env(atom() | nil) :: atom()
defp env(nil), do: Application.get_env(:glific, :environment)
defp env(e), do: e
@doc false
@spec plugins(atom() | nil) :: map()
def plugins(e \\ nil) do
if env(e) == :prod,
do: @plugins,
# for testing and development we'll use org id 1
else: %{@dev[:id] => @dev}
end
@doc """
Overwrite the default GCS storage bucket
"""
@spec gcs_file_name(map()) :: String.t()
def gcs_file_name(media) do
module_name = get_in(plugins(), [media["organization_id"], :gcs_file_name])
if module_name,
do: module_name.gcs_file_name(media),
else: media["remote_name"]
end
@doc """
Programmatically block clients based on organization needs. Use case could be:
Allow only numbers from India and US
"""
@spec blocked?(String.t(), non_neg_integer) :: boolean
def blocked?(phone, organization_id) do
module_name = get_in(plugins(), [organization_id, :blocked?])
if module_name,
do: module_name.blocked?(phone),
else: false
end
@doc """
Allow an organization to dynamically select which contact the broadcast message should
go to. This gives NGOs more flexibility when building flows
"""
@spec broadcast(Action.t(), Contact.t(), non_neg_integer) :: non_neg_integer
def broadcast(action, contact, staff_id) do
module_name = get_in(plugins(), [contact.organization_id, :broadcast])
if module_name,
do: module_name.broadcast(action, contact, staff_id),
else: staff_id
end
@doc """
Allow an organization to use glific functions to implement webhooks. A faster way
of modifying the DB and doing some advanced stuff in an easy manner
"""
@spec webhook(String.t(), map()) :: map()
def webhook(name, fields) do
module_name = get_in(plugins(), [fields["organization_id"], :webhook])
if module_name,
do: module_name.webhook(name, fields),
else: %{error: "Missing webhook function implementation"}
end
@doc """
Allow an organization to ran a glific functions at a daily basis.
"""
@spec daily_tasks(non_neg_integer()) :: map()
def daily_tasks(org_id) do
module_name = get_in(plugins(), [org_id, :daily_tasks])
if module_name,
do: module_name.daily_tasks(org_id),
else: %{error: "Missing daily function implementation"}
end
@doc """
Allow an organization to ran a glific functions on a weekly basis.
"""
@spec weekly_tasks(non_neg_integer()) :: map()
def weekly_tasks(org_id) do
module_name = get_in(plugins(), [org_id, :weekly_tasks])
if module_name,
do: module_name.weekly_tasks(org_id),
else: %{error: "Missing weekly function implementation"}
end
@doc """
Allow an organization to ran a glific functions on a weekly basis.
"""
@spec hourly_tasks(non_neg_integer()) :: map()
def hourly_tasks(org_id) do
module_name = get_in(plugins(), [org_id, :hourly_tasks])
if module_name,
do: module_name.hourly_tasks(org_id),
else: %{error: "Missing hourly function implementation"}
end
@doc """
Allow an organization to add additional conditions on starting a trigger
This allows an org to add a daily trigger which is executed only on some
days of the week
"""
@spec trigger_condition(Trigger.t()) :: boolean
def trigger_condition(trigger) do
module_name = get_in(plugins(), [trigger.organization_id, :trigger_condition])
if module_name,
do: module_name.trigger_condition(trigger),
else: true
end
end
