rtorrent_xmlrpc 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aec5bd8704d971c6eed048549bcb34ab77c1f203
-  data.tar.gz: dcb43f75567b59bb2d7527765f8466e2e19d7553
+  metadata.gz: 7c86aceddbf9e09b916268983bd63cf5a474cf77
+  data.tar.gz: df956f3f1c72817153881436aa1efe9bfb0218a2
 SHA512:
-  metadata.gz: 774572a3be0c2293acb2bf20808ebef6260f120905e1e36816b6bfa7cfe674c61274a806378af820984fa8912c8f80b809bdc4600b31f72ef29f9040f6ccc5fb
-  data.tar.gz: df05f889605f03f46efa6b4c739c2dd78c3cca46cbc55aa50bb570c2218897fc7c41be5db6cb5690c567a9940667d9303f467d1ca016555a7cb682bb52d3d23c
+  metadata.gz: 703f7b8e98876f2f64597f2bbf5cecc122afb70ff94c6f59e7e6316c385cdc2b7dbb3fbd85c30adea9563dffdd49280870f5fcf2dc09b7996fa2d6f5f7a8a0bd
+  data.tar.gz: bb82d0251aebab977ecdd49458d143b18c7f23c2e4191282fea4064f94a9f7d2895b5d7c1228d6db395bfa9d0be0c0da5569efdb33d1166df1777e1e6cb557f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rtorrent_xmlrpc (0.1)
+    rtorrent_xmlrpc (0.1.1)
       colorize (~> 0.7, >= 0.7.7)
       filesize (~> 0.1, >= 0.1.0)
       hashie (~> 3.4, >= 3.4.2)

data/bin/rtorrent_xmlrpc

@@ -19,7 +19,7 @@ class RTorrent_XMLRPC < Thor
     raise 'No config file found.' if config_file.nil?
     config = Hashie::Mash.load(config_file)
     # Connect to xmlrpc service
-    @xmlrpc = RTorrent::XMLRPC.new( host: config.host, port: config.port, path: config.path, user: config.user, password: config.password, use_ssl: config.use_ssl)
+    @xmlrpc = RTorrent::XMLRPC.new_from_hash(config.to_h)
     @xmlrpc.connect
     @xmlrpc.fetch_torrents
   end
@@ -65,6 +65,10 @@ class RTorrent_XMLRPC < Thor
     self.print @xmlrpc.with_label label
   end
 
+  desc "files HASH", "Print the torrent information with files."
+  def files(hash)
+    # TODO:
+  end
 end
 
 RTorrent_XMLRPC.start(ARGV)

data/lib/rtorrent_xmlrpc/torrent.rb

