qnap-file_station 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afd92ae3b99527ea64cb659f422cf54e8f4e3b04
-  data.tar.gz: 06665735be81179b757a10b1d980013eef0232b3
+  metadata.gz: 7b53bdac66bf563c2314cdad578479e57b1c621b
+  data.tar.gz: eba64d3cf0bec2d666fd2d43ce771317e327cb2e
 SHA512:
-  metadata.gz: 0c1ee4272265edcbed969ea1f7d93e1e628bb38568cc29723b89f0b6493aab5f4f9df27270a69b42812d75a009b7c03489dd5ad278a4a23cbf16b8e717617bc1
-  data.tar.gz: 3a88ad3757fabce25d6ad8a80b7619921fc290c9a46be98125ce1eea302ecd1247ad318df9d0914024a17fc2e20650bd3925a05ec397b46461aec125a11678a9
+  metadata.gz: 7e6c546e57b12b145e6101f97e69bc7f6509f886baff56c6add067a2996fc5ceddeba238c43e08acdb405b74441b2102611c0c9d24fad90805a8449bf895ab42
+  data.tar.gz: a080dea3bfb8c1868a7cd722234dfa91997c447d353dea539a94e182cb369bfb3ffcce7487c85fc9989bc04246c8dde09b20aa1ebc63708adee31a76d89aa9e7

data/README.md

@@ -17,7 +17,7 @@ Usage
 require 'qnap/file_station'
 
 fs = Qnap::FileStation.new '192.168.1.100', 'username', 'password'
-fs.createdir dest_folder: "", dest_path: ""
+fs.createdir dest_folder: "new_folder", dest_path: "/some/path"
 contents = fs.get_extract_list extract_file: "my_zip_file.zip"
 fs.logout
 ```
@@ -25,15 +25,47 @@ fs.logout
 ```ruby
 # Alternative syntax to guarantee logout
 
+Qnap::FileStation::DEBUG = true
+
 Qnap::FileStation.session('192.168.1.100', 'username', 'password') do |fs|
 	# Show contents of the recycle bin
 	pp fs.get_tree node: "recycle_root"
