qnap-file_station 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5b17e28b82aa0b9bd84caad5770597a5c2583cf
-  data.tar.gz: f32a9a1d6fb8b94567858240380a09e6f451346c
+SHA256:
+  metadata.gz: ca26ebc789756816af968b65dc339121add6123ff8d0711bc6ce76f22be61f66
+  data.tar.gz: f96d5b60f387ccba7c896ff1b8fc7f7dcd0653f7ff8b09d67e6f940140dff0bb
 SHA512:
-  metadata.gz: 0a4aad404e2a946c721b01e15d21eb0b17a9189a68b1c11533edf5fb7feda00215ba36c5d687b0804b53b80ceff41ae53f54f1ead168dd376e9bd7f801309492
-  data.tar.gz: 94334ac4acc3435d43d0e4889064463ff9754436d2eae99a0be96fa87376173c6f647d44cb2f01368875884e5c52a4e470a3e913f475e83b6edf0ce1037244c7
+  metadata.gz: e25869cf0edddbde0c6198044dfcfdba1e0ab95b5bb4095b09abd06b18cd11319dd88550d3211b24b22ef8e21b82c5be6f5ada2ae4c7823f6b44dcf2592e4c76
+  data.tar.gz: 46af445566e25654086b92a31ef4749cc48515f834e76ee6cad6144a0313a05e7db7f61f09c98d48cf648aa43b7c9d3b18293e4fb5e2656f38b6d72bd3700bc9

data/README.md

@@ -1,6 +1,8 @@
 Qnap::FileStation
 =======
 
+> 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 File Station app that comes installed by default on many QNAP NAS.
 
 It provides access to all available endpoints, but the documentation is patchy and untested. Use with caution.
@@ -39,6 +41,21 @@ end
 
 ```
 
+Alternatively, if the username and password are not provided, Qnap::FileStation will attempt to read them from environment variables.
+```ruby
+# ENV['QNAP_USERNAME']
+# ENV['QNAP_PASSWORD']
+
+fs = Qnap::FileStation.new '192.168.1.100'
+# ...
+fs.logout
+
+# or...
+Qnap::FileStation.session('192.168.1.100') do |fs|
+	# ...
+end
+```
+
 Constants
 -------
 `Qnap::FileStation::DEBUG`, default: `false`. Print extensive debugging information to `$stdout` if `true`
@@ -290,7 +307,7 @@ path | Folder path.
 file_total | Total number of folder/file(s).
 file_name | Folder/file name.
 
-### stat 
+### stat
 Set folder(s)/file(s) modification time.
 
 #### Parameters
@@ -316,7 +333,7 @@ limit | Number of response data
 sort | Sort field (filename/filesize/filetype/mt/privilege/owner/group)
 start | Response data start index
 
-### 
+###
 Download a shared file by an unique ID (ssid).
 
 #### Parameters
@@ -463,7 +480,7 @@ Show available network players (AirPlay, Chromecast, DLNA players, etc.) May not
 #### Parameters
 Key | Description
 --- | ---
-op | 1: 
+op | 1:
 
 ### video_ml_queue
 Retrieve the status of media library transcoding queue.

data/lib/qnap/file_station.rb

@@ -103,7 +103,11 @@ module Qnap
 			@sid ||= login(user: @username, pwd: Base64.encode64(@password).strip)[: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
@@ -111,7 +115,7 @@ module Qnap
 			@base_uri = URI "#{PROTOCOL}://#{@host}"
 			@path     = "/cgi-bin/filemanager/utilRequest.cgi"
 			@agent    = Net::HTTP.new @base_uri.host, @base_uri.port
-			
+
 			@agent.use_ssl = PROTOCOL == 'https',
 			@agent.verify_mode = OpenSSL::SSL::VERIFY_NONE
 			@agent.keep_alive_timeout = 10
@@ -123,7 +127,7 @@ module Qnap
 		def despatch_query(path, params)
 			uri = @base_uri.clone
 			uri.path = path
-			uri.query = URI.encode_www_form(params) if params.keys.length > 0
+			uri.query = URI.encode_www_form(params).gsub('+', '%20') if params.keys.length > 0
 			req = Net::HTTP::Get.new uri
 
 			puts "\n\n\e[1;32mDespatching request to #{params[:func]}\e[0m" if DEBUG

data/qnap-file_station.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
 	s.name         = "qnap-file_station"
-	s.version      = "0.0.3"
+	s.version      = "0.0.6"
 	s.summary      = "Interface to the File Station API"
-	s.description  = "Manage your files and folders in File Station"
+	s.description  = "Manage your files and folders in File Station. (Compatible with older, QTS 4.x models)"
 	s.authors      = "cyclotron3k"
 	s.files        = ["lib/qnap/file_station.rb", "lib/qnap/api_error.rb", "Rakefile", "qnap-file_station.gemspec", "README.md"]
 	s.test_files   = ["test/test_file_station.rb"]

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: qnap-file_station
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - cyclotron3k
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies: []
-description: Manage your files and folders in File Station
+description: Manage your files and folders in File Station. (Compatible with older,
+  QTS 4.x models)
 email: 
 executables: []
 extensions: []
@@ -41,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Interface to the File Station API