qbt_client 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8436ebfd25aa67e8c8f10ae8baa2fca78dc29ae2
-  data.tar.gz: f1877a204e61e20eb554d56feacd60bfcfb5a579
+  metadata.gz: 19603f9f387f46f6042de088397e2f79a0fd458c
+  data.tar.gz: f5080d278e403119bdccac72968f006da73831b8
 SHA512:
-  metadata.gz: ba09cc0d16fcd1d7a8162c8ffeb33d213418e09110bdddf5c8cff49ae8717ced8f1d62325208baf03fa2cccc93f7e4286dcdf6eb471fe9386d37df84f3f8f57d
-  data.tar.gz: 0df4fa56464b1bf4eff81582e85812519ded024a2ffea0442b4c7f257258f2273b25df90377e5bf8fde981e1c6c2ca497db488295557604b4e908117747d90c4
+  metadata.gz: d3366cbdb34f1f6ee4a635a025cfa8d0cc6ec7394c278ad37569645a7296ed06491bdbea3124f7b3d579066d444b25522a3df0aec56e07094e2a6b383b9485b7
+  data.tar.gz: f54b45c0fa6e33f3e3b237d4137473931da3925e2c52920e213af0318f710ac7ac35c4b15cfbfec0157f6ddbe8cae517a98d3d00b28b106f6639f9db8b4e5bbb

data/CHANGES.md

@@ -9,15 +9,15 @@ Update client to work with qBitTorrent 3.3.4 WebUI changes
 - `/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`
+- `/command/getTorrentDlLimit` changed to `/command/getTorrentsDlLimit`
   - `hash` option changed to `hashes` option
-- `/command/setTorrentDlLimit' changed to `/command/setTorrentsDlLimit`
+- `/command/setTorrentDlLimit` changed to `/command/setTorrentsDlLimit`
   - `hash` option changed to `hashes` option
-- `/command/getTorrentUpLimit' changed to `/command/getTorrentsUpLimit`
+- `/command/getTorrentUpLimit` changed to `/command/getTorrentsUpLimit`
   - `hash` option changed to `hashes` option
-- `/command/setTorrentUpLimit' changed to `/command/setTorrentsUpLimit`
+- `/command/setTorrentUpLimit` changed to `/command/setTorrentsUpLimit`
   - `hash` option changed to `hashes` option
-- Turn on network debug output when DEBUG env var is set
+- Turn on network debug output when `DEBUG` env var is set
 
 
 ## v0.1.0

data/lib/qbt_client.rb

@@ -1,6 +1,8 @@
 require "qbt_client/version"
 
 module QbtClient
+  class QbtClientError < StandardError
+  end
 end
 
 require 'qbt_client/web_ui'

data/lib/qbt_client/version.rb

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

data/lib/qbt_client/web_ui.rb

@@ -32,7 +32,9 @@ module QbtClient
       @sid        = nil
 
       #self.class.digest_auth(user, pass)
-      self.class.base_uri "#{ip}:#{port}"
+      host = "#{ip}:#{port}"
+      self.class.base_uri host
+      self.class.headers "Referer" => host
       authenticate
       self.class.cookies.add_cookies(@sid)
     end
@@ -56,14 +58,46 @@ module QbtClient
       res = self.class.post('/login', options)
       if res.success?
         token = res.headers["Set-Cookie"]
-        raise "Login failed" if token.nil?
+        raise QbtClientError.new("Login failed: no SID (cookie) returned") if token.nil?
 
         token = token.split(";")[0]
-        #token = token.split("SID=")[1]
         @sid = token
+      else
+        raise QbtClientError.new(res)
       end
     end
 
+    ###
+    # Get the application's API version
+    #
+    # Returns an integer
+    #
+    def api_version
+      self.class.format :json
+      self.class.get('/version/api').parsed_response
+    end
+
+    ###
+    # Get the application's minimum API version
+    #
+    # Returns an integer
+    #
+    def api_min_version
+      self.class.format :json
+      self.class.get('/version/api_min').parsed_response
+    end
+
+    ###
+    # Get the application's version
+    #
+    # Returns an integer
+    #
+    def qbittorrent_version
+      self.class.format :plain
+      self.class.get('/version/qbittorrent').parsed_response
+      #self.class.get('/version/qbittorrent')
+    end
+
     ###
     # Get array of all torrents
     #

data/qbt_client.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "httparty", "~> 0.7"
+  spec.add_runtime_dependency "json"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/lib/qbt_client/web_ui_spec.rb

@@ -8,6 +8,42 @@ describe WebUI do
     sleep 1
   end
 
+  context "#api_version" do
+
+    it "return the current API version" do
+      hash, name = given_a_paused_downloading_torrent
+      client = WebUI.new(test_ip, test_port, test_user, test_pass)
+      api_ver = client.api_version
+
+      puts "    api version: #{api_ver}"
+      expect(api_ver.integer?).to eq true
+    end
+  end
+
+  context "#api_min_version" do
+
+    it "return the minimum API version" do
+      hash, name = given_a_paused_downloading_torrent
+      client = WebUI.new(test_ip, test_port, test_user, test_pass)
+      api_ver = client.api_min_version
+
+      puts "    minimum api version: #{api_ver}"
+      expect(api_ver.integer?).to eq true
+    end
+  end
+
+  context "#qbittorrent_version" do
+
+    it "return the application version" do
+      hash, name = given_a_paused_downloading_torrent
+      client = WebUI.new(test_ip, test_port, test_user, test_pass)
+      app_ver = client.qbittorrent_version
+
+      puts "    qbittorrent version: #{app_ver}"
+      expect(app_ver.start_with?('v')).to eq true
+    end
+  end
+
   context "#torrent_list" do
 
     it "returns array of torrents" do
@@ -185,7 +221,9 @@ describe WebUI do
 
       # Read preferences back and verify update
       res = client.preferences
-      expect(res["save_path"]).to eq save_path
+      # NOTE: qBitTorrent now tacks on a trailing file separator to its
+      # save path if it doesn't already exist.
+      expect(res["save_path"]).to eq (save_path + "/")
 
       # Set the save_path back to original value
       res = client.set_preferences({ "save_path"=>orig_save_path })
@@ -221,7 +259,7 @@ describe WebUI do
       client = WebUI.new(test_ip, test_port, test_user, test_pass)
       res = client.pause_all
       # Give app a chance to update
-      sleep 2
+      sleep 4
 
       data = client.torrent_data hash
       #print_response data
@@ -531,6 +569,10 @@ describe WebUI do
 
       actual_limit = client.global_download_limit
 
+      puts "         old limit: #{old_limit}"
+      puts "    expected limit: #{expected_limit}"
+      puts "      actual limit: #{actual_limit}"
+
       expect(expected_limit == actual_limit).to eq true
 
       # Clean up

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbt_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeff McAffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: qBittorent client