paddle

v0.1.4

paddle v0.1.4 Paddle.Filters View Source

Module used internally by Paddle to manipulate LDAP filters.

Link to this section Summary

Types

easy_filter()
eldap_filter()
filter()
t()

Functions

class_filter(classes)

Construct a filter that matches a list of objectClasses

construct_filter(filter)

Construct a eldap filter from the given keyword list or map

merge_filter(lhs, rhs)

Merge two filters with an “and” operation

Link to this section Types

Link to this type easy_filter() View Source 
easy_filter() :: keyword() | %{optional(atom() | binary()) => binary()}
Link to this type eldap_filter() View Source 
eldap_filter() :: tuple()

Link to this section Functions

Link to this function class_filter(classes) View Source 
class_filter([binary()]) :: eldap_filter()

Construct a filter that matches a list of objectClasses.

Examples:

iex> Paddle.Filters.class_filter ["posixAccount", "account"]
{:and,
 [equalityMatch: {:AttributeValueAssertion, 'objectClass', 'posixAccount'},
  equalityMatch: {:AttributeValueAssertion, 'objectClass', 'account'}]}
Link to this function construct_filter(filter) View Source 
construct_filter(filter()) :: eldap_filter()

Construct a eldap filter from the given keyword list or map.

If given an :eldap filter (a tuple), it is returned as is.

If given nil, it will return an empty filter (:eldap.and([])).

Examples:

iex> Paddle.Filters.construct_filter(uid: "testuser")
{:equalityMatch, {:AttributeValueAssertion, 'uid', 'testuser'}}

iex> Paddle.Filters.construct_filter(%{uid: "testuser"})
{:equalityMatch, {:AttributeValueAssertion, 'uid', 'testuser'}}

iex> Paddle.Filters.construct_filter(%{"uid" => "testuser"})
{:equalityMatch, {:AttributeValueAssertion, 'uid', 'testuser'}}

iex> Paddle.Filters.construct_filter(:eldap.substrings('uid', initial: 'b'))
{:substrings, {:SubstringFilter, 'uid', [initial: 'b']}}

iex> Paddle.Filters.construct_filter(nil)
{:and, []}

iex> Paddle.Filters.construct_filter([])
{:and, []}

iex> Paddle.Filters.construct_filter(uid: "testuser", cn: "Test User")
{:and,
 [equalityMatch: {:AttributeValueAssertion, 'uid', 'testuser'},
  equalityMatch: {:AttributeValueAssertion, 'cn', 'Test User'}]}
Link to this function merge_filter(lhs, rhs) View Source 
merge_filter(filter(), filter()) :: filter()

Merge two filters with an “and” operation.

Examples:

iex> Paddle.Filters.merge_filter([uid: "testuser"], [cn: "Test User"])
{:and,
 [equalityMatch: {:AttributeValueAssertion, 'uid', 'testuser'},
  equalityMatch: {:AttributeValueAssertion, 'cn', 'Test User'}]}

iex> Paddle.Filters.merge_filter([uid: "testuser"], :eldap.substrings('cn', [initial: 'Tes']))
{:and,
 [equalityMatch: {:AttributeValueAssertion, 'uid', 'testuser'},
  substrings: {:SubstringFilter, 'cn', [initial: 'Tes']}]}

iex> Paddle.Filters.merge_filter([uid: "testuser"], [])
[uid: "testuser"]

iex> Paddle.Filters.merge_filter([], [cn: "Test User"])
[cn: "Test User"]

iex> Paddle.Filters.merge_filter([], nil)
{:and, []}