/ 
WWW-Freebox-0.0.2
River stage zero No dependents
/ WWW::Freebox

NAME

WWW::Freebox - Access to FreeboxOS API

VERSION

Version 0.02

SYNOPSIS

Before using this module in your script(s) you need to acquire a token and a ID.

use WWW::Freebox;

my $fbx = WWW::Freebox->new("mafreebox.freebox.fr");

my $app_id = "perl.helloworld";
my $app_name = "Perl script";
my $app_version = "1.0";
my $device_name = "John's computer";

# You have to launch this method only once because a unique token and a unique ID are required per application.
my ($app_token, $track_id) = $fbx->authorize($app_id, $app_name, $app_version, $device_name);
# You need to store $app_token and $track_id (in a config file for example)
# You will have to grant access to your application (a message will be displayed on LCD screen of the Freebox Server)

Once you've got the token and the ID you will be able to use the module as follow :

use WWW::Freebox;

my $fbx = WWW::Freebox->new("mafreebox.freebox.fr");

$fbx->login("perl.helloworld", $app_token, $track_id);

if($fbx->{permissions}{downloader}){
	# Doing a request to FreeboxOS API
	my $content = [download_dir => 'path', download_file => ['file.torrent']];
	my $jsonResponse = $fbx->request("downloads/add", 1, $content);
}

You can find more informations at http://dev.freebox.fr/sdk/os/.

METHODS

new($freebox)

my $fbx = WWW::Freebox->new("mafreebox.freebox.fr");

$fbx->authorize($app_id, $app_name, $app_version, $device_name)

my ($app_token, $track_id) = $fbx->authorize("perl.helloworld", "Perl script", "1.0", "John's computer");

$fbx->login($app_id, $app_token, $track_id)

$fbx->login("perl.helloworld", $app_token, $track_id);

$fbx->request($url, $method [, $content/@content])

# Possible values for the second parameter (method):
# 0: GET
# 1: POST
# 2: PUT
# 3: DELETE

my $jsonResponse = $fbx->request("downloads/", 0);

my $content = '{"io_priority": "high","status": "stopped"}';
my $jsonResponse = $fbx->request("downloads/16", 2, $content);

my @content = [download_dir => 'path', download_file => ['file.torrent']];
my $jsonResponse = $fbx->request("downloads/add", 1, @content);

$fbx->logout()

$fbx->logout();

$fbx->close()

$fbx->close();

AUTHOR

Alexandre van Beurden, <alexandre.vanbeurden.dev(at)gmail.com>

BUGS

Please report any bugs or feature requests to bug-www-freebox at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Freebox. You can also open an issue at https://github.com/KiLlOrBe/PM-Freebox.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::Freebox

You can also look for information at:

If you need help or you have any question about this module feel free to email me.

LICENSE AND COPYRIGHT

Copyright 2015 Alexandre van Beurden.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.