transmission-rpc-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4917b1b8a5ad7da8273c58280fac4f25996e6334
-  data.tar.gz: fb8415abcd21be4158c10195b2d2a2fa0ae9dc6e
+  metadata.gz: f40dbe21491bbcdd4f6aa056748678819a81347f
+  data.tar.gz: af1ac8e0854ab433daa58c1b56a8b6966cbfa9e2
 SHA512:
-  metadata.gz: 65366f6cafbce62cd391596bcec5c5455adf8e2edb6730e92031b74e11f9c10c1984c8f258906d9c592b04433c0fde71d34e28615d56ae932cdfa43426dd5d89
-  data.tar.gz: 70fd3fcfe593fa9c9ae34b07fe3be75a292fd596f64f957dc036b1306fbc6b94b1cd4091242a9b53be6e0a0a4927f6abb8b9ee2b2236dd3b29ffca6340a0dade
+  metadata.gz: d9e982241cd3efef6e490d678bf1404ae8d0e21d6bdd33fe3480d451599dee377ece0c889b2eb95194ce83d1be49e4290f747560346247f0b96a29a04b404a44
+  data.tar.gz: 7c458a66cf283b4b006d1bbd82d8cba6efe820b370917561866773ad3bbfb8048092419a8eac9a666395d7f49a9c18fc994b9c46c885cd3ed0687cc2502900de

data/.rspec

@@ -1,3 +1,2 @@
 --color
---warnings
 --require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -5,7 +5,8 @@ gem 'faraday', '~> 0.9'
 group :development, :test do
 
   gem 'rspec', '~> 3.2'
-  gem 'webmock', '~> 1.20'
+  gem 'webmock', '~> 1.21'
   gem 'rake', '~> 10.4'
+  gem 'coveralls', require: false
 
 end

data/Gemfile.lock

@@ -1,14 +1,32 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
+    addressable (2.3.8)
+    coveralls (0.7.12)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.23)
+      unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (2.4.3)
+    multi_json (1.11.0)
     multipart-post (2.0.0)
+    netrc (0.10.3)
     rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -23,7 +41,19 @@ GEM
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
     safe_yaml (1.0.4)
