remotransmission 0.0.1

data/bin/remotransmission

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+# RemoTransmission command line interface to control
+# a remote transmission client.
+#
+# Examples:
+#   $ remotransmission -p PaSsWord --add 'magnet://...'
+#   success
+#   $ remotransmission -p PaSsWord --server 214.512.12.20 --port 9092 --list
+#   100% - ubuntu-10.10-desktop-i386.iso
+#   100% - ubuntu-10.10-server-i386.iso
+
+
+require 'remotransmission'
+
+Choice.options do
+  header ""
+  header 'Commands:'
+  option :add do
+    short '-a'
+    long '--add=URL'
+    desc 'Add a torrent by its URL'
+  end
+
+  option :list do
+    short '-l'
+    long '--list'
+    desc "List current torrents"
+  end
+
+  option :help do
+    #short '-h'
+    long '--help'
+    desc 'Show this message'
+  end
+
+  option :version do
+    long '--version'
+    desc 'Show version'
+    action do
+      puts "RemoTransmission #{RemoTransmission::Version::STRING}"
+      exit
+    end
+  end
+
+  separator ""
+  separator 'Common options:'
+  option :host do
+    short '-s'
+    long '--server=IP'
+    desc 'The hostname or ip of the host to bind to (default 192.168.0.254)'
+    default '192.168.0.254'
+  end
+
+  option :port do
+    long '--port=PORT'
+    desc 'The port to bind to (default 9091)'
+    cast Integer
+    default 9091
+  end
+
+  option :user do
+    short '-u'
+    long '--user=USER'
+    desc 'User to authenticate (default freebox)'
+    default 'freebox'
+  end
+
+  option :password do
+    short '-p'
+    long '--password=PASSWORD'
+    desc 'Password to authenticate'
+  end
+
+  option :debug do
+    short '-d'
+    long '--debug'
+    desc 'Enable debug mode'
+  end
+
+  separator ""
+  separator "Examples:"
+  separator "    $ #{File.basename($0)} -p PaSsWord --add 'magnet://...'"
+  separator "    success"
+  separator "    $ #{File.basename($0)} -p PaSsWord --server 214.512.12.20 --port 9092 --list"
+  separator "    100% - ubuntu-10.10-desktop-i386.iso"
+  separator "    100% - ubuntu-10.10-server-i386.iso"
+end
+
+
+client = RemoTransmission::Client.new(
+  Choice[:host],
+  Choice[:port],
+  Choice[:user],
+  Choice[:password],
+  Choice[:debug]
+)
+
+if Choice[:add]
+  client.add(Choice[:add])
+elsif Choice[:list]
+  client.list
+else
+  Choice.help
+end

data/lib/remotransmission/client.rb

@@ -0,0 +1,110 @@
+# The main Remote Transmission driver
+class RemoTransmission::Client
+  # Initialize a remote transmission
+  #
+  # Arguments:
+  #   host: host to connect to (String)
+  #   port: port to connect to (Integer)
+  #   user: username to authenticate to (String)
+  #   password: password to authenticate to (String)
+  #   debug: flag to turn on debugging (Integer)
+  def initialize(host = "localhost", port = 9091, user = "", password = "", debug = false)
+    @host = host
+    @port = port
+    @user = user
+    @password = password
+    @debug = debug
+  end
+
+  # Add a torrent to the transmission client
+  # and prints output.
+  #
+  # Arguments:
+  #   url: magnet URL or URL of torrent file
+  #
+  # Example:
+  #   >> transmission.add("magnet://..."")
+  #   success
+  def add(url)
+    add = rpc(
+      method: "torrent-add",
+      tag: 8,
+      arguments: {
+        filename: url,
+      }
+    )
+    result = add["result"]
+    puts result
+  end
+
+  # Prints all active torrents
+  #
+  # Example:
+  #   >> transmission.list
+  #   100% - ubuntu-10.10-desktop-i386.iso
+  #   100% - ubuntu-10.10-server-i386.iso
+  def list
+    list = rpc(
+      method: "torrent-get",
+      tag: 4,
+      arguments: {
+        #fields: ["error","errorString","eta","id","isFinished","leftUntilDone","name","peersGettingFromUs","peersSendingToUs","rateDownload","rateUpload","sizeWhenDone","status","uploadRatio"],
+        fields: ["isFinished","leftUntilDone","sizeWhenDone", "name"],
+      }
+    )
+
+    args = list["arguments"]
+    torrents = args["torrents"]
+    torrents.each do |torrent|
+      left = torrent["leftUntilDone"].to_f
+      size = torrent["sizeWhenDone"].to_f
+      pourcent = size != 0 ? ((size-left)*100/size).floor : "?"
+      puts "#{pourcent}% - #{torrent["name"]}"
+    end
+  end
+
+  private
+
+    def command(*cmd)
+      debug *cmd
+      exit_status = nil
+      err = nil
+      out = nil
+
+      Open3.popen3(*cmd) do |stdin, stdout, stderr, wait_thread|
+        err = stderr.gets(nil)
+        out = stdout.gets(nil)
+        [stdin, stdout, stderr].each { |stream|
+          stream.send('close')
+        }
+        exit_status = wait_thread.value
+      end
+
+      if exit_status.to_i > 0
+        err = err.chomp if err
+        raise ShellError, err
+      elsif out
+        out.chomp
+      else
+        true
+      end
+    end
+
+    def rpc(options = {})
+      default_options = { arguments: { fields: ["error","errorString","eta","id","isFinished","leftUntilDone","name","peersGettingFromUs","peersSendingToUs","rateDownload","rateUpload","sizeWhenDone","status","uploadRatio"] }, tag: 4 }
+      options = default_options.merge(options).to_json
+
+      curl = command("curl -fsS -u #{@user}:#{@password} -d '#{options}' http://#{@host}:#{@port}/transmission/rpc")
+      json = JSON.parse(curl)
+      debug(json)
+      json
+    rescue ShellError => e
+      puts e.message
+      exit 1
+    end
+
+    def debug(*obj)
+      puts *obj if @debug
+    end
+end
+

data/lib/remotransmission/version.rb

@@ -0,0 +1,8 @@
+module RemoTransmission
+  module Version #:nodoc:
+    MAJOR  = 0
+    MINOR  = 0
+    TINY   = 1
+    STRING = [MAJOR, MINOR, TINY] * '.'
+  end
+end

data/lib/remotransmission.rb

@@ -0,0 +1,11 @@
+require 'choice'
+require 'json'
+require 'open3'
+
+module RemoTransmission
+  # :nodoc:
+  class ShellError < StandardError; end
+end
+
+require 'remotransmission/client'
+require 'remotransmission/version'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: remotransmission
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-24 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: &77320450 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77320450
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &77320180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77320180
+description: A gem that can talk to remote Transmission demons
+email: sunny@sunfox.org
+executables:
+- remotransmission
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/remotransmission.rb
+- lib/remotransmission/client.rb
+- lib/remotransmission/version.rb
+- bin/remotransmission
+has_rdoc: true
+homepage: http://github.com/sunny/remotransmission
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Curl command line
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Remote Transmission
+test_files: []