transmission-client 0.0.1 → 0.1.0

data/README.markdown

@@ -1,5 +1,7 @@
 # transmission-client: A Transmission RPC Client
 
+**Please note, with the current release i dropped support for the blocking api. Eventmachine is now required.**
+
 The goal is to support all requests described in the Transmission [RPC Specifications](http://trac.transmissionbt.com/browser/trunk/doc/rpc-spec.txt).
 
 ## Installing
@@ -16,24 +18,10 @@ To install transmission-client:
 
 	sudo gem install transmission-client
 
-If you want to use EventMachine (optional) you need to install the eventmachine gem and igrigorik's em-http-request:
-	
-	sudo gem install eventmachine
-	sudo gem install em-http-request
-
 ## Usage
 Get a list of torrents and print its file names:
 
 	require 'transmission-client'
-	t = Transmission::Client.new('127.0.0.1', 9091)
-	t.torrents.each do |torrent|
-	  puts torrent.name
-	end
-
-To use the EventMachine driven interface:
-
-	require 'eventmachine'
-	require 'transmission-client'
 
 	EventMachine.run do
 	  t = Transmission::Client.new
@@ -45,5 +33,28 @@ To use the EventMachine driven interface:
 	    end
 	  end
 	end
+	
+Authentication support (thanks hornairs):
+
+	t = Transmission::Client.new('127.0.0.1', 9091, 'username', 'password')
+	
+Callbacks:
 
+	EventMachine.run do
+		t = Transmission::Client.new
+	  	
+	  	t.on_download_finished do |torrent|
+	  	  puts "Wha torrent finished"
+	  	end
+	  	t.on_torrent_stopped do |torrent|
+	  	  puts "Oooh torrent stopped"
+	  	end
+	  	t.on_torrent_started do |torrent|
+	  	  puts "Torrent started."
+	  	end
+	  	t.on_torrent_removed do |torrent|
+	  	  puts "Darn torrent deleted."
+	  	end
+	end
+	
 RDoc is still to be written, at the meantime have a look at the code to find out which methods are supported.

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.email = "git@dsander.de"
     gem.homepage = "http://github.com/dsander/transmission-client"
     gem.authors = ["Dominik Sander"]
+    gem.add_dependency "em-http-request"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     gem.files += Dir['lib/**/*.rb','README.markdown']
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/transmission-client.rb

@@ -5,17 +5,8 @@ require 'rubygems'
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'transmission-client/client'
-
-if defined? EM
-  begin
-    require 'em-http'
-    require 'transmission-client/em-connection'
-  rescue LoadError
-    require 'transmission-client/connection'
-  end
-else
-  require 'transmission-client/connection'
-end
+require 'em-http'
+require 'transmission-client/em-connection'
 require 'transmission-client/torrent'
 require 'transmission-client/session'
 

data/lib/transmission-client/client.rb

@@ -1,71 +1,106 @@
 module Transmission
   class Client
-    def initialize(host='localhost',port=9091)
-      Connection.instance.init(host, port)
+    def on_download_finished(&blk); @on_download_finished = blk; callback_initialized; end
+    def on_torrent_added(&blk); @on_torrent_added = blk; callback_initialized; end
+    def on_torrent_stopped(&blk); @on_torrent_stopped = blk; callback_initialized; end
+    def on_torrent_started(&blk); @on_torrent_started = blk; callback_initialized; end
+    def on_torrent_removed(&blk); @on_torrent_removed = blk; callback_initialized; end
+    
+    def initialize(host='localhost',port=9091, username = nil, password = nil)
+      Connection.init(host, port, username, password)
+      @torrents = nil
     end
     
     def start_all &cb
-      Connection.instance.send('torrent-start', &cb)
+      Connection.send('torrent-start')
     end
     
-    def start(id, &cb)
-      Connection.instance.send('torrent-start', {'ids' => id.class == Array ? id : [id]}, &cb)
+    def start(id)
+      Connection.send('torrent-start', {'ids' => id.class == Array ? id : [id]})
     end
     
-    def stop(id, &cb)
-      Connection.instance.send('torrent-stop', {'ids' => id.class == Array ? id : [id]}, &cb)
+    def stop(id)
+      Connection.send('torrent-stop', {'ids' => id.class == Array ? id : [id]})
     end
     
     def stop_all &cb
-      Connection.instance.send('torrent-stop', &cb)
+      Connection.send('torrent-stop')
     end
     
-    def remove(id, delete_data = false, &cb)
-      Connection.instance.send('torrent-remove', {'ids' => id.class == Array ? id : [id], 'delete-local-data' => delete_data }, &cb)
+    def remove(id, delete_data = false)
+      Connection.send('torrent-remove', {'ids' => id.class == Array ? id : [id], 'delete-local-data' => delete_data })
     end
     
-    def remove_all(delete_data = false, &cb)
-      Connection.instance.send('torrent-remove', {'delete-local-data' => delete_data }, &cb)
+    def remove_all(delete_data = false)
+      Connection.send('torrent-remove', {'delete-local-data' => delete_data })
     end
 
-    def add_torrent(a, &cb)
+    def add_torrent(a)
       if a['filename'].nil? && a['metainfo'].nil?
         raise "You need to provide either a 'filename' or 'metainfo'."
       end
-      Connection.instance.send('torrent-add', a, &cb)
+      Connection.send('torrent-add', a)
     end
     
-    def add_torrent_by_file(filename, &cb)
-      add_torrent({'filename' => filename}, &cb)
+    def add_torrent_by_file(filename)
+      add_torrent({'filename' => filename})
     end
     
-    def add_torrent_by_data(data, &cb)
-      add_torrent({'metainfo' => data}, &cb)
+    def add_torrent_by_data(data)
+      add_torrent({'metainfo' => data})
     end
     
-    def session &cb
-      if cb
-        Connection.instance.request('session-get') { |resp| cb.call Session.new resp }
-      else
-        Session.new Connection.instance.request('session-get')
-      end
+    def session
+      Connection.request('session-get') { |resp| yield Session.new resp }
     end
     
-  	def torrents(fields = nil, &cb)
-  	  torrs = []
-  	  if cb
-    	  Connection.instance.request('torrent-get', {'fields' => fields ? fields : Transmission::Torrent::ATTRIBUTES}) { |resp| 
-    	    resp['torrents'].each do |t|
-    	      torrs << Torrent.new(t)
-  		    end
-  		    cb.call torrs
-		    }
-  	  else
-    	  Connection.instance.request('torrent-get', {'fields' => fields ? fields : Transmission::Torrent::ATTRIBUTES})['torrents'].each do |t|
-    	    torrs << Torrent.new(t)
-  		  end
-  		  torrs
-	    end
+    def torrents(fields = nil)
+  	  Connection.request('torrent-get', {'fields' => fields ? fields : Transmission::Torrent::ATTRIBUTES}) { |resp| 
+  	    torrs = []
+  	    resp['torrents'].each do |t|
+  	      torrs << Torrent.new(t)
+		    end
+		    yield torrs
+	    }
     end
+    
+    private
+    def callback_initialized
+      return if @torrent_poller
+      @torrent_poller = EM.add_periodic_timer(1) do
+        updated_torrents = {}
+        self.torrents do |tors|
+          tors.each do |torrent|
+            updated_torrents[torrent.id] = torrent
+          end
+          compare_torrent_status updated_torrents
+          @torrents = updated_torrents.dup
+        end
+        
+        
+      end
+    end
+    
+    def compare_torrent_status updated_torrents
+      return false unless @torrents
+      updated_torrents.each_pair do |id, t|
+        old = @torrents[t.id] if @torrents[t.id]
+        if old == nil
+          @on_torrent_started.call t if @on_torrent_started
+        elsif old.downloading? && t.seeding?
+          @on_download_finished.call t if @on_download_finished
+        elsif old.stopped? && !t.stopped?
+          @on_torrent_started.call t if @on_torrent_started
+        elsif !old.stopped? && t.stopped?
+          @on_torrent_stopped.call t if @on_torrent_stopped
+        end
+        @torrents.delete t.id
+      end
+      if @torrents.length > 0 && @on_torrent_removed
+        @torrents.values.each do |t|
+          @on_torrent_removed.call t    
+        end
+      end  
+    end 
   end
 end

data/lib/transmission-client/em-connection.rb

@@ -1,51 +1,53 @@
 module Transmission
   class Connection
-    include Singleton
-    #include EM::Deferrable
-    
-    def init(host, port)
-      @host = host
-      @port = port
-      uri = URI.parse("http://#{@host}:#{@port}/transmission/rpc")
-      #@conn = Net::HTTP.start(uri.host, uri.port)
-      @conn = EventMachine::HttpRequest.new(uri)
-      @header = {} #{"Accept-Encoding" => "deflate"} deflate is broken somewhere
-    end
-    
-    def request(method, attributes={}, &cb)
-      req = @conn.post(:body => build_json(method,attributes), :head => @header )
-      req.callback {
-        if req.response_header.status == 409 #&& @header['x-transmission-session-id'].nil?
-          @header['x-transmission-session-id'] = req.response_header['X_TRANSMISSION_SESSION_ID']
-          request(method,attributes, &cb)
-        elsif req.response_header.status == 200
-          resp = JSON.parse(req.response)
-          if resp["result"] == 'success'
-            cb.call resp['arguments'] if cb
-          else
-            cb.call resp if cb
+    class <<self
+      def init(host, port, username = nil, password = nil)
+        @host = host
+        @port = port
+        @header = username.nil? ? {} : {'authorization' => [username, password]}
+        uri = URI.parse("http://#{@host}:#{@port}/transmission/rpc")
+        @conn = EventMachine::HttpRequest.new(uri)
+      end
+      
+      def request(method, attributes={})
+        req = @conn.post(:body => build_json(method,attributes), :head => @header )
+        req.callback {
+          case req.response_header.status
+            when 401
+              raise SecurityError, 'The client was not able to authenticate, is your username or password wrong?'
+            when 409 #&& @header['x-transmission-session-id'].nil?
+              @header['x-transmission-session-id'] = req.response_header['X_TRANSMISSION_SESSION_ID']
+              request(method,attributes) do |resp|
+                yield resp
+              end
+            when 200
+              resp = JSON.parse(req.response)
+              if resp["result"] == 'success'
+                yield resp['arguments']
+              else
+                yield resp
+              end
           end
+        }
+        req.errback {
+          raise "Unknown response."
+        }
+      end
+      
+      def send(method, attributes={})
+        request(method, attributes) do |resp|
+          yield resp
         end
-      }
-      req.errback {
-        puts 'errback'
-        pp req
-      }
-    end
-    
-    def send(method, attributes={}, &cb)
-      request(method, attributes) do |resp|
-        cb.call resp if cb
       end
-    end
-    
-    def build_json(method,attributes = {})
-      if attributes.length == 0
-        {'method' => method}.to_json
-      else
-       {'method' => method, 'arguments' => attributes }.to_json
+      
+      def build_json(method,attributes = {})
+        if attributes.length == 0
+          {'method' => method}.to_json
+        else
+         {'method' => method, 'arguments' => attributes }.to_json
+        end
       end
+  
     end
-
   end
 end

data/lib/transmission-client/torrent.rb

@@ -3,31 +3,56 @@ module Transmission
     ATTRIBUTES = ['activityDate', 'addedDate', 'bandwidthPriority', 'comment', 'corruptEver', 'creator', 'dateCreated', 'desiredAvailable', 'doneDate', 'downloadDir', 'downloadedEver', 'downloadLimit', 'downloadLimited', 'error', 'errorString', 'eta', 'hashString', 'haveUnchecked', 'haveValid', 'honorsSessionLimits', 'id', 'isPrivate', 'leftUntilDone', 'manualAnnounceTime', 'maxConnectedPeers', 'name', 'peer-limit', 'peersConnected', 'peersGettingFromUs', 'peersKnown', 'peersSendingToUs', 'percentDone', 'pieces', 'pieceCount', 'pieceSize', 'rateDownload', 'rateUpload', 'recheckProgress', 'seedRatioLimit', 'seedRatioMode', 'sizeWhenDone', 'startDate', 'status', 'swarmSpeed', 'totalSize', 'torrentFile', 'uploadedEver', 'uploadLimit', 'uploadLimited', 'uploadRatio', 'webseedsSendingToUs']
     ADV_ATTRIBUTES = ['files', 'fileStats', 'peers', 'peersFrom', 'priorities', 'trackers', 'trackerStats', 'wanted', 'webseeds']
     SETABLE_ATTRIBUTES = ['bandwidthPriority', 'downloadLimit', 'downloadLimited', 'files-wanted', 'files-unwanted', 'honorsSessionLimits', 'ids', 'location', 'peer-limit', 'priority-high', 'priority-low', 'priority-normal', 'seedRatioLimit', 'seedRatioMode', 'uploadLimit', 'uploadLimited']
+    CHECK_WAIT = 1
+    CHECK      = 2
+    DOWNLOAD   = 4
+    SEED       = 8
+    STOPPED    = 16
     
     def initialize(attributes)
       @attributes = attributes
     end
 
     def start
-      Connection.instance.send('torrent-start', {'ids' => @attributes['id']})
+      Connection.send('torrent-start', {'ids' => @attributes['id']})
     end
     
     def stop
-      Connection.instance.send('torrent-stop', {'ids' => @attributes['id']})
+      Connection.send('torrent-stop', {'ids' => @attributes['id']})
     end
 
     def verify
-      Connection.instance.send('torrent-verify', {'ids' => @attributes['id']})
+      Connection.send('torrent-verify', {'ids' => @attributes['id']})
     end
     
     def reannounce
-      Connection.instance.send('torrent-reannounce', {'ids' => @attributes['id']})
+      Connection.send('torrent-reannounce', {'ids' => @attributes['id']})
     end
     
     def remove(delete_data = false)
-      Connection.instance.send('torrent-remove', {'ids' => @attributes['id'], 'delete-local-data' => delete_data })
+      Connection.send('torrent-remove', {'ids' => @attributes['id'], 'delete-local-data' => delete_data })
     end
     
+    def downloading?
+      self.status == DOWNLOAD
+    end
+    
+    def stopped?
+      self.status == STOPPED
+    end
+    
+    def checking?
+      self.status == CHECK || self.status == CHECK_WAIT
+    end
+    
+    def seeding?
+      self.status == SEED
+    end
+    
+    def id
+      @attributes['id']
+    end
+      
     def method_missing(m, *args, &block)
       if ATTRIBUTES.include? m.to_s
         return @attributes[m.to_s]
@@ -35,7 +60,7 @@ module Transmission
         raise "Attribute not yet supported."
       elsif m[-1..-1] == '='
         if SETABLE_ATTRIBUTES.include? m[0..-2]
-          Connection.instance.send('torrent-set', {'ids' => [@attributes['id']], m[0..-2] => args.first})  
+          Connection.send('torrent-set', {'ids' => [@attributes['id']], m[0..-2] => args.first})  
         else
           raise "Invalid Attribute."
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: transmission-client
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dominik Sander
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-27 00:00:00 +01:00
+date: 2010-02-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   type: :development
@@ -31,18 +41,15 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.markdown
-- README.rdoc
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.markdown
-- README.rdoc
 - Rakefile
 - VERSION
 - lib/transmission-client.rb
 - lib/transmission-client/client.rb
-- lib/transmission-client/connection.rb
 - lib/transmission-client/em-connection.rb
 - lib/transmission-client/session.rb
 - lib/transmission-client/torrent.rb
@@ -77,5 +84,5 @@ signing_key:
 specification_version: 3
 summary: A Transmission RPC Client
 test_files: 
-- test/test_transmission-rpc.rb
 - test/helper.rb
+- test/test_transmission-rpc.rb

data/README.rdoc

@@ -1,49 +0,0 @@
-# transmission-client: A Transmission RPC Client
-
-The goal is to support all requests described in the Transmission [RPC Specifications](http://trac.transmissionbt.com/browser/trunk/doc/rpc-spec.txt).
-
-## Installing
-You need to have http://gemcutter.org in you gem sources. To add it you can execute either
-
-	sudo gem install gemcutter
-	sudo gem tumble
-
-or
-
-	sudo gem source -a http://gemcutter.org
-
-To install transmission-client:
-
-	sudo gem install transmission-client
-
-If you want to use EventMachine (optional) you need to install the eventmachine gem and igrigorik's em-http-request:
-	
-	sudo gem install eventmachine
-	sudo gem install em-http-request
-
-## Usage
-Get a list of torrents and print its file names:
-
-	require 'transmission-client'
-	t = Transmission::Client.new('127.0.0.1', 9091)
-	t.torrents.each do |torrent|
-	  puts torrent.name
-	end
-
-To use the EventMachine driven interface:
-
-	require 'eventmachine'
-	require 'transmission-client'
-
-	EventMachine.run do
-	  t = Transmission::Client.new
-	  EM.add_periodic_timer(1) do
-	    t.torrents do |torrents|
-	      torrents.each do |tor|
-	        puts tor.percentDone
-	      end
-	    end
-	  end
-	end
-
-RDoc is still to be written, at the meantime have a look at the code to find out which methods are supported.

data/lib/transmission-client/connection.rb

@@ -1,42 +0,0 @@
-module Transmission
-  class Connection
-    include Singleton
-    
-    def init(host, port)
-      @host = host
-      @port = port
-      uri = URI.parse("http://#{@host}:#{@port}")
-      @conn = Net::HTTP.start(uri.host, uri.port)
-      @header = {}
-    end
-    
-    def request(method, attributes={})
-      res = @conn.post('/transmission/rpc',build_json(method,attributes),@header) 
-      if res.class == Net::HTTPConflict && @header['x-transmission-session-id'].nil?
-        @header['x-transmission-session-id'] = res['x-transmission-session-id']
-        request(method,attributes)
-      elsif res.class == Net::HTTPOK
-        resp = JSON.parse(res.body)
-        if resp["result"] == 'success'
-          #pp resp
-          resp['arguments']
-        else
-          resp
-        end
-      end
-    end
-    
-    def send(method, attributes={})
-      request(method, attributes)['result'].nil?
-    end
-    
-    def build_json(method,attributes = {})
-      if attributes.length == 0
-        {'method' => method}.to_json
-      else
-       {'method' => method, 'arguments' => attributes }.to_json
-      end
-    end
-
-  end
-end