qbt_client 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02480b67133ef8c463c04c2b734414497e1f98a5
-  data.tar.gz: 9e6287af4b5e9ff231454974ff8ba017ec7d3ea7
+  metadata.gz: 8436ebfd25aa67e8c8f10ae8baa2fca78dc29ae2
+  data.tar.gz: f1877a204e61e20eb554d56feacd60bfcfb5a579
 SHA512:
-  metadata.gz: 8c52453b44a058de5436aaff5da9fb1592ac2663e49752742751247086bd6b35e6c321d8fafed478c193255413a0b0a92c632b8197842b09c82b5a5fe1639d17
-  data.tar.gz: 64a53add284788198d77aec93a73c4039dc5152f3d616e9912e336fe62d4581147ea8b0b0d8c38d4fac25cf729afdaaafc4be1c9eb8e6d270658f060c71a6197
+  metadata.gz: ba09cc0d16fcd1d7a8162c8ffeb33d213418e09110bdddf5c8cff49ae8717ced8f1d62325208baf03fa2cccc93f7e4286dcdf6eb471fe9386d37df84f3f8f57d
+  data.tar.gz: 0df4fa56464b1bf4eff81582e85812519ded024a2ffea0442b4c7f257258f2273b25df90377e5bf8fde981e1c6c2ca497db488295557604b4e908117747d90c4

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.bin/
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/CHANGES.md

@@ -0,0 +1,25 @@
+# qbt_client CHANGELOG
+
+## v1.0.0
+
+Update client to work with qBitTorrent 3.3.4 WebUI changes
+
+- Login method has changed from digest authentication to cookie based token
+  - NOTE: minimum password length is now 6 chars
+- `/json/` url paths have changed to `/query/`
+- `/command/pauseall` has changed to `/command/pauseAll` (all paths are case sensitive)
+- `/command/resumeall` has changed to `/command/resumeAll`
+- `/command/getTorrentDlLimit' changed to `/command/getTorrentsDlLimit`
+  - `hash` option changed to `hashes` option
+- `/command/setTorrentDlLimit' changed to `/command/setTorrentsDlLimit`
+  - `hash` option changed to `hashes` option
+- `/command/getTorrentUpLimit' changed to `/command/getTorrentsUpLimit`
+  - `hash` option changed to `hashes` option
+- `/command/setTorrentUpLimit' changed to `/command/setTorrentsUpLimit`
+  - `hash` option changed to `hashes` option
+- Turn on network debug output when DEBUG env var is set
+
+
+## v0.1.0
+
+Initial release

data/README.md

@@ -28,7 +28,7 @@ require 'qtb_client'
 ip   = 'http://127.0.0.1' # Protocol is required.
 port = 8083
 user = 'admin'
