rtransmission 0.1 → 0.2

data/README.md

@@ -6,12 +6,14 @@ Ruby Transmission Bindings
 Basic Usage
 -----------
 
-    requre 'rtransmission'
+    require 'rtransmission'
+
+    RTransmission::Client.session(:user => 'foo', :password => 'bar') do |session|
+      session.speed_limit_down_enabled = false
 
-    RTransmission::Client.new(:user => 'foo', :password => 'bar') do |client|
       url = 'http://torrents.gentoo.org/torrents/livedvd-x86-amd64-32ul-11.1.torrent'
-      torrent = RTransmission::Torrent.add(client, :url => url)
-      torrent = RTransmission::Torrent.list(client)[0]
+      torrent = RTransmission::Torrent.add(session, :url => url)
+      torrent = RTransmission::Torrent.list(session)[0]
 
       files = torrent.files
       files.each { |f| puts f.name }

data/lib/rtransmission/client.rb

@@ -14,14 +14,21 @@ module RTransmission
 
     attr_reader :session_id
 
-    def initialize(args = {}, &block)
+    def self.session(args = {}, &block)
+      client = RTransmission::Client.new(args)
+      session = RTransmission::Session.new(client)
+
+      block.call(session) if block
+
+      session
+    end
+
+    def initialize(args = {})
       @host = args[:host] || 'localhost'
       @port = args[:port] || 9091
       @path = args[:path] || '/transmission/rpc'
       @user = args[:user] || nil
       @password = args[:password] || nil
-
-      block.call(self) if block
     end
 
     def call(request)

data/lib/rtransmission/fields/day.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2011, Andrew Kirilenko <andrew.kirilenko@gmail.com>
+# All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be found in the COPYING file.
+
+module RTransmission
+  module Fields
+    class Day
+      MAP = {1 => :sunday, 2 => :monday, 4 => :tuesday, 8 => :wednesday, 16 => :thursday, 32 => :friday, 64 => :saturday}
+
+      def self.unmap(value)
+        result = []
+        MAP.each do |mask, day|
+          result << day if mask & value != 0
+        end
+
+        result
+      end
+
+      def self.map(value)
+        result = 0
+        value.each do |day|
+          result += MAP.key(day)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/rtransmission/fields/encryption.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2011, Andrew Kirilenko <andrew.kirilenko@gmail.com>
+# All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be found in the COPYING file.
+
+module RTransmission
+  module Fields
+    class Encryption
+      def self.unmap(value)
+        value.to_sym
+      end
+
+      def self.map(value)
+        value.to_s
+      end
+    end
+  end
+end

data/lib/rtransmission/fields/stats.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2011, Andrew Kirilenko <andrew.kirilenko@gmail.com>
+# All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be found in the COPYING file.
+
+module RTransmission
+  module Fields
+    class Stats < RTransmission::Field
+      define_attribute :active_torrent_count, 'activeTorrentCount'
+      define_attribute :download_speed, 'downloadSpeed'
+      define_attribute :paused_torrent_count, 'pausedTorrentCount'
+      define_attribute :torrent_count, 'torrentCount'
+      define_attribute :upload_speed, 'uploadSpeed'
+      define_attribute :cumulative_stats, 'cumulative-stats', :type => RTransmission::Fields::TrafficStats
+      define_attribute :current_stats, 'current-stats', :type => RTransmission::Fields::TrafficStats
+
+      def self.unmap(value)
+        RTransmission::Fields::Stats.new(value)
+      end
+    end
+  end
+end

data/lib/rtransmission/fields/traffic_stats.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2011, Andrew Kirilenko <andrew.kirilenko@gmail.com>
+# All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be found in the COPYING file.
+
+module RTransmission
+  module Fields
+    class TrafficStats < RTransmission::Field
+      define_attribute :uploaded_bytes, 'uploadedBytes'
+      define_attribute :downloaded_bytes, 'downloadedBytes'
+      define_attribute :files_added, 'filesAdded'
+      define_attribute :session_count, 'sessionCount'
+      define_attribute :seconds_active, 'secondsActive'
+
+      def self.unmap(value)
+        RTransmission::Fields::TrafficStats.new(value)
+      end
+    end
+  end
+end

data/lib/rtransmission/fields.rb