@@ -0,0 +1,125 @@
+require 'colorize'
+require 'filesize'
+require 'xmlrpc/client'
+
+module RTorrent
+
+  class Torrent
+
+    def initialize
+      @labels = []
+      @files= []
+    end
+
+    # Attributes
+    attr_accessor :base_filename, :base_path, :completed, :files, :hash, :is_multi_file, :name, :tied_to_file
+    attr_reader :down_total, :labels, :priority, :ratio, :size, :up_total
+
+    def down_total=(down_total) # :nodoc:
+      @down_total = Filesize.new(down_total)
+    end
+
+    def labels=(labels) # :nodoc:
+      @labels = labels.split(',')
+      @labels.map! { |label| label.chomp }
+    end
+
+    def labels_str
+      @labels.join(', ')
+    end
+
+    def priority=(priority) # :nodoc:
+      begin
+        @priority = priority.to_i
+      rescue
+        @priority = 2
+      end
+    end
+
+    # Return priority converted to a human readable string
+    def priority_str
+      case @priority
+      when 0
+        "Off"
+      when 1
+        "Low"
+      when 2
+        "Normal"
+      when 3
+        "High"
+      else
+        "Unknown"
+      end
+    end
+
+    def ratio=(ratio) # :nodoc:
+      begin
+        @ratio = ratio.to_f
+      rescue
+        @ratio = 0.0
+      end
+    end
+
+    def size=(size) # :nodoc:
+      @size = Filesize.new(size)
+    end
+
+    def up_total=(up_total) # :nodoc:
+      @up_total = Filesize.new(up_total)
+    end
+
+    # Return hash of all values in Torrent
+    def to_h
+      {
+        base_filename: @base_filename,
+        base_path: @base_path,
+        completed: @completed,
+        hash: @hash,
+        is_multi_file: @is_multi_file,
+        labels: @labels,
+        name: @name,
+        priority: @priority,
+        ratio: @ratio,
+        size: @size,
+        tied_to_file: @tied_to_file,
+      }
+    end
+
+    # Single line header
+    def self.header
+      "hash : name : size : down : up : ratio : labels"
+    end
+
+    # All torrent data in a single string for output to screen
+    def to_s
+      "#{self.hash} : #{self.name} : #{self.size.pretty} : #{self.down_total.pretty} : #{self.up_total.pretty} : #{self.ratio} : #{self.labels_str}"
+    end
+
+    # All torrent data dumped to screen in color
+    def pp(with_files = false)
+      puts "-------------- ".red
+      puts "         hash: ".blue + self.hash.green
+      puts "         name: ".blue + self.name.green
+      puts "         size: ".blue + self.size.pretty.green
+      puts "   downloaded: ".blue + self.down_total.pretty.green
+      puts "     uploaded: ".blue + self.up_total.pretty.green
+      puts "        ratio: ".blue + self.ratio.to_s.green
+      puts "     priority: ".blue + self.priority_str.green
+      puts "       labels: ".blue + self.labels_str.green
+      puts "    completed: ".blue + self.completed.to_s.green
+      if with_files
+        puts "        files: ".blue
+        @files.each { |file| puts "               " + file.green }
+      end
+    end
+
+    # FILTERS
+
+    # Test if torrent has a specific label
+    def has_label?(label)
+      @labels.include? label.to_s
+    end
+
+  end
+
+end

data/lib/rtorrent_xmlrpc/xmlrpc.rb

@@ -0,0 +1,140 @@
+require 'hashie'
+require 'rtorrent_xmlrpc/torrent'
+require 'xmlrpc/client'
+
+module RTorrent
+
+  class XMLRPC
+    attr_accessor :host, :user, :password, :path
+    attr_reader :port, :use_ssl, :server, :torrents
+
+    def initialize(host: 'localhost', port: nil, user: nil, password: nil, path: '/xmlrpc', use_ssl: false)
+      unless port
+        if use_ssl
+          port = 443
+        else
+          port = 80
+        end
+      end
+      self.host = host
+      self.port = port
+      self.user = user
+      self.password = password
+      self.path = path
+      self.use_ssl = use_ssl
+      @torrents = []
+      @status = :initialized
+    end
+
+    def self.new_from_hash(hash = {})
+      h = {}
+      hash.each { |k,v| h[k.to_s.downcase.to_sym] = v }
+      self.new(host: h[:host], port: h[:port], user: h[:user], password: h[:password], path: h[:path], use_ssl: h[:use_ssl])
+    end
+
+    def port=(port)
+      fail unless port.is_a? Integer
+      @port = port
+    end
+
+    def use_ssl=(use_ssl)
+      fail unless use_ssl.is_a?(TrueClass) || use_ssl.is_a?(FalseClass)
+      @use_ssl = use_ssl
+    end
+
+    # Connect to rtorrent xmlrpc service
+    def connect
+      connection_options = {
+        host: @host,
+        port: @port,
+        user: @user,
+        password: @password,
+        path: @path,
+        use_ssl: @use_ssl,
+      }
+      @server = ::XMLRPC::Client.new3(connection_options)
+      @status = :connected
+    end
+
+    # Grab list of torrents from server
+    def fetch_torrents
+      self.connect unless @status == :connected
+      @torrents = []
+      #@server.call('d.multicall', 'main', 'd.hash=').each do |result|
+      #  @torrents << RTorrent::Torrent.new(@server, result.first)
+      #end
+      args = [
+        'd.multicall',
+        'main',
+        'd.hash=',
+        'd.name=',
+        'd.custom1=',
+        'd.complete=',
+        'd.base_filename=',
+        'd.base_path=',
+        'd.is_multi_file=',
+        'd.tied_to_file=',
+        'd.get_size_bytes=',
+        'd.get_down_total=',
+        'd.get_up_total=',
+        'd.get_ratio=',
+        'd.get_priority=',
+      ]
+      @server.call(*args).each do |stats|
+        torrent = RTorrent::Torrent.new
+        torrent.hash = stats[0]
+        torrent.name = stats[1]
+        torrent.labels = stats[2]
+        torrent.completed = stats[3] == 1 ? true : false
+        torrent.base_filename = stats[4]
+        torrent.base_path = stats[5]
+        torrent.is_multi_file = stats[6] == 1 ? true: false
+        torrent.tied_to_file = stats[7]
+        torrent.size = stats[8]
+        torrent.down_total = stats[9]
+        torrent.up_total = stats[10]
+        torrent.ratio = stats[11].to_f / 1000
+        torrent.priority = stats[12]
+        torrent.files = @server.call('f.multicall', torrent.hash, '', 'f.get_path=').flatten
+        @torrents << torrent
+      end
+    end
+
+    # Start a torrent
+    def start(hash)
+      @server.call('d.start', hash)
+    end
+
+    # Stop a torrent
+    def stop(hash)
+      @server.call('d.close', hash)
+    end
+
+    # Pause a torrent
+    def pause(hash)
+      @server.call('d.stop', hash)
+    end
+
+    # Get a list of completed torrents
+    def completed
+      result = []
+      @torrents.each { |torrent| result << torrent if torrent.completed }
+      return result
+    end
+
+    # Get a list of incomplete torrents
+    def incomplete
+      result = []
+      @torrents.each { |torrent| result << torrent unless torrent.completed }
+      return result
+    end
+
+    # Get a list of torrents with label
+    def with_label(label)
+      result = []
+      @torrents.each { |torrent| result << torrent if torrent.has_label? label }
+      return result
+    end
+  end
+
+end

