qnap-download_station 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b10081f0cf4abe429c48bdd7c60fa15d34c4fda8
-  data.tar.gz: 6104a3b1f6dc9db6d4d8d022aa1de0307a59f503
+SHA256:
+  metadata.gz: 8edd6d1df5e35026968775bcadeafc18732cda70f724eb9ebb8e38eab903b8ea
+  data.tar.gz: 6135d684cceca1cc61039b02d64fc9ff0d9d448cf8533a736de591bfaa95594d
 SHA512:
-  metadata.gz: c9961e935e456e2c7c3fdc568dca3c8db08066df54ab1bee6c67be8a7bae17c5b8d50b64b10d78412e0a4fb7cac6ae7dc04c51e7347ba12a457cfac879e0ac5b
-  data.tar.gz: f27c1be4a506a4e0286832c64cbba2d7b21c51b450ebdd50bd0cb0b2611668c5eb416b79a118016a79b87b0d19cc1714c0367a7a6cf08d1fdde4ea822543816e
+  metadata.gz: 795824e716f88a14a2d2827d78d4c3721d0c44bd29d085e69851a18252d93c0c274c4374a122fa0735c1db8cfae4ed9c408f71429f63c7e04e221f16985f7dc9
+  data.tar.gz: d3baf6d6ab6d54df37cc1ea76bb8a5516f7708a79efb1fd7e72848afb73422c6ac93a17b8ad6ed4ca31837c2c065bce8f9d692b3f069c1ce583023e42c343b99

data/README.md

@@ -1,10 +1,16 @@
 Qnap::DownloadStation
 =======
 
+> NOTE: This library works with older QNAP NAS models that use QTS 4.x. Newer models are now being released with QTS 5.x, and most likely this library will not work with them. Patches welcome.
+
 This gem provides an interface to the Download Station app that comes installed by default on many QNAP NAS.
 
 It provides access to all available endpoints, but only a few have been documented.
 
+If you can help document the endpoints, and provide example use cases, please feel free to send pull requests.
+
+This software is an unofficial client for the QNAP api, and is not endorsed by QNAP. Future updates to your QNAP could possibly break the functionality of this library without warning.
+
 Installation
 -------
 
@@ -14,20 +20,23 @@ Usage
 -------
 
 ```ruby
+# Download a Linux ISO from the web
 require 'qnap/download_station'
 
-magnet_link = "magnet:?xt=urn:btih:c12fe1c06bba254a9dc9f519b335aa7c1367a88a&dn"
+ubuntu_iso = "http://de.releases.ubuntu.com/18.04/ubuntu-18.04-desktop-amd64.iso"
 
 ds = Qnap::DownloadStation.new '192.168.1.100', 'username', 'password'
-ds.task_add_url temp: 'Download', move: 'Multimedia/New', url: magnet_link
+ds.task_add_url temp: 'Download', move: 'Multimedia/New', url: ubuntu_iso
 active_downloads = ds.task_query
 ds.logout
 ```
 
 ```ruby
 # Alternative syntax to guarantee logout
+# Start downloading a file over BitTorrent using a Magnet link
 
 Qnap::DownloadStation.session('192.168.1.100', 'username', 'password') do |ds|
+	magnet_link = "magnet:?xt=urn:btih:c12fe1c06bba254a9dc9f519b335aa7c1367a88a&dn"
 	ds.task_add_url temp: 'Download', move: 'Multimedia/New', url: magnet_link
 	pp ds.task_query
 	# logout is automatically called, even if there was an exception
@@ -35,6 +44,21 @@ end
 
 ```
 
+Alternatively, if the username and password are not provided, Qnap::DownloadStation will attempt to read them from environment variables.
+```ruby
+# ENV['QNAP_USERNAME']
+# ENV['QNAP_PASSWORD']
+
+ds = Qnap::DownloadStation.new '192.168.1.100'
+# ...
+ds.logout
+
+# or...
+Qnap::DownloadStation.session('192.168.1.100') do |ds|
+	# ...
+end
+```
+
 Available methods
 -------
 
@@ -80,6 +104,7 @@ Available methods
 * task_add_url
 * task_detail
 * task_get_file
+* task_get_torrent_file
 * task_pause
 * task_priority
 * task_query

data/lib/qnap/download_station.rb

@@ -10,7 +10,7 @@ module Qnap
 		API_VERSION = 'V4'
 		API_METHODS = {
 			misc:    [:dir, :env, :login, :logout, :socks_5],
-			task:    [:status, :query, :detail, :add_url, :add_torrent, :start, :stop, :pause, :remove, :priority, :get_file, :set_file],
+			task:    [:status, :query, :detail, :add_url, :add_torrent, :start, :stop, :pause, :remove, :priority, :get_file, :set_file, :get_torrent_file],
 			rss:     [:add, :query, :update, :remove, :query_feed, :update_feed, :add_job, :query_job, :update_job, :remove_job],
 			config:  [:get, :set],
 			account: [:add, :query, :update, :remove],
@@ -60,7 +60,11 @@ module Qnap
 			@sid ||= misc_login(user: @username, pass: Base64.encode64(@password))[:sid]
 		end
 
-		def initialize(host, username, password)
+		def initialize(host, username = ENV['QNAP_USERNAME'], password = ENV['QNAP_PASSWORD'])
+
+			raise ArgumentError.new("No username defined") if username.nil?
+			raise ArgumentError.new("No password defined") if password.nil?
+
 			@host     = host
 			@username = username
 			@password = password

data/qnap-download_station.gemspec

@@ -1,9 +1,8 @@
 Gem::Specification.new do |s|
 	s.name         = "qnap-download_station"
-	s.version      = "0.0.2"
-	s.date         = "2016-09-21"
+	s.version      = "0.0.5"
 	s.summary      = "Interface to the Download Station API"
-	s.description  = "Manage your downloads in Download Station"
+	s.description  = "Manage your downloads in Download Station. (Compatible with older, QTS 4.x models)"
 	s.authors      = "cyclotron3k"
 	s.files        = ["lib/qnap/download_station.rb", "Rakefile", "qnap-download_station.gemspec", "README.md"]
 	s.test_files   = ["test/test_download_station.rb"]

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: qnap-download_station
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - cyclotron3k
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies: []
-description: Manage your downloads in Download Station
+description: Manage your downloads in Download Station. (Compatible with older, QTS
+  4.x models)
 email: 
 executables: []
 extensions: []
@@ -40,8 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Interface to the Download Station API