@@ -17,3 +17,7 @@ require 'rtransmission/fields/seed_ratio_mode'
 require 'rtransmission/fields/status'
 require 'rtransmission/fields/tracker'
 require 'rtransmission/fields/tracker_stat'
+require 'rtransmission/fields/day'
+require 'rtransmission/fields/encryption'
+require 'rtransmission/fields/traffic_stats'
+require 'rtransmission/fields/stats'

data/lib/rtransmission/session.rb

@@ -0,0 +1,127 @@
+# Copyright (c) 2011, Andrew Kirilenko <andrew.kirilenko@gmail.com>
+# All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be found in the COPYING file.
+
+module RTransmission
+  class Session
+    attr_reader :client
+
+    def self.define_field(name, rpc_name, args = {})
+      self.send :define_method, name.to_s do
+        request = RTransmission::Request.new('session-get', {}, 'Session.' + name.to_s) do |arguments|
+          result = arguments[rpc_name]
+          if args[:type]
+            type = args[:type]
+            if type.class == Array
+              type = type[0]
+              result.map! { |r| type.unmap(r) }
+            else
+              result = type.unmap(result)
+            end
+          end
+
+          result 
+        end
+
+        @client.call(request)
+      end
+
+      if args[:writeable] == true
+        self.send :define_method, name.to_s.gsub('?', '') + '=' do |value|
+          rpc_value = value
+          if args[:type]
+            type = args[:type]
+            if type.class == Array
+              type = type[0]
+              rpc_value.map! { |r| type.map(r) }
+            else
+              rpc_value = type.map(rpc_value)
+            end
+          end
+
+          request = RTransmission::Request.new('session-set', {rpc_name => rpc_value}, 'Session.' + name.to_s + '=') do
+            value
+          end
+
+          @client.call(request)
+        end
+      end
+    end
+
+    define_field :alt_speed_down, 'alt-speed-down', :writeable => true
+    define_field :alt_speed_enabled?, 'alt-speed-enabled', :writeable => true
+    define_field :alt_speed_time_begin, 'alt-speed-time-begin', :writeable => true
+    define_field :alt_speed_time_enabled?, 'alt-speed-time-enabled', :writeable => true
+    define_field :alt_speed_time_end, 'alt-speed-time-end', :writeable => true
+    define_field :alt_speed_time_day, 'alt-speed-time-day', :type => RTransmission::Fields::Day, :writeable => true
+    define_field :alt_speed_up, 'alt-speed-up', :writeable => true
+    define_field :blocklist_url, 'blocklist-url', :writeable => true
+    define_field :blocklist_enabled?, 'blocklist-enabled', :writeable => true
+    define_field :blocklist_size, 'blocklist-size'
+    define_field :cache_size_mb, 'cache-size-mb', :writeable => true
+    define_field :config_dir, 'config-dir'
+    define_field :download_dir, 'download-dir', :writeable => true
+    define_field :download_dir_free_space, 'download-dir-free-space'
+    define_field :dht_enabled?, 'dht-enabled', :writeable => true
+    define_field :encryption, 'encryption', :type => RTransmission::Fields::Encryption, :writeable => true
+    define_field :idle_seeding_limit, 'idle-seeding-limit', :writeable => true
+    define_field :idle_seeding_limit_enabled?, 'idle-seeding-limit-enabled', :writeable => true
+    define_field :incomplete_dir, 'incomplete-dir', :writeable => true
+    define_field :incomplete_dir_enabled?, 'incomplete-dir-enabled', :writeable => true
+    define_field :lpd_enabled?, 'lpd-enabled', :writeable => true
+    define_field :peer_limit_global, 'peer-limit-global', :writeable => true
+    define_field :peer_limit_per_torrent, 'peer-limit-per-torrent', :writeable => true
+    define_field :pex_enabled?, 'pex-enabled', :writeable => true
+    define_field :peer_port, 'peer-port', :writeable => true
+    define_field :peer_port_random_on_start?, 'peer-port-random-on-start', :writeable => true
+    define_field :port_forwarding_enabled?, 'port-forwarding-enabled', :writeable => true
+    define_field :rename_partial_files?, 'rename-partial-files', :writeable => true
+    define_field :rpc_version, 'rpc-version'
+    define_field :rpc_version_minimum, 'rpc-version-minimum'
+    define_field :script_torrent_done_filename, 'script-torrent-done-filename', :writeable => true
+    define_field :script_torrent_done_enabled?, 'script-torrent-done-enabled', :writeable => true
+    define_field :seed_ratio_limit, 'seedRatioLimit', :type => RTransmission::Fields::Percent, :writeable => true
+    define_field :seed_ratio_limited?, 'seedRatioLimited', :writeable => true
+    define_field :speed_limit_down, 'speed-limit-down', :writeable => true
+    define_field :speed_limit_down_enabled?, 'speed-limit-down-enabled', :writeable => true
+    define_field :speed_limit_up, 'speed-limit-up', :writeable => true
+    define_field :speed_limit_up_enabled?, 'speed-limit-up-enabled', :writeable => true
+    define_field :start_added_torrents?, 'start-added-torrents', :writeable => true
+    define_field :trash_original_torrent_files?, 'trash-original-torrent-files', :writeable => true
+    define_field :units, 'units' # FIXME: add type and writeable
+    define_field :utp_enabled?, 'utp-enabled', :writeable => true
+    define_field :version, 'version'
+
+    def initialize(client)
+      @client = client
+    end
+
+    def stats
+      request = RTransmission::Request.new('session-stats', {}, 'Session.stats') do |arguments|
+        RTransmission::Fields::Stats.unmap(arguments)
+      end
+
+      @client.call(request)
+    end
+
+    def blocklist_update
+      request = RTransmission::Request.new('blocklist-update', {}, 'Session.blocklist_update') do |arguments|
+        arguments['blocklist-size']
+      end
+
+      @client.call(request)
+    end
+
+    def port_test
+      request = RTransmission::Request.new('port-test', {}, 'Session.port_test') do |arguments|
+        arguments['port-is-open']
+      end
+
+      @client.call(request)
+    end
+
+    def shutdown
+      @client.call(RTransmission::Request.new('session-close', {}, 'Session.shutdown'))
+    end
+  end
+end

