deluge-rpc 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8fdcfe0656ef321dd54ac8d8f5a8f788bcd17cd6
-  data.tar.gz: 1157ad39d1fbfe536fb1d35ed4c72c8dc16cad6f
+SHA256:
+  metadata.gz: fae94aca88e0cdf01efdc40596aea1d07b24d48d475f7302723bf82abdeb7a64
+  data.tar.gz: ffa497496c6caa1027eab7dde89a6676df48a34634344c109863cf974509f4b3
 SHA512:
-  metadata.gz: c2d795c706720dff717af01890ec926fb258444353456fe725dde872ba83c9a22e7d724760719daab364975f2dbd8136dfa6f605e338c798894e7b9e5b4aeb30
-  data.tar.gz: 4225adb085e5dceab4e3e7268335cfaddad2b53c9b62ada57df808cf69f1ca0644f000cc4ebc3636f512b24e7e597686b49456dd7e1d011692c2d0eb2f25d15c
+  metadata.gz: f670476d2ab81393c6b0db0393293c1ca2e4db7c3170bf19c7d17d623e3596447b5e622b4ad5287e9dde8e4c38a3f027f7a909f608f35267788b65c05e9b442e
+  data.tar.gz: 4fde233a805d65cccde068bf7838a2407682902ecb88bb42e9d1454dd67f0153e94703a75d984fd62aa7337dc34b5bf8e1628e65d293e87133140e3a99a4cd76

data/.ruby-version

@@ -1 +1 @@
-2.1.4
+3.0.3

data/README.md

@@ -1,14 +1,19 @@
 # Deluge::RPC
 
-Ruby RPC client library for Deluge torrent client.  
-Provides dynamic API bindings depending on RPC server.  
+Ruby RPC client library for [Deluge 2.0+ torrent client](https://deluge-torrent.org/).
+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 1.x is not supported anymore*.
 
-Deluge RPC API reference:  
-http://deluge.readthedocs.org/en/develop/core/rpc.html#remote-api
+## Reference
+
+* [Official RPC protocol documentation](https://deluge.readthedocs.io/en/latest/reference/rpc.html)
+* [Deluge RPC API reference](https://deluge.readthedocs.io/en/latest/reference/api.html)
+* [Official repository](https://github.com/deluge-torrent/deluge)
+* Other client implementations:
+  [Go](https://github.com/gdm85/go-libdeluge),
+  [Python](https://github.com/JohnDoee/deluge-client)
 
 ## Usage
 
@@ -72,10 +77,10 @@ client.register_event(:torrent_removed) do |torrent_id|
 end
 ```
 
-Unfortunately there is no way to listen ALL events, due to Deluge architecture.  
+Unfortunately there is no way to listen ALL events, due to Deluge architecture.
 You have to register each event you need.
 
-**Keep in mind event blocks would be executed in connection thread, NOT main thread!**  
+**Keep in mind event blocks would be executed in connection thread, NOT main thread!**
 Avoid time-consuming code!
 
 ### Known events
@@ -100,10 +105,11 @@ Avoid time-consuming code!
 ``PluginEnabledEvent``        | name                    | Plugin is enabled in the Core.
 ``PluginDisabledEvent``       | name                    | Plugin is disabled in the Core.
 
-This list was extracted from Deluge 1.3.11 sources. Events for your version could be different.  
+This list was extracted from Deluge 1.3.11 sources. Events for your version could be different.
 There is no official documentation.
 
-Current events could be found here: http://git.deluge-torrent.org/deluge/tree/deluge/event.py
+Current events could be found here:
+https://github.com/deluge-torrent/deluge/blob/master/deluge/event.py
 
 ## Installation
 
@@ -115,8 +121,12 @@ gem 'deluge-rpc'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install deluge-rpc
+```shell
+$ gem install deluge-rpc
+```

data/deluge-rpc.gemspec

@@ -12,14 +12,17 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Communicate with Deluge torrent client via RPC protocol}
   spec.homepage      = "https://github.com/t3hk0d3/deluge-rpc"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.6' # rubocop:disable Gemspec/RequiredRubyVersion
 
   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'
+  spec.add_dependency 'concurrent-ruby', '~> 1.1.8'
+  spec.add_dependency 'rencoder', '~> 0.2'
+
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.90'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.43'
 end

data/lib/deluge/rpc/connection.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'rencoder'
+
 require 'socket'
 require 'openssl'
 require 'thread'
@@ -14,6 +17,8 @@ module Deluge
       class InvokeTimeoutError < StandardError; end
       class ConnectionClosedError < StandardError; end
 
+      PROTOCOL_VERSION = 0x01
+
       DAEMON_LOGIN = 'daemon.login'
       DAEMON_METHOD_LIST = 'daemon.get_method_list'
       DAEMON_REGISTER_EVENT = 'daemon.set_event_interest'
@@ -62,7 +67,7 @@ module Deluge
       end
 
       def authenticate(login, password)
-        self.call(DAEMON_LOGIN, login, password)
+        self.call(DAEMON_LOGIN, [login, password, {'client_version' => Deluge::Rpc::VERSION.to_s}])
       end
 
       def method_list
@@ -88,7 +93,10 @@ module Deluge
         raise "Not connected!" unless @connection
 
         kwargs = {}
-        kwargs = args.pop if args.size == 1 && args.last.is_a?(Hash)
+        if args.size == 1 && args[0].last.is_a?(Hash)
+          kwargs = args[0].pop
+          args   = args[0]
+        end
 
         future = Concurrent::IVar.new
 
@@ -102,7 +110,7 @@ module Deluge
         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.")
+          raise InvokeTimeoutError.new("Failed to retrieve response for '#{method}' in #{@call_timeout} seconds. Probably method not exists.")
         end
 
         result
@@ -167,6 +175,7 @@ module Deluge
 
       def write_packet(packet)
         raw = Zlib::Deflate.deflate Rencoder.dump(packet)
+        raw = [PROTOCOL_VERSION, raw.bytesize].pack("CN") + raw
 
         @write_mutex.synchronize do
           if IO.select([], [@connection], nil, nil)
@@ -177,11 +186,16 @@ module Deluge
 
       def read_packets(socket)
         raw = ""
-        begin
-          buffer = socket.readpartial(1024)
-          raw += buffer
-        end until(buffer.size < 1024)
 
+        # Read message header
+        protocol_version, buffer_size = socket.readpartial(5).unpack('CN')
+
+        raise('Received response with unknown protocol_version=' + protocol_version) if protocol_version != PROTOCOL_VERSION
+
+        # a big response requires some extra reads because deluged may be
+        # slow to generate and send all the data through the socket
+        raw += socket.readpartial(buffer_size - raw.bytesize) while raw.bytesize < buffer_size
+        
         raw = Zlib::Inflate.inflate(raw)
 
         parse_packets(raw)
@@ -210,12 +224,7 @@ module Deluge
       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
+        OpenSSL::SSL::SSLContext.new
       end
 
       def parse_packets(raw)

data/lib/deluge/rpc/version.rb

@@ -1,5 +1,5 @@
 module Deluge
   module Rpc
-    VERSION = "0.1.3"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deluge-rpc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Igor Yamolov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,56 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 1.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 1.1.8
 - !ruby/object:Gem::Dependency
   name: rencoder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.43'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.43'
 description: Communicate with Deluge torrent client via RPC protocol
 email:
 - clouster@yandex.ru
@@ -93,7 +107,7 @@ homepage: https://github.com/t3hk0d3/deluge-rpc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,20 +115,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.32
+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: