The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-Spoor-0.01
River stage zero No dependents
++
/ App::Spoor::Config

NAME

App::Spoor::Config

VERSION

Version 0.01

SYNOPSIS

Allows access to the spoor config file located at /etc/spoor/spoor.yml which currently has the following format;

  ---
  application:
    ignored_entries_path: //var/lib/spoor/ignored
    parsed_entries_path: //var/lib/spoor/parsed
    transmitted_entries_path: //var/lib/spoor/transmitted
  followers:
    access:
      debug: 1
      maxinterval: 10
      name: /usr/local/cpanel/logs/access_log
      transformer: bin/login_log_transformer.pl
    error:
      debug: 1
      maxinterval: 10
      name: /usr/local/cpanel/logs/error_log
      transformer: bin/login_log_transformer.pl
    login:
      debug: 1
      maxinterval: 10
      name: /usr/local/cpanel/logs/login_log
      transformer: bin/login_log_transformer.pl
  transmission:
    credentials:
      api_identifier: api_identifier_goes_here
      api_secret: api_secret_goes_here
    endpoints:
      report: /api/reports
    host: https://spoor.capefox.co

SUBROUTINES/METHODS

get_follower_config

Gets the config related to a specific type of follower (access, error, login).

  $reference_to_access_config_hash = App::Spoor::Config::get_follower_config('access');

  # Optionally, you can pass in an alternative to the root path '/' which is used when building the path
  # to the config file. In the code snipper below, the method will look for the config file in /tmp/etc/spoor
  # rather than /etc/spoor. This is primarily used to support testing.

  $reference_to_access_config_hash = App::Spoor::Config::get_follower_config('access', '/tmp');

get_application_config

Returns application config. This is *not* actually read from the config file but it is, for now, hard coded data. Should the contents of the application config ever become more dynamic this will change.

  $reference_to_application_config_hash = App::Spoor::Config::get_application_config();

  # Optionally, you can pass in an alternative to the root path '/' which is used when building the path
  # to the config file. In the code snipper below, the method will look for the config file in /tmp/etc/spoor
  # rather than /etc/spoor. This is primarily used to support testing.

  $reference_to_application_config_hash = App::Spoor::Config::get_application_config('/tmp');

get_transmission_config

Returns the config from the `transmission` section of the config file.

  $reference_to_transmission_config_hash = App::Spoor::Config::get_transmission_config('access');

  # Optionally, you can pass in an alternative to the root path '/' which is used when building the path
  # to the config file. In the code snipper below, the method will look for the config file in /tmp/etc/spoor
  # rather than /etc/spoor. This is primarily used to support testing.

  $reference_to_transmission_config_hash = App::Spoor::Config::get_transmission_config('/tmp');

AUTHOR

Rory McKinley, <rorymckinley at capefox.co>

BUGS

Please report any bugs or feature requests to bug-. at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=.. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc App::Spoor::Config

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2019 Rory McKinley.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.