Project

btsync_api

0.0
No commit activity in last 3 years
No release in over 3 years
Wrapper for the BitTorrent Sync API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.3
>= 0
>= 0
 Project Readme

btsync

Build Status Gem Version

A Ruby wrapper for the BitTorrent Sync API.

Installation

Add this line to your application's Gemfile:

gem 'btsync_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install btsync_api

Usage

Once you started the BitTorrent Sync client as described in the documentation, you can use the wrapper:

options = {host: 'localhost', port: 8888, login: '', password: ''} # default
api = BtsyncApi::Api.new(options)
api.get_os # => {"os"=>"mac"}

# pass arguments to the API
api.add_folder(dir: dir_path, secret: my_secret, selective_sync: 1)

api.remove_folder # raises BtsyncApi::ApiError('Specify all the required parameters for remove_folder')

Note: The error codes from the BitTorrent Sync API are not yet completely consistent, so expect some NoMethodError where it should actually be Btsync::ApiError.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request