PutioKit

A Swift framework for Put.io's API

This project is currently a work in process but aims to be a feature complete wrapper for Put.io's API. It's derived from the framework of the same name used by Fetch.

Installation

CocoaPods

CocoaPods is the easiest way to install PutioKit for inclusion in your project. Just add the following to your Podfile.

pod 'PutioKit', '~> 1.0'

Swift Package Manager

PutioKit can easily be installed via Swift Pacakge Manager (SPM).

dependencies: [
    .Package(url: "https://github.com/TryFetch/PutioKit.git", majorVersion: 1)
]

Manual

Manually install PutioKit by including the contents of the Sources directory in your project.

Usage

In order to access the Put.io API you'll need to create an OAuth app and use its client ID and secret. The following static properties can be set on the main Putio class.

import PutioKit

Putio.clientId = 1234 // The client ID given when registering an app with Put.io
Putio.redirectUri = "http://example.com/auth" // The redirect URI registered with Put.io
Putio.accessToken = "ABC123DE" // The user's access token obtained from OAuth

Authentication

Authentication depends on whether you have a server or just want to authenticate on device. More information on these solutions can be found on Put.io's API.

Examples

Full documentation can be found at https://tryfetch.github.io/PutioKit/

The main methods for interacting with the API are all included on the Putio class. Some model specific methods will be included elsewhere. For example there is a method for retrying a transfer on the Transfer object itself.

Some examples of methods and their usage can be seen below.

import PutioKit

// FILES

Putio.getFiles { files, error in
  print(files)
  print(error)
}

Putio.delete(files: [file1, file2]) { completed in
  print(completed)
}

file.getSubtitles { subtitles, error in
  print(subtitles)
}

// TRANSFERS

Putio.getTransfers { transfers, error in
  print(transfers)
  print(error)
}

Putio.cleanTransfers { completed in
  print(completed)
}

transfer.cancel { completed in
  print(completed)
}