File Coverage

blib/lib/IO/Iron/IronCache/Client.pm

Criterion	Covered	Total	%
statement	76	126	60.3
branch	3	6	50.0
condition			n/a
subroutine	17	21	80.9
pod	6	6	100.0
total	102	159	64.1

package IO::Iron::IronCache::Client;

## no critic (Documentation::RequirePodAtEnd)
## no critic (Documentation::RequirePodSections)
## no critic (Subroutines::RequireArgUnpacking)

use 5.010_000;
use strict;
use warnings;

# Global creator
BEGIN {
	use parent qw(IO::Iron::ClientBase); # Inheritance
	use parent qw(IO::Iron::IronCache::Policy );
}

# Global destructor
END {
}


# ABSTRACT: IronCache (Online Item-Value Storage) Client.

our $VERSION = '0.13'; # VERSION: generated by DZP::OurPkgVersion



use Log::Any  qw{$log};
use Hash::Util 0.06 qw{lock_keys lock_keys_plus unlock_keys legal_keys};
use Carp::Assert::More;
use English '-no_match_vars';
use Params::Validate qw(:all);

use IO::Iron::IronCache::Api ();
use IO::Iron::Common ();
require IO::Iron::Connection;
require IO::Iron::IronCache::Cache;

# CONSTANTS for this package

# DEFAULTS
use Const::Fast;

# Service specific!
const my $DEFAULT_API_VERSION => '1';
const my $DEFAULT_HOST => 'cache-aws-us-east-1.iron.io';





sub new {
	my $class = shift;
	my %params = validate(
		@_, {
			map { $_ => { type => SCALAR, optional => 1 }, } IO::Iron::Common::IRON_CLIENT_PARAMETERS(), ## no critic (ValuesAndExpressions::ProhibitCommaSeparatedStatements)
		}
	);

	$log->tracef('Entering new(%s, %s)', $class, \%params);
	my $self = IO::Iron::ClientBase->new();
	# Add more keys to the self hash.
	my @self_keys = (
			'caches',        # References to all objects created of class IO::Iron::IronCache::Cache. Not in use!
			'policy',        # The policies of this client.
			legal_keys(%{$self}),
	);
	unlock_keys(%{$self});
	lock_keys_plus(%{$self}, @self_keys);
	my $config = IO::Iron::Common::get_config(%params);
	$log->debugf('The config: %s', $config);
	$self->{'project_id'} = defined $config->{'project_id'} ? $config->{'project_id'} : undef;
	$self->{'caches'} = [];
	assert_nonblank( $self->{'project_id'}, 'self->{project_id} is not defined or is blank');

	unlock_keys(%{$self});
	bless $self, $class;
	lock_keys(%{$self}, @self_keys);

    # Set up the policies
    # We have to do this after blessing the object
    # because get_policies has late bindings.
    $self->{'policy'} = $self->get_policies('policies' => $config->{'policies'});

	# Set up the connection client
	my $connection = IO::Iron::Connection->new( {
		'project_id' => $config->{'project_id'},
		'token' => $config->{'token'},
		'host' => defined $config->{'host'} ? $config->{'host'} : $DEFAULT_HOST,
		'protocol' => $config->{'protocol'},
		'port' => $config->{'port'},
		'api_version' => defined $config->{'api_version'} ? $config->{'api_version'} : $DEFAULT_API_VERSION,
		'timeout' => $config->{'timeout'},
		'connector' => $params{'connector'},
		}
	);
	$self->{'connection'} = $connection;
	$log->debugf('IronCache client created with config: (project_id=%s; token=%s; host=%s; timeout=%s).', $config->{'project_id'}, $config->{'token'}, $config->{'host'}, $config->{'timeout'});
	$log->tracef('Exiting new: %s', $self);
	return $self;
}


sub get_caches {
	my $self = shift;
	validate(
		@_, {
			# No parameters
		}
	);
	$log->tracef('Entering get_caches()');

	my @caches;
	my $connection = $self->{'connection'};
	my ($http_status_code, $response_message) = $connection->perform_iron_action(
			IO::Iron::IronCache::Api::IRONCACHE_LIST_CACHES(), { } );
	$self->{'last_http_status_code'} = $http_status_code;
	foreach my $cache_info (@{$response_message}) {
		my $get_cache_name = $cache_info->{'name'};
		my $cache = IO::Iron::IronCache::Cache->new({
			'ironcache_client' => $self, # Pass a reference to the parent object.
			'name' => $get_cache_name,
			'connection' => $self->{'connection'},
            'policy' => $self->{'policy'},
		});
		push @caches, $cache;
	}
	#push @{$self->{'caches'}}, @caches; # Store only created caches!
	$log->debugf('Created caches: %s', \@caches);

	$log->tracef('Exiting get_caches: %s', \@caches);
	return @caches;
}


