Finance::Bank::Cahoot::CredentialsProvider::Constant - Credentials provider for static data


Finance-Bank-Cahoot documentation Contained in the Finance-Bank-Cahoot distribution.

Index


Code Index:

NAME

Top

 Finance::Bank::Cahoot::CredentialsProvider::Constant - Credentials provider for static data

SYNOPSIS

Top

  my $credentials = Finance::Bank::Cahoot::CredentialsProvider::Constant->new(
     credentials => [qw(account password)],
     options => {account => 'acmeuser'});

DESCRIPTION

Top

Provides a credentials provider that returns static data. Each credential is available with its own access method of the same name. All methods may be optionally supplied a character offset in the credentials value (first character is 1).

METHODS

Top

new

Create a new instance of a static data credentials provider.

credentials is an array ref of all the credentials types available via the credentials provider.
options is a hash ref of constant return values of credentials.
get

Returns a credential value whose name is passed as the first parameter. An optional character offset (1 is the first character) may also be provided.

  my $password_char = $provider->password(5);

AUTHOR

Top

Jon Connell <jon@figsandfudge.com>

LICENSE AND COPYRIGHT

Top


Finance-Bank-Cahoot documentation Contained in the Finance-Bank-Cahoot distribution.

# Copyright (c) 2007 Jon Connell.
# All Rights Reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.

package Finance::Bank::Cahoot::CredentialsProvider::Constant;
use base qw(Finance::Bank::Cahoot::CredentialsProvider);

use strict;
use warnings 'all';
use vars qw($VERSION);

$VERSION = '1.07';

use Carp qw(croak);

sub _init
{
  my ($self, $options) = @_;
  while (my ($credential, $value) = each %{$options}) {
    croak 'Invalid credential '.$credential.' supplied with callback'
      if not $self->can($credential);
    $self->{$credential} = $value;
  }
  return $self;
}

sub get
{
  my ($self, $credential, $offset) = @_;
  croak 'Undefined credential '.$credential
    if not exists $self->{$credential};
  return substr $self->{$credential}, $offset - 1, 1
    if defined $offset;
  return $self->{$credential};
}

1;

__END__