rtorrent_xmlrpc 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daca72ab047033fdbdb755df64975cbf3ec9fb83
-  data.tar.gz: 19f9811596b204dbef819081946ccd98d15044f2
+  metadata.gz: 2f0bfd0edd180624bed08aa55707e4c47c065b0b
+  data.tar.gz: 09d7015d51db1581c6215eeb91c2bd44cf04b58d
 SHA512:
-  metadata.gz: 7444dae6f5fa0678b77b5937cfb08f137037a7658975f5abcf04749d197a0e42ff7e66152c6ae93cc9b35cab40273b52d85cdc6c6096111347ee89636df8a4bd
-  data.tar.gz: b2b992429973f84dfcc44fed4a7579627134571c91d476797014ed8f45a6995ec5eb4208e4dbd4508d63a92752ef3ab1d94ca99165f8228ce6ee6969506cf9be
+  metadata.gz: 8d1a568e51254c94817b3893855982876241d6e5c3a20cd0ef55a47bdb03abfec86a15ccaed94626408fbed0481eb17fe818e22c9ef21ee665ba43b19b3bd4c5
+  data.tar.gz: 720660e8abf7a30f9c4396c210d9ac65af71f739f58fec5435a4e09d528e1ab54dbee694393ee898f81cbf0c3ad599288a26ae9f166f20f7b36184fe4ca513a9

data/Gemfile

@@ -1,5 +1,3 @@
 source 'https://rubygems.org/'
 
-gem 'rake', '~> 10.4', '>= 10.4.2'
-
 gemspec

data/README.md

@@ -0,0 +1,11 @@
+# rtorrent_xmlrpc
+
+**I seriously recommend you do NOT use this library until it has a v1.0
+release. I am constantly changing things in it that will break functionality.**
+
+This is a simple ruby library designed to pull basic information about torrents
+from a remote rtorrent server using xmlrpc. It is not designed have complete
+coverage of all features and methods provided by the xmlrpc interface. It is
+only designed to have enough to manage your torrents from scripts. Included in
+this gem is a binary that provides some basic functionality from the command
+line in case you need to use it from non-ruby scripts.

data/Rakefile

@@ -16,7 +16,23 @@ task :push do
 end
 
 task :console do
-  exec "irb -I ./lib"
+  require 'hashie'
+  require 'pry'
+  require 'rtorrent_xmlrpc'
+
+  def load_xmlrpc
+    config = Hashie::Mash.load(File.expand_path('~/.config/rtorrent_xmlrpc.conf'))
+    RTorrent::XMLRPC.new_from_hash(config)
+  end
+
+  def reload!
+    # Change 'gem_name' here too:
+    files = $LOADED_FEATURES.select { |feat| feat =~ /\/rtorrent_xmlrpc\// }
+    files.each { |file| load file }
+  end
+
+  ARGV.clear
+  Pry.start
 end
 
 task :run do

data/bin/rtorrent_xmlrpc

@@ -7,8 +7,6 @@ require 'thor'
 
 class RTorrent_XMLRPC < Thor
 
-  class_option '--json', type: :boolean
-
   def initialize(*args)
     super
     # Read in config file
@@ -23,25 +21,28 @@ class RTorrent_XMLRPC < Thor
     config = Hashie::Mash.load(config_file)
     # Connect to xmlrpc service
     @xmlrpc = RTorrent::XMLRPC.new_from_hash(config.to_h)
-    @xmlrpc.connect
-    @xmlrpc.fetch_torrents
   end
 
-  no_tasks do
-    def print(torrents)
-      if options[:json]
-        puts torrents.to_json
-      else
-        torrents.each { |torrent| torrent.pp(true) }
-      end
+  desc "print", "Print the torrent information"
+  option :any, aliases: '-a', type: :array
+  option :complete, aliases: '-c', type: :boolean
+  option :files, aliases: '-f', type: :boolean
+  option :incomplete, aliases: '-i', type: :boolean
+  option :json, aliases: '-j', type: :boolean
+  option :labels, aliases: '-l', type: :array
+  def print
+    torrents = @xmlrpc.torrents
+    torrents = torrents.complete if options[:complete]
+    torrents = torrents.incomplete if options[:incomplete]
+    torrents = torrents.with_labels options[:labels] if options[:labels]
+    torrents = torrents.with_any_labels options[:any] if options[:any]
+    if options[:json]
+      puts torrents.to_json
+    else
+      torrents.each { |hash, torrent| torrent.pp(options[:files]) }
     end
   end
 
-  desc "list", "Pretty print all the torrents on the server."
-  def list
-    self.print @xmlrpc.torrents
-  end
-
   desc "start HASH", "Start torrent with HASH"
   def start(hash)
     @xmlrpc.start hash
@@ -57,25 +58,21 @@ class RTorrent_XMLRPC < Thor
     @xmlrpc.pause hash
   end
 
-  desc "complete", "Print all torrents that are complete."
-  def complete
-    self.print @xmlrpc.torrents.completed
+  desc "add_labels HASH LABELS", "Add labels to torrent identified by HASH"
+  def add_labels(hash, *labels)
+    @xmlrpc.add_labels(hash, labels)
   end
 
-  desc "incomplete", "Print all incomplete torrents."
-  def incomplete
-    self.print @xmlrpc.incomplete
+  desc "remove_labels HASH LABELS", "Remove labels from torrent identified by HASH"
+  def remove_labels(hash, *labels)
+    @xmlrpc.remove_labels(hash, labels)
   end
 
-  desc "labeled LABEL", "Print all torrents with label"
-  def labeled(label)
-    self.print @xmlrpc.torrents.with_label label
+  desc "set_labels HASH LABELS", "Label the torrent identified by HASH with LABELS"
+  def set_labels(hash, *labels)
+    @xmlrpc.set_labels(hash, labels)
   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

@@ -7,26 +7,41 @@ module RTorrent
 
   class Torrent
 
+    PRIORITIES = ['Off', 'Low', 'Normal', 'High']
+    PRIORITY_OFF = 0
+    PRIORITY_LOW = 1
+    PRIORITY_NORMAL = 2
+    PRIORITY_HIGH = 3
+
     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
+    attr_accessor :base_filename, :base_path, :completed, :down_total, :files, :hash, :is_multi_file, :name, :size, :tied_to_file, :up_total
+    attr_reader :labels, :priority, :ratio
 
     def completed?
       self.completed
     end
 
-    def down_total=(down_total) # :nodoc:
-      @down_total = Filesize.new(down_total)
+    def add_labels(labels)
+      labels = Array(labels)
+      labels.map!(&:strip)
+      self.labels = @labels | labels
+    end
+
+    def remove_labels(labels)
+      labels = Array(labels)
+      labels.map!(&:strip)
+      self.labels = @labels - labels
     end
 
     def labels=(labels) # :nodoc:
-      @labels = labels.split(',')
-      @labels.map! { |label| label.chomp }
+      labels = labels.split(',') if labels.is_a? String
+      labels.map!(&:strip)
+      @labels = labels
     end
 
     def labels_str
@@ -43,34 +58,11 @@ module RTorrent
 
     # 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
+      PRIORITIES[@priority]
     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)
+      @ratio = ratio.to_f
     end
 
     # Return hash of all values in Torrent
@@ -98,19 +90,20 @@ module RTorrent
 
     # 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
+      i = 12
+      puts ("-" * i).red
+      puts "%s %s" % ['hash:'.rjust(i).blue, self.hash.green]
+      puts "%s %s" % ['name:'.rjust(i).blue, self.name.green]
+      puts "%s %s" % ['size:'.rjust(i).blue, Filesize.new(self.size).pretty.green]
+      puts "%s %s" % ['downloaded:'.rjust(i).blue, Filesize.new(self.down_total).pretty.green]
+      puts "%s %s" % ['uploaded:'.rjust(i).blue, Filesize.new(self.up_total).pretty.green]
+      puts "%s %s" % ['ratio:'.rjust(i).blue, self.ratio.to_s.green]
+      puts "%s %s" % ['priority:'.rjust(i).blue, self.priority_str.green]
+      puts "%s %s" % ['labels:'.rjust(i).blue, self.labels_str.green]
+      puts "%s %s" % ['completed:'.rjust(i).blue, self.completed.to_s.green]
       if with_files
-        puts "        files: ".blue
-        @files.each { |file| puts "               " + file.green }
+        puts "%s %s" % ['files:'.rjust(i).blue, @files.first.green]
+        @files.each { |file| puts "%s %s" % [' ' * i, file.green] unless file == @files.first }
       end
     end
 
@@ -121,6 +114,11 @@ module RTorrent
       @labels.include? label.to_s
     end
 
+    # Test if torrent has any of the labels
+    def has_any_labels?(labels)
+      ! (@labels & labels).empty?
+    end
+
   end
 
 end

data/lib/rtorrent_xmlrpc/torrents.rb

@@ -1,20 +1,33 @@
 module RTorrent
 
-  class Torrents < Array
+  class Torrents < Hash
+
     def completed
       result = Torrents.new
-      self.each do |torrent|
-        result << torrent if torrent.completed?
+      self.each do |hash, torrent|
+        result[torrent.hash] = torrent if torrent.completed?
+      end
+      return result
+    end
+
+    def with_labels(labels)
+      labels = [labels] unless labels.is_a? Array
+      result = Torrents.new
+      self.each do |hash, torrent|
+        result[torrent.hash] = torrent if torrent.has_labels? labels
       end
       return result
     end
-    def with_label(label)
+
+    def with_any_labels(labels)
+      labels = [labels] unless labels.is_a? Array
       result = Torrents.new
-      self.each do |torrent|
-        result << torrent if torrent.has_label? label
+      self.each do |hash, torrent|
+        result[torrent.hash] = torrent if torrent.has_any_labels? labels
       end
       return result
     end
+
   end
 
 end

data/lib/rtorrent_xmlrpc/xmlrpc.rb

@@ -1,4 +1,3 @@
-require 'hashie'
 require 'rtorrent_xmlrpc/torrent'
 require 'rtorrent_xmlrpc/torrents'
 require 'xmlrpc/client'
