qnap-download_station 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95c97768502e19e7b96d3d507bf82287141dfede
-  data.tar.gz: 78f15e2110972d614542ecf16b22c49e8f170e53
+  metadata.gz: b10081f0cf4abe429c48bdd7c60fa15d34c4fda8
+  data.tar.gz: 6104a3b1f6dc9db6d4d8d022aa1de0307a59f503
 SHA512:
-  metadata.gz: 4c110e4dc4cd730ccf8970961c10b77af96e6bc14847af6c2246db0f5644901cd7cc99c599ecd9609bbc255e86ace8159413da1afc8600f5654ea67604753034
-  data.tar.gz: ba26c14d726db3a5e30f80a44a0fa3cfd71e1e141d54be7e48f399be5b35eb22462d7ddf78efe0d3496c4cb5024a574828429103e78d05b5b55bfddf66f012cc
+  metadata.gz: c9961e935e456e2c7c3fdc568dca3c8db08066df54ab1bee6c67be8a7bae17c5b8d50b64b10d78412e0a4fb7cac6ae7dc04c51e7347ba12a457cfac879e0ac5b
+  data.tar.gz: f27c1be4a506a4e0286832c64cbba2d7b21c51b450ebdd50bd0cb0b2611668c5eb416b79a118016a79b87b0d19cc1714c0367a7a6cf08d1fdde4ea822543816e

data/README.md

@@ -1,9 +1,9 @@
 Qnap::DownloadStation
 =======
 
-This gem provides an interface to the Download Station app that comes installed by default on many QNAP NAS
+This gem provides an interface to the Download Station app that comes installed by default on many QNAP NAS.
 
-It proves access to all endpoints, but only a few have been documented.
+It provides access to all available endpoints, but only a few have been documented.
 
 Installation
 -------
@@ -24,6 +24,17 @@ active_downloads = ds.task_query
 ds.logout
 ```
 
+```ruby
+# Alternative syntax to guarantee logout
+
+Qnap::DownloadStation.session('192.168.1.100', 'username', 'password') do |ds|
+	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
+end
+
+```
+
 Available methods
 -------
 
@@ -52,7 +63,7 @@ Available methods
 * misc_logout
 * misc_socks_5
 
-**Rss methods**
+**RSS methods**
 * rss_add
 * rss_add_job
 * rss_query
@@ -78,8 +89,9 @@ Available methods
 * task_status
 * task_stop
 
-Notes and known issues
+TODO
 -------
 
-* Needs inputs validation
-* Need to allow users to specify a SSL cert instead of just ignoring certificate errors
+* Document the endpoints
+* Input validation
+* Allow users to specify a SSL cert instead of just ignoring certificate errors

data/lib/qnap/download_station.rb

@@ -17,6 +17,15 @@ module Qnap
 			addon:   [:query, :enable, :verify, :install, :uninstall, :search],
 		}
 
+		def self.session(*args)
+			ds = self.new *args
+			begin
+				yield ds
+			ensure
+				ds.logout
+			end
+		end
+
 		def logout
 			return unless @sid
 
@@ -62,7 +71,7 @@ module Qnap
 
 		def uri_for_path(app, endpoint)
 			path = [app, endpoint].map { |s| s.to_s.gsub(/(^|_)(.)/){ $2.upcase } }.join "/"
-			URI("#{PROTOCOL}://#{@host}/#{APP_NAME}/#{API_VERSION}/#{path}")
+			URI "#{PROTOCOL}://#{@host}/#{APP_NAME}/#{API_VERSION}/#{path}"
 		end
 
 		def despatch_query(uri, params)
@@ -81,8 +90,7 @@ module Qnap
 			data = JSON.parse response.read_body, symbolize_names: true
 
 			if (data.key?(:error) and data[:error] > 0)
-				pp data
-				raise RuntimeError.new data[:reason]
+				raise RuntimeError.new "Error response from #{uri} -> #{data}"
 			end
 
 			data

data/qnap-download_station.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name         = "qnap-download_station"
-	s.version      = "0.0.1"
+	s.version      = "0.0.2"
 	s.date         = "2016-09-21"
 	s.summary      = "Interface to the Download Station API"
 	s.description  = "Manage your downloads in Download Station"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qnap-download_station
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - cyclotron3k
@@ -41,7 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Interface to the Download Station API