From b68acde87f748ee8e80aa9bb27d2defd72e5833f Mon Sep 17 00:00:00 2001 From: Felipe Ripoll Date: Mon, 10 Sep 2018 06:10:26 -0600 Subject: [PATCH] [#64] generating documentation --- doc/.build | 3 +- doc/404.html | 2 +- doc/POABackend.Auth.Guardian.Plug.html | 2 +- doc/POABackend.Auth.Models.Token.html | 2 +- doc/POABackend.Auth.Models.User.html | 2 +- doc/POABackend.Auth.REST.html | 2 +- doc/POABackend.Auth.html | 2 +- doc/POABackend.CustomHandler.REST.html | 2 +- doc/POABackend.CustomHandler.html | 2 +- doc/POABackend.Protocol.DataType.html | 2 +- doc/POABackend.Protocol.Message.html | 2 +- doc/POABackend.Protocol.MessageType.html | 2 +- doc/POABackend.Protocol.html | 2 +- doc/POABackend.Receiver.html | 2 +- doc/POABackend.Receivers.Dashboard.html | 2 +- doc/POABackend.Receivers.DynamoDB.html | 2 +- doc/POABackend.Receivers.Eth.Stats.html | 2 +- doc/POABackend.Receivers.Repo.html | 2 +- doc/POABackend.Receivers.System.Stats.html | 2 +- doc/POABackend.Release.Tasks.html | 182 +++++++++++++++++++++ doc/POABackend.html | 21 ++- doc/api-reference.html | 10 +- doc/dist/sidebar_items-3a7a458c10.js | 1 + doc/dist/sidebar_items-f62ce50de1.js | 1 - doc/initial_architecture.html | 2 +- doc/search.html | 2 +- 26 files changed, 233 insertions(+), 25 deletions(-) create mode 100644 doc/POABackend.Release.Tasks.html create mode 100644 doc/dist/sidebar_items-3a7a458c10.js delete mode 100644 doc/dist/sidebar_items-f62ce50de1.js diff --git a/doc/.build b/doc/.build index 702ea54..45e42a5 100644 --- a/doc/.build +++ b/doc/.build @@ -4,13 +4,14 @@ fonts/icomoon.eot fonts/icomoon.svg fonts/icomoon.ttf fonts/icomoon.woff -dist/sidebar_items-f62ce50de1.js +dist/sidebar_items-3a7a458c10.js api-reference.html initial_architecture.html search.html 404.html POABackend.html POABackend.Receivers.Repo.html +POABackend.Release.Tasks.html POABackend.Auth.html POABackend.Auth.Guardian.Plug.html POABackend.Auth.Models.Token.html diff --git a/doc/404.html b/doc/404.html index d6e0a25..4d71f13 100644 --- a/doc/404.html +++ b/doc/404.html @@ -8,7 +8,7 @@ 404 – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Auth.Guardian.Plug.html b/doc/POABackend.Auth.Guardian.Plug.html index 09a4f41..17a8143 100644 --- a/doc/POABackend.Auth.Guardian.Plug.html +++ b/doc/POABackend.Auth.Guardian.Plug.html @@ -8,7 +8,7 @@ POABackend.Auth.Guardian.Plug – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Auth.Models.Token.html b/doc/POABackend.Auth.Models.Token.html index 46c01ec..a070f2a 100644 --- a/doc/POABackend.Auth.Models.Token.html +++ b/doc/POABackend.Auth.Models.Token.html @@ -8,7 +8,7 @@ POABackend.Auth.Models.Token – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Auth.Models.User.html b/doc/POABackend.Auth.Models.User.html index 5e0d00c..f0e35a5 100644 --- a/doc/POABackend.Auth.Models.User.html +++ b/doc/POABackend.Auth.Models.User.html @@ -8,7 +8,7 @@ POABackend.Auth.Models.User – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Auth.REST.html b/doc/POABackend.Auth.REST.html index 2b45bd7..96b2939 100644 --- a/doc/POABackend.Auth.REST.html +++ b/doc/POABackend.Auth.REST.html @@ -8,7 +8,7 @@ POABackend.Auth.REST – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Auth.html b/doc/POABackend.Auth.html index 649369e..54a5b5e 100644 --- a/doc/POABackend.Auth.html +++ b/doc/POABackend.Auth.html @@ -8,7 +8,7 @@ POABackend.Auth – poa_backend v0.1.0 - + diff --git a/doc/POABackend.CustomHandler.REST.html b/doc/POABackend.CustomHandler.REST.html index b61344c..f9ddb8a 100644 --- a/doc/POABackend.CustomHandler.REST.html +++ b/doc/POABackend.CustomHandler.REST.html @@ -8,7 +8,7 @@ POABackend.CustomHandler.REST – poa_backend v0.1.0 - + diff --git a/doc/POABackend.CustomHandler.html b/doc/POABackend.CustomHandler.html index 9578c8e..6f573ae 100644 --- a/doc/POABackend.CustomHandler.html +++ b/doc/POABackend.CustomHandler.html @@ -8,7 +8,7 @@ POABackend.CustomHandler – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Protocol.DataType.html b/doc/POABackend.Protocol.DataType.html index 548e309..bbd0e0d 100644 --- a/doc/POABackend.Protocol.DataType.html +++ b/doc/POABackend.Protocol.DataType.html @@ -8,7 +8,7 @@ POABackend.Protocol.DataType – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Protocol.Message.html b/doc/POABackend.Protocol.Message.html index 829faa6..f970f10 100644 --- a/doc/POABackend.Protocol.Message.html +++ b/doc/POABackend.Protocol.Message.html @@ -8,7 +8,7 @@ POABackend.Protocol.Message – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Protocol.MessageType.html b/doc/POABackend.Protocol.MessageType.html index ebc9e32..3058fe3 100644 --- a/doc/POABackend.Protocol.MessageType.html +++ b/doc/POABackend.Protocol.MessageType.html @@ -8,7 +8,7 @@ POABackend.Protocol.MessageType – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Protocol.html b/doc/POABackend.Protocol.html index 3858eb4..459c326 100644 --- a/doc/POABackend.Protocol.html +++ b/doc/POABackend.Protocol.html @@ -8,7 +8,7 @@ POABackend.Protocol – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receiver.html b/doc/POABackend.Receiver.html index dd06271..751f1a2 100644 --- a/doc/POABackend.Receiver.html +++ b/doc/POABackend.Receiver.html @@ -8,7 +8,7 @@ POABackend.Receiver – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receivers.Dashboard.html b/doc/POABackend.Receivers.Dashboard.html index c48aa8b..bca2d03 100644 --- a/doc/POABackend.Receivers.Dashboard.html +++ b/doc/POABackend.Receivers.Dashboard.html @@ -8,7 +8,7 @@ POABackend.Receivers.Dashboard – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receivers.DynamoDB.html b/doc/POABackend.Receivers.DynamoDB.html index 34a4169..f11db2b 100644 --- a/doc/POABackend.Receivers.DynamoDB.html +++ b/doc/POABackend.Receivers.DynamoDB.html @@ -8,7 +8,7 @@ POABackend.Receivers.DynamoDB – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receivers.Eth.Stats.html b/doc/POABackend.Receivers.Eth.Stats.html index 855cee3..9b1d22e 100644 --- a/doc/POABackend.Receivers.Eth.Stats.html +++ b/doc/POABackend.Receivers.Eth.Stats.html @@ -8,7 +8,7 @@ POABackend.Receivers.Eth.Stats – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receivers.Repo.html b/doc/POABackend.Receivers.Repo.html index e98e556..c10b659 100644 --- a/doc/POABackend.Receivers.Repo.html +++ b/doc/POABackend.Receivers.Repo.html @@ -8,7 +8,7 @@ POABackend.Receivers.Repo – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Receivers.System.Stats.html b/doc/POABackend.Receivers.System.Stats.html index 3bac864..234e1ba 100644 --- a/doc/POABackend.Receivers.System.Stats.html +++ b/doc/POABackend.Receivers.System.Stats.html @@ -8,7 +8,7 @@ POABackend.Receivers.System.Stats – poa_backend v0.1.0 - + diff --git a/doc/POABackend.Release.Tasks.html b/doc/POABackend.Release.Tasks.html new file mode 100644 index 0000000..03db0ee --- /dev/null +++ b/doc/POABackend.Release.Tasks.html @@ -0,0 +1,182 @@ + + + + + + + + POABackend.Release.Tasks – poa_backend v0.1.0 + + + + + + + + + + + +
+ + +
+ + + +
+

+ poa_backend +

+

+ v0.1.0 +

+
+ + + +
+ + +
+ + +
+ +
+ +
+
+
+ + +

+ poa_backend v0.1.0 + POABackend.Release.Tasks + + + + View Source + + +

+ + +
+

This module is needed when we create a release. We are using Mnesia locally so when we start create a release +we have to create the Mnesia files there. In order to do that we have to run this migrate/0 function.

+ +
+ + + +
+

+ + + Link to this section + + Summary +

+ + + +
+

+ Functions +

+
+
+ migrate() +
+ +
+ +
+ + + + +
+ + + + + +
+

+ + + Link to this section + + Functions +

+
+ + +
+ + + Link to this function + + migrate() + + + + View Source + + + + +
+
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + diff --git a/doc/POABackend.html b/doc/POABackend.html index 8ad49f7..03d97d6 100644 --- a/doc/POABackend.html +++ b/doc/POABackend.html @@ -8,7 +8,7 @@ POABackend – poa_backend v0.1.0 - + @@ -176,18 +176,35 @@ mix dialyzer

To build an executable you’ll need Elixir 1.6 (and Erlang/OTP 20).

    +
  1. Start a clean Terminal +
  2. Once you have a copy of this repository configure the backend for production in the file config/prod.exs.
  3. An example configuration can be found in the current config/prod.exs.
  4. Do a mix deps.get to fetch, among other dependencies, the tooling for building server executables.
    5. +
  5. We have to export the MNESIA_HOST variable in order to tell in which node we are going to create the mnesia schema +
    6. +
+
export MNESIA_HOST=poa_backend@127.0.0.1
+
  1. A env MIX_ENV=prod mix release --name=poa_backend --env=prod will assemble an executable.

A resulting artifact resides at _build/prod/rel/poa_backend/releases/0.1.0/poa_backend.tar.gz which you can move to a remote host. -Use tar xfz then bin/poa_agent start (bin/poa_agent stop will stop the server cleanly).

+Use tar xfz then bin/poa_backend start (bin/poa_backend stop will stop the server cleanly).

If you want to run it on the local host then the procedure is as simple as: _build/prod/rel/poa_backend/bin/poa_backend.

+
    +
  1. Set up Mnesia. After start the POABackend we have to set up mnesia. First we have to check if the Mnesia directory exists (probably not). In our case we have set it to priv/data/mnesia +
    2. +
+
config :mnesia,
+  dir: 'priv/data/mnesia' # make sure this directory exists!
+

so we have to create that folder inside the release folder.

+

After that we have to create and migrate the database. In order to do that we have make a RPC to the running node, this command is run only once (Note that the node must be running, that means we have executed bin/poa_backend start):

+
bin/poa_backend rpc Elixir.POABackend.Release.Tasks migrate
+

That will create the Mnesia Database. After those steps the app is ready to be used

Note: executables must be built on the platform (OS and architecture) they are destined for under the project’s current configuration. Other options are possible (see https://hexdocs.pm/distillery/getting-started.html).

diff --git a/doc/api-reference.html b/doc/api-reference.html index d93d3bd..b3e3ab8 100644 --- a/doc/api-reference.html +++ b/doc/api-reference.html @@ -8,7 +8,7 @@ API Reference – poa_backend v0.1.0 - + @@ -215,6 +215,14 @@ database. If we want to use it we have to declare it in the Config file, inside database. If we want to use it we have to declare it in the Config file, inside the :receivers section, ie

+ +
+
POABackend.Release.Tasks
+ +

This module is needed when we create a release. We are using Mnesia locally so when we start create a release +we have to create the Mnesia files there. In order to do that we have to run this migrate/0 function

+
+
diff --git a/doc/dist/sidebar_items-3a7a458c10.js b/doc/dist/sidebar_items-3a7a458c10.js new file mode 100644 index 0000000..981246f --- /dev/null +++ b/doc/dist/sidebar_items-3a7a458c10.js @@ -0,0 +1 @@ +sidebarNodes={"extras":[{"id":"api-reference","title":"API Reference","group":"","headers":[{"id":"Modules","anchor":"modules"},{"id":"POA Protocol","anchor":"poa-protocol"}]},{"id":"initial_architecture","title":"Initial Architecture","group":"","headers":[]}],"exceptions":[],"modules":[{"id":"POABackend","title":"POABackend","group":""},{"id":"POABackend.Receivers.Repo","title":"POABackend.Receivers.Repo","group":"","functions":[{"id":"aggregate/4","anchor":"aggregate/4"},{"id":"all/2","anchor":"all/2"},{"id":"config/0","anchor":"config/0"},{"id":"delete/2","anchor":"delete/2"},{"id":"delete!/2","anchor":"delete!/2"},{"id":"delete_all/2","anchor":"delete_all/2"},{"id":"get/3","anchor":"get/3"},{"id":"get!/3","anchor":"get!/3"},{"id":"get_by/3","anchor":"get_by/3"},{"id":"get_by!/3","anchor":"get_by!/3"},{"id":"in_transaction?/0","anchor":"in_transaction?/0"},{"id":"insert/2","anchor":"insert/2"},{"id":"insert!/2","anchor":"insert!/2"},{"id":"insert_all/3","anchor":"insert_all/3"},{"id":"insert_or_update/2","anchor":"insert_or_update/2"},{"id":"insert_or_update!/2","anchor":"insert_or_update!/2"},{"id":"load/2","anchor":"load/2"},{"id":"one/2","anchor":"one/2"},{"id":"one!/2","anchor":"one!/2"},{"id":"preload/3","anchor":"preload/3"},{"id":"query/3","anchor":"query/3"},{"id":"query!/3","anchor":"query!/3"},{"id":"rollback/1","anchor":"rollback/1"},{"id":"start_link/1","anchor":"start_link/1"},{"id":"stop/2","anchor":"stop/2"},{"id":"stream/2","anchor":"stream/2"},{"id":"transaction/2","anchor":"transaction/2"},{"id":"update/2","anchor":"update/2"},{"id":"update!/2","anchor":"update!/2"},{"id":"update_all/3","anchor":"update_all/3"}]},{"id":"POABackend.Release.Tasks","title":"POABackend.Release.Tasks","group":"","functions":[{"id":"migrate/0","anchor":"migrate/0"}]},{"id":"POABackend.Auth","title":"POABackend.Auth","group":"POA Auth","functions":[{"id":"activate_user/1","anchor":"activate_user/1"},{"id":"authenticate_admin/2","anchor":"authenticate_admin/2"},{"id":"authenticate_user/2","anchor":"authenticate_user/2"},{"id":"create_banned_token/1","anchor":"create_banned_token/1"},{"id":"create_banned_token/2","anchor":"create_banned_token/2"},{"id":"create_user/3","anchor":"create_user/3"},{"id":"deactivate_user/1","anchor":"deactivate_user/1"},{"id":"delete_user/1","anchor":"delete_user/1"},{"id":"generate_password/0","anchor":"generate_password/0"},{"id":"generate_user_name/0","anchor":"generate_user_name/0"},{"id":"generate_user_name/1","anchor":"generate_user_name/1"},{"id":"get_user/1","anchor":"get_user/1"},{"id":"list_users/0","anchor":"list_users/0"},{"id":"purge_banned_tokens/0","anchor":"purge_banned_tokens/0"},{"id":"remove_user/1","anchor":"remove_user/1"},{"id":"token_banned?/1","anchor":"token_banned?/1"},{"id":"user_active?/1","anchor":"user_active?/1"},{"id":"valid_token?/1","anchor":"valid_token?/1"},{"id":"valid_user_name?/1","anchor":"valid_user_name?/1"}]},{"id":"POABackend.Auth.Guardian.Plug","title":"POABackend.Auth.Guardian.Plug","group":"POA Auth","functions":[{"id":"authenticated?/2","anchor":"authenticated?/2"},{"id":"current_claims/2","anchor":"current_claims/2"},{"id":"current_resource/2","anchor":"current_resource/2"},{"id":"current_token/2","anchor":"current_token/2"},{"id":"implementation/0","anchor":"implementation/0"},{"id":"put_current_claims/3","anchor":"put_current_claims/3"},{"id":"put_current_resource/3","anchor":"put_current_resource/3"},{"id":"put_current_token/3","anchor":"put_current_token/3"},{"id":"remember_me/4","anchor":"remember_me/4"},{"id":"remember_me_from_token/4","anchor":"remember_me_from_token/4"},{"id":"sign_in/4","anchor":"sign_in/4"},{"id":"sign_out/2","anchor":"sign_out/2"}]},{"id":"POABackend.Auth.Models.Token","title":"POABackend.Auth.Models.Token","group":"POA Auth","functions":[{"id":"new/2","anchor":"new/2"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Auth.Models.User","title":"POABackend.Auth.Models.User","group":"POA Auth","functions":[{"id":"changeset/2","anchor":"changeset/2"},{"id":"to_map/1","anchor":"to_map/1"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Auth.REST","title":"POABackend.Auth.REST","group":"POA Auth"},{"id":"POABackend.Protocol","title":"POABackend.Protocol","group":"POA Protocol"},{"id":"POABackend.Protocol.DataType","title":"POABackend.Protocol.DataType","group":"POA Protocol","types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Protocol.Message","title":"POABackend.Protocol.Message","group":"POA Protocol","functions":[{"id":"assign/3","anchor":"assign/3"},{"id":"new/0","anchor":"new/0"},{"id":"new/4","anchor":"new/4"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Protocol.MessageType","title":"POABackend.Protocol.MessageType","group":"POA Protocol","types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.CustomHandler","title":"POABackend.CustomHandler","group":"Custom Handler","callbacks":[{"id":"child_spec/1","anchor":"c:child_spec/1"}],"functions":[{"id":"publish_inactive/1","anchor":"publish_inactive/1"},{"id":"send_to_receivers/1","anchor":"send_to_receivers/1"}]},{"id":"POABackend.CustomHandler.REST","title":"POABackend.CustomHandler.REST","group":"Custom Handler","functions":[{"id":"ping_monitor/1","anchor":"ping_monitor/1"}]},{"id":"POABackend.Receiver","title":"POABackend.Receiver","group":"Receivers","callbacks":[{"id":"handle_inactive/2","anchor":"c:handle_inactive/2"},{"id":"handle_message/2","anchor":"c:handle_message/2"},{"id":"init_receiver/1","anchor":"c:init_receiver/1"},{"id":"metrics_received/3","anchor":"c:metrics_received/3"},{"id":"terminate/1","anchor":"c:terminate/1"}]},{"id":"POABackend.Receivers.Dashboard","title":"POABackend.Receivers.Dashboard","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.DynamoDB","title":"POABackend.Receivers.DynamoDB","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.Eth.Stats","title":"POABackend.Receivers.Eth.Stats","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.System.Stats","title":"POABackend.Receivers.System.Stats","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]}],"tasks":[]} \ No newline at end of file diff --git a/doc/dist/sidebar_items-f62ce50de1.js b/doc/dist/sidebar_items-f62ce50de1.js deleted file mode 100644 index 23d7145..0000000 --- a/doc/dist/sidebar_items-f62ce50de1.js +++ /dev/null @@ -1 +0,0 @@ -sidebarNodes={"extras":[{"id":"api-reference","title":"API Reference","group":"","headers":[{"id":"Modules","anchor":"modules"},{"id":"POA Protocol","anchor":"poa-protocol"}]},{"id":"initial_architecture","title":"Initial Architecture","group":"","headers":[]}],"exceptions":[],"modules":[{"id":"POABackend","title":"POABackend","group":""},{"id":"POABackend.Receivers.Repo","title":"POABackend.Receivers.Repo","group":"","functions":[{"id":"aggregate/4","anchor":"aggregate/4"},{"id":"all/2","anchor":"all/2"},{"id":"config/0","anchor":"config/0"},{"id":"delete/2","anchor":"delete/2"},{"id":"delete!/2","anchor":"delete!/2"},{"id":"delete_all/2","anchor":"delete_all/2"},{"id":"get/3","anchor":"get/3"},{"id":"get!/3","anchor":"get!/3"},{"id":"get_by/3","anchor":"get_by/3"},{"id":"get_by!/3","anchor":"get_by!/3"},{"id":"in_transaction?/0","anchor":"in_transaction?/0"},{"id":"insert/2","anchor":"insert/2"},{"id":"insert!/2","anchor":"insert!/2"},{"id":"insert_all/3","anchor":"insert_all/3"},{"id":"insert_or_update/2","anchor":"insert_or_update/2"},{"id":"insert_or_update!/2","anchor":"insert_or_update!/2"},{"id":"load/2","anchor":"load/2"},{"id":"one/2","anchor":"one/2"},{"id":"one!/2","anchor":"one!/2"},{"id":"preload/3","anchor":"preload/3"},{"id":"query/3","anchor":"query/3"},{"id":"query!/3","anchor":"query!/3"},{"id":"rollback/1","anchor":"rollback/1"},{"id":"start_link/1","anchor":"start_link/1"},{"id":"stop/2","anchor":"stop/2"},{"id":"stream/2","anchor":"stream/2"},{"id":"transaction/2","anchor":"transaction/2"},{"id":"update/2","anchor":"update/2"},{"id":"update!/2","anchor":"update!/2"},{"id":"update_all/3","anchor":"update_all/3"}]},{"id":"POABackend.Auth","title":"POABackend.Auth","group":"POA Auth","functions":[{"id":"activate_user/1","anchor":"activate_user/1"},{"id":"authenticate_admin/2","anchor":"authenticate_admin/2"},{"id":"authenticate_user/2","anchor":"authenticate_user/2"},{"id":"create_banned_token/1","anchor":"create_banned_token/1"},{"id":"create_banned_token/2","anchor":"create_banned_token/2"},{"id":"create_user/3","anchor":"create_user/3"},{"id":"deactivate_user/1","anchor":"deactivate_user/1"},{"id":"delete_user/1","anchor":"delete_user/1"},{"id":"generate_password/0","anchor":"generate_password/0"},{"id":"generate_user_name/0","anchor":"generate_user_name/0"},{"id":"generate_user_name/1","anchor":"generate_user_name/1"},{"id":"get_user/1","anchor":"get_user/1"},{"id":"list_users/0","anchor":"list_users/0"},{"id":"purge_banned_tokens/0","anchor":"purge_banned_tokens/0"},{"id":"remove_user/1","anchor":"remove_user/1"},{"id":"token_banned?/1","anchor":"token_banned?/1"},{"id":"user_active?/1","anchor":"user_active?/1"},{"id":"valid_token?/1","anchor":"valid_token?/1"},{"id":"valid_user_name?/1","anchor":"valid_user_name?/1"}]},{"id":"POABackend.Auth.Guardian.Plug","title":"POABackend.Auth.Guardian.Plug","group":"POA Auth","functions":[{"id":"authenticated?/2","anchor":"authenticated?/2"},{"id":"current_claims/2","anchor":"current_claims/2"},{"id":"current_resource/2","anchor":"current_resource/2"},{"id":"current_token/2","anchor":"current_token/2"},{"id":"implementation/0","anchor":"implementation/0"},{"id":"put_current_claims/3","anchor":"put_current_claims/3"},{"id":"put_current_resource/3","anchor":"put_current_resource/3"},{"id":"put_current_token/3","anchor":"put_current_token/3"},{"id":"remember_me/4","anchor":"remember_me/4"},{"id":"remember_me_from_token/4","anchor":"remember_me_from_token/4"},{"id":"sign_in/4","anchor":"sign_in/4"},{"id":"sign_out/2","anchor":"sign_out/2"}]},{"id":"POABackend.Auth.Models.Token","title":"POABackend.Auth.Models.Token","group":"POA Auth","functions":[{"id":"new/2","anchor":"new/2"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Auth.Models.User","title":"POABackend.Auth.Models.User","group":"POA Auth","functions":[{"id":"changeset/2","anchor":"changeset/2"},{"id":"to_map/1","anchor":"to_map/1"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Auth.REST","title":"POABackend.Auth.REST","group":"POA Auth"},{"id":"POABackend.Protocol","title":"POABackend.Protocol","group":"POA Protocol"},{"id":"POABackend.Protocol.DataType","title":"POABackend.Protocol.DataType","group":"POA Protocol","types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Protocol.Message","title":"POABackend.Protocol.Message","group":"POA Protocol","functions":[{"id":"assign/3","anchor":"assign/3"},{"id":"new/0","anchor":"new/0"},{"id":"new/4","anchor":"new/4"}],"types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.Protocol.MessageType","title":"POABackend.Protocol.MessageType","group":"POA Protocol","types":[{"id":"t/0","anchor":"t:t/0"}]},{"id":"POABackend.CustomHandler","title":"POABackend.CustomHandler","group":"Custom Handler","callbacks":[{"id":"child_spec/1","anchor":"c:child_spec/1"}],"functions":[{"id":"publish_inactive/1","anchor":"publish_inactive/1"},{"id":"send_to_receivers/1","anchor":"send_to_receivers/1"}]},{"id":"POABackend.CustomHandler.REST","title":"POABackend.CustomHandler.REST","group":"Custom Handler","functions":[{"id":"ping_monitor/1","anchor":"ping_monitor/1"}]},{"id":"POABackend.Receiver","title":"POABackend.Receiver","group":"Receivers","callbacks":[{"id":"handle_inactive/2","anchor":"c:handle_inactive/2"},{"id":"handle_message/2","anchor":"c:handle_message/2"},{"id":"init_receiver/1","anchor":"c:init_receiver/1"},{"id":"metrics_received/3","anchor":"c:metrics_received/3"},{"id":"terminate/1","anchor":"c:terminate/1"}]},{"id":"POABackend.Receivers.Dashboard","title":"POABackend.Receivers.Dashboard","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.DynamoDB","title":"POABackend.Receivers.DynamoDB","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.Eth.Stats","title":"POABackend.Receivers.Eth.Stats","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]},{"id":"POABackend.Receivers.System.Stats","title":"POABackend.Receivers.System.Stats","group":"Receivers","functions":[{"id":"handle_inactive/2","anchor":"handle_inactive/2"},{"id":"handle_message/2","anchor":"handle_message/2"},{"id":"init_receiver/1","anchor":"init_receiver/1"},{"id":"metrics_received/3","anchor":"metrics_received/3"},{"id":"terminate/1","anchor":"terminate/1"}]}],"tasks":[]} \ No newline at end of file diff --git a/doc/initial_architecture.html b/doc/initial_architecture.html index 0c0cfe1..52e75ac 100644 --- a/doc/initial_architecture.html +++ b/doc/initial_architecture.html @@ -8,7 +8,7 @@ Initial Architecture – poa_backend v0.1.0 - + diff --git a/doc/search.html b/doc/search.html index 5854f32..2c143b7 100644 --- a/doc/search.html +++ b/doc/search.html @@ -8,7 +8,7 @@ Search – poa_backend v0.1.0 - +