File Coverage

lib/Webservice/OVH.pm

Criterion	Covered	Total	%
statement	36	97	37.1
branch	0	4	0.0
condition	0	4	0.0
subroutine	12	21	57.1
pod	9	9	100.0
total	57	135	42.2

=encoding utf-8

=head1 NAME

Webservice::OVH  - A perl representation of the ovh-api

=head1 SYNOPSIS

    use Webservice::OVH;

    my $ovh = Webservice::OVH->new("credentials.json");

    my $ovh = Webservice::OVH->new(application_key => $key, application_secret => $secret, consumer_key => $token);

    my $services = $ovh->domain->services;

    foreach my $service (@$services) {

        my $last_update = $service->last_update;
        print $last_update->datetime;
    }

=head1 DESCRIPTION

This module reflects the path structure of the ovh web-api.
This is the base object from where all api calls originate.

This module uses the perl api module provided by ovh.

=begin html

<p><center><img src="https://raw.githubusercontent.com/itnode/Webservice-OVH/master/inc/API_HowTo.png"></center></p>

=end html


=head1 METHODS

=cut

use strict;
use warnings;
use Carp qw{ carp croak };

our $VERSION = 0.47;

# api module provided by ovh
use OVH::OvhApi;

# sub-modules
use Webservice::OVH::Domain;
use Webservice::OVH::Me;
use Webservice::OVH::Order;
use Webservice::OVH::Email;
use Webservice::OVH::Cloud;
use Webservice::OVH::Hosting;

# other requirements
use JSON;
use File::Slurp qw(read_file);

=head2 new_from_json

Creates an api Object based on credentials in a json File

=over

=item * Parameter: $file_json - dir to json file

=item * Return: L<Webservice::OVH>

=item * Synopsis: Webservice::OVH->new_from_json("path/file");

=back

=over 2

=item * application_key      is generated when creating an application via ovh web interface

=item * application_secret   is generated when creating an application via ovh web interface

=item * consumer_key         must be requested through ovh authentification

=item * timeout              timeout in milliseconds, warning some request may take a while

=back

=cut


    my ( $class, $file_json ) = @_;

    # slurp file
    my $json = read_file($file_json, { binmode => ':raw' });

    # decode json
    my $Json = JSON->new->allow_nonref;
    my $data = $Json->decode($json);

    # check for missing parameters in the json file
    my @keys = qw{ application_key application_secret consumer_key };
    if ( my @missing_parameters = grep { not $data->{$_} } @keys ) {

        croak "Missing parameter: @missing_parameters";
    }

    my $self = bless {}, $class;

    # Create internal objects to mirror the web api of ovh
    my $api_wrapper = OVH::OvhApi->new( 'type' => "https://eu.api.ovh.com/1.0", applicationKey => $data->{application_key}, applicationSecret => $data->{application_secret}, consumerKey => $data->{consumer_key} );
    my $domain = Webservice::OVH::Domain->_new( wrapper => $api_wrapper, module => $self );
    my $me = Webservice::OVH::Me->_new( wrapper => $api_wrapper, module => $self );
    my $order = Webservice::OVH::Order->_new( wrapper => $api_wrapper, module => $self );
    my $email = Webservice::OVH::Email->_new( wrapper => $api_wrapper, module => $self );
    my $cloud = Webservice::OVH::Cloud->_new( wrapper => $api_wrapper, module => $self );
    my $hosting = Webservice::OVH::Hosting->_new( wrapper => $api_wrapper, module => $self );

    # Timeout can be also set in the json file
    OVH::OvhApi->setRequestTimeout( timeout => $data->{timeout} || 120 );

    # Setting private variables
    $self->{_domain}      = $domain;
    $self->{_me}          = $me;
    $self->{_order}       = $order;
    $self->{_api_wrapper} = $api_wrapper;
    $self->{_email}       = $email;
    $self->{_cloud}       = $cloud;
    $self->{_hosting}     = $hosting;

    return $self;
}