+
+	# Show available network players (AirPlay, Chromecast, DLNA players, etc.)
+	# May not be available, depending on model
+	pp fs.get_network_players op: 1
 	# logout is automatically called, even if there was an exception
 end
 
 ```
 
+Constants
+-------
+`Qnap::FileStation::DEBUG`, default: `false`. Print extensive debugging information to @stdout of `true`
+`Qnap::FileStation::DISCARD_EXTRANEOUS` default: `true`, Discard any parameters we're not expecting, before despatching to the API
+`Qnap::FileStation::PROTOCOL`, default: `"https"`
+
+Exceptions
+-------
+API communication errors will raise a Qnap::ApiError exception. The message will indicate what went wrong, the `uri` method will return the URI that was being queried at the time, and `the response` method will return the `Net::HTTPResponse` response
+
+```ruby
+begin
+	Qnap::FileStation.session('192.168.1.100', 'username', 'invalid_password') do |fs|
+		fs.get_tree node: "recycle_root"
+	end
+rescue Qnap::ApiError => e
+	puts "Error message was" + e.message
+	puts "URI was " + e.uri.to_s
+	puts "Response code was " + e.response.code
+	puts "Response body was " + e.response.read_body
+end
+
+```
+
+
 Available methods
+-------
 
 ### createdir
 Create a folder in the specified path.
@@ -423,6 +455,14 @@ Key | Description
 path | The path folder name of recycle bin
 file_name | Same as the value ${path}
 
+### get_network_players (alias: `qrpac`)
+Show available network players (AirPlay, Chromecast, DLNA players, etc.) May not be available, depending on model
+
+#### Parameters
+Key | Description
+--- | ---
+op | 1: 
+
 ### video_ml_queue
 Retrieve the status of media library transcoding queue.
 

data/lib/qnap/api_error.rb

@@ -0,0 +1,64 @@
+module Qnap
+	class ApiError < StandardError
+		attr_reader :uri, :response
+
+		STATUS_CODES = [
+			[ 0, "WFM2_FAIL",                        "Unknown error"],
+			[ 1, "WFM2_DONE",                        "Success"],
+			# [ 1, "WFM2_SUCCESS",                     "Success"],
+			[ 2, "WFM2_FILE_EXIST",                  "File already exists"],
+			[ 3, "WFM2_AUTH_FAIL",                   "Authentication Failure"],
+			[ 4, "WFM2_PERMISSION_DENY",             "Permission Denied"],
+			[ 5, "WFM2_FILE_NO_EXIST",               "File or folder does not exist"],
+			# [ 5, "WFM2_SRC_FILE_NO_EXIST",           "File/folder does not exist"],
+			[ 6, "WFM2_EXTRACTING",                  "FILE EXTRACTING"],
+			[ 7, "WFM2_OPEN_FILE_FAIL",              "Failed to open file"],
+			[ 8, "WFM2_DISABLE",                     "Web File Manager is not enabled"],
+			[ 9, "WFM2_QUOTA_ERROR",                 "You have reached the disk quota limit"],
+			[10, "WFM2_SRC_PERMISSION_DENY",         "You do not have permission to perform this action"],
+			[11, "WFM2_DES_PERMISSION_DENY",         "You do not have permission to perform this action"],
+			[12, "WFM2_ILLEGAL_NAME",                "Invalid character encountered: \"+=/\\:|*?<>;[]%,`'"],
+			[13, "WFM2_EXCEED_ISO_MAX",              "The maximum number of allowed ISO shares is 256"],
+			[14, "WFM2_EXCEED_SHARE_MAX",            "The maximum number of shares is going to be exceeded"],
+			[15, "WFM2_NEED_CHECK",                  nil],
+			[16, "WFM2_RECYCLE_BIN_NOT_ENABLE",      "Recycle bin is not enabled"],
+			[17, "WFM2_CHECK_PASSWORD_FAIL",         "Enter password"],
+			[18, "WFM2_VIDEO_TCS_DISABLE",           nil],
+			[19, "WFM2_DB_FAIL",                     "The system is currently busy"],
+			# [19, "WFM2_DB_QUERY_FAIL",               "The system is currently busy"],
+			[20, "WFM2_PARAMETER_ERROR",             "There were input errors"],
+			[21, "WFM2_DEMO_SITE",                   "Your files are now being transcoded"],
+			[22, "WFM2_TRANSCODE_ONGOING",           "Your files are now being transcoded"],
+			[23, "WFM2_SRC_VOLUME_ERROR",            "An error occurred in the source file"],
+			[24, "WFM2_DES_VOLUME_ERROR",            "A write error has occurred at the destination"],
+			[25, "WFM2_DES_FILE_NO_EXIST",           "The destination is unavailable"],
+			[26, "WFM2_FILE_NAME_TOO_LONG",          "255 filename byte limit exceeded"],
+			[27, "WFM2_FOLDER_ENCRYPTION",           "This folder has been encrypted"],
+			[28, "WFM2_PREPARE",                     "Processing now"],
+			[29, "WFM2_NO_SUPPORT_MEDIA",            "This file format is not supported"],
+			[30, "WFM2_DLNA_QDMS_DISABLE",           "Please enable the DLNA Media Server"],
+			[31, "WFM2_RENDER_NOT_FOUND",            "Cannot find any available DLNA devices"],
+			[32, "WFM2_CLOUD_SERVER_ERROR",          "The SmartLink service is currently busy"],
+			[33, "WFM2_NAME_DUP",                    "File or folder name already exists"],
+			[34, "WFM2_EXCEED_SEARCH_MAX",           nil],
+			[35, "WFM2_MEMORY_ERROR",                nil],
+			[36, "WFM2_COMPRESSING",                 nil],
+			[37, "WFM2_EXCEED_DAV_MAX",              nil],
+			[38, "WFM2_UMOUNT_FAIL",                 nil],
+			[39, "WFM2_MOUNT_FAIL",                  nil],
+			[40, "WFM2_WEBDAV_ACCOUNT_PASSWD_ERROR", nil],
+			[41, "WFM2_WEBDAV_SSL_ERROR",            nil],
+			[42, "WFM2_WEBDAV_REMOUNT_ERROR",        nil],
+			[43, "WFM2_WEBDAV_HOST_ERROR",           nil],
+			[44, "WFM2_WEBDAV_TIMEOUT_ERROR",        nil],
+			[45, "WFM2_WEBDAV_CONF_ERROR",           nil],
+			[46, "WFM2_WEBDAV_BASE_ERROR",           nil],
+		]
+
+		def initialize(status_code, uri, response=nil)
+			@uri = uri
+			@response = response
+			super STATUS_CODES[status_code.to_i].last(2).compact.join ' - '
+		end
+	end
+end

data/lib/qnap/file_station.rb

@@ -2,10 +2,14 @@ require 'json'
 require 'net/http'
 require 'openssl'
 require 'base64'
+require 'qnap/api_error'
 
 module Qnap
 	class FileStation
+		DEBUG = false
+		DISCARD_EXTRANEOUS = true
 		PROTOCOL = 'https'