data/lib/rtorrent_xmlrpc.rb

@@ -1,234 +1 @@
-require 'colorize'
-require 'filesize'
-require 'hashie'
-require 'xmlrpc/client'
-
-module RTorrent
-
-  class Torrent
-
-    # Attributes
-    attr_accessor :hash, :name, :completed, :base_filename, :base_path, :is_multi_file, :tied_to_file
-    attr_reader :down_total, :labels, :priority, :ratio, :size, :up_total
-
-    def down_total=(down_total) # :nodoc:
-      @down_total = Filesize.new(down_total)
-    end
-
-    def labels=(labels) # :nodoc:
-      @labels = labels.split(',')
-      @labels.map! { |label| label.chomp }
-    end
-
-    def labels_str
-      @labels.join(', ')
-    end
-
-    def priority=(priority) # :nodoc:
-      begin
-        @priority = priority.to_i
-      rescue
-        @priority = 2
-      end
-    end
-
-    # Return priority converted to a human readable string
-    def priority_str
-      case @priority
-      when 0
-        "Off"
-      when 1
-        "Low"
-      when 2
-        "Normal"
-      when 3
-        "High"
-      else
-        "Unknown"
-      end
-    end
-
-    def ratio=(ratio) # :nodoc:
-      begin
-        @ratio = ratio.to_f
-      rescue
-        @ratio = 0.0
-      end
-    end
-
-    def size=(size) # :nodoc:
-      @size = Filesize.new(size)
-    end
-
-    def up_total=(up_total) # :nodoc:
-      @up_total = Filesize.new(up_total)
-    end
-
-    # Return hash of all values in Torrent
-    def to_h
-      {
-        base_filename: @base_filename,
-        base_path: @base_path,
-        completed: @completed,
-        hash: @hash,
-        is_multi_file: @is_multi_file,
-        labels: @labels,
-        name: @name,
-        priority: @priority,
-        ratio: @ratio,
-        size: @size,
-        tied_to_file: @tied_to_file,
-      }
-    end
-
-    # Single line header
-    def self.header
-      "hash : name : size : down : up : ratio : labels"
-    end
-
-    # All torrent data in a single string for output to screen
-    def to_s
-      "#{self.hash} : #{self.name} : #{self.size.pretty} : #{self.down_total.pretty} : #{self.up_total.pretty} : #{self.ratio} : #{self.labels_str}"
-    end
-
-    # All torrent data dumped to screen in color
-    def pp
-      puts "-------------- ".red
-      puts "         hash: ".blue + self.hash.green
-      puts "         name: ".blue + self.name.green
-      puts "         size: ".blue + self.size.pretty.green
-      puts "   downloaded: ".blue + self.down_total.pretty.green
-      puts "     uploaded: ".blue + self.up_total.pretty.green
-      puts "        ratio: ".blue + self.ratio.to_s.green
-      puts "     priority: ".blue + self.priority_str.green
-      puts "       labels: ".blue + self.labels_str.green
-      puts "    completed: ".blue + self.completed.to_s.green
-    end
-
-    # FILTERS
-
-    # Test if torrent has a specific label
-    def has_label?(label)
-      @labels.include? label.to_s
-    end
-
-  end
-
-  class XMLRPC
-    attr_accessor :host, :user, :password, :path
-    attr_reader :port, :use_ssl, :torrents
-
-    def initialize(host:, port: 80, user:, password:, path: '/xmlrpc', use_ssl: false)
-      self.host = host
-      self.port = port
-      self.user = user
-      self.password = password
-      self.path = path
-      self.use_ssl = use_ssl
-      @torrents = []
-      @status = :initialized
-    end
-
-    def port=(port)
-      fail unless port.is_a? Integer
-      @port = port
-    end
-
-    def use_ssl=(use_ssl)
-      fail unless use_ssl.is_a?(TrueClass) || use_ssl.is_a?(FalseClass)
-      @use_ssl = use_ssl
-    end
-
-    # Connect to rtorrent xmlrpc service
-    def connect
-      connection_options = {
-        host: @host,
-        port: @port,
-        user: @user,
-        password: @password,
-        path: @path,
-        use_ssl: @use_ssl,
-      }
-      @server = ::XMLRPC::Client.new3(connection_options)
-      @status = :connected
-    end
-
-    # Grab list of torrents from server
-    def fetch_torrents
-      self.connect unless @status == :connected
-      @torrents = []
-      args = [
-        'd.multicall',
-        'main',
-        'd.hash=',
-        'd.name=',
-        'd.custom1=',
-        'd.complete=',
-        'd.base_filename=',
-        'd.base_path=',
-        'd.is_multi_file=',
-        'd.tied_to_file=',
-        'd.get_size_bytes=',
-        'd.get_down_total=',
-        'd.get_up_total=',
-        'd.get_ratio=',
-        'd.get_priority=',
-      ]
-      #@server.call('d.multicall', 'main', 'd.hash=', 'd.name=', 'd.custom1=', 'd.complete=', 'd.base_filename=', 'd.base_path=', 'd.is_multi_file=', 'd.tied_to_file=', 'd.get_size').each do |stats|
-      @server.call(*args).each do |stats|
-        torrent = RTorrent::Torrent.new
-        torrent.hash = stats[0]
-        torrent.name = stats[1]
-        torrent.labels = stats[2]
-        torrent.completed = stats[3] == 1 ? true : false
-        torrent.base_filename = stats[4]
-        torrent.base_path = stats[5]
-        torrent.is_multi_file = stats[6] == 1 ? true: false
-        torrent.tied_to_file = stats[7]
-        torrent.size = stats[8]
-        torrent.down_total = stats[9]
-        torrent.up_total = stats[10]
-        torrent.ratio = stats[11].to_f / 1000
-        torrent.priority = stats[12]
-        @torrents << torrent
-      end
-    end
-
-    # Start a torrent
-    def start(hash)
-      @server.call('d.start', hash)
-    end
-
-    # Stop a torrent
-    def stop(hash)
-      @server.call('d.close', hash)
-    end
-
-    # Pause a torrent
-    def pause(hash)
-      @server.call('d.stop', hash)
-    end
-
-    # Get a list of completed torrents
-    def completed
-      result = []
-      @torrents.each { |torrent| result << torrent if torrent.completed }
-      return result
-    end
-
-    # Get a list of incomplete torrents
-    def incomplete
-      result = []
-      @torrents.each { |torrent| result << torrent unless torrent.completed }
-      return result
-    end
-
-    # Get a list of torrents with label
-    def with_label(label)
-      result = []
-      @torrents.each { |torrent| result << torrent if torrent.has_label? label }
-      return result
-    end
-  end
-
-end
+require 'rtorrent_xmlrpc/xmlrpc'