deluge-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e9faac059b0177c915d0ca94ef0de556498441e
+  data.tar.gz: 59d61e6ae269205d9c7db3349c8749d4ecaab409
+SHA512:
+  metadata.gz: a3f922e08b48c0ebe7fdef0b0c0420c0546ad315382e0cf6f979f315058003610bb643ed56f1a4423e71fd8789ee77786e30f0bf0e45e61fb1dd66a2840b81ba
+  data.tar.gz: 1b18c1573281c8ac0e4052cb989d273ac190676fc7d3fab0114391d73b01842b6c82772246aa8c7c8caf8bd54b1287b29cb3149273dd927538dc6da5a0205de0

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Igor Yamolov
+
+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,70 @@
+# Deluge::Api
+
+Ruby RPC client library for Deluge torrent client.  
+Provides dynamic API bindings depending on RPC server.  
+Multi-threading friendly, thanks to ``concurrent-ruby`` gem.
+
+Official RPC protocol documentation:  
+http://deluge.readthedocs.org/en/develop/core/rpc.html
+
+Deluge RPC API reference:  
+http://deluge.readthedocs.org/en/develop/core/rpc.html#remote-api
+
+## Usage
+
+```ruby
+require 'deluge'
+
+# Initialize client
+client = Deluge::Api::Client.new(host: 'localhost', port: 58846, login: 'username', password: 'password')
+
+# Start connection and authenticate
+client.start
+
+# Get auth level
+client.auth_level
+# => 5
+
+# Get available methods
+client.api_methods
+# => ['daemon.add_torrent_file', 'core.shutdown', ...]
+
+# Get deluge version
+client.daemon.info
+# => "1.3.10"
+
+# Get torrents list
+client.core.get_torrents_status({}, ['name', 'hash'])
+# => [{name: 'Hot Chicks Action', hash: '<torrent_hash>'}, ...]
+
+# Get namespace
+core = client.core
+# => <Deluge::Api::Namespace name="core">
+
+# Get namespace methods
+core.api_methods
+# => ['core.get_session_status', 'core.get_upload_rate', ....]
+
+# Invoke namespace method
+core.get_config
+# => {"info_sent"=>0.0, "lsd"=>true, "send_info"=>false, ... }
+
+# Close connection
+client.close
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deluge-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deluge-api

data/Rakefile

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

data/deluge-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deluge/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deluge-api"
+  spec.version       = Deluge::Api::VERSION
+  spec.authors       = ["Igor Yamolov"]
+  spec.email         = ["clouster@yandex.ru"]
+  spec.summary       = %q{Deluge RPC protocol wrapper}
+  spec.description   = %q{Communicate with Deluge torrent client via RPC protocol}
+  spec.homepage      = "https://github.com/t3hk0d3/deluge-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'concurrent-ruby', '~> 0.7'
+  spec.add_dependency 'rencoder', '~> 0.1'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/deluge.rb

@@ -0,0 +1 @@
+require_relative 'deluge/api'

data/lib/deluge/api.rb

@@ -0,0 +1,10 @@
+require 'deluge/api/version'
+
+module Deluge
+  module Api
+    require_relative 'api/namespace'
+    require_relative 'api/connection'
+    require_relative 'api/client'
+
+  end
+end

data/lib/deluge/api/client.rb

@@ -0,0 +1,77 @@
+module Deluge
+  module Api
+    class Client
+      attr_reader :namespaces, :api_methods, :auth_level
+
+      def initialize(options = {})
+        @connection = Deluge::Api::Connection.new(options)
+        @login = options.fetch(:login)
+        @password = options.fetch(:password)
+
+        @namespaces = {}
+        @api_methods = []
+      end
+
+      def connect
+        @connection.start
+
+        @auth_level = @connection.call('daemon.login', @login, @password)
+
+        register_methods!
+
+        true
+      end
+
+      def close
+        @connection.close
+        @auth_level = nil
+        @api_methods = []
+        @namespaces.each_key do |ns|
+          self.singleton_class.send :undef_method, ns
+        end
+        @namespaces = {}
+      end
+
+      private
+
+      def register_methods!
+        methods = @connection.call('daemon.get_method_list')
+
+        methods.each do |method|
+          *namespaces, method_name = method.split('.')
+
+          register_method!(namespaces, method_name)
+          @api_methods << method
+        end
+      end
+
+      def register_method!(namespaces, method)
+        namespace = register_namespace(namespaces)
+
+        namespace.register_method(method)
+      end
+
+      def register_namespace(namespaces)
+        ns = namespaces.shift
+
+        root = @namespaces[ns]
+
+        unless root
+          root = Api::Namespace.new(ns, @connection)
+          @namespaces[ns] = root
+
+          define_singleton_method(ns.to_sym) do
+            @namespaces[ns]
+          end
+        end
+
+        namespaces.each do |namespace|
+          root = root.register_namespace(namespace)
+        end
+
+        root
+      end
+
+    end
+  end
+end

data/lib/deluge/api/connection.rb

@@ -0,0 +1,158 @@
+require 'rencoder'
+require 'socket'
+require 'openssl'
+require 'thread'
+require 'zlib'
+require 'stringio'
+
+require 'concurrent'
+
+module Deluge
+  module Api
+    class Connection
+      class RPCError < StandardError; end
+
+      class InvokeTimeoutError < StandardError; end
+
+      DEFAULT_CALL_TIMEOUT = 5.0 # seconds
+
+      DEFAULT_PORT = 58846
+
+      RPC_RESPONSE = 1
+      RPC_ERROR = 2
+      RPC_EVENT = 3
+
+      attr_reader :host, :port
+
+      def initialize(options = {})
+        @host = options.delete(:host) || 'localhost'
+        @port = (options.delete(:port) || DEFAULT_PORT).to_i
+
+        @call_timeout = options.delete(:call_timeout) || DEFAULT_CALL_TIMEOUT
+
+        @request_id = Concurrent::AtomicFixnum.new
+        @running = Concurrent::AtomicBoolean.new
+
+        @messages = {}
+
+        @write_mutex = Mutex.new
+      end
+
+      def start
+        raise 'Connection already opened' if @connection
+
+        @connection = OpenSSL::SSL::SSLSocket.new(create_socket, ssl_context)
+
+        @connection.connect
+
+        @running.make_true
+
+        @main_thread = Thread.current
+        @thread = Thread.new(&self.method(:read_loop))
+      end
+
+      def close
+        @running.make_false
+      end
+
+      def call(method, *args)
+        kwargs = {}
+        kwargs = args.pop if args.size == 1 && args.last.is_a?(Hash)
+
+        future = Concurrent::IVar.new
+
+        request_id = @request_id.increment
+        message = [[request_id, method, args, kwargs]]
+
+        raw = Zlib::Deflate.deflate Rencoder.dump(message)
+
+        @write_mutex.synchronize do
+          @messages[request_id] = future
+
+          if IO.select([], [@connection], nil, nil)
+            @connection.write(raw)
+          end
+        end
+
+        result = future.value!(@call_timeout)
+
+        if result.nil? && future.pending?
+          raise InvokeTimeoutError.new("Failed to retreive response for '#{method}' in #{@call_timeout} seconds. Probably method not exists.")
+        end
+
+        result
+      end
+
+      private
+
+      def read_loop
+        while(@running.true?)
+          next unless IO.select([@connection], nil, nil, 0.1)
+
+          raw = ""
+          begin
+            buffer = @connection.readpartial(1024)
+            raw += buffer
+          end until(buffer.size < 1024)
+
+          raw = Zlib::Inflate.inflate(raw)
+
+          parse_packets(raw).each do |packet|
+            type, response_id, value = packet
+
+            var = @messages[response_id]
+
+            next unless var # TODO: Handle unknown messages
+
+            case type
+            when RPC_RESPONSE
+              var.set(value)
+            when RPC_ERROR
+              var.fail(RPCError.new(value))
+            # TODO: Add events support
+            else
+              raise "Unknown response type #{type}"
+            end
+          end
+        end
+
+        @connection.close if @connection
+        @connection = nil
+      rescue => e
+        @main_thread.raise(e)
+      end
+
+      def create_socket
+        socket = TCPSocket.new(host, port)
+
+        if ::Socket.constants.include?('TCP_NODELAY') || ::Socket.constants.include?(:TCP_NODELAY)
+          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, true)
+        end
+        socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true)
+
+        socket
+      end
+
+      def ssl_context
+        # SSLv3 is not allowed (http://dev.deluge-torrent.org/ticket/2555)
+        context = OpenSSL::SSL::SSLContext.new('SSLv23')
+        # TODO: Consider allowing server certificate validation
+        context.set_params(verify_mode: OpenSSL::SSL::VERIFY_NONE)
+
+        context
+      end
+
+      def parse_packets(raw)
+        io = StringIO.new(raw)
+
+        packets = []
+
+        until(io.eof?)
+          packets << Rencoder.load(io)
+        end
+
+        packets
+      end
+    end
+  end
+end

data/lib/deluge/api/namespace.rb

@@ -0,0 +1,45 @@
+module Deluge
+  module Api
+    class Namespace
+      attr_reader :name, :connection, :namespaces, :api_methods
+
+      def initialize(name, connection)
+        @name, @connection = name, connection
+        @namespaces = {}
+        @api_methods = []
+      end
+
+      def register_namespace(namespace)
+        namespace = namespace.to_sym
+
+        return namespaces[namespace] if namespaces.include?(namespace)
+
+        ns = Namespace.new("#{self.name}.#{namespace}", connection)
+
+        namespaces[namespace] = ns
+
+        define_singleton_method(namespace) do
+          ns
+        end
+
+        ns
+      end
+
+      def register_method(method)
+        method = method.to_sym
+
+        api_methods << "#{name}.#{method}"
+
+        define_singleton_method(method) do |*args|
+          call(method, *args)
+        end
+      end
+
+      def call(method, *args)
+        method_name = "#{name}.#{method}"
+
+        @connection.call(method_name, *args)
+      end
+    end
+  end
+end

data/lib/deluge/api/version.rb

@@ -0,0 +1,5 @@
+module Deluge
+  module Api
+    VERSION = "0.1.0"
+  end
+end

data/spec/deluge/api/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Deluge::Api::Client do
+
+  let(:connection) do
+    double('ApiConnection').tap do |connection|
+      allow(connection).to receive(:start)
+      allow(connection).to receive(:call).with('daemon.login', 'test', 'password').and_return(5)
+      allow(connection).to receive(:call).with('daemon.get_method_list').and_return(['test.api.method'])
+      allow(connection).to receive(:call).with('test.api.method').and_return('winning')
+      allow(connection).to receive(:close)
+    end
+  end
+
+  before do
+    allow(Deluge::Api::Connection).to receive(:new).with(kind_of(Hash)).and_return(connection)
+  end
+
+  subject { described_class.new(host: 'localhost', login: 'test', password: 'password') }
+
+  describe '#connect' do
+    before do
+      subject.connect
+    end
+
+    it 'starts connection' do
+      expect(connection).to have_received(:start)
+    end
+
+    it 'authenticate' do
+      expect(connection).to have_received(:call).with('daemon.login', 'test', 'password')
+    end
+
+    it 'set auth_level' do
+      expect(subject.auth_level).to eq(5)
+    end
+
+    it 'fetch methods' do
+      expect(connection).to have_received(:call).with('daemon.get_method_list')
+    end
+
+    it 'register methods' do
+      expect(subject.api_methods).to include('test.api.method')
+    end
+
+    it 'create namespace access methods' do
+      expect(subject.test).to be_a(Deluge::Api::Namespace).and have_attributes(name: 'test')
+    end
+
+    it 'create api access methods' do
+      expect(subject.test.api.method).to eq('winning')
+    end
+  end
+
+  describe '#close' do
+    before do
+      subject.connect
+
+      subject.close
+    end
+
+    it 'closes connection' do
+      expect(connection).to have_received(:close)
+    end
+
+    it 'clear namespaces' do
+      expect(subject.namespaces).to be_empty
+    end
+
+    it 'clear methods' do
+      expect(subject.api_methods).to be_empty
+    end
+
+    it 'remove namespace methods' do
+      expect(subject).not_to respond_to(:test)
+    end
+  end
+end

data/spec/deluge/api/namespace_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Deluge::Api::Namespace do
+
+  let(:connection) do
+    double('ApiConnection').tap do |connection|
+      allow(connection).to receive(:call)
+    end
+  end
+
+  let(:instance) { described_class.new('root', connection) }
+
+  describe '#register_namespace' do
+    let(:result) { instance.register_namespace('test') }
+
+    it 'register new namespace' do
+      expect(result).to eq(instance.namespaces[:test])
+    end
+
+    it 'returns registered namespace' do
+      expect(result).to be_a(described_class).and have_attributes(name: 'root.test')
+    end
+
+    it 'returns existing namespace if its already registered' do
+      expect(instance.register_namespace('test')).to eql(result)
+    end
+
+    it 'creates namespace access instance method' do
+      expect(result).to eq(instance.test)
+    end
+  end
+
+  describe '#register_method' do
+    before do
+      instance.register_method('test')
+    end
+
+    it 'register new api method' do
+      expect(instance.api_methods).to include('root.test')
+    end
+
+    it 'create instance method' do
+      expect(instance).to respond_to(:test)
+    end
+  end
+
+  describe 'api access instance method' do
+    before do
+      instance.register_method('test')
+
+      instance.test('hello', 'world')
+    end
+
+    it 'invoke api call' do
+      expect(connection).to have_received(:call).with('root.test', 'hello', 'world')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'deluge/api'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: deluge-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Yamolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rencoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Communicate with Deluge torrent client via RPC protocol
+email:
+- clouster@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- deluge-api.gemspec
+- lib/deluge.rb
+- lib/deluge/api.rb
+- lib/deluge/api/client.rb
+- lib/deluge/api/connection.rb
+- lib/deluge/api/namespace.rb
+- lib/deluge/api/version.rb
+- spec/deluge/api/client_spec.rb
+- spec/deluge/api/namespace_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/t3hk0d3/deluge-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Deluge RPC protocol wrapper
+test_files:
+- spec/deluge/api/client_spec.rb
+- spec/deluge/api/namespace_spec.rb
+- spec/spec_helper.rb
+has_rdoc: