jmoses-transmission-client 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+transmission-client.gemspec
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dominik Sander
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,60 @@
+# 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
+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
+
+## Usage
+Get a list of torrents and print its file names:
+
+	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
+	
+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

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jmoses-transmission-client"
+    gem.summary = %Q{A Transmission RPC Client}
+    #gem.description = %Q{}
+    gem.email = "jon@burningbush.us"
+    gem.homepage = "http://github.com/jmoses/transmission-client"
+    gem.authors = ["Dominik Sander", "Jon Moses"]
+    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
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "transmission-rpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/transmission-client.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'singleton'
+require 'json'
+require 'rubygems'
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'transmission-client/client'
+require 'em-http'
+require 'transmission-client/em-connection'
+require 'transmission-client/torrent'
+require 'transmission-client/session'
+

data/lib/transmission-client/client.rb

@@ -0,0 +1,106 @@
+module Transmission
+  class Client
+    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.send('torrent-start')
+    end
+    
+    def start(id)
+      Connection.send('torrent-start', {'ids' => id.class == Array ? id : [id]})
+    end
+    
+    def stop(id)
+      Connection.send('torrent-stop', {'ids' => id.class == Array ? id : [id]})
+    end
+    
+    def stop_all &cb
+      Connection.send('torrent-stop')
+    end
+    
+    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)
+      Connection.send('torrent-remove', {'delete-local-data' => delete_data })
+    end
+
+    def add_torrent(a)
+      if a['filename'].nil? && a['metainfo'].nil?
+        raise "You need to provide either a 'filename' or 'metainfo'."
+      end
+      Connection.send('torrent-add', a)
+    end
+    
+    def add_torrent_by_file(filename)
+      add_torrent({'filename' => filename})
+    end
+    
+    def add_torrent_by_data(data)
+      add_torrent({'metainfo' => data})
+    end
+    
+    def session
+      Connection.request('session-get') { |resp| yield Session.new resp }
+    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

@@ -0,0 +1,57 @@
+module Transmission
+  class Connection
+    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 {
+          STDERR.puts "Response Start ->"
+          STDERR.puts req.response
+          STDERR.puts "<- Response End"
+          
+          raise "Unknown response."
+        }
+      end
+      
+      def send(method, attributes={})
+        request(method, attributes) do |resp|
+          yield resp
+        end
+      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
+end

data/lib/transmission-client/session.rb

@@ -0,0 +1,22 @@
+module Transmission  
+  class Session
+    ATTRIBUTES = ['alt-speed-down', 'alt-speed-enabled', 'alt-speed-time-begin', 'alt-speed-time-enabled', 'alt-speed-time-end', 'alt-speed-time-day', 'alt-speed-up', 'blocklist-enabled', 'blocklist-size', 'download-dir', 'dht-enabled', 'encryption', 'incomplete-dir', 'incomplete-dir-enabled', 'peer-limit-global', 'peer-limit-per-torrent', 'pex-enabled', 'peer-port', 'peer-port-random-on-start', 'port-forwarding-enabled', 'rpc-version', 'rpc-version-minimum', 'seedRatioLimit', 'seedRatioLimited', 'speed-limit-down', 'speed-limit-down-enabled', 'speed-limit-up', 'speed-limit-up-enabled', 'version']
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def method_missing(m, *args, &block)
+      m = m.to_s.gsub('_','-')
+      if ATTRIBUTES.include? m
+        return @attributes[m]
+      elsif m[-1..-1] == '='
+        if ["blocklist-size","rpc-version", "rpc-version-minimum", "version"].include? m[0..-2]
+          raise "Invalid Attribute."
+        end
+        return Connection.instance.send('session-set', {m[0..-2] => args.first})
+      else
+        raise "Invalid Attribute."
+      end
+    end
+  end
+end

data/lib/transmission-client/torrent.rb

@@ -0,0 +1,74 @@
+module Transmission
+  class Torrent
+    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', 'files']
+    ADV_ATTRIBUTES = ['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
+      @adv_attributes = {}
+    end
+
+    def start
+      Connection.send('torrent-start', {'ids' => @attributes['id']})
+    end
+    
+    def stop
+      Connection.send('torrent-stop', {'ids' => @attributes['id']})
+    end
+
+    def verify
+      Connection.send('torrent-verify', {'ids' => @attributes['id']})
+    end
+    
+    def reannounce
+      Connection.send('torrent-reannounce', {'ids' => @attributes['id']})
+    end
+    
+    def remove(delete_data = false)
+      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]
+      elsif ADV_ATTRIBUTES.include? m.to_s
+        raise "Can't access that yet."
+      elsif m[-1..-1] == '='
+        if SETABLE_ATTRIBUTES.include? m[0..-2]
+          Connection.send('torrent-set', {'ids' => [@attributes['id']], m[0..-2] => args.first})  
+        else
+          raise "Invalid Attribute."
+        end
+      else
+        raise "Invalid Attribute."
+      end
+    end
+  end # end class 
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'transmission-rpc'
+
+class Test::Unit::TestCase
+end

data/test/test_transmission-rpc.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTransmissionRpc < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: jmoses-transmission-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dominik Sander
+- Jon Moses
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: jon@burningbush.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/transmission-client.rb
+- lib/transmission-client/client.rb
+- lib/transmission-client/em-connection.rb
+- lib/transmission-client/session.rb
+- lib/transmission-client/torrent.rb
+- test/helper.rb
+- test/test_transmission-rpc.rb
+has_rdoc: true
+homepage: http://github.com/jmoses/transmission-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Transmission RPC Client
+test_files: 
+- test/helper.rb
+- test/test_transmission-rpc.rb