qnap-download_station 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95c97768502e19e7b96d3d507bf82287141dfede
+  data.tar.gz: 78f15e2110972d614542ecf16b22c49e8f170e53
+SHA512:
+  metadata.gz: 4c110e4dc4cd730ccf8970961c10b77af96e6bc14847af6c2246db0f5644901cd7cc99c599ecd9609bbc255e86ace8159413da1afc8600f5654ea67604753034
+  data.tar.gz: ba26c14d726db3a5e30f80a44a0fa3cfd71e1e141d54be7e48f399be5b35eb22462d7ddf78efe0d3496c4cb5024a574828429103e78d05b5b55bfddf66f012cc

data/README.md

@@ -0,0 +1,85 @@
+Qnap::DownloadStation
+=======
+
+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.
+
+Installation
+-------
+
+`gem install qnap-download_station`
+
+Usage
+-------
+
+```ruby
+require 'qnap/download_station'
+
+magnet_link = "magnet:?xt=urn:btih:c12fe1c06bba254a9dc9f519b335aa7c1367a88a&dn"
+
+ds = Qnap::DownloadStation.new '192.168.1.100', 'username', 'password'
+ds.task_add_url temp: 'Download', move: 'Multimedia/New', url: magnet_link
+active_downloads = ds.task_query
+ds.logout
+```
+
+Available methods
+-------
+
+**Account methods**
+* account_add
+* account_query
+* account_remove
+* account_update
+
+**Addon methods**
+* addon_enable
+* addon_install
+* addon_query
+* addon_search
+* addon_uninstall
+* addon_verify
+
+**Config methods**
+* config_get
+* config_set
+
+**Misc methods**
+* misc_dir
+* misc_env
+* misc_login
+* misc_logout
+* misc_socks_5
+
+**Rss methods**
+* rss_add
+* rss_add_job
+* rss_query
+* rss_query_feed
+* rss_query_job
+* rss_remove
+* rss_remove_job
+* rss_update
+* rss_update_feed
+* rss_update_job
+
+**Tasks**
+* task_add_torrent
+* task_add_url
+* task_detail
+* task_get_file
+* task_pause
+* task_priority
+* task_query
+* task_remove
+* task_set_file
+* task_start
+* task_status
+* task_stop
+
+Notes and known issues
+-------
+
+* Needs inputs validation
+* Need to allow users to specify a SSL cert instead of just ignoring certificate errors

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/qnap/download_station.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'net/http'
+require 'openssl'
+require 'base64'
+
+module Qnap
+	class DownloadStation
+		PROTOCOL = 'https'
+		APP_NAME = 'downloadstation'
+		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],
+			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],
+			addon:   [:query, :enable, :verify, :install, :uninstall, :search],
+		}
+
+		def logout
+			return unless @sid
+
+			data = misc_logout
+
+			@sid = nil
+			data
+		end
+
+		def misc_login(params={})
+			# override the auto-gen method
+			# otherwise `get_sid` is called
+			despatch_query(uri_for_path(:misc, :login), params)
+		end
+
+		API_METHODS.each do |app, endpoints|
+			endpoints.each do |endpoint|
+
+				method_name = "#{app}_#{endpoint}".to_sym
+				next if method_defined? method_name
+
+				define_method method_name, Proc.new { |params={}|
+					despatch_query(
+						uri_for_path(app, endpoint),
+						params.merge(sid: get_sid)
+					)
+				}
+			end
+		end
+
+		def get_sid
+			@sid ||= misc_login(user: @username, pass: Base64.encode64(@password))[:sid]
+		end
+
+		def initialize(host, username, password)
+			@host     = host
+			@username = username
+			@password = password
+			@sid      = nil
+		end
+
+		private
+
+		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}")
+		end
+
+		def despatch_query(uri, params)
+			req = Net::HTTP::Post.new uri
+			req.form_data = params
+
+			response = Net::HTTP.start(
+				uri.host,
+				uri.port,
+				use_ssl: PROTOCOL == 'https',
+				verify_mode: OpenSSL::SSL::VERIFY_NONE
+			) do |https|
+				https.request req
+			end
+
+			data = JSON.parse response.read_body, symbolize_names: true
+
+			if (data.key?(:error) and data[:error] > 0)
+				pp data
+				raise RuntimeError.new data[:reason]
+			end
+
+			data
+		end
+	end
+end

data/qnap-download_station.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+	s.name         = "qnap-download_station"
+	s.version      = "0.0.1"
+	s.date         = "2016-09-21"
+	s.summary      = "Interface to the Download Station API"
+	s.description  = "Manage your downloads in Download Station"
+	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"]
+	s.homepage     = "https://github.com/cyclotron3k/qnap-download_station"
+	s.license      = "MIT"
+	s.required_ruby_version = ">= 1.9.0"
+end

data/test/test_download_station.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'qnap/download_station'
+
+class TestDownloadStation < Minitest::Test
+	def test_argument
+		assert_raises ArgumentError do
+			Qnap::DownloadStation.new
+		end
+	end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: qnap-download_station
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- cyclotron3k
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies: []
+description: Manage your downloads in Download Station
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/qnap/download_station.rb
+- qnap-download_station.gemspec
+- test/test_download_station.rb
+homepage: https://github.com/cyclotron3k/qnap-download_station
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Interface to the Download Station API
+test_files:
+- test/test_download_station.rb