transmission-rpc-ruby 0.1.0

data/lib/transmission/arguments/torrent_set.rb

@@ -0,0 +1,34 @@
+module Transmission
+  class Arguments
+    class TorrentSet < Transmission::Arguments
+
+      ATTRIBUTES = [
+          'bandwidthPriority',
+          'downloadLimit',
+          'downloadLimited',
+          'downloadLimit',
+          'files-wanted',
+          'files-unwanted',
+          'honorsSessionLimits',
+          'ids',
+          'location',
+          'peer-limit',
+          'priority-high',
+          'priority-low',
+          'priority-normal',
+          'queuePosition',
+          'seedIdleLimit',
+          'seedIdleMode',
+          'seedRatioLimit',
+          'seedRatioMode',
+          'trackerAdd',
+          'trackerRemove',
+          'trackerReplace',
+          'uploadLimit',
+          'uploadLimited',
+          'uploadLimit'
+      ]
+
+    end
+  end
+end

data/lib/transmission/config.rb

@@ -0,0 +1,18 @@
+module Transmission
+  class Config
+    class << self
+      def set(options = {})
+        @@config = options
+        @@connector = Transmission::RPC.new @@config
+      end
+
+      def get
+        @@config
+      end
+
+      def get_connector
+        @@connector
+      end
+    end
+  end
+end

data/lib/transmission/model.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), 'model', 'torrent')
+require File.join(File.dirname(__FILE__), 'model', 'session')
+
+module Transmission
+  module Model
+
+  end
+end

data/lib/transmission/model/session.rb

@@ -0,0 +1,35 @@
+module Transmission
+  module Model
+    class Session
+      class SessionError < StandardError; end
+
+      attr_accessor :attributes
+
+      def initialize(session_object)
+        @attributes = session_object
+      end
+
+      def version
+        @attributes['version'].split(' ').first
+      end
+
+      def rpc_version
+        @attributes['rpc-version']
+      end
+
+      class << self
+        def get(options = {})
+          rpc = options[:connector] || connector
+          session_body = rpc.get_session options
+          session_stats_body = rpc.get_session_stats options
+          merged_body = session_body.merge(session_stats_body)
+          Session.new merged_body
+        end
+
+        def connector
+          Transmission::Config.get_connector
+        end
+      end
+    end
+  end
+end

data/lib/transmission/model/torrent.rb

@@ -0,0 +1,97 @@
+module Transmission
+  module Model
+    class Torrent
+      class TorrentError < StandardError; end
+      class TorrentNotFoundError < StandardError; end
+      class MissingAttributesError < StandardError; end
+      class DuplicateTorrentError < StandardError; end
+
+      attr_accessor :attributes, :deleted
+
+      def initialize(torrent_object)
+        @attributes = torrent_object
+      end
+
+      def delete!(remove_local_data = false)
+        Torrent.connector.remove_torrent [self.attributes['id']], remove_local_data
+        @deleted = true
+      end
+
+      def set
+
+      end
+
+      def move_up
+
+      end
+
+      def move_down
+
+      end
+
+      def move_top
+
+      end
+
+      def move_bottom
+
+      end
+
+      def start
+
+      end
+
+      def start_now
+
+      end
+
+      def stop
+
+      end
+
+      def verify
+
+      end
+
+      def re_announce
+
+      end
+
+      def finished?
+
+      end
+
+      def to_json
+
+      end
+
+      class << self
+        def all(options = {})
+          rpc = options[:connector] || connector
+          body = rpc.get_torrent nil, options
+          body['torrents'].inject([]) do |torrents, torrent|
+            torrents << Torrent.new(torrent)
+          end
+        end
+
+        def find(id, options = {})
+          rpc = options[:connector] || connector
+          body = rpc.get_torrent [id], options
+          raise TorrentNotFoundError if body['torrents'].size == 0
+          Torrent.new body['torrents'].first
+        end
+
+        def add(options = {})
+          rpc = options[:connector] || connector
+          body = rpc.add_torrent options[:arguments]
+          raise DuplicateTorrentError if body['torrent-duplicate']
+          find body['torrent-added']['id']
+        end
+
+        def connector
+          Transmission::Config.get_connector
+        end
+      end
+    end
+  end
+end

data/lib/transmission/rpc.rb

@@ -0,0 +1,108 @@
+require File.join(File.dirname(__FILE__), 'rpc', 'connector')
+
+module Transmission
+  class RPC
+
+    attr_accessor :session, :connector
+
+    def initialize(options = {})
+      @connector = Connector.new options
+    end
+
+    def get_session(options = {})
+      fields = Transmission::Arguments::SessionGet.new(options[:fields])
+      arguments = {fields: fields.to_arguments}
+      @connector.post method: 'session-get', arguments: arguments
+    end
+
+    def set_session(arguments)
+      @connector.post method: 'session-set', arguments: arguments
+    end
+
+    def get_session_stats(options = {})
+      fields = Transmission::Arguments::SessionStats.new(options[:fields])
+      arguments = {fields: fields.to_arguments}
+      @connector.post method: 'session-stats', arguments: arguments
+    end
+
+    def close_session
+      @connector.post method: 'session-close'
+    end
+
+    def test_port
+      @connector.post method: 'port-test'
+    end
+
+    def blocklist
+      @connector.post method: 'blocklist-update'
+    end
+
+    def get_torrent(ids = nil, options = {})
+      fields = Transmission::Arguments::TorrentGet.new(options[:fields])
+      arguments = {fields: fields.to_arguments}
+      arguments[:ids] = ids if ids.is_a?(Array)
+      @connector.post method: 'torrent-get', arguments: arguments
+    end
+
+    def set_torrent
+      @connector.post method: 'torrent-set'
+    end
+
+    def add_torrent(arguments = {})
+      @connector.post method: 'torrent-add', arguments: arguments
+    end
+
+    def remove_torrent(ids, delete_local_data = false)
+      @connector.post method: 'torrent-remove', arguments: {ids: ids, 'delete-local-data' => delete_local_data}
+    end
+
+    def free_space
+      @connector.post method: 'free-space'
+    end
+
+    def start_torrent
+
+    end
+
+    def start_torrent_now
+
+    end
+
+    def stop_torrent
+
+    end
+
+    def verify_torrent
+
+    end
+
+    def re_announce
+
+    end
+
+    def set_torrent_location
+
+    end
+
+    def rename_torrent_path
+
+    end
+
+    def move_up_torrent
+
+    end
+
+    def move_down_torrent
+
+    end
+
+    def move_top_torrent
+
+    end
+
+    def move_bottom_torrent
+
+    end
+
+  end
+end

