transmission-rpc 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transmission-rpc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jarred Sumner
+
+MIT License
+
+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.md

@@ -0,0 +1,86 @@
+# Transmission::RPC
+
+A simplistic Transmission RPC client for Ruby. It implements part of [RPC 1.7.x](https://trac.transmissionbt.com/browser/branches/1.7x/doc/rpc-spec.txt).
+
+You can:
+
+* Add a torrent by URL or file path
+* Start a torrent
+* Stop a torrent
+* Get all torrents
+* Delete torrents from Transmission and from disk
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transmission-rpc'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install transmission-rpc
+
+It depends on ```transmission-daemon```. Install it from homebrew:
+		
+	$ brew install transmission
+
+```transmission-daemon``` must be running, run it like so:
+
+	$ transmission-daemon
+
+## Usage
+
+To add a torrent by URL or file path:
+
+```ruby
+Transmission::RPC::Torrent + "http://example.com/url/to/torrent.torrent"
+```
+
+To start all torrents:
+
+```ruby
+Transmission::RPC::Torrent.start!
+```
+
+To stop all torrents:
+
+```ruby
+Transmission::RPC::Torrent.stop!
+```
+
+To get all torrents:
+
+```ruby
+Transmission.torrents
+```
+
+To start a specific torrent:
+
+```ruby
+Transmission.torrents.first.start!
+```
+
+To stop a specific torrent:
+
+```ruby
+Transmission.torrents.first.stop!
+```
+
+To delete a torrent:
+
+```ruby
+Transmission.torrents.first.delete!
+```
+
+To delete a torrent and delete the contents from disk:
+
+```ruby
+Transmission.torrents.first.delete!(true)
+```
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/transmission-rpc/client.rb

@@ -0,0 +1,58 @@
+module Transmission
+	module RPC
+		# This communicates with Transmission's RPC server. Transmission's RPC is just an HTTP server with a JSON API
+		# It implements part of the [RPC 1.7.X spec](https://trac.transmissionbt.com/browser/branches/1.7x/doc/rpc-spec.txt)
+		module Client
+			API_VERSION = '1.7'
+
+			# Checks if we're connected to the Trasmission Daemon.
+			# If you're having problems, make sure you have the Transmission Daemon installed and then try running transmission-daemon -f in your shell
+			def self.connected?
+				begin
+					request("session-get")
+					true
+				rescue
+					false
+				end
+			end
+
+			# Sends out a request to Transmission's RPC server
+			# If you're curious about the formatting, [read this](https://trac.transmissionbt.com/browser/branches/1.7x/doc/rpc-spec.txt) 
+			def self.request(method, arguments = {}, ids = [])
+				arguments = self.add_ids(arguments, ids) if ids.present?
+				begin
+					@response = RestClient.post(self.url, { :method => method, :arguments => arguments }.to_json, :x_transmission_session_id => self.session_id)
+					JSON.parse(@response.body)
+				rescue
+					puts "Couldn't connect to Transmission. Is Transmission running at http://#{Transmission.configuration.ip}:#{Transmission.configuration.port}?"
+				end
+			end
+
+			private
+
+			# Transmission's RPC requires a session ID. When you do a GET on /transmission/rpc then it gives you a 409 and a header that contains the session ID.
+			# This gets that session ID
+			def self.session_id
+				return @session_id unless @session_id.blank?
+				begin
+					RestClient.get(self.url)
+				rescue => e
+					return @session_id = e.response.headers[:x_transmission_session_id]
+				end
+			end
+
+			# Utility method for adding IDs to the arguments hash, even if it doesn't exist
+			def self.add_ids(arguments, ids)
+				arguments = {} if arguments.nil?
+				arguments[:ids] = ids
+				arguments
+			end
+
+			# URL to current Transmission Daemon
+			def self.url
+				"http://#{Transmission.configuration.ip}:#{Transmission.configuration.port}/#{Transmission.configuration.path}"
+			end
+
+		end
+	end
+end

data/lib/transmission-rpc/torrent.rb

@@ -0,0 +1,98 @@
+module Transmission
+	module RPC
+		# A nice wrapper around Transmission's RPC
+		class Torrent
+			attr_accessor :id, :seeders, :leechers, :name, :download_directory, :eta, :percent_done, :files, :total_size, :date_added, :bytes_left, :comment, :description, :torrent_file, :hash, :status
+			include Transmission::RPC
+			
+			def initialize(options = {})
+				self.id 					= options['id']
+				self.date_added 	= options['addedDate']
+				self.comment 			= options['comment']
+				self.eta 					= options['eta']
+				self.bytes_left 	= options['leftUntilDone'] 
+				self.name         = options['name']
+				self.percent_done = options['percentDone']
+				self.torrent_file = options['torrentFile']
+				self.total_size   = options['totalSize']
+				self.hash  				= options['hashString']
+				self.status 			= options['status']
+			end
+
+			# Starts downloading the current torrent
+			def start!
+				Client.request("torrent-start", nil, [self.id])
+			end
+
+			# Stops downloading the current torrent
+			def stop!
+				Client.request("torrent-stop", nil, [self.id])
+			end
+
+			# Deletes the current torrent, and, optionally, the data for that torrent
+			def delete!(delete_data = false)
+				Client.request("torrent-remove", { :delete_local_data => delete_data }, [self.id])
+			end
+
+			# Checks if torrent is currently downloading
+			def downloading?
+				self.status == 4
+			end
+
+			# Checks if torrent is paused 
+			def paused?
+				self.status == 0
+			end
+
+			# Adds a torrent by URL or file path
+			def self.+(url)
+				self.add(:url => url)
+			end
+
+			# Gets all the torrents
+			def self.all
+				@unprocessed_torrents = Client.request("torrent-get", { :fields => self.fields })['arguments']['torrents']
+				@unprocessed_torrents.collect { |torrent| self.new(torrent) }				
+			end
+
+			# Finds a torrent by ID
+			def self.find(id)
+				@unprocessed_response = Client.request("torrent-get", { :fields => self.fields }, [id])
+				@torrents = @unprocessed_response['arguments']['torrents']
+				if @torrents.count > 0
+					return self.new(@torrents.first)
+				else
+					return nil
+				end
+			end
+
+			# Adds a torrent by file path or URL (.torrent file's only right now)
+			def self.add(options = {})
+				@response = Client.request("torrent-add", :filename => options[:url])
+				if @response['result'] == 'success'
+					self.find(@response['arguments']['torrent-added']['id'])
+				else
+					nil
+				end
+			end
+
+			# Starts all torrents
+			def self.start!
+				Client.request "torrent-start"
+			end
+
+			# Stops all torrents
+			def self.stop!
+				Client.request "torrent-stop"
+			end
+
+			private
+
+			# The accessors for a torrent, the way that Transmission's RPC likes them.
+			def self.fields
+				@fields ||= %w(addedDate comment eta id leechers name seeders percentDone totalSize torrentFile status leftUntilDone hashString)
+			end
+
+		end
+	end
+end

data/lib/transmission-rpc/version.rb

@@ -0,0 +1,5 @@
+module Transmission
+  module RPC
+    VERSION = "0.0.1"
+  end
+end

data/lib/transmission-rpc.rb

@@ -0,0 +1,40 @@
+require 'rest-client'
+require 'active_support/core_ext'
+require 'transmission-rpc/torrent'
+require 'transmission-rpc/client'
+
+module Transmission
+	mattr_writer :configuration
+
+	def self.configuration
+		@configuration = Transmission::Configuration.new if @configuration.nil?
+		@configuration
+	end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+	def self.connected?
+		Transmission::RPC::Client.connected?
+	end
+
+	# Convenience method for getting all the torrents
+ 	def self.torrents
+ 		Transmission::RPC::Torrent.all
+ 	end
+
+	class Configuration
+    attr_accessor :ip, :port, :path
+
+    def initialize
+			self.ip 				= "127.0.0.1"
+			self.port 			= 9091
+			self.path 			= "transmission/rpc"
+
+			self
+		end
+  end
+
+end

data/transmission-rpc.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "transmission-rpc"
+  gem.version       = '0.1.0'
+  gem.authors       = ["Jarred Sumner"]
+  gem.email         = ["jarred@jarredsumner.com"]
+  gem.description   = %q{A simple Transmission RPC client for Ruby.}
+  gem.summary       = %q{A simple Transmission RPC client for Ruby. It can add torrents, start/stop torrents, remove them to/from Transmission.}
+  gem.homepage      = "https://github.com/jarred-sumner/transmission-rpc"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rest-client"
+  gem.add_dependency "json"
+  gem.add_dependency "activesupport"
+end

data/transmission-rpc.sublime-project

@@ -0,0 +1,8 @@
+{
+	"folders":
+	[
+		{
+			"path": "/Users/jarred/Code/Content/transmission-rpc"
+		}
+	]
+}