File Coverage

blib/lib/WebService/Freebox.pm

Criterion	Covered	Total	%
statement	18	73	24.6
branch	0	12	0.0
condition			n/a
subroutine	6	15	40.0
pod	5	5	100.0
total	29	105	27.6

use strict;
use warnings;

package WebService::Freebox;

# ABSTRACT: Freebox API wrappers.


use Mouse;

use JSON;
use REST::Client;

our $VERSION = '0.001'; # VERSION

has app_id => ( is => 'ro', isa => 'Str', required => 1 );
has app_version => ( is => 'ro', isa => 'Str', required => 1 );

has app_token => ( is => 'ro', isa => 'Str' );

has _client => ( is => 'ro', builder => '_create_client' );
has _api_version => ( is => 'ro', builder => '_get_api_version' );

# Create the REST client we're going to use for all our requests.
sub _create_client {
    my $self = shift;

    my $c = REST::Client->new(host => 'http://mafreebox.freebox.fr');
    $c->addHeader('Accept', 'application/json');
    $c->addHeader('Content-Type', 'application/json');

    return $c;
}

# Wrapper around REST::Client request() checking for errors: the first
# argument is the error message given if the request failed.
sub _request {
    my ($self, $errmsg, $request, $url, $body) = @_;

    my $c = $self->_client;
    $c->request($request, $url, $body);

    my $errcode = $c->responseCode();
    if ($errcode != 200) {
        die qq{$errmsg ("$request $url" failed with HTTP error $errcode).\n}
    }

    return decode_json $c->responseContent()
}

# Helper for making normal API requests, i.e. all except for the initial one,
# checking for the Freebox presence and detecting the API version.
sub _api_request {
    my ($self, $errmsg, $request, $url, @rest) = @_;
    $self->_request($errmsg, $request, '/api/v' . $self->_api_version . "/$url", @rest);
}

# Detect the Freebox and get the API version used by it.
sub _get_api_version {
    my $self = shift;

    my $res = $self->_request('Freebox v6 not detected', 'GET', '/api_version');

    my $api_version = $res->{api_version};
    die "Unexpected Freebox API version $api_version.\n" if $api_version !~ '[23].0';

    # We need to use just the major number in the HTTP requests.
    $api_version =~ s/\.\d$//;

    return $api_version;
}





sub authorize {
    my ($self, $app_name, $device_name) = @_;

    my $app_id = $self->app_id;

    my $res = $self->_api_request(
            'Requesting authorization failed',
            'POST',
            'login/authorize/',
            encode_json({
                app_id => $app_id,
                app_name => $app_name,
                app_version => $self->app_version,
                device_name => $device_name
            })
        );

    my $app_token = $res->{result}{app_token};

    my $track_id = $res->{result}{track_id};
    while (1) {
        $res = $self->_api_request(
            'Waiting for authorization failed',
            'GET',
            "login/authorize/$track_id"
        );

        last if $res->{result}{status} ne 'pending';

        sleep 1;
    }

    die "Failed to obtain authorization for $app_id: $res->{result}{status}.\n"
        unless $res->{result}{status} eq 'granted';

    return $app_token
}



sub login {
    my ($self, $session_token) = @_;

    if (defined $session_token) {
        $self->_client->addHeader('X-Fbx-App-Auth', $session_token);
    }

    my $res = $self->_api_request(
                'Checking logged in status failed',
                'GET',
                'login/'
            );

    if (!$res->{result}{logged_in}) {
        use Digest::SHA qw(hmac_sha1_hex);

        my $challenge = $res->{result}{challenge};
        my $password = hmac_sha1_hex($challenge, $self->app_token);

        $res = $self->_api_request(
                    'Logging in failed',
                    'POST',
                    "login/session/",
                    encode_json({
                        app_id => $self->app_id,
                        app_version => $self->app_version,
                        password => $password,
                    })
                );

        $session_token = $res->{result}{session_token};

        $self->_client->addHeader('X-Fbx-App-Auth', $session_token);
    }

    return $session_token;
}



sub get_system_config {
    my $self = shift;

    my $res = $self->_api_request(
            'Getting system configuration failed',
            'GET',
            'system/'
        );

    return $res->{result}
}



sub get_connection_status {
    my $self = shift;

    my $res = $self->_api_request(
                'Getting connection status failed',
                'GET',
                'connection/'
            );

    return $res->{result}
}



sub get_all_freeplugs {
    my $self = shift;

    my $res = $self->_api_request(
                'Failed to get freeplugs list',
                'GET',
                'freeplug/'
            );

    my $fps = [];
    foreach my $fp (@{$res->{result}[0]{members}}) {
        push @$fps, $fp;
    }

    return $fps
}

__PACKAGE__->meta->make_immutable();

__END__