ducts-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ba367c428158d0baa377345220b10c67538329d4e0167b1d6dce86a29d732a0
+  data.tar.gz: 72f19f903159044c7f88c04b8a60e45fdc64672c44c7583f82f4d81d3cc4b5e9
+SHA512:
+  metadata.gz: 6e4e8e33b10ee10c684a9f09b0a0871f2cef598b8f3a80c88cfec56bbcd8a952790ad79079201994ac09f840faebc0cdff6121324d6d753b3c6669da3f6ad1c2
+  data.tar.gz: fa68f8a558a5a95826b0f0bcf3084d90582ccecfd072b4a8669b97645b43704065cf6c25f5d18f48f1712bb603c0d61ba9392950b7cb4688a9f0ea99a8c4d9bd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+Gemfile.lock
+.DS_Store

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kenshiro.ueda@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ductsclient.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kenshiro Ueda
+
+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,44 @@
+# Ducts-client
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ductsclient`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ducts-client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ducts-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iflb/ducts-client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/iflb/ducts-client-ruby/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ducts-client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iflb/ducts-client-ruby/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ductsclient"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ductsclient.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/ducts/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ducts-client'
+  spec.version       = Ducts::Client::VERSION
+  spec.authors       = ['Kenshiro Ueda']
+  spec.email         = ['ueda@iflab.co.jp']
+
+  spec.summary       = 'APIs of DUCTS for ruby clients.'
+  spec.homepage      = 'https://www.iflab.co.jp/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/iflb/ducts-client-ruby'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'faye-websocket', '~> 0.11'
+  spec.add_development_dependency 'msgpack', '~> 1.4'
+end

data/lib/ducts/client.rb

@@ -0,0 +1,306 @@
+#! /usr/bin/env ruby
+
+require_relative 'client/version'
+require 'thread'
+require 'timeout'
+require 'uri'
+require 'net/http'
+require 'json'
+require 'faye/websocket'
+require 'faye/websocket/api/event'
+require 'msgpack'
+require 'eventmachine'
+
+module Ducts
+  class Client
+    attr_reader :WSD, :EVENT, :connection_listener
+    attr_accessor :catchall_event_handler, :uncaught_event_handler, :event_error_handler
+
+    private
+    class DuctError < StandardError; end
+
+    class DuctCallTimeout < DuctError; end
+
+    class DuctEvent; end
+
+    class DuctConnectionEvent < DuctEvent
+      attr_reader :state, :source
+      def initialize(state, source)
+        super()
+        @state = state
+        @source = source
+      end
+    end
+
+    class DuctMessageEvent < DuctEvent
+      attr_reader :rid, :eid, :data
+      def initialize(event)
+        super()
+        rid, eid, data = MessagePack.unpack(event.data.map(&:chr).join)
+        @rid = rid
+        @eid = eid
+        @data = data
+      end
+    end
+
+    class DuctEventListener
+      def on(names, func)
+        names = [ names ] unless names.kind_of? Array
+        names.each do |name|
+          unless methods.include? name.to_sym
+            raise NoMethodError.new("[#{name}] in #{self.class}")
+          end
+          remove_method(name.to_sym)
+          define_singleton_method(name.to_sym, func)
+        end
+      end
+    end
+
+    class ConnectionEventListener < DuctEventListener
+      attr_writer :onopen, :onclose, :onerror, :onmessage
+      def onopen(event)
+        @onopen.call(event) if @onopen
+      end
+      def onclose(event)
+        @onclose.call(event) if @onclose
+      end
+      def onerror(event)
+        @onerror.call(event) if @onerror
+      end
+      def onmessage(event)
+        @onmessage.call(event) if @onmessage
+      end
+    end
+
+    module State
+      CLOSE           = -1
+      OPEN_CONNECTING = Faye::WebSocket::API::CONNECTING
+      OPEN_CONNECTED  = Faye::WebSocket::API::OPEN
+      OPEN_CLOSING    = Faye::WebSocket::API::CLOSING
+      OPEN_CLOSED     = Faye::WebSocket::API::CLOSED
+
+      def self.get_state_from_value(value)
+        (constants.map{ |x| const_get(x) }.include? value)? value : nil
+      end
+    end
+
+    module Message
+      PREFIX = '[Ducts]'
+
+      module Level
+        LOG = 0
+        WARNING = 1
+        ERROR = 2
+      end
+
+      def self.construct(level, raw_message)
+        case level
+        when Level::LOG
+          PREFIX + '[LOG] ' + raw_message
+        when Level::WARNING
+          PREFIX + '[WARNING] ' + raw_message
+        when Level::ERROR
+          PREFIX + '[ERROR] ' + raw_message
+        end
+      end
+    end
+
+    public
+    def initialize
+      @WSD = nil
+      @EVENT = nil
+      @connection_listener = ConnectionEventListener.new
+      @catchall_event_handler = lambda{ |rid, eid, data| }
+      @uncaught_event_handler = lambda{ |rid, eid, data| }
+      @event_error_handler = lambda{ |rid, eid, data, error|
+        warn Message.construct(Message::Level::ERROR, error.message)
+      }
+
+      @_last_rid = nil
+      @_ws = nil
+      @_waiting_completion = Hash.new
+    end
+
+    def next_rid
+      next_id = Time.now.to_i
+      if (!@_last_rid.nil? && (next_id <= @_last_rid))
+        next_id = @_last_rid + 1
+      end
+      @_last_rid = next_id
+      next_id
+    end
+
+    def open(wsd_url, uuid = nil, **params, &proc)
+      _open(wsd_url, uuid, **params, &proc)
+    end
+
+    def reconnect
+      _reconnect
+    end
+
+    def send(rid, eid, data)
+      _send(rid, eid, data)
+    end
+
+    def call(eid, data)
+      _call(eid, data)
+    end
+
+    def close
+      _close
+    end
+
+    def set_event_handler(event_id, &handler)
+      @_event_handler ||= {}
+      @_event_handler[event_id] = handler
+    end
+
+    def state
+      if @_ws
+        State.get_state_from_value(@_ws.ready_state)
+      else
+        State::CLOSE
+      end
+    end
+
+    private
+    def _reconnect(wsd)
+      if wsd
+        @WSD = wsd
+        @EVENT = @WSD['EVENT']
+      end
+      return if @_ws
+      Faye::WebSocket::Client.new(@WSD['websocket_url_reconnect']).tap do |ws|
+        ws.on(:open) do |event|
+          @_ws = ws
+          connection_event = DuctConnectionEvent.new('onopen', event)
+          _onreconnect(connection_event)
+          @connection_listener.onopen(connection_event)
+        end
+        ws.on(:close) do |event|
+          connection_event = DuctConnectionEvent.new('onclose', event)
+          @connection_listener.onclose(connection_event)
+        end
+        ws.on(:message) do |event|
+          message_event = DuctMessageEvent.new(event)
+          connection_event = DuctConnectionEvent.new('onmessage', message_event)
+          _onmessage(connection_event)
+          @connection_listener.onmessage(connection_event)
+        end
+        ws.on(:error) do |event|
+          connection_event = DuctConnectionEvent.new('onerror', event)
+          @connection_listener.onerror(connection_event)
+        end
+      end
+    end
+
+    def _open(wsd_url, uuid, **params)
+      return if @_ws
+      begin
+        query = '?uuid=' + (uuid || 'dummy') + params.map{ |k, v| "&#{k}=#{v}" }.join
+        uri = URI.parse(wsd_url + query)
+        https = Net::HTTP.new(uri.host, Net::HTTP.https_default_port).tap{ |h|
+          h.ssl_version = :SSLv23
+          h.use_ssl = true
+          h.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        }
+        response = https.get(uri)
+        @WSD = JSON.parse(response.body)
+        @EVENT = @WSD['EVENT']
+        Faye::WebSocket::Client.new(@WSD['websocket_url']).tap do |ws|
+          ws.on(:open) do |event|
+            @_ws = ws
+            connection_event = DuctConnectionEvent.new('onopen', event)
+            _onopen(connection_event)
+            @connection_listener.onopen(connection_event)
+          end
+          ws.on(:message) do |event|
+            message_event = DuctMessageEvent.new(event)
+            connection_event = DuctConnectionEvent.new('onmessage', message_event)
+            _onmessage(connection_event)
+            @connection_listener.onmessage(connection_event)
+          end
+          ws.on(:error) do |event|
+            connection_event = DuctConnectionEvent.new('onerror', event)
+            @connection_listener.onerror(connection_event)
+          end
+          ws.on(:close) do |event|
+            connection_event = DuctConnectionEvent.new('onclose', event)
+            @connection_listener.onclose(connection_event)
+          end
+        end
+      rescue => error
+        @connection_listener.onerror(DuctConnectionEvent.new('onerror', error))
+      end
+    end
+
+    def _onopen(event)
+      @_send_timestamp = Time.now.to_f
+      @_time_offset = 0
+      @_time_latency = 0
+      @_time_count = 0
+      set_event_handler(@EVENT['ALIVE_MONITORING']) do |rid, eid, data|
+        client_received = Time.now.to_f
+        server_sent, server_received = data
+        client_sent = @_send_timestamp
+        new_offset = ((server_received - client_sent) - (client_received - server_sent)) / 2
+        new_latency = ((client_received - client_sent) - (server_sent - server_received)) / 2
+        @_time_offset = (@_time_offset * @_time_count + new_offset) / (@_time_count + 1)
+        @_time_latency = (@_time_latency * @_time_count + new_latency) / (@_time_count + 1)
+        @_time_count += 1
+      end
+      rid = next_rid
+      eid = @EVENT['ALIVE_MONITORING']
+      value = @_send_timestamp
+      send(rid, eid, value)
+    end
+
+    def _onreconnect(connection_event)
+    end
+
+    def _send(rid, eid, data)
+      msgpack = [ rid, eid, data ].to_msgpack
+      @_ws.send(msgpack.chars.map(&:ord))
+      rid
+    end
+
+    def _call(eid, data)
+      rid = next_rid
+      _send(rid, eid, data)
+      raise if @_waiting_completion.keys.include? rid
+      EM::Completion.new.tap { |completion| @_waiting_completion[rid] = completion }
+    end
+
+    def _close
+      begin
+        @_ws.close if @_ws
+      ensure
+        @_ws = nil
+      end
+    end
+
+    def _onmessage(connection_event)
+      begin
+        rid, eid, data = %i(rid eid data).map{ |name| connection_event.source.public_send(name) }
+        begin
+          @catchall_event_handler.call(rid, eid, data)
+          handle = @_event_handler[eid]
+          handle = @uncaught_event_handler unless handle
+          handle.call(rid, eid, data)
+          completion = @_waiting_completion.delete(rid)
+          if completion
+            if eid > 0
+              completion.succeed(data)
+            else
+              completion.fail(DuctError.execption(data))
+            end
+          end
+        rescue => error
+          @event_error_handler.call(rid, eid, data, error)
+        end
+      rescue => error
+        @event_error_handler.call(-1, -1, nil, error)
+      end
+    end
+  end
+end

data/lib/ducts/client/version.rb

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+
+module Ducts
+  class Client
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+    end
+
+    VERSION = [ Version::MAJOR, Version::MINOR, Version::PATCH ].map(&:to_s).join('.')
+  end
+end

data/lib/ductsclient.rb

@@ -0,0 +1 @@
+require_relative 'ducts/client'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ducts-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kenshiro Ueda
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description:
+email:
+- ueda@iflab.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ductsclient.gemspec
+- lib/ducts/client.rb
+- lib/ducts/client/version.rb
+- lib/ductsclient.rb
+homepage: https://www.iflab.co.jp/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.iflab.co.jp/
+  source_code_uri: https://github.com/iflb/ducts-client-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: APIs of DUCTS for ruby clients.
+test_files: []