synowebapi 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7ec3b360d441100cae0596ff45f524c9f48156e0
-  data.tar.gz: a685d90e737519bce903bbfd62594a197a56b931
+SHA256:
+  metadata.gz: cd7b2c36dcab9883e6f5f5487f7d25393a3a230d4e0d5fd1d75e7c6ffd2709e3
+  data.tar.gz: 52b1b96765944fde24b2aa6c3ebcbbb2fd6528297879f8b57f6339b02e1d52af
 SHA512:
-  metadata.gz: 978be7989b2a57cdc5de5119dba59f8c7374980fa9b6f947da6ca966a54bdb8c3abc00177963c05751ce6ddad1026a40edfea716ebc8318fc550d857ff3dbf16
-  data.tar.gz: c4e4250cef5f09be9f4fe01393eea63e31ee194c610207146dac02a00cbc23c678a0c5020d427742e6b038b09dca816626d72fdca814fbb2c179b2270ddf09f4
+  metadata.gz: 139fde7fc431783e0f3aa22864811f5039eeac85db8e08ef0dbd5cab123f4755e66694885bb3f7af81e2ce05ed8019e92e9c5f94214d32c32dd6439366f9f370
+  data.tar.gz: 94a8472a89085e32e507c463c7af3523fc0954581e95024e824f01e513f63cf99108c68db8cf9f01b6c398f8cd8384a2b50ab1a915708c4adf35ece06d8feacb

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    synowebapi (0.0.3)
+      faraday (~> 0)
+      faraday_middleware (~> 0)
+      httpclient
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.17.6)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.14.0)
+      faraday (>= 0.7.4, < 1.0)
+    httpclient (2.8.3)
+    multipart-post (2.4.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  synowebapi!
+
+BUNDLED WITH
+   2.3.5

data/LICENSE

@@ -0,0 +1,23 @@
+
+http://cccheng.mit-license.org/
+
+Copyright © 2015 Chung-Chiang Cheng <shepjeng@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -4,7 +4,7 @@ Ruby gem for [Synology](http://www.synology.com//) Web API
 
 ## Installation
 
-```
+```sh
 $ gem install synowebapi
 ```
 
@@ -16,38 +16,29 @@ require 'synowebapi'
 client = SYNOWebAPI::Client.new('http://192.168.10.10:5000')
 client.connect(username: 'admin', password: 'password')
 
+# Enable telnet service
+# Check `cat /usr/syno/synoman/webapi/SYNO.Core.Terminal.lib | jq` for partial API info
 client['SYNO.Core.Terminal'].request(method: 'set', enable_telnet: true)
+# Yet another way to send the identical request above
 client['SYNO.Core.Terminal'].set(enable_ssh: true)
 
+# Show disks information.
+# Check `cat /usr/syno/synoman/webapi/SYNO.Storage.CGI.lib | jq` for partial API info
+resp = client['SYNO.Storage.CGI.Storage'].load_info
+resp['disks'].each do |disk|
+        puts "%-8s %-10s %-25s %-20s" % [disk['name'], disk['vendor'], disk['model'], disk['serial']]
+end
+
+# Download file from shared folder 'public'
+# https://global.download.synology.com/download/Document/DeveloperGuide/Synology_File_Station_API_Guide.pdf
+client['SYNO.FileStation.Download'].download('/any/test.jpg', {method: 'download', version: 2, path: '/public/file', mode: 'open'})
+
 client.disconnect
 ```
 
 ## Requirements
 
+* httpclient
 * faraday
 * faraday-middleware
 
-## License
-
-http://cccheng.mit-license.org/
-
-Copyright © 2015 Chung-Chiang Cheng <shepjeng@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-

data/lib/synowebapi/api.rb

@@ -15,6 +15,20 @@ module SYNOWebAPI
       @request_format = params['requestFormat']
     end
 
+    def download(output_path, params, options = {})
+      @client.download(self, output_path, params, options)
+    end
+
+    def post(params)
+      resp = @client.post(self, params)
+
+      if resp['success']
+        resp['data']
+      else
+        error_handling(resp['error'])
+      end
+    end
+
     def request(params)
       resp = @client.send(self, params)
 

data/lib/synowebapi/client.rb

@@ -7,15 +7,14 @@ module SYNOWebAPI
   class Client
     attr_reader :url, :api, :session_id, :session_name
 
-    def initialize(url, **params)
+    def initialize(url)
       @url = url
       @session_id = @session_name = ''
       @conn = Faraday.new(:url => @url) do |f|
         f.request(:url_encoded)
+        f.response(:json)
         f.adapter(Faraday.default_adapter)
-        f.use(FaradayMiddleware::ParseJson)
       end
-      connect(params) if params
     end
 
     def connect(params)
@@ -33,6 +32,37 @@ module SYNOWebAPI
       self['SYNO.API.Auth'].logout(:session => @session_id)
     end
 
+    def download(api, output_path, params = {}, options = {})
+      require 'httpclient'
+      http_client = HTTPClient.new
+      if options[:receive_timeout]
+        http_client.receive_timeout = options[:receive_timeout]
+      end
+      open(output_path, 'wb') do |file|
+        http_client.get_content(
+          URI.parse(URI.encode("#{@url}/webapi/#{api.path}")),
+          {
+            :api => api.api_name,
+            :version => api.max_version,
+            :_sid => @session_id,
+          }.merge(params)
+        ) do |chunk|
+          file.write chunk
+        end
+      end
+    end
+
+    def post(api, params = {})
+      @conn.post("/webapi/#{api.path}", {
+        :api => api.api_name,
+        :version => api.max_version,
+        :_sid => @session_id,
+      }.merge(params)).body
+
+    rescue Faraday::ParsingError
+      raise StandardError.new("Failed to parse response")
+    end
+
     def send(api, params = {})
       @conn.get("/webapi/#{api.path}", {
         :api => api.api_name,
@@ -62,8 +92,10 @@ module SYNOWebAPI
           api[api_name] = API.new(api_name, self, params)
         end
       end
+
+    rescue Faraday::ParsingError
+      raise StandardError.new("Failed to parse query response")
     end
 
   end
 end
-

data/lib/synowebapi/version.rb

@@ -1,5 +1,5 @@
 
 module SYNOWebAPI
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end
 

data/lib/synowebapi.rb

@@ -9,5 +9,4 @@ module SYNOWebAPI
   require 'synowebapi/version'
   require 'synowebapi/client'
   require 'synowebapi/api'
-
 end

data/synowebapi.gemspec

@@ -9,12 +9,13 @@ Gem::Specification.new do |s|
   s.email           = ['shepjeng@gmail.com', 'cccheng@synology.com']
   s.summary         = 'Ruby gem for Synology Web API'
   s.description     = s.summary
-  s.homepage        = 'http://github.com/shepjeng/ruby-synowebapi'
+  s.homepage        = 'https://github.com/Synology/ruby-synowebapi'
   s.license         = 'MIT'
 
   s.files           = %x[git ls-files].split($/).sort
   s.require_paths   = ['lib']
 
-  s.add_dependency 'faraday', '~> 0'
-  s.add_dependency 'faraday_middleware', '~> 0'
+  s.add_dependency 'httpclient'
+  s.add_dependency 'faraday'
+  s.add_dependency 'faraday_middleware'
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: synowebapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Chung-Chiang Cheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby gem for Synology Web API
@@ -47,6 +61,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
 - lib/synowebapi.rb
 - lib/synowebapi/api.rb
@@ -54,7 +70,7 @@ files:
 - lib/synowebapi/error.rb
 - lib/synowebapi/version.rb
 - synowebapi.gemspec
-homepage: http://github.com/shepjeng/ruby-synowebapi
+homepage: https://github.com/Synology/ruby-synowebapi
 licenses:
 - MIT
 metadata: {}
@@ -73,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Ruby gem for Synology Web API