@@ -6,8 +5,8 @@ require 'xmlrpc/client'
 module RTorrent
 
   class XMLRPC
-    attr_accessor :host, :user, :password, :path
-    attr_reader :port, :use_ssl, :server, :torrents
+    attr_accessor :host, :user, :password, :path, :port
+    attr_reader :connection_options, :use_ssl, :server, :torrents
 
     def initialize(host: 'localhost', port: nil, user: nil, password: nil, path: '/xmlrpc', use_ssl: false)
       unless port
@@ -25,6 +24,8 @@ module RTorrent
       self.use_ssl = use_ssl
       @torrents = Torrents.new
       @status = :initialized
+      connect
+      fetch_torrents
     end
 
     def self.new_from_hash(hash = {})
@@ -33,18 +34,14 @@ module RTorrent
       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)
+      fail "use_ssl must be a boolean value" unless use_ssl.is_a?(TrueClass) || use_ssl.is_a?(FalseClass)
       @use_ssl = use_ssl
     end
 
     # Connect to rtorrent xmlrpc service
     def connect
+      return true if @status == :connected
       connection_options = {
         host: @host,
         port: @port,
@@ -57,6 +54,12 @@ module RTorrent
       @status = :connected
     end
 
+    # Disconnect from xmlrpc service
+    def disconnect
+      @server = nil
+      @status = :disconnected
+    end
+
     # Grab list of torrents from server
     def fetch_torrents
       self.connect unless @status == :connected
@@ -84,8 +87,8 @@ module RTorrent
         torrent.name = stats[1]
         torrent.labels = stats[2]
         torrent.completed = stats[3] == 1 ? true : false
-        torrent.base_filename = stats[4].gsub(/^#{@trim_suffix}/, '')
-        torrent.base_path = stats[5].gsub(/^#{@trim_suffix}/, '')
+        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]
@@ -93,8 +96,8 @@ module RTorrent
         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.map { |file| file.gsub(/^#{@trim_suffix}/, '') }
-        @torrents << torrent
+        torrent.files = @server.call('f.multicall', torrent.hash, '', 'f.get_path=').flatten
+        @torrents[torrent.hash] = torrent
       end
     end
 
@@ -113,9 +116,23 @@ module RTorrent
       @server.call('d.stop', hash)
     end
 
+    # Add labels to torrent
+    def add_labels(hash, labels)
+      self.torrents[hash].add_labels(labels)
+      @server.call('d.set_custom1', hash, self.torrents[hash].labels_str)
+    end
+
+    # Remove labels from torrent
+    def remove_labels(hash, labels)
+      self.torrents[hash].remove_labels(labels)
+      @server.call('d.set_custom1', hash, self.torrents[hash].labels_str)
+    end
+
     # Set the custom1 (label) field for a torrent
     def set_labels(hash, labels)
-      @server.call('d.set_custom1', hash, labels)
+      labels = [labels] unless labels.is_a? Array
+      @server.call('d.set_custom1', hash, labels.join(', '))
+      self.torrents[hash].labels = labels
     end
   end
 

data/rtorrent_xmlrpc.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'rtorrent_xmlrpc'
-  s.version     = '0.2.2'
-  s.date        = '2015-07-03'
+  s.version     = '0.2.3'
+  s.date        = '2015-07-04'
   s.summary     = 'A library and tool to query an rtorrent xmlrpc service.'
   s.description = 'This is a library to get torrent information from a remote rtorrent server.'
   s.authors     = ['Zan Loy']
@@ -16,4 +16,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'filesize', '~> 0.1', '>= 0.1.0'
   s.add_dependency 'thor', '~> 0.19', '>= 0.19.1'
 
+  s.add_development_dependency 'awesome_print', '~> 1.6', '>= 1.6.1'
+  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.1'
+  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtorrent_xmlrpc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Zan Loy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -90,6 +90,66 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 description: This is a library to get torrent information from a remote rtorrent server.
 email: zan.loy@gmail.com
 executables:
@@ -98,14 +158,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
+- README.md
 - Rakefile
 - bin/rtorrent_xmlrpc
 - lib/rtorrent_xmlrpc.rb
 - lib/rtorrent_xmlrpc/torrent.rb
 - lib/rtorrent_xmlrpc/torrents.rb
 - lib/rtorrent_xmlrpc/xmlrpc.rb
-- methods.txt
 - rtorrent_xmlrpc.conf.sample
 - rtorrent_xmlrpc.gemspec
 homepage: http://zanloy.com/ruby/rtorrent_xmlrpc/

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rtorrent_xmlrpc (0.2.1)
-      colorize (~> 0.7, >= 0.7.7)
-      filesize (~> 0.1, >= 0.1.0)
-      hashie (~> 3.4, >= 3.4.2)
-      thor (~> 0.19, >= 0.19.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    colorize (0.7.7)
-    filesize (0.1.0)
-    hashie (3.4.2)
-    rake (10.4.2)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 10.4, >= 10.4.2)
-  rtorrent_xmlrpc!
-
-BUNDLED WITH
-   1.10.5