view release on metacpan or  search on metacpan

lib/WebService/Braintree/Configuration.pm  view on Meta::CPAN

# vim: sw=4 ts=4 ft=perl

package WebService::Braintree::Configuration;
$WebService::Braintree::Configuration::VERSION = '1.7';
use 5.010_001;
use strictures 1;

=head1 NAME

WebService::Braintree::Configuration

=head1 PURPOSE

This keeps all configuration information for your WebService::Braintree
installation.

A singleton of this class is instantiated when you use L<WebService::Braintree>.
You are intended to set attributes of this class immediately, then the rest of
the distribution knows what to do.

=cut

use WebService::Braintree::Gateway;
use Moo;

# IS THIS UNUSED? I cannot find reference in the current documentation for Ruby
# or Node.JS nor is it referenced anywhere else in the code.
has partner_id => (is => 'rw');

=head1 ATTRIBUTES

Get these values from L<Braintree's API credentials documentation|https://articles.braintreepayments.com/control-panel/important-gateway-credentials#api-credentials>.

These attributes are standard mutators. If you invoke them with a value, they
will set the attribute to that value. If you invoke them without a value, they
will return the current value.

=head2 merchant_id(?$value)

This is your merchant_id.

=cut

has merchant_id => (is => 'rw');

=head2 public_key(?$value)

This is your public_key.

=cut

has public_key => (is => 'rw');

=head2 private_key(?$value)

This is your private_key.

=cut

has private_key => (is => 'rw');

=head2 environment(?$value)

This is your environment. The environment can be:

=over 4

=item development | integration

This is when you're using a local server for testing. It's unlikely you will
ever want to use this.

=item sandbox

This is when you're using your Braintree sandbox for testing.

=item qa

This is when you're using qa-master.braintreegateway.com for testing.

=item production

This is when you're live and rocking.

=back

If you provide a value other than the ones listed above, a warning will be
thrown. This distribution will probably not work properly in that case.

Management reserves the right to change this from a warning to a thrown
exception in the future.

=head1 USAGE

Do yourself a favor and store these values in a configuration file, not your
source-controlled code.

=cut

has environment => (
    is => 'rw',
    trigger => sub {
        my ($self, $new_value, $old_value) = @_;
        my %valid = map { $_ => 1 } qw(
            development integration sandbox qa production
        );
        if (!$valid{$new_value}) {
            warn 'Assigned invalid value to WebService::Braintree::Configuration::environment';
        }

        if ($new_value eq 'integration') {
            $self->public_key('integration_public_key');
            $self->private_key('integration_private_key');
            $self->merchant_id('integration_merchant_id');
        }
    }
);

has gateway => (is  => 'ro', lazy => 1, default => sub {
    WebService::Braintree::Gateway->new({config => shift});
});

# This method is used in ::HTTP
sub base_merchant_url {
    my $self = shift;
    return $self->base_url() . $self->base_merchant_path;
}

# Below here, these methods do *NOT* appear to be used outside of this class.

sub base_merchant_path {
    my $self = shift;
    return '/merchants/' . $self->merchant_id;
}

sub base_url {
    my $self = shift;
    return $self->protocol . '://' . $self->server . ':' . $self->port;
}

sub is_development {
    my $self = shift;
    return 1 if $self->environment eq 'development';
    return 1 if $self->environment eq 'integration';
    return;
}

sub port {
    my $self = shift;
    if ($self->is_development) {
        return $ENV{'GATEWAY_PORT'} || '3000'
    } else {
        return 443;
    }
}

sub server {
    my $self = shift;
    return {
        development => 'localhost',
        integration => 'localhost',
        sandbox     => 'api.sandbox.braintreegateway.com',
        qa          => 'qa-master.braintreegateway.com',
        production  => 'api.braintreegateway.com',
    }->{$self->environment};
}

sub auth_url {
    my $self = shift;
    return {
        development => 'http://auth.venmo.dev:9292',
        integration => 'http://auth.venmo.dev:9292',
        sandbox     => 'https://auth.sandbox.venmo.com',