rtorrent_xmlrpc 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e970b5dddb523638d1ea5f441ae458ecae5922aa
+  data.tar.gz: 68b65a6be40657e357d2f12165b278a8a84a6750
+SHA512:
+  metadata.gz: 3126a3f7e45654edafa139b673867e4b6413f955994597defc9269f14509a29c701a31b52cd6d8e954a74132111ee7ae8c449640c984e233a1c0a9057eea510f
+  data.tar.gz: c0fd3a6a085cf20e679faf37232a2a53a594dfff3d11639a4101f9f3bd86a352fffd0c148b01e80ddb844a9e725a5abda904a78d0ca05277b9dc2a3bc33195cd

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    rtorrent_xmlrpc (0.1)
+      colorize (~> 0.7, >= 0.7.7)
+      hashie (~> 3.4, >= 3.4.2)
+      thor (~> 0.19, >= 0.19.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.7.7)
+    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

data/Rakefile

@@ -0,0 +1,24 @@
+task :default => [:build]
+task :test => [:build, :install]
+
+task :build do
+  system("gem build ./rtorrent_xmlrpc.gemspec")
+end
+
+task :install do
+  gem = Dir['*.gem'].last
+  system("sudo gem install #{gem}")
+end
+
+task :push do
+  gem = Dir['*.gem'].last
+  system("gem push #{gem}")
+end
+
+task :console do
+  exec "irb -I ./lib"
+end
+
+task :run do
+  ruby "-Ilib", 'bin/rtorrent_xmlrpc'
+end

data/bin/rtorrent_xmlrpc

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'hashie'
+require 'rtorrent_xmlrpc'
+require 'thor'
+
+class RTorrent_XMLRPC < Thor
+
+  def initialize(*args)
+    super
+    # Read in config file
+    config_file = nil
+    %W[rtorrent_xmlrpc.conf #{Dir.home}/.config/rtorrent_xmlrpc.conf #{Dir.home}/.rtorrent_xmlrpc.conf /etc/rtorrent_xmlrpc.conf].each do |f|
+      if File.exists?(f)
+        config_file = f
+        break
+      end
+    end
+    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.connect
+    @xmlrpc.fetch_torrents
+  end
+
+  no_tasks do
+    def print(torrents)
+      torrents.each { |torrent| torrent.pp }
+    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
+  end
+
+  desc "stop HASH", "Stop torrent with HASH"
+  def stop(hash)
+    @xmlrpc.stop hash
+  end
+
+  desc "pause HASH", "Pause torrent with HASH"
+  def pause(hash)
+    @xmlrpc.pause hash
+  end
+
+  desc "complete", "Print all torrents that are complete."
+  def complete
+    self.print @xmlrpc.completed
+  end
+
+  desc "incomplete", "Print all incomplete torrents."
+  def incomplete
+    self.print @xmlrpc.incomplete
+  end
+
+  desc "labeled LABEL", "Print all torrents with label"
+  def labeled(label)
+    self.print @xmlrpc.with_label label
+  end
+
+end
+
+RTorrent_XMLRPC.start(ARGV)

data/lib/rtorrent_xmlrpc.rb

@@ -0,0 +1,139 @@
+require 'colorize'
+require 'hashie'
+require 'xmlrpc/client'
+
+module RTorrent
+
+  class Torrent
+    attr_accessor :hash, :name, :completed, :base_filename, :base_path, :is_multi_file, :tied_to_file
+    attr_reader :labels
+
+    def has_label(label)
+      @labels.include? label.to_s
+    end
+
+    def labels=(labels)
+      @labels = labels.split(',')
+    end
+
+    def to_h
+      {
+        hash: @hash,
+        name: @name,
+        labels: @labels,
+        completed: @completed,
+        base_filename: @base_filename,
+        base_path: @base_path,
+        is_multi_file: @is_multi_file,
+        tied_to_file: @tied_to_file,
+      }
+    end
+
+    def pp
+      puts "-------------- ".red
+      puts "         hash: ".blue + @hash.green
+      puts "         name: ".blue + @name.green
+      puts "       labels: ".blue + @labels.join(', ').green
+      puts "    completed: ".blue + @completed.to_s.green
+      puts "base_filename: ".blue + @base_filename.green
+      puts "    base_path: ".blue + @base_path.green
+      puts "is_multi_file: ".blue + @is_multi_file.to_s.green
+      puts " tied_to_file: ".blue + @tied_to_file.green
+    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 = []
+      @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=').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]
+        @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/rtorrent_xmlrpc.conf.sample

@@ -0,0 +1,9 @@
+---
+host: 'example.com'
+port: 443
+use_ssl: true
+path: '/xmlrpc'
+user: 'user'
+password: 'P@$$w0rd'
+
+# vim: filetype=yaml

data/rtorrent_xmlrpc.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'rtorrent_xmlrpc'
+  s.version     = '0.1'
+  s.date        = '2015-07-02'
+  s.summary     = 'A library and tool to query an rtorrent xmlrpc service.'
+  s.authors     = ['Zan Loy']
+  s.email       = 'zan.loy@gmail.com'
+  s.homepage    = 'http://zanloy.com/ruby/rtorrent_xmlrpc/'
+  s.license     = 'MIT'
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+  s.executables = ['rtorrent_xmlrpc']
+
+  s.add_dependency 'colorize', '~> 0.7', '>= 0.7.7'
+  s.add_dependency 'hashie', '~> 3.4', '>= 3.4.2'
+  s.add_dependency 'thor', '~> 0.19', '>= 0.19.1'
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rtorrent_xmlrpc
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Zan Loy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: 
+email: zan.loy@gmail.com
+executables:
+- rtorrent_xmlrpc
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/rtorrent_xmlrpc
+- lib/rtorrent_xmlrpc.rb
+- rtorrent_xmlrpc.conf.sample
+- rtorrent_xmlrpc.gemspec
+homepage: http://zanloy.com/ruby/rtorrent_xmlrpc/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A library and tool to query an rtorrent xmlrpc service.
+test_files: []