data/lib/rtransmission/torrent.rb

@@ -6,11 +6,12 @@ require 'base64'
 
 # FIXME: files-wanted/unwanted & prioriry-high/low/normal for both add and new torrents
 # FIXME: add/remove/replace trackers
+# FIXME: location set support
 module RTransmission
   class Torrent
     attr_reader :id
 
-    def self.add(client, args = {})
+    def self.add(session, args = {})
       pargs = {}
 
       raise RTransmission::Exception.new('Torrent#add: only one of remote_file, url, or torrent must be specified') if (args.keys & [:remote_file, :url, :torrent]).count != 1
@@ -22,26 +23,26 @@ module RTransmission
       pargs['download-dir'] = args[:download_dir] if args[:download_dir]
       pargs['paused'] = args[:paused] if args[:paused]
       pargs['peer-limit'] = args[:peer_limit] if args[:peer_limit]
-      pargs['bandwithPriority'] = args[:bandwith_priority] if args[:bandwith_priority] # FIXME: use field here
+      pargs['bandwidthPriority'] = RTransmission::Fields::Priority.map(args[:bandwidth_priority]) if args[:bandwidth_priority]
 
       request = RTransmission::Request.new('torrent-add', pargs, 'Torrent#add') do |arguments|
-        RTransmission::Torrent.new(client, arguments['torrent-added']['id'])
+        RTransmission::Torrent.new(session, arguments['torrent-added']['id'])
       end
 
-      client.call(request)
+      session.client.call(request)
     end
 
-    def self.list(client)
+    def self.list(session)
       request = RTransmission::Request.new('torrent-get', {'fields' => ['id']}, 'Torrent#list') do |arguments|
         torrents = []
         arguments['torrents'].each do |torrent|
-          torrents << RTransmission::Torrent.new(client, torrent['id'])
+          torrents << RTransmission::Torrent.new(session, torrent['id'])
         end
 
         torrents
       end
 
-      client.call(request)
+      session.client.call(request)
     end
 
     def self.define_field(name, rpc_name, args = {})
@@ -61,7 +62,7 @@ module RTransmission
           result 
         end
 
-        @client.call(request)
+        @session.client.call(request)
       end
 
       if args[:writeable] == true
@@ -81,7 +82,7 @@ module RTransmission
             value
           end
 
-          @client.call(request)
+          @session.client.call(request)
         end
       end
     end
@@ -151,25 +152,25 @@ module RTransmission
     define_field :webseeds, 'webseeds' # FIXME: add type
     define_field :webseeds_sending_to_us, 'webseedsSendingToUs'
 