=head2 new

Create the api object. Credentials are given directly via %params
Credentials can be generated via ovh web interface and ovh authentification

=over

=item * Parameter: %params - application_key => value, application_secret => value, consumer_key => value

=item * Return: L<Webservice::OVH>

=item * Synopsis: Webservice::OVH->new(application_key => $key, application_secret => $secret, consumer_key => $token);

=back

=cut


    my ( $class, %params ) = @_;

    my @keys = qw{ application_key application_secret consumer_key };

    if ( my @missing_parameters = grep { not $params{$_} } @keys ) {

        croak "Missing parameter: @missing_parameters";
    }

    my $self = bless {}, $class;

    my $api_wrapper = OVH::OvhApi->new( 'type' => "https://eu.api.ovh.com/1.0", applicationKey => $params{application_key}, applicationSecret => $params{application_secret}, consumerKey => $params{consumer_key} );
    my $domain = Webservice::OVH::Domain->_new( wrapper => $api_wrapper, module => $self );
    my $me = Webservice::OVH::Me->_new( wrapper => $api_wrapper, module => $self );
    my $order = Webservice::OVH::Order->_new( wrapper => $api_wrapper, module => $self );
    my $email = Webservice::OVH::Email->_new( wrapper => $api_wrapper, module => $self );
    my $cloud = Webservice::OVH::Cloud->_new( wrapper => $api_wrapper, module => $self );
    my $hosting = Webservice::OVH::Hosting->_new( wrapper => $api_wrapper, module => $self );

    OVH::OvhApi->setRequestTimeout( timeout => $params{timeout} || 120 );

    $self->{_domain}      = $domain;
    $self->{_me}          = $me;
    $self->{_order}       = $order;
    $self->{_api_wrapper} = $api_wrapper;
    $self->{_email}       = $email;
    $self->{_cloud}       = $cloud;
    $self->{_hosting}     = $hosting;

    return $self;
}

=head2 set_timeout

Sets the timeout of the underlying LWP::Agent

=over

=item * Parameter: timeout - in milliseconds default 120

=item * Synopsis: Webservice::OVH->set_timeout(120);

=back

=cut


    my ( $class, $timeout ) = @_;

    OVH::OvhApi->setRequestTimeout( timeout => $timeout );
}

=head2 domain

Main access to all /domain/ api methods

=over

=item * Return: L<Webservice::OVH::Domain>

=item * Synopsis: $ovh->domain;

=back

=cut


    my ($self) = @_;

    return $self->{_domain};
}

=head2 me

Main access to all /me/ api methods

=over

=item * Return: L<Webservice::OVH::Me>

=item * Synopsis: $ovh->me;

=back

=cut


    my ($self) = @_;

    return $self->{_me};
}

=head2 order

Main access to all /order/ api methods

=over

=item * Return: L<Webservice::OVH::Order>

=item * Synopsis: $ovh->order;

=back

=cut


    my ($self) = @_;

    return $self->{_order};
}

=head2 email

Main access to all /email/ api methods

=over

=item * Return: L<Webservice::OVH::Email>

=item * Synopsis: $ovh->email;

=back

=cut


    my ($self) = @_;

    return $self->{_email};
}

=head2 cloud

Main access to all /cloud/ api methods

=over

=item * Return: L<Webservice::OVH::Cloud>

=item * Synopsis: $ovh->cloud;

=back

=cut


    my ($self) = @_;

    return $self->{_cloud};
}

=head2 hosting

Main access to all /hosting/ api methods

=over

=item * Return: L<Webservice::OVH::Cloud>

=item * Synopsis: $ovh->cloud;

=back

=cut


    my ($self) = @_;

    return $self->{_hosting};
}

=head1 AUTHOR

Patrick Jendral

=head1 COPYRIGHT AND LICENSE

This library is free software; you may redistribute it and/or modify it under the same terms as Perl itself.

=cut

1;