rsynology 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rsynology.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Chen (chendo)
+
+MIT License
+
+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

@@ -0,0 +1,69 @@
+# RSynology
+
+This gems lets you interact the Synology DSM via their API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rsynology'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rsynology
+
+## Usage
+
+```ruby
+require 'rsynology'
+client = RSynology::Client.new("https://<DSM host>:5001/", verify_ssl: false)
+client.login!("username", "password")
+pp client.endpoints['SYNO.SurveillanceStation.Event'].query
+
+{"events"=>
+  [{"camera_id"=>2,
+    "event_size"=>3.739612579345703,
+    "frame_count"=>114,
+    "start_time"=>2013-02-26 22:02:16 +1100,
+    "stop_time"=>2013-02-26 22:02:30 +1100,
+    "video_codec"=>"MJPEG",
+    "id"=>24823,
+    "mode"=>1,
+    "status"=>0},
+   {"camera_id"=>2,
+    "event_size"=>3.819374084472656,
+    "frame_count"=>117,
+    "start_time"=>2013-02-26 22:02:02 +1100,
+    "stop_time"=>2013-02-26 22:02:16 +1100,
+    "video_codec"=>"MJPEG",
+    "id"=>24822,
+    "mode"=>1,
+    "status"=>0}],
+ "offset"=>0,
+ "total"=>11523}
+ ```
+
+ ## Status
+
+ ### Implemented APIs
+
+ * SYNO.API.Auth
+ * SYNO.SurveillanceStation.Event
+
+ Adding new APIs is pretty trivial. See either `auth.rb` or `surveillence_station_event.rb` in `lib/rsynology/client/`. Pull requests welcome!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT! See `LICENSE.txt`

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rsynology/client/api.rb

@@ -0,0 +1,76 @@
+module RSynology
+  class Client
+    class API
+      attr_reader :client, :options, :endpoint, :minVersion, :maxVersion
+
+      def self.api_name
+        raise NotImplementedError
+      end
+
+      def initialize(client, options)
+        @client = client
+        @options = options
+        @endpoint = options['path']
+        @minVersion = options['minVersion']
+        @maxVersion = options['maxVersion']
+      end
+
+      def api_name
+        self.class.api_name
+      end
+
+      def request(method, params, version = maxVersion)
+        params = {
+          method: method,
+          version: maxVersion,
+          api: api_name
+        }.merge(params)
+        client.request(endpoint, params)
+      end
+
+      protected
+
+      class UnknownError < StandardError; end
+      class InvalidParameters < ArgumentError; end
+      class APINotFound < ArgumentError; end
+      class MethodNotFound < ArgumentError; end
+      class APIVersionNotSupported < ArgumentError; end
+      class AccessDenied < StandardError; end
+      class ConnectionTimedOut < StandardError; end
+      class MultipleLoginsDetected < StandardError; end
+      class UnhandledErrorCode < StandardError; end
+
+      def handle_response(response)
+        if response['success']
+          response['data']
+        else
+          handle_error(response['error'])
+        end
+      end
+
+      def handle_error(error)
+        error_code = error['code']
+        case error_code
+        when 100
+          raise UnknownError
+        when 101
+          raise InvalidParameters
+        when 102
+          raise APINotFound
+        when 103
+          raise MethodNotFound
+        when 104
+          raise APIVersionNotSupported
+        when 105
+          raise AccessDenied
+        when 106
+          raise ConnectionTimedOut
+        when 107
+          raise MultipleLoginsDetected
+        else
+          raise UnhandledErrorCode, error_code
+        end
+      end
+    end
+  end
+end

data/lib/rsynology/client/auth.rb

@@ -0,0 +1,50 @@
+module RSynology
+  class Client
+    class Auth < API
+      attr_reader :client, :endpoint, :maxVersion
+
+      class AuthenticationFailed < StandardError; end
+
+      def self.api_name
+        'SYNO.API.Auth'
+      end
+
+      def login(account, password, session = nil, format = 'sid')
+        params = {
+          account: account,
+          passwd: password,
+          format: format,
+        }
+        params.merge!(session: session) if session
+
+        response = request("Login", params)
+
+        raise AuthenticationFailed if !response['success']
+
+        client.session_id = response['data']['sid']
+      end
+
+      def logout(session)
+        client.request(endpoint, {session: session})
+      end
+
+      protected
+
+      class AccountNotSpecified < ArgumentError; end
+      class InvalidPassword < StandardError; end
+      class AccountDisabledOrGuest < StandardError; end
+
+      def handle_error(error)
+        case error['code']
+        when 101
+          raise AccountNotSpecified
+        when 400
+          raise InvalidPassword
+        when 401
+          raise AccountDisabledOrGuest
+        end
+        super
+      end
+    end
+  end
+end