-    def initialize(client, id)
-      @client = client
+    def initialize(session, id)
+      @session = session
       @id = id
     end
 
     def start
-      @client.call(RTransmission::Request.new('torrent-start', {'ids' => @id}, 'Torrent.start'))
+      @session.client.call(RTransmission::Request.new('torrent-start', {'ids' => @id}, 'Torrent.start'))
     end
 
     def stop
-      @client.call(RTransmission::Request.new('torrent-stop', {'ids' => @id}, 'Torrent.stop'))
+      @session.client.call(RTransmission::Request.new('torrent-stop', {'ids' => @id}, 'Torrent.stop'))
     end
 
     def verify
-      @client.call(RTransmission::Request.new('torrent-verify', {'ids' => @id}, 'Torrent.verify'))
+      @session.client.call(RTransmission::Request.new('torrent-verify', {'ids' => @id}, 'Torrent.verify'))
     end
 
     def reannounce
-      @client.call(RTransmission::Request.new('torrent-reannounce', {'ids' => @id}, 'Torrent.reannounce'))
+      @session.client.call(RTransmission::Request.new('torrent-reannounce', {'ids' => @id}, 'Torrent.reannounce'))
     end
 
     def remove(args = {})
@@ -177,7 +178,7 @@ module RTransmission
 
       pargs['delete-local-data'] = args[:delete_local_data] if args[:delete_local_data]
 
-      @client.call(RTransmission::Request.new('torrent-remove', {'ids' => @id}.merge(pargs), 'Torrent.remove'))
+      @session.client.call(RTransmission::Request.new('torrent-remove', {'ids' => @id}.merge(pargs), 'Torrent.remove'))
     end
 
     def move(args = {})
@@ -186,7 +187,7 @@ module RTransmission
       pargs['location'] = args[:location] if args[:location]
       pargs['move'] = args[:move] if args[:move]
 
-      @client.call(RTransmission::Request.new('torrent-set-location', {'ids' => @id}.merge(pargs), 'Torrent.move'))
+      @session.client.call(RTransmission::Request.new('torrent-set-location', {'ids' => @id}.merge(pargs), 'Torrent.move'))
     end
   end
 end

data/lib/rtransmission/version.rb

@@ -5,7 +5,7 @@
 module RTransmission
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
 
     STRING = [MAJOR, MINOR].join('.')
   end

data/lib/rtransmission.rb

@@ -4,9 +4,10 @@
 
 require 'rtransmission/version'
 require 'rtransmission/exception'
-require 'rtransmission/client'
 require 'rtransmission/request'
 require 'rtransmission/response'
 require 'rtransmission/field'
 require 'rtransmission/fields'
+require 'rtransmission/session'
 require 'rtransmission/torrent'
+require 'rtransmission/client'

metadata

@@ -2,7 +2,7 @@
 name: rtransmission
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Andrew Kirilenko
@@ -28,6 +28,7 @@ files:
 - rtransmission.gemspec
 - lib/rtransmission/fields.rb
 - lib/rtransmission/client.rb
+- lib/rtransmission/session.rb
 - lib/rtransmission/version.rb
 - lib/rtransmission/torrent.rb
 - lib/rtransmission/response.rb
@@ -36,8 +37,10 @@ files:
 - lib/rtransmission/fields/eta.rb
 - lib/rtransmission/fields/time.rb
 - lib/rtransmission/fields/tracker_stat.rb
+- lib/rtransmission/fields/encryption.rb
 - lib/rtransmission/fields/error.rb
 - lib/rtransmission/fields/tracker.rb
+- lib/rtransmission/fields/stats.rb
 - lib/rtransmission/fields/peers_from.rb
 - lib/rtransmission/fields/file_stat.rb
 - lib/rtransmission/fields/percent.rb
@@ -47,7 +50,9 @@ files:
 - lib/rtransmission/fields/seed_ratio_mode.rb
 - lib/rtransmission/fields/peer.rb
 - lib/rtransmission/fields/priority.rb
+- lib/rtransmission/fields/traffic_stats.rb
 - lib/rtransmission/fields/seed_idle_mode.rb
+- lib/rtransmission/fields/day.rb
 - lib/rtransmission/field.rb
 - lib/rtransmission.rb
 has_rdoc: true