-    webmock (1.20.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
+    webmock (1.21.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
 
@@ -31,7 +61,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   faraday (~> 0.9)
   rake (~> 10.4)
   rspec (~> 3.2)
-  webmock (~> 1.20)
+  webmock (~> 1.21)

data/README.md

@@ -1,78 +1,172 @@
 # Transmission RPC Ruby
 
-First primitive version.
+[![Build Status](https://travis-ci.org/transmission-rails/transmission-rpc-ruby.svg?branch=master)](https://travis-ci.org/transmission-rails/transmission-rpc-ruby) [![Code Climate](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby/badges/gpa.svg)](https://codeclimate.com/github/transmission-rails/transmission-rpc-ruby) [![Dependency Status](https://gemnasium.com/transmission-rails/transmission-rpc-ruby.svg)](https://gemnasium.com/transmission-rails/transmission-rpc-ruby) [![Coverage Status](https://coveralls.io/repos/transmission-rails/transmission-rpc-ruby/badge.svg?branch=master)](https://coveralls.io/r/transmission-rails/transmission-rpc-ruby?branch=master)
 
-There is a couple of these RPC wrappers around already, but I am looking for a nice object oriented solution.
+Transmission RPC Ruby is a Ruby library to communicate with Transmission RPC (bittorrent client).
+This library is based on this [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt) and currently supports RPC versions >= 14
 
-Main aim for this project => Object Oriented solution for Transmission RPC connection.
+## Installation
 
-This Project follows the RPC spec for transmission under `https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt` and is planning on supporting release version >= 2.40 and RPC version >= 14
+    gem install transmission-rpc-ruby
 
-## Examples (Currently working)
+Then require it
 
-To use the `Model` classes you need to set up some configs first
+    require 'transmission'
+
+## Getting started
+
+To get started with this gem you need to decide if you are using this library to connect to one or multiple transmission daemons.
+__Both is possible__
+
+### Single connection
+
+Just set up a single configuration with will be used throughout any library calls
 
     Transmission::Config.set host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
 
-Now all models will use the globally set configs
+    torrents = Transmission::Model::Torrent.all
+
+### Multiple connections
+
+Introducing the `Transmission::RPC` class, which represent all the raw rpc connection requests.
+
+    rpc = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
+
+    torrents = Transmission::Model::Torrent.all connector: rpc
+
+This Object can be passed to the `Transmission::Model` classes. Examples are shown below.
+
+### Configuration options
+
+Both `Transmission::Config` and `Transmission::RPC` take the same arguments, these are the default settings:
 
-### Finding a torrent
+    {
+      host: 'localhost',
+      port: 9091
+      path: '/transmission/rpc',
+      ssl: false,
+      credentials: {username: 'transmission', password: '********'},
+      session_id: ''
+    }
 
-    torrent = Transmission::Model::Torrent.find 1
+### Torrents
 
-### Getting all torrents
+To work with torrents you need use the `Transmission::Model::Torrent` class
+
+#### Get all torrents
 
     torrents = Transmission::Model::Torrent.all
 
-### Adding a torrent
+If only a few fields are required
+
+    torrents = Transmission::Model::Torrent.all fields: ['id']
+
+#### Find a torrent
+
+    id = 1
+    torrent = Transmission::Model::Torrent.find id
+
+If only a few fields are required
+
+    torrent = Transmission::Model::Torrent.find id, fields: ['id']
+
+#### Add a torrent
+
+    filename = 'http://example.com/torrent.torrent'
+    torrent = Transmission::Model::Torrent.add filename: filename
+
+__NOTE:__ you can also specify a magnet link instead
+
+#### Torrent instance methods
+
+    id = 1
+    torrent = Transmission::Model::Torrent.find(id)
+
+    torrent.start!
+    torrent.start_now!
+    torrent.stop!
+    torrent.verify!
+    torrent.re_announce!
+
+    torrent.move_up!
+    torrent.move_down!
+    torrent.move_top!
+    torrent.move_bottom!
+
+You can access the torrent accessors & mutators via instance methods too
+
+    # uploadLimited
+    torrent.upload_limited
+    torrent.upload_limited = true
+
+    torrent.save!
+
+The `save!` method will update the torrent on your remote transmission daemon.
+
+To find all the torrent [accessors](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L127) & [mutators](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L90) visit [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt)
+
+### Session
+
+To find out more about the current session use the `Transmission::Model::Session` class.
+
+#### Get session
+
+    session = Transmission::Model::Session.get
+
+If only a few fields are required
+
+    session = Transmission::Model::Session.get fields: ['version']
+
+If used with a connector
+
+    options = {}
+    rpc = Transmission::RPC.new options
+
+    session = Transmission::Model::Session.get connector: rpc
+
+#### Change session
+
+Like the `Transmission::Model::Torrent` class, you change some session properties
+
+    session = Transmission::Model::Session.get
+
+    # alt-speed-enabled
+    session.alt_speed_enabled
+    session.alt_speed_enabled = true
+
+    session.save!
+
+To find all the session [accessors](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L444) & [mutators](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L514) visit [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt)
 
-    torrent = Transmission::Model::Torrent.add filename: 'http://example.com/some_torrent.torrent'
-    # or
-    torrent = Transmission::Model::Torrent.add filename: 'magnet_link'
+### Session Stats
 
-### Deleting a torrent
+You can also retrieve some session stats by using the `Transmission::Model::SessionStats` class
 
-    torrent = Transmission::Model::Torrent.find 1
-    # Deletes torrents
-    torrent.delete!
-    # Deletes torrent and local data
-    torrent.delete! true
+    session_stats = Transmission::Model::SessionStats.get
 
-### Dealing with fields
+    # activeTorrentCount
+    session_stats.active_torrent_count
 
-To limit the amount of fields sent around you can limit the information by passing an array of desired fields
+For session stats there are no mutators. To find out more about the [accessors](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt#L531) visit the [spec](https://trac.transmissionbt.com/browser/trunk/extras/rpc-spec.txt)
 
-    torrent = Transmission::Model::Torrent.all fields: ['id']
+### RPC Connector
 
-### Using different connectors
+If it is not desired to use any of the `Transmission::Model` classes you can use the RPC connector
 
-If you are planning on using this lib to connect to multiple transmission daemon instances you can pass your own `Transmission::RPC` instance
+#### Examples
 
-    connector = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
-    torrents = Transmission::Model::Torrent.all connector: connector
+    rpc = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
 
-### Find out Transmission & RPC version
+    session_body = rpc.get_session
 
-    connector = Transmission::RPC.new host: 'some.host', port: 9091, ssl: false, credentials: {username: 'transmission', password: '********'}
-    session = connector.session
-    session.rpc_version          #=> 14
-    session.version              #=> "2.52"
+    ids = [1, 2, 3]
 
-## Examples (Currently NOT working but desired)
+    torrent_bodies = rpc.get_torrent ids
+    rpc.start_torrents ids
 
-### Torrent instance methods
+For more methods check out `lib/transmission/rpc.rb`
 
-    torrent = Transmission::Model::Torrent.find 1
-    torrent.move_up
-    torrent.move_down
-    torrent.move_top
-    torrent.move_bottom
-    torrent.start
-    torrent.start_now
-    torrent.stop
-    torrent.verify
-    torrent.re_announce
-    torrent.finished?
-    torrent.to_json
+## Contribute
 
-### This project is still WIP!!
+Please help make this gem awesome! If you have any suggestions or feedback either create an issue or PR.
+Just make sure you run the tests before.

data/Rakefile

@@ -1,3 +1,5 @@
+task :default => [:spec]
+
 task :spec do
   system 'rspec'
 end

data/lib/transmission.rb

@@ -1,8 +1,10 @@
 require File.join(File.dirname(__FILE__), 'transmission', 'rpc')
 require File.join(File.dirname(__FILE__), 'transmission', 'model')
 require File.join(File.dirname(__FILE__), 'transmission', 'config')
+require File.join(File.dirname(__FILE__), 'transmission', 'fields')
 require File.join(File.dirname(__FILE__), 'transmission', 'arguments')
+require File.join(File.dirname(__FILE__), 'transmission', 'utils')
 
 module Transmission
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/transmission/arguments.rb

@@ -1,9 +1,7 @@
 require File.join(File.dirname(__FILE__), 'arguments', 'torrent_add')
-require File.join(File.dirname(__FILE__), 'arguments', 'torrent_get')
 require File.join(File.dirname(__FILE__), 'arguments', 'torrent_set')
-require File.join(File.dirname(__FILE__), 'arguments', 'session_get')
 require File.join(File.dirname(__FILE__), 'arguments', 'session_set')
-require File.join(File.dirname(__FILE__), 'arguments', 'session_stats')
+require File.join(File.dirname(__FILE__), 'utils')
 
 module Transmission
   class Arguments
@@ -11,10 +9,15 @@ module Transmission
 
     attr_accessor :arguments
 
+    ATTRIBUTES = []
+
     def initialize(arguments = nil)
-      @arguments = arguments.inject([]) do |attributes, attribute|
-        raise Transmission::Arguments::InvalidArgument unless self.class::ATTRIBUTES.include? attribute
-        attributes << attribute
+      @arguments = arguments.inject({}) do |attributes, (key, value)|
+        key = key.to_s
+        found = self.class::ATTRIBUTES.select { |attr| attr[:field] == key }
+        raise Transmission::Arguments::InvalidArgument, key if found.empty?
+        attributes[key] = value
+        attributes
       end if arguments
       @arguments = self.class::ATTRIBUTES if arguments.nil?
     end
@@ -23,5 +26,25 @@ module Transmission
       @arguments
     end
 
+    class << self
+      include Transmission::Utils
+
+      def is_valid?(key)
+        is_valid_key? key, self::ATTRIBUTES
+      end
+
+      def real_key(key)
+        option_key key, self::ATTRIBUTES
+      end
+
+      def filter(arguments)
+        arguments.inject({}) do |hash, (key, value)|
+          found = self::ATTRIBUTES.select { |attr| attr[:field] == key.to_s }
+          hash[key] = value unless found.empty?
+          hash
+        end
+      end
+    end
+
   end
 end

data/lib/transmission/arguments/session_set.rb

@@ -3,54 +3,54 @@ module Transmission
     class SessionSet < Transmission::Arguments
 
       ATTRIBUTES = [
-          'alt-speed-down',
-          'alt-speed-enabled',
-          'alt-speed-time-begin',
-          'alt-speed-time-enabled',
-          'alt-speed-time-end',
-          'alt-speed-time-day',
-          'alt-speed-up',
-          'blocklist-url',
-          'blocklist-update',
-          'blocklist-enabled',
-          'cache-size-mb',
-          'download-dir',
-          'download-queue-size',
-          'download-queue-enabled',
-          'dht-enabled',
-          'encryption',
-          'required',
-          'preferred',
-          'tolerated',
-          'idle-seeding-limit',
-          'idle-seeding-limit-enabled',
-          'incomplete-dir',
-          'incomplete-dir-enabled',
-          'lpd-enabled',
-          'peer-limit-global',
-          'peer-limit-per-torrent',
-          'pex-enabled',
-          'peer-port',
-          'peer-port-random-on-start',
-          'port-forwarding-enabled',
-          'queue-stalled-enabled',
-          'queue-stalled-minutes',
-          'rename-partial-files',
-          'script-torrent-done-filename',
-          'script-torrent-done-enabled',
-          'done',
-          'seedRatioLimit',
-          'seedRatioLimited',
-          'seed-queue-size',
-          'seed-queue-enabled',
-          'speed-limit-down',
-          'speed-limit-down-enabled',
-          'speed-limit-up',
-          'speed-limit-up-enabled',
-          'start-added-torrents',
-          'trash-original-torrent-files',
-          'units',
-          'utp-enabled'
+          {field: 'alt-speed-down'},
+          {field: 'alt-speed-enabled'},
+          {field: 'alt-speed-time-begin'},
+          {field: 'alt-speed-time-enabled'},
+          {field: 'alt-speed-time-end'},
+          {field: 'alt-speed-time-day'},
+          {field: 'alt-speed-up'},
+          {field: 'blocklist-url'},
+          {field: 'blocklist-update'},
+          {field: 'blocklist-enabled'},
+          {field: 'cache-size-mb'},
+          {field: 'download-dir'},
+          {field: 'download-queue-size'},
+          {field: 'download-queue-enabled'},
+          {field: 'dht-enabled'},
+          {field: 'encryption'},
+          {field: 'required'},
+          {field: 'preferred'},
+          {field: 'tolerated'},
+          {field: 'idle-seeding-limit'},
+          {field: 'idle-seeding-limit-enabled'},
+          {field: 'incomplete-dir'},
+          {field: 'incomplete-dir-enabled'},
+          {field: 'lpd-enabled'},
+          {field: 'peer-limit-global'},
+          {field: 'peer-limit-per-torrent'},
+          {field: 'pex-enabled'},
+          {field: 'peer-port'},
+          {field: 'peer-port-random-on-start'},
+          {field: 'port-forwarding-enabled'},
+          {field: 'queue-stalled-enabled'},
+          {field: 'queue-stalled-minutes'},
+          {field: 'rename-partial-files'},
+          {field: 'script-torrent-done-filename'},
+          {field: 'script-torrent-done-enabled'},
+          {field: 'done'},
+          {field: 'seedRatioLimit'},
+          {field: 'seedRatioLimited'},
+          {field: 'seed-queue-size'},
+          {field: 'seed-queue-enabled'},
+          {field: 'speed-limit-down'},
+          {field: 'speed-limit-down-enabled'},
+          {field: 'speed-limit-up'},
+          {field: 'speed-limit-up-enabled'},
+          {field: 'start-added-torrents'},
+          {field: 'trash-original-torrent-files'},
+          {field: 'units'},
+          {field: 'utp-enabled'}
       ]
 
     end