paddle v0.1.3 Paddle.Parsing

Module composed of utility functions for translating between :eldap and Paddle representation.

Summary

Functions

Convert an :eldap search result to a Paddle representation

Get a binary map representation of several eldap entries

Get a binary map representation of a single eldap entry

Construct a DN Erlang string based on a keyword list or a string

Tranform an LDAP DN to a keyword list

Convert a Paddle entry to a given Paddle class object

Escape special LDAP characters in a string

Wrap things in lists and convert binaries / atoms to charlists

Convert a user-friendly modify operation to an eldap operation

Types

eldap_dn()
eldap_dn() :: charlist
eldap_entry()
eldap_entry() :: {:eldap_entry, eldap_dn, [{charlist, [charlist]}]}

Functions

clean_eldap_search_results(arg)
clean_eldap_search_results({:ok, {:eldap_search_result, [eldap_entry]}} | {:error, atom}) ::
  {:ok, [Paddle.ldap_entry]} |
  {:error, Paddle.search_ldap_error}

Convert an :eldap search result to a Paddle representation.

Also see clean_entries/1

Examples:

iex> eldap_entry = {:eldap_entry, 'uid=testuser,ou=People', [{'uid', ['testuser']}]}
iex> Paddle.Parsing.clean_eldap_search_results({:ok, {:eldap_search_result, [eldap_entry], []}})
{:ok, [%{"dn" => "uid=testuser,ou=People", "uid" => ["testuser"]}]}

iex> Paddle.Parsing.clean_eldap_search_results({:ok, {:eldap_search_result, [], []}})
{:error, :noSuchObject}

iex> Paddle.Parsing.clean_eldap_search_results({:error, :insufficientAccessRights})
{:error, :insufficientAccessRights}
clean_entries(entries)
clean_entries([eldap_entry]) :: [Paddle.ldap_entry]

Get a binary map representation of several eldap entries.

Example:

iex> Paddle.Parsing.clean_entries([{:eldap_entry, 'uid=testuser,ou=People', [{'uid', ['testuser']}]}])
[%{"dn" => "uid=testuser,ou=People", "uid" => ["testuser"]}]
clean_entry(arg)
clean_entry(eldap_entry) :: Paddle.ldap_entry

Get a binary map representation of a single eldap entry.

Example:

iex> Paddle.Parsing.clean_entry({:eldap_entry, 'uid=testuser,ou=People', [{'uid', ['testuser']}]})
%{"dn" => "uid=testuser,ou=People", "uid" => ["testuser"]}
construct_dn(map, base \\ [])
construct_dn(keyword | [{binary, binary}], binary | charlist) :: charlist

Construct a DN Erlang string based on a keyword list or a string.

Examples:

iex> Paddle.Parsing.construct_dn(uid: "user", ou: "People")
'uid=user,ou=People'

iex> Paddle.Parsing.construct_dn([{"uid", "user"}, {"ou", "People"}], "dc=organisation,dc=org")
'uid=user,ou=People,dc=organisation,dc=org'

iex> Paddle.Parsing.construct_dn("uid=user,ou=People", "dc=organisation,dc=org")
'uid=user,ou=People,dc=organisation,dc=org'

Values are escaped.

Note: using a map is highly discouraged because the key / values may be reordered and because they can be mistaken for a class object (see Paddle.Class).

dn_to_kwlist(dn)
dn_to_kwlist(charlist | binary) :: [{binary, binary}]

Tranform an LDAP DN to a keyword list.

Well, not exactly a keyword list but a list like this:

[{"uid", "user"}, {"ou", "People"}, {"dc", "organisation"}, {"dc", "org"}]

Example:

iex> Paddle.Parsing.dn_to_kwlist("uid=user,ou=People,dc=organisation,dc=org")
[{"uid", "user"}, {"ou", "People"}, {"dc", "organisation"}, {"dc", "org"}]
entry_to_class_object(entry, target)
entry_to_class_object(Paddle.ldap_entry, Paddle.Class.t) :: Paddle.Class.t

Convert a Paddle entry to a given Paddle class object.

Example:

iex> entry = %{"dn" => "uid=testuser,ou=People", "uid" => ["testuser"], "description" => ["hello"]}
iex> Paddle.Parsing.entry_to_class_object(entry, %MyApp.PosixAccount{})
%MyApp.PosixAccount{cn: nil, description: ["hello"], gecos: nil,
  gidNumber: nil, homeDirectory: nil, host: nil, l: nil,
  loginShell: nil, o: nil, ou: nil, seeAlso: nil, uid: ["testuser"],
  uidNumber: nil, userPassword: nil}
ldap_escape(token)
ldap_escape(charlist | binary) :: charlist

Escape special LDAP characters in a string.

Example:

iex> Paddle.Parsing.ldap_escape("a=b#c\\")
'a\\=b\\#c\\\\'
list_wrap(list)
list_wrap(term) :: [charlist]

Wrap things in lists and convert binaries / atoms to charlists.

iex> Paddle.Parsing.list_wrap "hello"
['hello']

iex> Paddle.Parsing.list_wrap :hello
['hello']

iex> Paddle.Parsing.list_wrap ["hello", "world"]
['hello', 'world']
mod_convert(operation)
mod_convert(Paddle.mod) :: tuple

Convert a user-friendly modify operation to an eldap operation.

Examples:

iex> Paddle.Parsing.mod_convert {:add, {"description", "This is a description"}}
{:ModifyRequest_changes_SEQOF, :add,
 {:PartialAttribute, 'description', ['This is a description']}}

iex> Paddle.Parsing.mod_convert {:delete, "description"}
{:ModifyRequest_changes_SEQOF, :delete,
 {:PartialAttribute, 'description', []}}

iex> Paddle.Parsing.mod_convert {:replace, {"description", "This is a description"}}
{:ModifyRequest_changes_SEQOF, :replace,
 {:PartialAttribute, 'description', ['This is a description']}}