data/lib/transmission/rpc/connector.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'json'
+
+module Transmission
+  class RPC
+    class Connector
+      class AuthError < StandardError; end
+      class ConnectionError < StandardError; end
+      class InvalidSessionError < StandardError; end
+
+      attr_accessor :host, :port, :ssl, :credentials, :path, :session_id, :response
+
+      def initialize(options = {})
+        @host = options[:host] || 'localhost'
+        @port = options[:port] || 9091
+        @ssl  = !!options[:ssl]
+        @credentials = options[:credentials] || nil
+        @path = options[:path] || '/transmission/rpc'
+        @session_id = options[:session_id] || ''
+      end
+
+      def post(params = {})
+        response = connection.post do |req|
+          req.url @path
+          req.headers['X-Transmission-Session-Id'] = @session_id
+          req.headers['Content-Type'] = 'application/json'
+          req.body = JSON.generate(params)
+        end
+        handle_response response
+      end
+
+      private
+
+      def json_body(response)
+        JSON.parse response.body
+      rescue
+        {}
+      end
+
+      def handle_response(response)
+        @response = response
+        if response.status == 409
+          @session_id = response.headers['x-transmission-session-id']
+          raise InvalidSessionError
+        end
+        body = json_body response
+        raise AuthError if response.status == 401
+        raise ConnectionError, body['result'] unless response.status == 200 && body['result'] == 'success'
+        body['arguments']
+      end
+
+      def connection
+        @connection ||= begin
+          connection = Faraday.new(:url => "#{scheme}://#{@host}:#{@port}", :ssl => {:verify => false}) do |faraday|
+            faraday.request  :url_encoded
+            faraday.response :logger
+            faraday.adapter  Faraday.default_adapter
+          end
+          connection.basic_auth(@credentials[:username], @credentials[:password]) if @credentials
+          connection
+        end
+      end
+
+      def scheme
+        @ssl ? 'https' : 'http'
+      end
+    end
+  end
+end

data/spec/helpers/stubs.rb

@@ -0,0 +1,60 @@
+module Stubs
+
+  def stub_rpc_request(options = {})
+    host = options[:host] || 'localhost'
+    port = options[:port] || 9091
+    path = options[:path] || '/transmission/rpc'
+    scheme  = !!options[:ssl] ? 'https' : 'http'
+    stub_request(:post, "#{scheme}://#{host}:#{port}#{path}")
+  end
+
+  def stub_get_torrent(body, torrents)
+    stub_rpc_request
+        .with(body: torrent_get_body(body))
+        .to_return(successful_response({arguments: {torrents: torrents}}))
+  end
+
+  def torrent_get_body(arguments = {})
+    args = {fields: Transmission::Arguments::TorrentGet.new.to_arguments}.merge(arguments)
+    {method: 'torrent-get', arguments: args}.to_json
+  end
+
+  def torrent_add_body(arguments = {})
+    {method: 'torrent-add', arguments: arguments}.to_json
+  end
+
+  def torrent_remove_body(arguments = {})
+    {method: 'torrent-remove', arguments: arguments}.to_json
+  end
+
+  def session_get_body(arguments = {})
+    {method: 'session-get', arguments: arguments}.to_json
+  end
+
+  def session_set_body(arguments = {})
+    {method: 'session-set', arguments: arguments}.to_json
+  end
+
+  def session_stats_body(arguments = {})
+    {method: 'session-stats', arguments: arguments}.to_json
+  end
+
+  def successful_response(options = {})
+    body = {result: 'success', arguments: (options[:arguments] || {})}
+    {status: 200, body: body.to_json, headers: options[:headers] || {}}
+  end
+
+  def unsuccessful_response(options = {})
+    body = {result: (options[:result] || ''), arguments: (options[:arguments] || {})}
+    {status: 200, body: body.to_json, headers: options[:headers] || {}}
+  end
+
+  def unauthorized_response(options = {})
+    {status: 401, body: (options[:body] || {}).to_json, headers: options[:headers] || {}}
+  end
+
+  def conflict_response(options = {})
+    {status: 409, body: (options[:body] || {}).to_json, headers: options[:headers] || {}}
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'webmock/rspec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'transmission')
+require File.join(File.dirname(__FILE__), 'helpers', 'stubs')
+
+ENV['TESTING'] = 'true'
+
+RSpec.configure do |config|
+
+  config.include Stubs
+
+end