nao-pon/copy

Copy PHP library

Copy PHP API

, _(*1)

A php library for communicating with the copy cloud api, _(*2)

This library demos the binary part api, an efficient way to de-dupe and send/receive data with the Copy cloud, and the JSONRPC api used by the Copy agent, and Copy mobile devices, for doing advanced things with Copy., _(*3)

This demo works with the OAUTH api, which you will need to setup at the Copy developer portal (https://www.copy.com/developer/)., _(*4)

Please check out our changelog to see what has changed between versions., _(*5)

The Basics

Connect to the cloud

// create a cloud api connection to Copy
$copy = new \Barracuda\Copy\API($consumerKey, $consumerSecret, $accessToken, $tokenSecret);

List items

// list items in the root
$items = $copy->listPath('/');

Uploading a file

// open a file to upload
$fh = fopen('/tmp/file', 'rb');

// upload the file in 1MB chunks
$parts = array();
while ($data = fread($fh, 1024 * 1024)) {
    $part = $copy->sendData($data);
    array_push($parts, $part);
}

// close the file
fclose($fh);

// finalize the file
$copy->createFile('/copy-file-path', $parts);

Downloading a file

// obtain a list of files and parts
$files = $copy->listPath('/copy-file-path', array("include_parts" => true));

// process each file
foreach ($files as $file) {
    $data = '';

    // enumerate the parts in the latest revision
    foreach ($file->revisions[0]->parts as $part) {
        $data .= $copy->getPart($part->fingerprint, $part->size);
    }
}

Delete a file

$copy->removeFile('/copy-file-path');

Rename an object

$copy->rename('/source-copy-file-path', '/destination-copy-file-path');

Installing via Composer

The recommended way to install the Copy PHP API is through Composer., _(*6)

# Install Composer
curl -sS https://getcomposer.org/installer | php

# Add Copy API as a dependency
php composer.phar require barracuda/copy

After installing, you need to require Composer's autoloader:, _(*7)

require 'vendor/autoload.php';

Running the tests

First install the dependencies for the library using Composer. See above for how to install Composer., _(*8)

composer install

Then add connection info for your Copy account as environment variables:, _(*9)

export CONSUMER_KEY=<check the developer portal>
export CONSUMER_SECRET=<check the developer portal>
export ACCESS_TOKEN=<OAuth token>
export ACCESS_TOKEN_SECRET=<OAuth secret>

License

This library is MIT licensed, so feel free to use it anyway you see fit., _(*10)