data/lib/rsynology/client/surveillance_station_event.rb

@@ -0,0 +1,50 @@
+require 'hashie/trash'
+
+module RSynology
+  class Client
+    class SurveillanceStationEvent < API
+
+      class Event < Hashie::Trash
+        TIME_TRANSFORM = lambda { |epoch| Time.at(epoch) }
+        property :id
+        property :camera_id, from: :cameraId
+        property :event_size, from: :eventSize
+        property :frame_count, from: :frameCount
+        property :mode
+        property :start_time, from: :startTime, with: TIME_TRANSFORM
+        property :stop_time, from: :stopTime, with: TIME_TRANSFORM
+        property :status
+        property :video_codec, from: :videoCodec
+
+        def duration
+          stop_time - start_time
+        end
+      end
+
+      def self.api_name
+        'SYNO.SurveillanceStation.Event'
+      end
+
+      def query(params = {})
+        default_params = {
+          offset: 0,
+          limit: 10,
+          mode: nil,
+          locked: nil,
+          camera_ids: nil,
+          from_time: nil,
+          to_time: nil
+        }
+
+        merged_params = default_params.merge(params).reject do |k, v|
+          v.nil?
+        end
+
+        resp = request("Query", merged_params)
+        event_collection = handle_response(resp)
+        event_collection['events'].map! { |event_data| Event.new(event_data) }
+        event_collection
+      end
+    end
+  end
+end

data/lib/rsynology/client.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module RSynology
+  class Client
+    attr_reader :connection
+    attr_accessor :session_id
+
+    class RequestFailed < StandardError; end
+
+    def initialize(url, options = {})
+      faraday_options = {url: url}
+      faraday_options[:ssl] = {verify: false} if options[:verify_ssl] == false
+
+      @connection = Faraday.new(faraday_options) do |faraday|
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.use FaradayMiddleware::ParseJson
+        faraday.use FaradayMiddleware::Mashify
+      end
+    end
+
+    def login!(account, password, session = nil, format = 'sid')
+      endpoints['SYNO.API.Auth'].login(account, password, session, format)
+    end
+
+    def endpoints
+      # Returns a hash of endpoints. Will return nil if no support
+      @endpoints ||= begin
+        resp = request('query.cgi', {
+          api: 'SYNO.API.Info',
+          method: 'Query',
+          version: 1,
+          query: 'SYNO.'
+        })
+        {}.tap do |result|
+          resp['data'].each do |endpoint, options|
+            next unless supported_apis[endpoint]
+            result[endpoint] = supported_apis[endpoint].new(self, options)
+          end
+        end
+      end
+    end
+
+    def request(endpoint, params)
+      params = params.merge(_sid: session_id) if session_id
+      resp = connection.get("/webapi/#{endpoint}", params)
+      resp.body
+    end
+
+    private
+
+    def supported_apis
+      @supported_apis ||= {}.tap do |apis|
+        self.class.constants.each do |symbol|
+          next if symbol == :API
+          const = self.class.const_get(symbol)
+          if const.respond_to?(:api_name)
+            apis[const.api_name] = const
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rsynology/version.rb

@@ -0,0 +1,3 @@
+module RSynology
+  VERSION = "0.0.1"
+end

data/lib/rsynology.rb

@@ -0,0 +1,4 @@
+Dir[File.join(File.dirname(__FILE__), 'rsynology', '**', '*.rb')].each { |f| require f }
+module RSynology
+
+end

data/rsynology.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rsynology/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rsynology"
+  gem.version       = RSynology::VERSION
+  gem.authors       = ["Jack Chen (chendo)"]
+  gem.email         = ["gems+rsynology@chen.do"]
+  gem.description   = %q{A gem to access the API exposed by Synology DSM apps}
+  gem.summary       = %q{A gem to access the API exposed by Synology DSM apps}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('faraday', '~> 0.8.5')
+  gem.add_dependency('faraday_middleware')
+  gem.add_dependency('hashie')
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: rsynology
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jack Chen (chendo)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to access the API exposed by Synology DSM apps
+email:
+- gems+rsynology@chen.do
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rsynology.rb
+- lib/rsynology/client.rb
+- lib/rsynology/client/api.rb
+- lib/rsynology/client/auth.rb
+- lib/rsynology/client/surveillance_station_event.rb
+- lib/rsynology/version.rb
+- rsynology.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A gem to access the API exposed by Synology DSM apps
+test_files: []