+
 		API_METHODS = {
 			cancel_compress: [:pid],
 			cancel_extract: [:pid],
@@ -31,6 +35,7 @@ module Qnap
 			get_tree: [:is_iso, :node],
 			get_video_qstatus: [:pid],
 			move: [:mode, :source_file, :source_path, :source_total],
+			qrpac: [:op],
 			rename: [:dest_name, :path, :source_name],
 			search: [:dir, :keyword, :limit, :sort, :source_path, :start],
 			share_file: [:access_code, :access_enabled, :addressee, :content, :day, :dowdownload_type, :expire_time, :file_name, :file_total, :hostname, :hour, :include_access_code, :link_url, :mail_content_date, :mail_content_pwd, :network_type, :path, :ssl, :subject, :valid_duration],
@@ -58,21 +63,24 @@ module Qnap
 
 			define_method method_name, Proc.new { |params={}|
 				if (diff = fields - params.keys).count > 0
-					puts "Missing keys: #{diff}"
+					puts "Missing keys: #{diff}" if DEBUG
 				end
 
-				if (diff = params.keys - fields).count > 0
-					puts "Extra keys: #{diff}"
+				if DISCARD_EXTRANEOUS and (diff = params.keys - fields).count > 0
+					puts "Discarding extra keys: #{diff}"
+					params.select! { |k, v| fields.include? k }
 				end
 
-				despatch_query @url, params.merge(func: method_name, sid: get_sid)
+				despatch_query @path, params.merge(func: method_name, sid: get_sid)
 			}
 
 		end
 
+		alias get_network_players qrpac
+
 		def login(params={})
 			despatch_query(
-				"#{PROTOCOL}://#{@host}/cgi-bin/filemanager/wfm2Login.cgi",
+				"/cgi-bin/filemanager/wfm2Login.cgi",
 				params
 			)
 		end
@@ -80,10 +88,15 @@ module Qnap
 		def logout(params={})
 			return unless @sid
 			despatch_query(
-				"#{PROTOCOL}://#{@host}/cgi-bin/filemanager/wfm2Logout.cgi",
+				"/cgi-bin/filemanager/wfm2Logout.cgi",
 				params.merge(sid: @sid)
 			)
 			@sid = nil
+
+			if @agent.started?
+				@agent.finish
+				puts "\e[1;32mClosing connection\e[0m" if DEBUG
+			end
 		end
 
 		def get_sid
@@ -95,27 +108,33 @@ module Qnap
 			@username = username
 			@password = password
 			@sid      = nil
-			@url      = "#{PROTOCOL}://#{@host}/cgi-bin/filemanager/utilRequest.cgi"
+			@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
+			@agent.set_debug_output $stdout if DEBUG
 		end
 
 		private
 
-		def despatch_query(url, params)
-			uri = URI url
+		def despatch_query(path, params)
+			uri = @base_uri.clone
+			uri.path = path
 			uri.query = URI.encode_www_form(params) if params.keys.length > 0
 			req = Net::HTTP::Get.new uri
 
-			response = Net::HTTP.start(
-				uri.host,
-				uri.port,
-				use_ssl: PROTOCOL == 'https',
-				verify_mode: OpenSSL::SSL::VERIFY_NONE
-			) do |https|
-				https.request req
-			end
+			puts "\n\n\e[1;32mDespatching request to #{params[:func]}\e[0m" if DEBUG
+
+			@session = @agent.start unless @agent.started?
+			response = @session.request req
+
+			puts "\e[1;32mResponse received\e[0m" if DEBUG
 
 			unless (200..299).include? response.code.to_i
-				raise RuntimeError.new "Error response from #{uri} -> #{response.read_body}"
+				raise "Error response from #{uri} -> #{response.read_body}"
 			end
 
 			unless response['content-type'] =~ /application\/json/
@@ -125,63 +144,10 @@ module Qnap
 			data = JSON.parse response.read_body, symbolize_names: true
 			
 			if data.respond_to?(:key?) and data.key?(:status) and data[:status] != 1
-				raise RuntimeError.new "Error response from #{uri} -> #{data}"
+				raise Qnap::ApiError.new data[:status], uri, response
 			end
 
 			data
 		end
 	end
 end
-
-__END__
-Error code, Token, Description
-0 WFM2_FAIL UNKNOWN ERROR
-1 WFM2_DONE SUCCESS
-1 WFM2_SUCCESS SUCCESS
-2 WFM2_FILE_EXIST FILE EXIST
-3 WFM2_AUTH_FAIL Authentication Failure
-4 WFM2_PERMISSION_DENY Permission Denied
-5 WFM2_FILE_NO_EXIST FILE/FOLDER NOT EXIST
-5 WFM2_SRC_FILE_NO_EXIST FILE/FOLDER NOT EXIST
-6 WFM2_EXTRACTING FILE EXTRACTING
-7 WFM2_OPEN_FILE_FAIL FILE IO ERROR
-8 WFM2_DISABLE Web File Manager is not enabled.
-9 WFM2_QUOTA_ERROR You have reached the disk quota limit.
-10 WFM2_SRC_PERMISSION_DENY You do not have permission to perform this action.
-11 WFM2_DES_PERMISSION_DENY You do not have permission to perform this action.
-12 WFM2_ILLEGAL_NAME " + = / \ : | * ? < > ; [ ] % , ` '
-13 WFM2_EXCEED_ISO_MAX The maximum number of allowed ISO shares is 256. Please unmount an ISO share
-14 WFM2_EXCEED_SHARE_MAX The maximum number of shares is going to be exceeded.
-15 WFM2_NEED_CHECK
-16 WFM2_RECYCLE_BIN_NOT_ENABLE
-17 WFM2_CHECK_PASSWORD_FAIL Enter password
-18 WFM2_VIDEO_TCS_DISABLE
-19 WFM2_DB_FAIL The system is currently busy. Please try again later.
-19 WFM2_DB_QUERY_FAIL The system is currently busy. Please try again later.
-20 WFM2_PARAMETER_ERROR There were input errors. Please try again later.
-21 WFM2_DEMO_SITE Your files are now being transcoded.
-22 WFM2_TRANSCODE_ONGOING Your files are now being transcoded.
-23 WFM2_SRC_VOLUME_ERROR An error occurred in the source file. Please check and try again later.
-24 WFM2_DES_VOLUME_ERROR A write error has occurred at the target destination. Please check and try again
-25 WFM2_DES_FILE_NO_EXIST The target destination is unavailable. Please check and try again later.
-26 WFM2_FILE_NAME_TOO_LONG 255 byte limit exceeded
-27 WFM2_FOLDER_ENCRYPTION This folder has been encrypted. Please decrypt it and try again.
-28 WFM2_PREPARE Processing now
-29 WFM2_NO_SUPPORT_MEDIA This file format is not supported.
-30 WFM2_DLNA_QDMS_DISABLE Please enable the DLNA Media Server
-31 WFM2_RENDER_NOT_FOUND Cannot find any available DLNA devices.
-32 WFM2_CLOUD_SERVER_ERROR The SmartLink service is currently busy. Please try again later.
-33 WFM2_NAME_DUP That folder or file name already exists. Please use another name.
-34 WFM2_EXCEED_SEARCH_MAX      1000
-35 WFM2_MEMORY_ERROR
-36 WFM2_COMPRESSING
-37 WFM2_EXCEED_DAV_MAX
-38 WFM2_UMOUNT_FAIL
-39 WFM2_MOUNT_FAIL
-40 WFM2_WEBDAV_ACCOUNT_PASSWD_ERROR
-41 WFM2_WEBDAV_SSL_ERROR
-42 WFM2_WEBDAV_REMOUNT_ERROR
-43 WFM2_WEBDAV_HOST_ERROR
-44 WFM2_WEBDAV_TIMEOUT_ERROR
-45 WFM2_WEBDAV_CONF_ERROR
-46 WFM2_WEBDAV_BASE_ERROR

data/qnap-file_station.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
 	s.name         = "qnap-file_station"
-	s.version      = "0.0.1"
+	s.version      = "0.0.2"
 	s.date         = "2016-09-28"
 	s.summary      = "Interface to the File Station API"
 	s.description  = "Manage your files and folders in File Station"
 	s.authors      = "cyclotron3k"
-	s.files        = ["lib/qnap/file_station.rb", "Rakefile", "qnap-file_station.gemspec", "README.md"]
+	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"]
 	s.homepage     = "https://github.com/cyclotron3k/qnap-file_station"
 	s.license      = "MIT"

data/test/test_file_station.rb

@@ -1,5 +1,6 @@
 require 'minitest/autorun'
 require 'qnap/file_station'
+require 'qnap/api_error'
 
 class TestFileStation < Minitest::Test
 	def test_argument
@@ -7,4 +8,8 @@ class TestFileStation < Minitest::Test
 			Qnap::FileStation.new
 		end
 	end
+
+	def test_error_code_integrity
+		assert_equal (0..46).to_a, Qnap::ApiError::STATUS_CODES.map(&:first)
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qnap-file_station
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - cyclotron3k
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/qnap/api_error.rb
 - lib/qnap/file_station.rb
 - qnap-file_station.gemspec
 - test/test_file_station.rb