remotransmission 0.0.2 → 1.0.0

data/bin/remotransmission

@@ -1,17 +1,12 @@
 #!/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 'choice'
 require 'remotransmission'
 
+defaults = RemoTransmission::default_options("~/.config/remotransmission/settings.json")
+
 Choice.options do
   header ""
   header 'Commands:'
@@ -28,7 +23,6 @@ Choice.options do
   end
 
   option :help do
-    #short '-h'
     long '--help'
     desc 'Show this message'
   end
@@ -45,55 +39,58 @@ Choice.options do
   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'
+    long '--host=IP'
+    desc "The hostname or ip of the server to connect to (default #{defaults[:host].inspect})"
+    default defaults[:host]
   end
 
   option :port do
     long '--port=PORT'
-    desc 'The port to bind to (default 9091)'
+    desc "The port to bind to (default #{defaults[:port].inspect})"
     cast Integer
-    default 9091
+    default defaults[:port]
   end
 
   option :user do
     short '-u'
     long '--user=USER'
-    desc 'User to authenticate (default freebox)'
+    desc "User to authenticate (default #{defaults[:user].inspect})"
     default 'freebox'
+    default defaults[:user]
   end
 
   option :password do
     short '-p'
     long '--password=PASSWORD'
-    desc 'Password to authenticate'
+    desc "Password to authenticate"
+    default defaults[:password]
   end
 
   option :debug do
     short '-d'
     long '--debug'
-    desc 'Enable debug mode'
+    desc "Enable debug mode (default #{defaults[:debug].inspect})"
+    default defaults[:debug]
   end
 
   separator ""
   separator "Examples:"
-  separator "    $ #{File.basename($0)} -p PaSsWord --add 'magnet://...'"
+  separator "    $ #{File.basename($0)} --add 'magnet://...'"
   separator "    success"
-  separator "    $ #{File.basename($0)} -p PaSsWord --server 214.512.12.20 --port 9092 --list"
+  separator "    $ #{File.basename($0)} -p PaSsWord --host 192.168.0.254 --list"
   separator "    100% - ubuntu-10.10-desktop-i386.iso"
   separator "    100% - ubuntu-10.10-server-i386.iso"
 end
 
+options = {
+  host: Choice[:host],
+  port: Choice[:port],
+  user: Choice[:user],
+  password: Choice[:password],
+  debug: Choice[:debug]
+}
 
-client = RemoTransmission::Client.new(
-  Choice[:host],
-  Choice[:port],
-  Choice[:user],
-  Choice[:password],
-  Choice[:debug]
-)
+client = RemoTransmission::Client.new(options)
 
 if Choice[:add]
   client.add(Choice[:add])

data/lib/remotransmission/client.rb

@@ -1,21 +1,5 @@
 # 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
-
+class RemoTransmission::Client < RemoTransmission::Remote
   # Add a torrent to the transmission client
   # and prints output.
   #
@@ -26,15 +10,8 @@ class RemoTransmission::Client
   #   >> transmission.add("magnet://..."")
   #   success
   def add(url)
-    add = rpc(
-      method: "torrent-add",
-      tag: 8,
-      arguments: {
-        filename: url,
-      }
-    )
-    result = add["result"]
-    puts result
+    add = super
+    puts add["result"]
   end
 
   # Prints all active torrents
@@ -44,15 +21,7 @@ class RemoTransmission::Client
   #   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"],
-      }
-    )
-
+    list = super
     args = list["arguments"]
     torrents = args["torrents"]
     torrents.each do |torrent|
@@ -62,49 +31,5 @@ class RemoTransmission::Client
       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 RemoTransmission::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 RemoTransmission::ShellError => e
-      puts e.message
-      exit 1
-    end
-
-    def debug(*obj)
-      puts *obj if @debug
-    end
 end
 

data/lib/remotransmission/remote.rb

@@ -0,0 +1,73 @@
+# Driver for all API calls
+class RemoTransmission::Remote
+  # Initialize a remote transmission
+  #
+  # Arguments:
+  #   options: hash
+  #
+  # Options:
+  #   :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(options = {})
+    defaults = RemoTransmission::DEFAULT_OPTIONS
+    options = defaults.merge(options)
+    @host = options[:host]
+    @port = options[:port]
+    @user = options[:user]
+    @password = options[:password]
+    @debug = options[:debug]
+  end
+
+  # Add a torrent to the transmission client
+  # and returns output.
+  #
+  # Arguments:
+  #   url: magnet URL or URL of torrent file
+  #
+  # Example:
+  #   >> transmission.add("magnet://..."")
+  #   { "result" => "success" }
+  def add(url)
+    rpc(
+      method: "torrent-add",
+      tag: 8,
+      arguments: { filename: url }
+    )
+  end
+
+  # Prints all active torrents
+  #
+  # Example:
+  #   >> transmission.list
+  #   { "arguments" => { "torrents" => { "leftUntilDone" => ... } }
+  def 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"],
+      }
+    )
+  end
+
+  private
+
+    def rpc(options = {})
+      uri = URI("http://#{@host}:#{@port}/transmission/rpc")
+      response = Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Post.new(uri.path)
+        request.body = options.to_json
+        request.basic_auth(@user, @password)
+        http.request(request)
+      end
+
+      json = JSON.parse(response.body)
+      $stderr.puts json if @debug
+      json
+    end
+end
+

data/lib/remotransmission/version.rb

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

data/lib/remotransmission.rb

@@ -1,11 +1,42 @@
-require 'choice'
 require 'json'
-require 'open3'
+require 'net/http'
 
 module RemoTransmission
+  DEFAULT_OPTIONS = {
+    host: "localhost",
+    port: 9091,
+    user: "freebox",
+    password: "",
+    debug: false
+  }.freeze
+
+  # Returns the default options hash, optionnaly pulled from the given
+  # configuration file.
+  #
+  # Arguments:
+  #   file: path to JSON configuration file
+  def self.default_options(file = nil)
+    defaults = DEFAULT_OPTIONS
+
+    if file and file = File.expand_path(file) and File.exists?(file)
+      config = JSON.parse(File.read(file))
+
+      # symbolize keys
+      config = config.inject({}) do |options, (key, value)|
+        options[key.to_sym] = value
+        options
+      end
+
+      defaults = defaults.merge(config)
+    end
+
+    defaults
+  end
+
   # :nodoc:
   class ShellError < StandardError; end
 end
 
-require 'remotransmission/client'
 require 'remotransmission/version'
+require 'remotransmission/remote'
+require 'remotransmission/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remotransmission
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-08-24 00:00:00.000000000 +02:00
+default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: choice
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &82533290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +22,10 @@ dependencies:
         version: '0.1'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.1'
+  version_requirements: *82533290
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &82533040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,12 +33,7 @@ dependencies:
         version: '1.7'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
+  version_requirements: *82533040
 description: A gem that can talk to remote Transmission demons
 email: sunny@sunfox.org
 executables:
@@ -52,8 +43,10 @@ extra_rdoc_files: []
 files:
 - lib/remotransmission.rb
 - lib/remotransmission/client.rb
+- lib/remotransmission/remote.rb
 - lib/remotransmission/version.rb
 - bin/remotransmission
+has_rdoc: true
 homepage: http://github.com/sunny/remotransmission
 licenses:
 - MIT
@@ -73,10 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- Curl command line
+requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Remote Transmission