packserv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cffb8a18775bc97caa1f140d8d235067a251ee93c4de27d26e80cc285b075da
+  data.tar.gz: b435f4d13ae3b241be06b12aef669bd027fb4c38ab86393327aee54f182a71ee
+SHA512:
+  metadata.gz: 0d0844a8d74cc9777a1138226ee820fe3cddfe9a29ad0f9d4ed378d02732f16a81c8a6edbfb68821921e0e3419728799ee8810278a9e79d4ff7985ba56a53f9d
+  data.tar.gz: 673337d9f7a334faf5e2e953699d085586e995074189f0e130f1e76b9a6d55efe7d34407b92c52d8794b75eab188730112ab5bab90e924c08c8bed5816054768

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stone Tickle
+
+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,39 @@
+# Packserv
+[![Build Status](https://travis-ci.org/annacrombie/packserv.svg?branch=master)](https://travis-ci.org/annacrombie/packserv)
+[![Coverage Status](https://coveralls.io/repos/github/annacrombie/packserv/badge.svg?branch=master)](https://coveralls.io/github/annacrombie/packserv?branch=master)
+
+A simple server/client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'packserv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install packserv
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/packserv.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'packserv'
+
+# 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/lib/packserv.rb

@@ -0,0 +1,22 @@
+require 'socket'
+require 'msgpack'
+
+require 'packserv/client'
+require 'packserv/default_protocol'
+require 'packserv/exceptions'
+require 'packserv/io_packer'
+require 'packserv/io_unpacker'
+require 'packserv/server'
+require 'packserv/version'
+
+module PackServ
+  class << self
+    def connect(host, port)
+      Client.new.connect(host, port)
+    end
+
+    def serve(port)
+      Server.new.serve(port)
+    end
+  end
+end

data/lib/packserv/client.rb

@@ -0,0 +1,62 @@
+module PackServ
+  class Client
+    attr_accessor :handler
+
+    def initialize(proto = nil)
+      @proto = proto || DefaultProtocol
+
+      @handler = ->(_) {}
+      @event_queue = Queue.new
+      @response_queue = Queue.new
+      @outgoing_queue = Queue.new
+
+      @threads = ThreadGroup.new
+    end
+
+    def connect(host, port)
+      @server = TCPSocket.new(host, port)
+
+      @threads.add(Thread.new { _connect(@server) })
+      @threads.add(Thread.new { dispatch_events })
+
+      self
+    end
+
+    def disconnect
+      @threads.list.map(&:exit)
+      @server.close
+    end
+
+    def send(obj)
+      @outgoing_queue.push(obj)
+
+      @response_queue.pop
+    end
+
+    private
+
+    def dispatch_events
+      loop { handler.(@event_queue.pop) }
+    end
+
+    def setup_mailbox(server)
+      packer = IOPacker.new(server, @proto)
+      @threads.add(Thread.new do
+        loop { packer.pack(@proto.create(@outgoing_queue.pop)) }
+      end)
+    end
+
+    def _connect(server)
+      setup_mailbox(server)
+
+      IOUnpacker.each_from(server, @proto) do |msg|
+        case msg['type']
+        when 'event'
+          @event_queue
+        else
+          @response_queue
+        end.push(@proto.extract(msg))
+      end
+    end
+  end
+end

data/lib/packserv/default_protocol.rb

@@ -0,0 +1,21 @@
+module PackServ
+  module DefaultProtocol
+    HEADER_LENGTH = 8
+    HEADER_FORMAT = '%08x'.freeze
+
+    module_function
+
+    def create(obj, type = '', id = nil)
+      {
+        'ver'     => PackServ::VERSION,
+        'id'      => id || obj.object_id,
+        'type'    => type,
+        'payload' => obj
+      }
+    end
+
+    def extract(msg)
+      msg['payload']
+    end
+  end
+end

data/lib/packserv/exceptions.rb

@@ -0,0 +1,4 @@
+module PackServ
+  module Exceptions
+  end
+end

data/lib/packserv/io_packer.rb

@@ -0,0 +1,22 @@
+module PackServ
+  class IOPacker
+    def initialize(io, proto)
+      @proto = proto
+      @io = io
+    end
+
+    def pack(obj)
+      write(MessagePack.pack(obj))
+    end
+
+    private
+
+    def frame_length(packed)
+      sprintf(@proto::HEADER_FORMAT, packed.bytesize)
+    end
+
+    def write(packed)
+      @io.write(frame_length(packed) + packed)
+    end
+  end
+end

data/lib/packserv/io_unpacker.rb

@@ -0,0 +1,32 @@
+module PackServ
+  class IOUnpacker
+    class << self
+      def each_from(io, proto)
+        iou = IOUnpacker.new(io, proto)
+
+        loop do
+          frame = iou.get_frame
+
+          break if frame.empty?
+
+          yield(MessagePack.unpack(frame))
+        end
+      end
+    end
+
+    def initialize(io, proto)
+      @proto = proto
+      @io = io
+    end
+
+    def get_frame
+      @io.read(get_frame_length)
+    end
+
+    private
+
+    def get_frame_length
+      @io.read(@proto::HEADER_LENGTH).then { |g| g.nil? ? '' : g }.to_i(16)
+    end
+  end
+end

data/lib/packserv/server.rb

@@ -0,0 +1,69 @@
+module PackServ
+  class Server
+    attr_accessor :handler
+
+    def initialize(proto = nil)
+      @proto = proto || DefaultProtocol
+
+      @handler = ->(_) {}
+      @packers = {}
+      @event_queue = Queue.new
+      @threads = ThreadGroup.new
+    end
+
+    def event(data)
+      @event_queue.push(data)
+    end
+
+    def serve(port)
+      server = TCPServer.new(port)
+
+      @threads.add(Thread.new { _serve(server) })
+      @threads.add(Thread.new { deliver_events })
+
+      self
+    end
+
+    def stop
+      @threads.list.map(&:exit)
+    end
+
+    private
+
+    def setup_mailbox(client)
+      packer   = IOPacker.new(client, @proto)
+      outgoing = Queue.new
+
+      @threads.add(Thread.new do
+        loop { packer.pack(@proto.create(outgoing.pop)) }
+      end)
+
+      @packers[client.object_id] = packer
+
+      outgoing
+    end
+
+    def handle(client)
+      outgoing = setup_mailbox(client)
+
+      IOUnpacker.each_from(client, @proto) do |msg|
+        response = handler.(@proto.extract(msg))
+
+        outgoing.push(response)
+      end
+    end
+
+    def deliver_events
+      loop do
+        data = @event_queue.pop
+        @packers.each { |_, k| k.pack(@proto.create(data, 'event')) }
+      end
+    end
+
+    def _serve(server)
+      loop do
+        @threads.add(Thread.new(server.accept) { |client| handle(client) })
+      end
+    end
+  end
+end

data/lib/packserv/version.rb

@@ -0,0 +1,3 @@
+module PackServ
+  VERSION = '0.1.0'.freeze
+end

data/packserv.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'packserv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'packserv'
+  spec.version       = PackServ::VERSION
+  spec.authors       = ['Stone Tickle']
+  spec.email         = ['lattis@mochiro.moe']
+
+  spec.summary       = 'A simple TCP server/client'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+
+
+  spec.add_runtime_dependency 'msgpack', '~> 1.2'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: packserv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stone Tickle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- lattis@mochiro.moe
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/packserv.rb
+- lib/packserv/client.rb
+- lib/packserv/default_protocol.rb
+- lib/packserv/exceptions.rb
+- lib/packserv/io_packer.rb
+- lib/packserv/io_unpacker.rb
+- lib/packserv/server.rb
+- lib/packserv/version.rb
+- packserv.gemspec
+homepage: 
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A simple TCP server/client
+test_files: []