transmission-rpc-ruby-ext 0.1.0

data/lib/transmission/arguments/torrent_add.rb

@@ -0,0 +1,24 @@
+module Transmission
+  class Arguments
+    class TorrentAdd < Transmission::Arguments
+      ATTRIBUTES = [
+        { field: 'cookies' },
+        { field: 'download-dir' },
+        { field: 'filename' },
+        { field: 'metainfo' },
+        { field: 'paused' },
+        { field: 'peer-limit' },
+        { field: 'bandwidthPriority' },
+        { field: 'files-wanted' },
+        { field: 'files-unwanted' },
+        { field: 'priority-high' },
+        { field: 'priority-low' },
+        { field: 'priority-normal' }
+      ].freeze
+
+      REQUIRED = [
+        'filename metainfo'
+      ].freeze
+    end
+  end
+end

data/lib/transmission/arguments/torrent_set.rb

@@ -0,0 +1,32 @@
+module Transmission
+  class Arguments
+    class TorrentSet < Transmission::Arguments
+      ATTRIBUTES = [
+        { field: 'bandwidthPriority' },
+        { field: 'downloadLimit' },
+        { field: 'downloadLimited' },
+        { field: 'downloadLimit' },
+        { field: 'files-wanted' },
+        { field: 'files-unwanted' },
+        { field: 'honorsSessionLimits' },
+        { field: 'ids' },
+        { field: 'location' },
+        { field: 'peer-limit' },
+        { field: 'priority-high' },
+        { field: 'priority-low' },
+        { field: 'priority-normal' },
+        { field: 'queuePosition' },
+        { field: 'seedIdleLimit' },
+        { field: 'seedIdleMode' },
+        { field: 'seedRatioLimit' },
+        { field: 'seedRatioMode' },
+        { field: 'trackerAdd' },
+        { field: 'trackerRemove' },
+        { field: 'trackerReplace' },
+        { field: 'uploadLimit' },
+        { field: 'uploadLimited' },
+        { field: 'uploadLimit' }
+      ].freeze
+    end
+  end
+end

data/lib/transmission/config.rb

@@ -0,0 +1,18 @@
+module Transmission
+  class Config
+    class << self
+      def set(options = {})
+        @@config = options
+        @@connector = Transmission::RPC.new @@config
+      end
+
+      def get
+        @@config
+      end
+
+      def get_connector
+        @@connector
+      end
+    end
+  end
+end

data/lib/transmission/extensions.rb

@@ -0,0 +1,4 @@
+require_relative 'extensions/torrent_actions'
+require_relative 'extensions/torrent_attributes'
+require_relative 'extensions/torrent_status'
+require_relative 'extensions/transmission'

data/lib/transmission/extensions/torrent_actions.rb

@@ -0,0 +1,15 @@
+module Transmission
+  module Model
+    class Torrent
+      def remove!
+        connector.remove_torrent @ids
+        @deleted = true
+      end
+
+      def remove_data!
+        connector.remove_torrent @ids, true
+        @deleted = true
+      end
+    end
+  end
+end

data/lib/transmission/extensions/torrent_attributes.rb

