Project

BtSync

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Class to interact with BTSync's web interface using their unofficial API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
>= 0
>= 0

Runtime

>= 0
 Project Readme

BtSync

Gem Version Build Status Code Climate Coverage Status Flattr this

BtSync is a library to help you interact with Bittorrent Sync in Ruby

Installation

Add this line to your application's Gemfile:

gem 'btsync'

And then execute:

$ bundle

Or install it yourself as:

$ gem install btsync

Usage

Using BtSync

bittorrent = BtSync.new(options)

options is a hash that can contain any of the following options. The values shown are the defaults if no argument is passed in

{
  :protocol => "http",
  :uri => "localhost",
  :port => "8888",
  :user => "",
  :password => ""
}

####BtSync::Directory

A system directory managed with Bittorrent Sync is represented as a BtSync::Directory.

On a BtSync::Directory you can

  • Update the secret
  • change the settings for
    • Use tracker server
    • Use relay server when required
    • Search LAN
    • SearchDHT network
    • Delete Files to Sync Trash
    • Use Predefined Hosts

Todo

  • Manage predefined hosts
  • Allow user authentication

Known Issues

  • [] Bittorrent Sync must be run on a Linux system

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