sub get_info_about_cache {
	my $self = shift;
	my %params = validate(
		@_, {
			'name' => { type => SCALAR, }, # cache name.
		}
	);
	$log->tracef('Entering get_info_about_cache(%s)', \%params);

	my $connection = $self->{'connection'};
	my ($http_status_code, $response_message) = $connection->perform_iron_action(
			IO::Iron::IronCache::Api::IRONCACHE_GET_INFO_ABOUT_A_CACHE(),
			{ '{Cache Name}' => $params{'name'}, }
		);
	$self->{'last_http_status_code'} = $http_status_code;
	my $info = $response_message;

	# info:
	# {'id':'523566104a734c39bf00041e','project_id':'51bdf5fb2267d84ced002c99',
	# 'name':'TEST_CACHE_01','size':0,'data_size':0}
    # Fetched info about cache:{created_at => '0001-01-01T00:00:00Z',data_size => 0,id => '53083eb79ef7915a7f005bc0'
    # ,name => 'name',project_id => '51bdf5fb2267d84ced002c99',size => 1,updated_at => '0001-01-01T00:00:00Z'}
	$log->tracef('Exiting get_info_about_cache: %s', $info);
	return $info;
}


sub get_cache {
	my $self = shift;
	my %params = validate(
		@_, {
			'name' => { type => SCALAR, }, # cache name.
		}
	);
	$log->tracef('Entering get_cache(%s)', \%params);

	my $connection = $self->{'connection'};
	my ($http_status_code, $response_message) = $connection->perform_iron_action(
			IO::Iron::IronCache::Api::IRONCACHE_GET_INFO_ABOUT_A_CACHE(),
			{ '{Cache Name}' => $params{'name'}, }
		);
	$self->{'last_http_status_code'} = $http_status_code;
	my $get_cache_name = $response_message->{'name'};
	my $cache = IO::Iron::IronCache::Cache->new({
		'ironcache_client' => $self, # Pass a reference to the parent object.
		'name' => $get_cache_name,
		'connection' => $self->{'connection'},
        'policy' => $self->{'policy'},
	});
	push @{$self->{'caches'}}, $cache;
	$log->debugf('Created a new IO::Iron::IronCache::Cache object (name=%s).', $get_cache_name);
	$log->tracef('Exiting get_cache: %s', $cache);
	return $cache;
}


sub create_cache {
	my $self = shift;
	my %params = validate(
		@_, {
			'name' => { type => SCALAR, callbacks => {
                    'RFC 3986 reserved character check' => sub { return ! IO::Iron::Common::contains_rfc_3986_res_chars(shift) },
                }}, # cache name.
		}
	);
	$log->tracef('Entering create_cache(%s)', \%params);

    $self->validate_cache_name('name' => $params{'name'});
	my $cache = IO::Iron::IronCache::Cache->new({
		'ironcache_client' => $self, # Pass a reference to the parent object.
		'name' => $params{'name'},
		'connection' => $self->{'connection'},
		'policy' => $self->{'policy'},
	});
	push @{$self->{'caches'}}, $cache;

	$log->debugf('Created a new IO::Iron::IronCache::Cache object (name=%s.)', $params{'name'});
	$log->tracef('Exiting get_cache: %s', $cache);
	return $cache;
}


sub delete_cache {
	my $self = shift;
	my %params = validate(
		@_, {
			'name' => { type => SCALAR, }, # cache name.
		}
	);
	$log->tracef('Entering delete_cache(%s)', \%params);

	my $connection = $self->{'connection'};
	my ($http_status_code) = $connection->perform_iron_action(
			IO::Iron::IronCache::Api::IRONCACHE_DELETE_A_CACHE(),
			{
				'{Cache Name}' => $params{'name'},
			}
		);
	$self->{'last_http_status_code'} = $http_status_code;
	@{$self->{'caches'}} = grep { $_->name() ne $params{'name'} } @{$self->{'caches'}};

	$log->debugf('Deleted cache (name=%s.)', $params{'name'});
	$log->tracef('Exiting delete_cache: %d', 1);
	return 1;
}

1;

__END__