-pass = 'abc'
+pass = 'abcabc'  # Min length for password is 6 chars
 
 client = QtbClient::WebUI.new(ip, port, user, pass)
 ```
@@ -59,7 +59,7 @@ To run the tests, you'll need to have qBittorrent installed locally, WebUI
 turned on, and the credentials set to:
 
 - user: admin
-- pass: abc
+- pass: abcabc
 
 The tests assume that qBittorrent is running at 127.0.0.1, port 8083.
 

data/lib/qbt_client/version.rb

@@ -1,3 +1,3 @@
 module QbtClient
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/qbt_client/web_ui.rb

@@ -17,7 +17,9 @@ module QbtClient
   class WebUI
     include HTTParty
 
-    #debug_output $stdout
+    if ENV["DEBUG"]
+      debug_output $stdout
+    end
 
     ###
     # constructor
@@ -27,9 +29,39 @@ module QbtClient
       @port       = port
       @user       = user
       @pass       = pass
+      @sid        = nil
 
-      self.class.digest_auth(user, pass)
+      #self.class.digest_auth(user, pass)
       self.class.base_uri "#{ip}:#{port}"
+      authenticate
+      self.class.cookies.add_cookies(@sid)
+    end
+
+
+    ###
+    # Authenticate with the server
+    #
+    # Login with username and password.
+    # Store returned SID cookie value used as auth token for later calls.
+    #
+    def authenticate
+      options = {
+        body: "username=#{@user}&password=#{@pass}"
+      }
+
+      # Have to clear out the cookies or the old SID gets sent while requesting
+      # the new SID (and it fails).
+      self.class.cookies.clear
+
+      res = self.class.post('/login', options)
+      if res.success?
+        token = res.headers["Set-Cookie"]
+        raise "Login failed" if token.nil?
+
+        token = token.split(";")[0]
+        #token = token.split("SID=")[1]
+        @sid = token
+      end
     end
 
     ###
@@ -69,7 +101,7 @@ module QbtClient
     #
     def torrent_list
       self.class.format :json
-      self.class.get('/json/torrents').parsed_response
+      self.class.get('/query/torrents').parsed_response
     end
 
     def torrent_data torrent_hash
@@ -104,7 +136,7 @@ module QbtClient
     #
     def properties torrent_hash
       self.class.format :json
-      self.class.get('/json/propertiesGeneral/' + torrent_hash).parsed_response
+      self.class.get('/query/propertiesGeneral/' + torrent_hash).parsed_response
     end
 
     ###
@@ -136,7 +168,7 @@ module QbtClient
     #
     def trackers torrent_hash
       self.class.format :json
-      self.class.get('/json/propertiesTrackers/' + torrent_hash).parsed_response
+      self.class.get('/query/propertiesTrackers/' + torrent_hash).parsed_response
     end
 
     ###
@@ -173,7 +205,7 @@ module QbtClient
     #
     def contents torrent_hash
       self.class.format :json
-      self.class.get('/json/propertiesFiles/' + torrent_hash).parsed_response
+      self.class.get('/query/propertiesFiles/' + torrent_hash).parsed_response
     end
 
     ###
@@ -187,7 +219,7 @@ module QbtClient
     #
     def transfer_info
       self.class.format :json
-      self.class.get('/json/transferInfo').parsed_response
+      self.class.get('/query/transferInfo').parsed_response
     end
 
     ###
@@ -269,7 +301,7 @@ module QbtClient
     #
     def preferences
       self.class.format :json
-      self.class.get('/json/preferences').parsed_response
+      self.class.get('/query/preferences').parsed_response
     end
 
     ###
@@ -303,7 +335,7 @@ module QbtClient
     # Pause all torrents
     #
     def pause_all
-      self.class.post('/command/pauseall')
+      self.class.post('/command/pauseAll')
     end
 
     ###
@@ -321,7 +353,7 @@ module QbtClient
     # Resume downloading/seeding of all torrents
     #
     def resume_all
-      self.class.post('/command/resumeall')
+      self.class.post('/command/resumeAll')
     end
 
     ###
@@ -539,10 +571,12 @@ module QbtClient
       self.class.format :json
 
       options = {
-        body: "hash=#{torrent_hash}"
+        body: "hashes=#{torrent_hash}"
       }
 
-      self.class.post('/command/getTorrentDlLimit', options).parsed_response
+      self.class
+        .post('/command/getTorrentsDlLimit', options)
+        .parsed_response[torrent_hash]
     end
 
     ###
@@ -554,13 +588,13 @@ module QbtClient
     # limit: integer (bytes)
     #
     def set_download_limit torrent_hash, limit
-      query = ["hash=#{torrent_hash}", "limit=#{limit}"]
+      query = ["hashes=#{torrent_hash}", "limit=#{limit}"]
 
       options = {
         body: query.join('&')
       }
 
-      self.class.post('/command/setTorrentDlLimit', options)
+      self.class.post('/command/setTorrentsDlLimit', options)
     end
 
     ###
@@ -574,10 +608,12 @@ module QbtClient
       self.class.format :json
 
       options = {
-        body: "hash=#{torrent_hash}"
+        body: "hashes=#{torrent_hash}"
       }
 
-      self.class.post('/command/getTorrentUpLimit', options).parsed_response
+      self.class
+        .post('/command/getTorrentsUpLimit', options)
+        .parsed_response[torrent_hash]
     end
 
     ###
@@ -589,13 +625,13 @@ module QbtClient
     # limit: integer (bytes)
     #
     def set_upload_limit torrent_hash, limit
-      query = ["hash=#{torrent_hash}", "limit=#{limit}"]
+      query = ["hashes=#{torrent_hash}", "limit=#{limit}"]
 
       options = {
         body: query.join('&')
       }
 
-      self.class.post('/command/setTorrentUpLimit', options)
+      self.class.post('/command/setTorrentsUpLimit', options)
     end
 
   private

data/spec/lib/qbt_client/web_ui_spec.rb

@@ -153,8 +153,8 @@ describe WebUI do
       res = client.transfer_info
 
       expect(res.class).to eq Hash
-      expect(res['dl_info']).to_not eq nil
-      expect(res['up_info']).to_not eq nil
+      expect(res['dl_info_data']).to_not eq nil
+      expect(res['up_info_data']).to_not eq nil
     end
   end
 
@@ -193,7 +193,7 @@ describe WebUI do
 
     it "fails when not provided a Hash" do
       client = WebUI.new(test_ip, test_port, test_user, test_pass)
-      expect{ client.set_preferences("\"save_path\":\"#{save_path}\"") }.to raise_exception
+      expect{ client.set_preferences("\"save_path\":\"#{save_path}\"") }.to raise_exception( TypeError )
     end
   end
 
@@ -356,6 +356,8 @@ describe WebUI do
       #puts "State: #{data['state']}"
       state_is_expected = (state == 'checkingDL' or state == 'checkingUP')
 
+      puts "    expected state: checkingDL or checkingUP"
+      puts "    actual state:   #{state}"
       expect(state_is_expected).to eq true
     end
   end
@@ -371,13 +373,14 @@ describe WebUI do
       # Turn on queueing or priority is always '*'.
       enable_queueing client, true
       sleep 2
+      puts "    queuing enabled: #{queueing_enabled?(client)}"
 
       # Get initial priority.
       prio = get_torrent_info client, hash2, 'priority'
 
       # Increase the priority.
       client.increase_priority hash2
-      sleep 2
+      sleep 5
 
       # Verify it got better (lower number).
       prio_after_increase = get_torrent_info client, hash2, 'priority'
@@ -400,13 +403,14 @@ describe WebUI do
       # Turn on queueing or priority is always '*'.
       enable_queueing client, true
       sleep 2
+      puts "    queuing enabled: #{queueing_enabled?(client)}"
 
       # Get initial priority.
       prio = get_torrent_info client, hash, 'priority'
 
       # Decrease the priority.
       client.decrease_priority hash
-      sleep 2
+      sleep 5
 
       # Verify it got worse (higher number).
       prio_after_decrease = get_torrent_info client, hash, 'priority'
@@ -443,7 +447,8 @@ describe WebUI do
       # Turn queueing back off.
       enable_queueing client, false
 
-      expect(prio_after_increase == '1').to eq true
+      puts "    prio_after_increase: #{prio_after_increase}"
+      expect(prio_after_increase == 1).to eq true
     end
   end
 
@@ -472,7 +477,8 @@ describe WebUI do
       # Turn queueing back off.
       enable_queueing client, false
 
-      expect(prio_after_decrease == '2').to eq true
+      puts "    prio_after_decrease: #{prio_after_decrease}"
+      expect(prio_after_decrease == 2).to eq true
     end
   end
 
@@ -569,6 +575,8 @@ describe WebUI do
       client = WebUI.new(test_ip, test_port, test_user, test_pass)
       limit = client.download_limit hash
 
+      puts "    limit is #{limit}"
+
       expect(limit.integer?).to eq true
     end
   end
@@ -585,6 +593,9 @@ describe WebUI do
 
       actual_limit = client.download_limit hash
 
+      puts "    expected limit is #{expected_limit}"
+      puts "    actual limit is #{actual_limit}"
+
       expect(expected_limit == actual_limit).to eq true
 
       # Clean up

data/spec/lib/qbt_client_spec.rb

@@ -4,8 +4,4 @@ describe QbtClient do
   it 'has a version number' do
     expect(QbtClient::VERSION).not_to be nil
   end
-
-  it 'does something useful' do
-    expect(false).to eq(true)
-  end
 end

data/spec/spec_helper.rb

@@ -20,7 +20,7 @@ def test_user
 end
 
 def test_pass
-  'abc'
+  'abcabc'
 end
 
 def test_torrent_url
@@ -149,6 +149,11 @@ def enable_queueing client, enable
   client.set_preferences({ "queueing_enabled" => enable })
 end
 
+def queueing_enabled? client
+  prefs = client.preferences
+  prefs['queueing_enabled']
+end
+
 def delete_all_torrents
   client = QbtClient::WebUI.new(test_ip, test_port, test_user, test_pass)
   torrents = client.torrent_list

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbt_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jeff McAffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
+date: 2016-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: qBittorent client
@@ -143,4 +144,3 @@ test_files:
 - spec/lib/qbt_client/web_ui_spec.rb
 - spec/lib/qbt_client_spec.rb
 - spec/spec_helper.rb
-has_rdoc: