synowebapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95ed9aa63ce6edb70a0cd2fdf0affa15e3f7eb85
+  data.tar.gz: 2ac9ba4a1b31f3963977b81b70c1584de9f58098
+SHA512:
+  metadata.gz: e37b1cd570ae8ef30ae1cbbecfd54f1eef9a9268672592403287137ac72de4f0baaed7ce92f00b5bc89ed204a48842fea273f05a962747934c63f981d74ec29d
+  data.tar.gz: e31c3ecec2f461d85d378984a12f78a02c1c04d045b1f40d9c9f2586ce7270401e043027c68f40f88617f17c61100cc2d304dcb8f978e9fabb6be6c08fac40f2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# SYNOWebAPI
+
+Ruby gem for [Synology](http://www.synology.com//) Web API
+
+## Installation
+
+```
+$ gem install synowebapi
+```
+
+## Synopsis
+
+```ruby
+require 'synowebapi'
+
+client = SYNOWebAPI::Client.new('http://192.168.10.10:5000')
+client.connect(username: 'admin', password: 'password')
+
+client['SYNO.Core.Terminal'].request(method: 'set', enable_telnet: true)
+client['SYNO.Core.Terminal'].set(enable_ssh: true)
+
+client.disconnect
+```
+
+## Requirements
+
+* 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.rb

@@ -0,0 +1,13 @@
+
+module SYNOWebAPI
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
+  unless $LOAD_PATH.any? { |lp| File.expand_path(lp) == ROOT }
+    $LOAD_PATH.unshift(ROOT)
+  end
+
+  require 'synowebapi/version'
+  require 'synowebapi/client'
+  require 'synowebapi/api'
+
+end

data/lib/synowebapi/api.rb

@@ -0,0 +1,32 @@
+
+require 'synowebapi/error'
+
+module SYNOWebAPI
+  class API
+    include SYNOWebAPI::ErrorHandler
+    attr_reader :api_name, :path, :min_version, :max_version, :request_format, :methods
+
+    def initialize(api_name, client, params)
+      @api_name = api_name
+      @client = client
+      @path = params['path']
+      @min_version = params['minVersion']
+      @max_version = params['maxVersion']
+      @request_format = params['requestFormat']
+    end
+
+    def request(params)
+      resp = @client.send(self, params)
+
+      if resp['success']
+        resp['data']
+      else
+        error_handling(resp['error'])
+      end
+    end
+
+    def method_missing(method_name, **args, &block)
+      request({:method => method_name}.merge(args))
+    end
+  end
+end

data/lib/synowebapi/client.rb

@@ -0,0 +1,68 @@
+
+require 'faraday'
+require 'faraday_middleware'
+require 'synowebapi/api'
+
+module SYNOWebAPI
+  class Client
+    attr_reader :url, :api, :session_id
+
+    def initialize(url, params = nil)
+      @url = url
+      @conn = Faraday.new(:url => @url) do |f|
+        f.adapter(Faraday.default_adapter)
+        f.use(FaradayMiddleware::ParseJson)
+      end
+      connect(params) if params
+    end
+
+    def connect(params)
+      resp = self['SYNO.API.Auth'].request(
+        :method => 'login',
+        :account => params[:username],
+        :passwd => params[:password],
+        :session => params[:session_id],
+        :format => 'sid',
+      )
+
+      @session_id = resp['sid']
+    end
+
+    def disconnect
+      self['SYNO.API.Auth'].request(:method => 'logout', :session => @session_id)
+    end
+
+    def send(api, params = {})
+      @conn.get("/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 [](api_name)
+      @api ||= query_api
+      @api[api_name] ? @api[api_name] : (raise ArgumentError.new("#{api_name} isn't found"))
+    end
+
+    private
+    def query_api
+      resp = @conn.get('webapi/query.cgi', {
+        :api => 'SYNO.API.Info',
+        :version => 1,
+        :method => 'Query',
+      }).body
+
+      {}.tap do |api|
+        resp['data'].each do |api_name, params|
+          api[api_name] = API.new(api_name, self, params)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/synowebapi/error.rb

@@ -0,0 +1,53 @@
+
+module SYNOWebAPI
+
+  ERRNO = {
+    100 => 'unknown error',
+    101 => 'bad request',
+    102 => 'API not found',
+    103 => 'method not found',
+    104 => 'unsupported version',
+    105 => 'no permission',
+    106 => 'session timeout',
+    107 => 'session interrupted',
+    108 => 'handling upload',
+    109 => 'process relay',
+    110 => 'process entry',
+    111 => 'process lib',
+    112 => 'compound stop',
+    113 => 'compound reject',
+    114 => 'no required parameter',
+    115 => 'denied in upload mode',
+    116 => 'denied in demo mode',
+    117 => 'internal error',
+    118 => 'process name error',
+    119 => 'session not found',
+    120 => 'invalid request parameter',
+    121 => 'mismatched lib entry',
+    122 => 'sharing session not found',
+    123 => 'sharing error token',
+    124 => 'sharing invalid entry',
+    125 => 'sharing timeout',
+    126 => 'sharing no permission',
+    127 => 'sharing no app permission',
+    400 => 'authentication failed',
+    401 => 'account disabled',
+    402 => 'permission denied',
+    403 => 'OTP code required',
+    404 => 'OTP code incorrect',
+    405 => 'App portal incorrect',
+    406 => 'OTP code enforced',
+    407 => 'max tries by auto blocking',
+  }
+
+  module ErrorHandler
+    def error_handling(error)
+      code = error['code']
+      if ERRNO.has_key?(code)
+        raise StandardError.new(ERRNO[code])
+      else
+        raise StandardError.new(code)
+      end
+    end
+  end
+end

data/lib/synowebapi/version.rb

@@ -0,0 +1,5 @@
+
+module SYNOWebAPI
+  VERSION = '0.0.1'
+end
+

data/synowebapi.gemspec

@@ -0,0 +1,20 @@
+
+require File.expand_path('../lib/synowebapi/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name            = 'synowebapi'
+  s.version         = SYNOWebAPI::VERSION
+  s.date            = Time.now.strftime('%Y-%m-%d')
+  s.authors         = ['Chung-Chiang Cheng']
+  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.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'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: synowebapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chung-Chiang Cheng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-07 00:00:00.000000000 Z
+dependencies:
+- !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
+email:
+- shepjeng@gmail.com
+- cccheng@synology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/synowebapi.rb
+- lib/synowebapi/api.rb
+- lib/synowebapi/client.rb
+- lib/synowebapi/error.rb
+- lib/synowebapi/version.rb
+- synowebapi.gemspec
+homepage: http://github.com/shepjeng/ruby-synowebapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby gem for Synology Web API
+test_files: []