/TransmissionApi

small ruby wrapper for the Transmission RPC API

Primary LanguageRubyMIT LicenseMIT

TransmissionApi

Very simple Ruby Gem to comunicate with the Transmission API.

There are other alternatives, this one just works better for me but I recommend you to check out the others.:

Installation

Add this line to your application"s Gemfile:

gem "transmission_api"

And then execute:

$ bundle

Or install it yourself as:

$ gem install transmission_api

Usage

transmission_api_client =
  TransmissionApi::Client.new(
    :username => "username",
    :password => "password",
    :url      => "http://127.0.0.1:9091/transmission/rpc"
  )

torrents = transmission_api_client.all
# same as .all without arguments, but fetches only specified fields
torrents = transmission_api_client.all(fields: ['id', 'name', 'addedDate'])
# find with default fields
torrent = transmission_api_client.find(id)
# find with custom fields
torrent = transmission_api_client.find(id, fields: ['id', 'name'])
torrent = transmission_api_client.create("http://torrent.com/nice_pic.torrent")
transmission_api_client.destroy(id)

## State

Version experimental, not use in production.

Transmission Api Doc

Supported Transmission Api Version: 2.40

Contributing

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