From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

 / 
Yandex-Disk-0.07
River stage zero No dependents
⭐ Starred 4 GitHub stars
/ Yandex::Disk

NAME

Yandex::Disk - a simple API for Yandex Disk

VERSION

version 0.07

SYNOPSYS


            

              
              
use Yandex::Disk;
my $TOKEN = 'aaaabbbbccc'; #Auth token. You can get token from module L<Yandex::OAuth>
my $disk = Yandex::Disk->new( -token => $TOKEN );
#Get info about disk and print
my $diskinfo = $disk->getDiskInfo();
p $diskinfo;
#Upload file from local disk to Yandex disk
$disk->uploadFile(
                    -overwrite      => 1,
                    -file           => 'my_test_upload_file',  # Path to file on local disk
                    -remote_path    => "/Upload",              # Folder on Yandex Disk
                    ) or die "Cant upload file";
#Download file form Yandex Disk to local disk
$disk->downloadFile(
                    -path   => "/Upload/my_test_upload_file",   # Path to file on Yandex Disk
                    -file   => 'my_test_upload_file',           # Path to save file on local disk
                    ) or die "Cant download file";
#Create folder on Yandex Disk
$disk->createFolder(
                        -path       => '/Temp/new_folder',      # Path to new folder on Yandex Disk
                        -recursive  => 1,                       # Recursive create folder
#Share file and get public link
my $public = $disk->public();
$public->publicFile(
                        -path   => "/Upload/my_test_upload_file",  # Path to file, which need share
                    ) or die "Cant public file";
my $publicUrl = $public->publicUrl() or die "Cant get public url";

METHODS

getDiskInfo()

Return disk info data as hashref


            

              
              
my $info = $disk->getDiskInfo();
$info:
Example output:
    {
        max_file_size    1073741824,
        revision         14987326771107,
        system_folders   {
            applications    "disk:/Приложения",
            downloads       "disk:/Загрузки/",
            facebook        "disk:/Социальные сети/Facebook",
            google          "disk:/Социальные сети/Google+",
            instagram       "disk:/Социальные сети/Instagram",
            mailru          "disk:/Социальные сети/Мой Мир",
            odnoklassniki   "disk:/Социальные сети/Одноклассники",
            photostream     "disk:/Фотокамера/",
            screenshots     "disk:/Скриншоты/",
            social          "disk:/Социальные сети/",
            vkontakte       "disk:/Социальные сети/ВКонтакте"
        },
        total_space      67645734912,
        trash_size       0,
        used_space       19942927435,
        user             {
            login   "login",
            uid     123456
        }
    }

uploadFile(%opt)

Upload file (-file) to Yandex Disk in folder (-remote_path). Return 1 if success


            

              
              
$disk->uploadFile(-file => '/root/upload', -remote_path => 'Temp', -overwrite => 0);
Options:
    -overwrite          => Owervrite file if exists (default: 1)
    -remote_path        => Path to upload file on disk
    -file               => Path to local file
    -show_progress_bar  => Show progress bar upload file

createFolder(%opt)

Create folder on disk


            

              
              
$disk->createFolder(-path => 'Temp/test', -recursive => 1);
Options:
    -path               => Path to folder,
    -recursive          => Recursive create folder (default: 0)

deleteResource(%opt)

Delete file or folder from disk. Return 1 if success


            

              
              
$disk->deleteResource(-path => 'Temp/test');
Options:
    -path               => Path to delete file or folder
    -permanently        => Do not move to trash, delete permanently (default: 0(moving file to trash))
    -wait               => Wait delete resource (defailt: 0)

downloadFile(%opt)

Download file from Yandex Disk to local file. Method overwrites local file if exists. Return 1 if success


            

              
              
$disk->downloadFile(-path => 'Temp/test', -file => 'test');
Options:
    -path               => Path to file on Yandex Disk
    -file               => Path to local destination
    -show_progress_bar  => Show progress bar download file

emptyTrash(%opt)

Empty trash. If -path specified, delete -path resource, otherwise - empty all trash. Return 1 if success


            

              
              
$disk->emptyTrash(-path => 'Temp/test');        #Delete '/Temp/test' from trash
Options:
    -path               => Path to resource on Yandex Disk to delete from trash
    -wait               => Wait empty trash (defailt: 0)
$disk->emptyTrash;      #Full empty trash

listFiles(%opt)

List files in folder. Return arrayref to hashref(keys: "path", "type", "name", "preview", "created", "modified", "md5", "mime_type", "size")


            

              
              
$disk->listFiles(-path => 'Temp/test');
Options:
    -path               => Path to resource (file or folder) on Yandex Disk for which need get info
    -limit              => Limit max files to output (default: unlimited)
    -offset             => Offset records from start (default: 0)

listAllFiles(%opt)

List all files on YandexDisk. Return arrayref to hashref(keys: "path", "type", "name", "preview", "created", "modified", "md5", "mime_type", "size")


            

              
              
$disk->listAllFiles();
Options:
    -media_type         => Type of file to return. Afaible types listed below. Multiple types can be specified by using a comma. (default: all types)
    -limit              => Limit max files to output (default: unlimited)
    -offset             => Offset records from start (default: 0)

Media types: audio, backup, book, compressed, data, development, diskimage, document, encoded, executable, flash, font, image, settings, spreadsheet, text, unknown, video, web

lastUploadedFiles(%opt)

List last uploaded files. Return arrayref to hashref(keys: "path", "type", "name", "preview", "created", "modified", "md5", "mime_type", "size")


            

              
              
$disk->lastUploadedFiles();
Options:
    -media_type         => Type of file to return. Afaible types same as listAllFiles. Multiple types can be specified by using a comma. (default: all types)
    -limit              => Limit max files to output (default: unlimited)

Public files

my $public = $disk->public(); #Create Yandex::Disk::Public object

CLI/API Sparrow plugin https://sparrowhub.org/info/yandex-disk

DEPENDENCE

LWP::UserAgent, JSON::XS, URI::Escape, IO::Socket::SSL

AUTHORS

  • Pavel Andryushin <vrag867@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Pavel Andryushin.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.