@@ -0,0 +1,103 @@
+module Transmission
+  module Model
+    class Torrent
+      # torrent attributes methods
+      def name
+        attributes['name']
+      end
+
+      def path
+        dir = File.expand_path(attributes['downloadDir'])
+        File.join(dir, name)
+      end
+
+      def id
+        attributes['id']
+      end
+
+      def hash
+        attributes['hashString']
+      end
+
+      def length
+        attributes['totalSize']
+      end
+
+      def valid
+        attributes['haveValid']
+      end
+
+      def percent_downloaded
+        (attributes['haveValid'] * 1.0 / attributes['totalSize']).round(2)
+      end
+
+      def percent_uploaded
+        (attributes['uploadedEver'] * 1.0 / attributes['totalSize']).round(2)
+      end
+
+      def percent_ratio
+        session = Transmission::Model::Session.get
+        return unless session.seed_ratio_limited
+        (attributes['uploadRatio'] * 1.0 / session.seed_ratio_limit).round(2)
+      end
+
+      def speed_download
+        attributes['rateDownload']
+      end
+
+      def speed_upload
+        attributes['rateUpload']
+      end
+
+      def ratio
+        (attributes['uploadRatio'] * 1.0).round(2)
+      end
+
+      def eta
+        pretty_time(attributes['eta']) if attributes['eta'] > 0
+      end
+
+      def file?
+        name = attributes['name']
+        files = attributes['files']
+        files.size == 1 && files.first['name'] == name
+      end
+
+      def folder?
+        !file?
+      end
+
+      def files
+        dir = File.absolute_path(attributes['downloadDir'])
+        attributes['files'].map { |f| File.join(dir, f['name']) }
+      end
+
+      def content
+        files.map { |f| File.basename(f) }
+      end
+
+      def biggest
+        b = attributes['files'].max_by { |f| f['length'] }
+        [File.basename(b['name']), b['length']]
+      end
+
+      def smallest
+        b = attributes['files'].min_by { |f| f['length'] }
+        [File.basename(b['name']), b['length']]
+      end
+
+      def magnet
+        attributes['magnetLink']
+      end
+
+      def trackers
+        url_regex = /([-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b)(?:[-a-zA-Z0-9@:%_\+.~#?&\/=]*)/i
+        attributes['trackers'].map do |r|
+          if (a = r['announce'].match(url_regex))
+            a[1]
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/transmission/extensions/torrent_status.rb

@@ -0,0 +1,42 @@
+module Transmission
+  module Model
+    class Torrent
+      # torrent status methods
+      def paused?
+        attributes['status'] == 0
+      end
+
+      def queued?
+        attributes['status'] == 3
+      end
+
+      def downloading?
+        attributes['status'] == 4
+      end
+
+      def seeding?
+        attributes['status'] == 6
+      end
+
+      def isolated?
+        attributes['status'] == 7
+      end
+
+      def finished?
+        attributes['isFinished']
+      end
+
+      def completed?
+        attributes['percentDone'] >= 1
+      end
+
+      def incomplete?
+        attributes['percentDone'] < 1
+      end
+
+      def error?
+        attributes['error'] != 0
+      end
+    end
+  end
+end

data/lib/transmission/extensions/transmission.rb

@@ -0,0 +1,82 @@
+module Transmission
+  # list torrents methods
+  def self.all(connector = nil)
+    t = Transmission::Model::Torrent.all connector: connector
+    case t.ids.size
+    when 0 then Array([])
+    when 1 then Array(t)
+    else Array(t.torrents)
+    end
+  end
+
+  def self.finished
+    all.select { |t| t.attributes['isFinished'] }
+  end
+
+  def self.completed
+    all.select { |t| t.attributes['percentDone'] >= 1 }
+  end
+
+  def self.incomplete
+    all.select { |t| t.attributes['percentDone'] < 1 }
+  end
+
+  def self.paused
+    all.select { |t| t.attributes['status'] == 0 }
+  end
+
+  def self.queued
+    all.select { |t| t.attributes['status'] == 3 }
+  end
+
+  def self.downloading
+    all.select { |t| t.attributes['status'] == 4 }
+  end
+
+  def self.seeding
+    all.select { |t| t.attributes['status'] == 6 }
+  end
+
+  def self.error
+    all.select { |t| t.attributes['error'] != 0 }
+  end
+
+  def self.hashes
+    all.map { |t| t.attributes['hashString'] }
+  end
+
+  # find torrents methods
+  def self.find_by_name(name)
+    re = name.split(' ').join('.*')
+    all.select { |t| t.attributes['name'] =~ /#{re}/i }
+  end
+
+  def self.find_by_hash(hash)
+    all.select { |t| t.attributes['hashString'].casecmp(hash) == 0 }
+  end
+
+  def self.find_by_id(id)
+    all.select { |t| t.attributes['id'] == id }
+  end
+
+  def self.find_by_tracker(tracker)
+    url_regex = /([-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b)(?:[-a-zA-Z0-9@:%_\+.~#?&\/=]*)/i
+    re = tracker.split(' ').join('.*')
+    all.select do |t|
+      trackers = t.attributes['trackers'].map do |r|
+        if (a = r['announce'].match(url_regex))
+          a[1]
+        end
+      end
+      trackers.any? { |r| r =~ /#{re}/i }
+    end
+  end
+
+  # add torrents methods
+  def self.add(file, connector = nil)
+    Transmission::Model::Torrent.add(
+      connector: connector,
+      arguments: { filename: file }
+    )
+  end
+end

data/lib/transmission/fields.rb

@@ -0,0 +1,41 @@
+require_relative 'fields/torrent_get'
+require_relative 'fields/session_get'
+require_relative 'fields/session_stats'
+require_relative 'utils'
+
+module Transmission
+  class Fields
+    class InvalidField < StandardError; end
+
+    attr_accessor :fields
+
+    ATTRIBUTES = []
+
+    def initialize(fields = nil)
+      @fields = fields.inject([]) do |fields, field|
+        found = self.class::ATTRIBUTES.select { |attr| attr[:field] == field }
+        raise Transmission::Fields::InvalidField, field if found.empty?
+        fields << field
+      end if fields
+      @fields = self.class::ATTRIBUTES.collect do |key|
+        key[:field]
+      end if fields.nil?
+    end
+
+    def to_fields
+      @fields
+    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
+    end
+  end
+end

data/lib/transmission/fields/session_get.rb

@@ -0,0 +1,61 @@
+module Transmission
+  class Fields
+    class SessionGet < Transmission::Fields
+      ATTRIBUTES = [
+        { 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: 'blocklist-size' },
+        { field: 'cache-size-mb' },
+        { field: 'config-dir' },
+        { 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: 'rpc-version' },
+        { field: 'rpc-version-minimum' },
+        { 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' },
+        { field: 'version' }
+      ].freeze
+    end
+  end
+end

data/lib/transmission/fields/session_stats.rb

@@ -0,0 +1,15 @@
+module Transmission
+  class Fields
+    class SessionStats < Transmission::Fields
+      ATTRIBUTES = [
+        { field: 'activeTorrentCount' },
+        { field: 'downloadSpeed' },
+        { field: 'pausedTorrentCount' },
+        { field: 'torrentCount' },
+        { field: 'uploadSpeed' },
+        { field: 'cumulative-stats' },
+        { field: 'current-stats' }
+      ].freeze
+    end
+  end
+end