akdh / client-php

SmartFile API Client (PHP).

A SmartFile Open Source project. Read more about how SmartFile uses and contributes to Open Source software.

Summary

This library includes two API clients. Each one represents one of the supported authentication methods. BasicClient is used for HTTP Basic authentication, using an API key and password. OAuthClient is used for OAuth (version 1) authentication, using tokens, which will require user interaction to complete authentication with the API.

Both clients provide a thin wrapper around an HTTP library, taking care of some of the mundane details for you. The intended use of this library is to refer to the API documentation to discover the API endpoint you wish to call, then use the client library to invoke this call.

SmartFile REST API information is available at the SmartFile developer site.

Installation

via source code / GitHub.

$ git clone https://github.com/smartfile/client-php.git smartfile

More information is available at GitHub

Usage

Choose between Basic and OAuth authentication methods, then continue to use the SmartFile API.

Some of the details this library takes care of are:

• Encoding and decoding of parameters and return values. You deal with Python types only.
• URLs, using the API version, endpoint, and object ID, the URL is created for you.
• Authentication. Provide your API credentials to this library, it will take care of the details.

Basic Authentication

sample PHP code:

include_once 'Services/SmartFile/BasicClient.php';
$api = new Service_SmartFile_BasicClient('**********', '**********');
$api->get('/ping');

OAuth Authentication

Authentication using OAuth authentication is bit more complicated, as it involves tokens and secrets.

sample PHP code:

include_once 'Services/SmartFile/OAuthClient.php';
$api = new Service_SmartFile_OAuthClient('**********', '**********');
// Be sure to only call each method once for each OAuth login

// This is the first step with the client, which should be left alone
$api->getRequestToken();

// Redirect users to the following URL:
echo "In your browser, go to: " . $api->getAuthorizationUrl() . "\n";
// This example uses raw_input to get the verification from the console:
$clientVerification = trim(fgets(STDIN));
$api.getAccessToken($clientVerification);
$api.get('/ping');

Calling endpoints

Once you instantiate a client, you can use the get/put/post/delete methods to make the corresponding HTTP requests to the API. There is also a shortcut for using the GET method, which is to simply invoke the client.

Some endpoints accept an ID, this might be a numeric value, a path, or name, depending on the object type. For example, a user's id is their unique username. For a file path, the id is it's full path.

File transfers

Uploading and downloading files is supported.

To upload a file, pass either a file-like object or a tuple of (filename, file-like) as a kwarg.

Downloading is automatic, if the 'Content-Type' header indicates content other than the expected JSON return value, then a file-like object is returned.

Tasks

Operations are long-running jobs that are not executed within the time frame of an API call. For such operations, a task is created, and the API can be used to poll the status of the task.

Synchronization

If you have many files that you wish to keep synchronized between a number of computer systems and SmartFile, the sync API can help. The sync API is an implementation of the excellent and popular rsync delta algorithm. It is completely compatible with the file formats used in librsync version 0.9.7.

The Rsync algorithm provides a means to synchronize two files by transferring just the parts that differ, while retaining the parts that are the same. This allows files to be quickly and efficiently synchronized. The rsync algorithm is very popular and widely deployed. The implementation in librsync is very high quality Open Source software.

Once you have librsync available, synchronizing files using the SmartFile sync API is very simple. The API exposes three calls, corresponding to the three steps of the algorithm.

1. Signature (destination)
2. Delta (source)
3. Patch (destination)

Depending on the direction of synchronization, source and destination may be either your local machine or the SmartFile API. In either case, the steps are performed in the same order.

The SmartFile API client provides a simple SyncClient class that demonstrates synchronizing files in either direction. An example of it's usage follows.