alo7-net 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9203184940ea7875e9119f7dfeb7f195b41a6c7c
+  data.tar.gz: 08ad750866199fcf9d0b2b0ebbac1b165af472ae
+SHA512:
+  metadata.gz: 16a36c6b9afffdeb260d65384d61c14d46631f79363be391e00fc1e70abee619981e12cbefcfc25963f41182a1ce24ee0ceabe2aa21a76bc15fb5a7ddd129a08
+  data.tar.gz: 259cfb5db9ea77d663b774ad807bfa3ba8d4697a00efe6e2bb8dd052ad68250700d06c647c9854645c44be1753974e35d5220a696932e7f4ee3962efd2bdae93

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,57 @@
+before_script:
+  - ruby -v
+  - gem -v
+  - bundle -v
+  - bundle config mirror.https://rubygems.org https://ruby.taobao.org
+  - bundle install --without development --path vendor/bundle
+
+cache:
+  paths:
+    - vendor/bundle
+
+stages:
+  - test
+  - doc
+
+.test: &test
+  stage: test
+  script:
+    - bundle exec rake test
+  variables:
+    COVERAGE: 'true'
+  tags:
+    - docker
+
+test:2.3:
+  <<: *test
+  image: ruby:2.3
+
+test:2.2:
+  <<: *test
+  image: ruby:2.2
+
+test:2.1:
+  <<: *test
+  image: ruby:2.1
+
+test:2.0:
+  <<: *test
+  image: ruby:2.0
+
+test:1.9:
+  <<: *test
+  image: ruby:1.9
+
+pages:
+  image: ruby
+  stage: doc
+  script:
+    - bundle exec rake yard
+    - mv doc public
+  artifacts:
+    paths:
+      - public
+  tags:
+    - docker
+  only:
+    - master

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.1
+  Exclude:
+    - 'examples/**/*'
+    - '*.gemspec'
+    - 'Guardfile'

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - '1.9'
+  - '2.0'
+  - '2.1'
+  - '2.2'
+  - '2.3.1'
+bundler_args: --without development
+env:
+- COVERAGE=true

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+-
+README.md
+CHANGELOG.md
+LICENSE.txt
+CONTRIBUTING.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* Initial release.

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at qqshfox@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'bundler', '~> 1.7'
+  gem 'rake', '~> 10.0'
+  gem 'minitest', '~> 5.0'
+  gem 'simplecov'
+  gem 'coveralls', require: false
+  gem 'rubocop', require: false
+  gem 'yard', require: false
+end
+
+group :development do
+  gem 'guard'
+  gem 'guard-minitest'
+  gem 'guard-yard'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end
+
+guard :yard, cli: '--reload' do
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| 'yard' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hanfei Shen
+
+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 @@
+# alo7-net [![Build Status](https://travis-ci.org/qqshfox/alo7-net.svg)](https://travis-ci.org/qqshfox/alo7-net) [![Coverage Status](https://coveralls.io/repos/github/qqshfox/alo7-net/badge.svg)](https://coveralls.io/github/qqshfox/alo7-net) [![Code Climate](https://codeclimate.com/github/qqshfox/alo7-net/badges/gpa.svg)](https://codeclimate.com/github/qqshfox/alo7-net) [![Dependency Status](https://gemnasium.com/badges/github.com/qqshfox/alo7-net.svg)](https://gemnasium.com/github.com/qqshfox/alo7-net)
+
+alo7-net is the TCP server/client library we developed specifically for our ALO7 Learning Platform. This library provides a way to write asynchronous code in a straight-line fashion using fibers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alo7-net'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alo7-net
+
+## Usage
+
+### Server
+
+```ruby
+require 'alo7-net'
+
+class EchoServer < Alo7::Net::Server
+  def receive_data(data)
+    send_data data
+  end
+end
+
+Alo7::Net.run do
+  EchoServer.listen 3000
+end
+```
+
+### Client
+
+```ruby
+require 'alo7-net'
+
+class EchoClient < Alo7::Net::Client
+  def receive_data(data)
+    puts data
+  end
+end
+
+Alo7::Net.run do
+  c = EchoClient.connect 'localhost', 3000
+  c.send_data 'Hello World!'
+end
+```
+
+## 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/qqshfox/alo7-net. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'yard'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+YARD::Rake::YardocTask.new(:yard)
+
+task default: :test

data/alo7-net.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alo7/net/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'alo7-net'
+  spec.version       = Alo7::Net::VERSION
+  spec.authors       = ['Hanfei Shen']
+  spec.email         = ['qqshfox@gmail.com']
+
+  spec.summary       = 'A TCP server/client library used at ALO7.'
+  spec.description   = 'alo7-net is the TCP server/client library we developed specifically for our ALO7 Learning Platform. This library provides a way to write asynchronous code in a straight-line fashion using fibers.'
+  spec.homepage      = 'https://github.com/qqshfox/alo7-net'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'eventmachine', '~> 1.0'
+  spec.add_runtime_dependency 'em-synchrony', '~> 1.0'
+end

data/bin/console

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

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/examples/echo/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'alo7-net', path: '../../'

data/examples/echo/client.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'alo7-net'
+
+class EchoClient < Alo7::Net::Client
+  def receive_data(data)
+    puts data
+  end
+end
+
+Alo7::Net.run do
+  c = EchoClient.connect 'localhost', 3000
+  c.send_data 'Hello World!'
+end

data/examples/echo/server.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'alo7-net'
+
+class EchoServer < Alo7::Net::Server
+  def receive_data(data)
+    send_data data
+  end
+end
+
+Alo7::Net.run do
+  EchoServer.listen 3000
+end

data/lib/alo7-net.rb

@@ -0,0 +1,4 @@
+require 'alo7/net'
+
+module Alo7
+end

data/lib/alo7/net.rb

@@ -0,0 +1,185 @@
+require 'fiber'
+require 'eventmachine'
+require 'em-synchrony'
+require 'alo7/net/version'
+require 'alo7/net/connection'
+require 'alo7/net/server'
+require 'alo7/net/client'
+require 'alo7/net/error'
+require 'alo7/net/defer'
+
+module Alo7
+  module Net
+    # Run an event loop in the fiber way.
+    #
+    # @overload run(block)
+    # @overload run(&block)
+    #
+    # @param block [MethodObject] the block to run
+    # @return [void]
+    #
+    # @example Starting an event loop in the current thread to run the "Hello, world"-like Echo server example
+    #
+    #     !!!ruby
+    #     require 'alo7-net'
+    #
+    #     class EchoServer < Alo7::Net::Server
+    #       def receive_data(data)
+    #         send_data data
+    #       end
+    #     end
+    #
+    #     Alo7::Net.run do
+    #       EchoServer.listen 3000
+    #     end
+    #
+    # @note This method blocks the calling thread.
+    # @note This method only returns if the event loop stopped.
+    #
+    # @see stop
+    def self.run(blk = nil, &block)
+      EM.synchrony(blk || block)
+    end
+
+    # Run an event loop and then terminate the loop as soon as the block completes.
+    #
+    # @param block [MethodObject] the block to run once
+    # @return [void]
+    def self.run_once(&block)
+      run do
+        block.call
+        stop
+      end
+    end
+
+    # Stop the running event loop.
+    #
+    # @return [void]
+    #
+    # @example Stopping a running event loop.
+    #
+    #     !!!ruby
+    #     require 'alo7-net'
+    #
+    #     class OnceClient < Alo7::Net::Client
+    #       def post_init
+    #         puts 'sending a dump HTTP request'
+    #         send_data "GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n"
+    #       end
+    #
+    #       def receive_data(data)
+    #         puts "data.length: #{data.length}"
+    #         puts 'stopping the event loop now'
+    #         Net.stop
+    #       end
+    #     end
+    #
+    #     Alo7::Net.run do
+    #       OnceClient.connect 'www.google.com', 80
+    #     end
+    #
+    # @see run
+    def self.stop
+      EM.stop_event_loop
+    end
+
+    # Initiate a TCP server on the specified IP address and port.
+    #
+    # @overload listen(handler, host, port, *args)
+    #   @param handler [ClassObject] a module or class that has an innerclass named `Impl`
+    #   @param host [String] host to listen on
+    #   @param port [Integer] port to listen on
+    #   @param *args passed to the initializer of the handler
+    # @overload listen(handler, port, *args)
+    #   @param handler [ClassObject] a module or class that has an innerclass named `Impl`
+    #   @param port [Integer] port to listen on
+    #   @param *args passed to the initializer of the handler
+    # @yield [handler] initiated when a connection is made
+    # @return [Integer] the internal signature
+    #
+    # @raise (see check_handler!)
+    #
+    # @see connect
+    def self.listen(handler, host_or_port, port = nil, *args)
+      check_handler! handler
+      if port
+        host = host_or_port
+      else
+        host = 'localhost'
+        port = host_or_port
+      end
+      EM.start_server host, port, handler::Impl, handler, *args do |server|
+        yield server.handler if block_given?
+      end
+    end
+
+    # Initiate a TCP connection to a remote server and set up event handling for
+    # the connection.
+    #
+    # @param handler [ClassObject] a module or class that has an innerclass named `Impl`
+    # @param host [String] host to connect to
+    # @param port [Integer] port to connect to
+    # @return [handler] the initiated handler instance
+    #
+    # @raise (see check_handler!)
+    #
+    # @note This requires event loop to be running. (see {run}).
+    #
+    # @see listen
+    # @see reconnect
+    def self.connect(handler, host, port, *args)
+      check_handler! handler
+      connection = EM.connect host, port, handler::Impl, handler, *args
+      connection.handler
+    end
+
+    # Connect to a given host/port and re-use the provided handler instance.
+    #
+    # @param handler [#impl] a instance that has a property named `impl`
+    # @param host [String] host to reconnect to
+    # @param port [Integer] port to reconnect to
+    # @return [handler] the previous handler instance
+    #
+    # @raise [ArgumentError] if the handler doesn't implement a method named impl
+    #
+    # @see connect
+    # @see listen
+    def self.reconnect(handler, host, port)
+      raise ArgumentError, 'must provide a impl property' unless handler.respond_to? :impl
+      connection = EM.reconnect host, port, handler.impl
+      connection.handler
+    end
+
+    # Wait the defer succeed and then return anything the defer returns. Or
+    # raise the exception from the defer.
+    #
+    # @param defer [Defer] defer to wait
+    # @return anything the defer returns
+    #
+    # @raise [Exception] the exception returns from defer
+    def self.await(defer)
+      result = EM::Synchrony.sync defer
+      raise result if result.is_a? Exception
+      result
+    end
+
+    # Execute the block in a fiber.
+    #
+    # @param args passed as arguments to the block that are executed
+    # @yieldparam *args arguments passed from outside
+    # @yieldreturn [Object] anything
+    # @return [Object] anything returned from the block
+    def self.fiber_block(*args)
+      Fiber.new { yield(*args) }.resume
+    end
+
+    class << self
+      private
+
+      # @raise [ArgumentError] if the handler doesn't have a innerclass named Impl
+      def check_handler!(handler)
+        raise ArgumentError, 'must provide a innerclass of Impl' unless defined? handler::Impl
+      end
+    end
+  end
+end

data/lib/alo7/net/client.rb

@@ -0,0 +1,47 @@
+require 'alo7/net'
+require 'alo7/net/connection'
+require 'alo7/net/defer'
+
+module Alo7
+  module Net
+    # This is a class that provides the client logics.
+    class Client < Connection
+      # Initiate a TCP connection to a remote server and set up event handling
+      # for the connection.
+      #
+      # @param host [String] host to connect to
+      # @param port [Integer] port to connect to
+      # @param args passed to the initializer of the client
+      # @return [Client] the initiated client instance
+      def self.connect(host, port, *args)
+        connection = Net.connect self, host, port, *args
+        await_connect connection
+      end
+
+      # Connect to a given host/port and re-use the instance.
+      #
+      # @param host [String] host to connect to
+      # @param port [Integer] port to connect to
+      # @return [self]
+      def reconnect(host, port)
+        Net.reconnect self, host, port
+        self.class.await_connect self
+      end
+
+      class << self
+        # @private
+        def await_connect(connection)
+          defer = Defer.new
+          connection.define_singleton_method :connection_completed do
+            defer.succeed
+          end
+          Net.await defer
+          connection.singleton_class.instance_eval do
+            remove_method :connection_completed
+          end
+          connection
+        end
+      end
+    end
+  end
+end

data/lib/alo7/net/connection.rb

@@ -0,0 +1,182 @@
+require 'eventmachine'
+require 'alo7/net'
+require 'alo7/net/error'
+
+module Alo7
+  module Net
+    # This is a class that is instantiated by the event loop whenever a new
+    # connection is created. New connections can be created by {listen accepting
+    # a remote client} or {connect connecting to a remote server}.
+    #
+    # Users should overwrite {#initialize}, following callbacks included from
+    # {Callbacks} to implement their own business logics:
+    #
+    # * {#post_init}
+    # * {#connection_completed}
+    # * {#receive_data}
+    # * {#unbind}
+    #
+    # @note This class is considered to be a base class. Use the derived class
+    #   {Server} or {Client} instead of this class directly.
+    # @note This class should never be instantiated by user code.
+    class Connection
+      # This method declaires the callbacks users can overwrite to implement
+      # their own business logics.
+      module Callbacks
+        # Called by the event loop immediately after the network connection has
+        # been established, and before resumption of the network loop.
+        #
+        # @return [void]
+        #
+        # @see #connection_completed
+        def post_init
+        end
+
+        # Called by the event loop when a remote TCP connection attempt
+        # completes successfully.
+        #
+        # @return [void]
+        #
+        # @see Net.connect
+        # @see #post_init
+        def connection_completed
+        end
+
+        # Called by the event loop whenever data has been received by the
+        # network connection. It's called with a single parameter, a String
+        # containing the network protocol data, which may of course be binary.
+        # You will generally overwrite this method to perform your own
+        # processing of the incoming data.
+        #
+        # @param data [String] data received from the remote end
+        # @return [void]
+        #
+        # @see #send_data
+        def receive_data(data)
+        end
+
+        # Called by the event loop whenever a connection (either a server or a
+        # client connection) is closed. The close can occur because of your code
+        # intentionally (using {#disconnect}), because of the remote end closed
+        # the connection, or because of a network error.
+        #
+        # @return [void]
+        #
+        # @see #disconnect
+        #
+        # @note You may not assume that the network connection is still open and
+        #   able to send or receive data when the callback to unbind is made.
+        #   This is intended only to give you a chance to clean up associations
+        #   your code may have made to the connection object while it was open.
+        def unbind
+        end
+      end
+
+      include Callbacks
+
+      # @private
+      attr_accessor :impl
+
+      # @param args passed from {listen} or {connect}
+      def initialize(*args)
+      end
+
+      # Send the data to the remote end of the connection asynchronously.
+      #
+      # @param data [String] data to send
+      # @return [void]
+      #
+      # @see #receive_data
+      #
+      # @note Data is buffered to be send which means it is not guaranteed to be
+      #   sent immediately when calling this method.
+      def send_data(data)
+        @impl.send_data data
+      end
+
+      # Close the connection asynchronously after all of the outbound data has
+      # been written to the remote end. {#unbind} will be called later after
+      # this method returns.
+      #
+      # @return [void]
+      #
+      # @see #unbind
+      def disconnect
+        @impl.close_connection_after_writing
+      end
+
+      # (see Impl#await)
+      def await(defer)
+        @impl.await defer
+      end
+
+      # @private
+      class Impl < EM::Connection
+        # @private
+        attr_reader :handler
+
+        def initialize(klass, *args)
+          raise ArgumentError, "must provide a subclass of #{Connection.name}" \
+            unless klass <= Connection
+          @handler = klass.new(*args)
+          @handler.impl = self
+        end
+
+        def post_init
+          Net.fiber_block do
+            @unbinding = false
+            @defers = []
+
+            @handler.post_init
+          end
+        end
+
+        def connection_completed
+          Net.fiber_block { @handler.connection_completed }
+        end
+
+        def receive_data(data)
+          Net.fiber_block { @handler.receive_data data }
+        end
+
+        def unbind
+          Net.fiber_block do
+            @unbinding = true
+            @defers.dup.each { |defer| defer.fail ConnectionLost.new }
+
+            @handler.unbind
+
+            @unbinding = false
+          end
+        end
+
+        # (see Net.await)
+        #
+        # @note It keeps the pending defers internally. When unbinding, it fails
+        #   them with a ConnectionLost error.
+        # @note It fails the defer and raise a ConnectionLost error
+        #   intermediately between unbinding.
+        def await(defer)
+          if @unbinding
+            err = ConnectionLost.new
+            defer.fail err
+            raise err
+          else
+            _await defer
+          end
+        end
+
+        private
+
+        def _await(defer)
+          @defers.push defer
+          begin
+            Net.await defer
+          ensure
+            @defers.delete defer
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alo7/net/defer.rb

@@ -0,0 +1,56 @@
+require 'em/deferrable'
+
+module Alo7
+  module Net
+    # This is a callback which will be put off until later.
+    class Defer
+      include EM::Deferrable
+
+      # @!method callback(&block)
+      #   Specify a block to be executed if and when the Deferrable object succeeded.
+      #
+      #   * If there is no status, add a callback to an internal list.
+      #   * If status is succeeded, execute the callback immediately.
+      #   * If status is failed, do nothing.
+      #
+      #   @param block [MethodObject]
+      #   @return [self]
+
+      # @!method cancel_callback
+      #   Cancels an outstanding callback to &block if any. Undoes the action of {#callback}.
+      #
+      #   @return [MethodObject] The cancelled callback.
+
+      # @!method errback
+      #   Specify a block to be executed if and when the Deferrable object failed.
+      #
+      #   * If there is no status, add a errback to an internal list.
+      #   * If status is failed, execute the errback immediately.
+      #   * If status is succeeded, do nothing.
+      #
+      #   @param block [MethodObject]
+      #   @return [self]
+
+      # @!method cancel_errback
+      #   Cancels an outstanding errback to &block if any. Undoes the action of {#errback}.
+      #
+      #   @return [MethodObject] The cancelled errback.
+
+      # @!method succeed(*args)
+      #   Execute all of the blocks passed to the object using the {#callback}
+      #   method (if any) BEFORE this method returns. All of the blocks passed
+      #   to the object using {#errback} will be discarded.
+      #
+      #   @param args passed as arguments to any callbacks that are executed
+      #   @return [void]
+
+      # @!method fail(*args)
+      #   Execute all of the blocks passed to the object using the {#errback}
+      #   method (if any) BEFORE this method returns. All of the blocks passed
+      #   to the object using {#callback} will be discarded.
+      #
+      #   @param args passed as arguments to any errbacks that are executed
+      #   @return [void]
+    end
+  end
+end

data/lib/alo7/net/error.rb

@@ -0,0 +1,10 @@
+module Alo7
+  module Net
+    # The base error type in this library. All other errors should derived from
+    # this class.
+    class Error < StandardError; end
+
+    # A error used to indicate a connection lost.
+    class ConnectionLost < Error; end
+  end
+end

data/lib/alo7/net/server.rb

@@ -0,0 +1,26 @@
+require 'alo7/net'
+require 'alo7/net/connection'
+
+module Alo7
+  module Net
+    # This is a class that provides the server logics.
+    class Server < Connection
+      # Initiate a TCP server on the specified IP address and port.
+      #
+      # @overload listen(host, port)
+      #   @param host [String] host to listen on
+      #   @param port [Integer] port to listen on
+      #   @param *args passed to the initializer of the server
+      # @overload listen(port)
+      #   @param port [Integer] port to listen on
+      #   @param *args passed to the initializer of the server
+      # @yield [connection] initiated when a connection is made
+      # @return (see Net.listen)
+      #
+      # @raise (see Net.listen)
+      def self.listen(host_or_port, port = nil, *args, &block)
+        Net.listen self, host_or_port, port, *args, &block
+      end
+    end
+  end
+end

data/lib/alo7/net/version.rb

@@ -0,0 +1,5 @@
+module Alo7
+  module Net
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: alo7-net
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hanfei Shen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: alo7-net is the TCP server/client library we developed specifically for
+  our ALO7 Learning Platform. This library provides a way to write asynchronous code
+  in a straight-line fashion using fibers.
+email:
+- qqshfox@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alo7-net.gemspec
+- bin/console
+- bin/setup
+- examples/echo/Gemfile
+- examples/echo/client.rb
+- examples/echo/server.rb
+- lib/alo7-net.rb
+- lib/alo7/net.rb
+- lib/alo7/net/client.rb
+- lib/alo7/net/connection.rb
+- lib/alo7/net/defer.rb
+- lib/alo7/net/error.rb
+- lib/alo7/net/server.rb
+- lib/alo7/net/version.rb
+homepage: https://github.com/qqshfox/alo7-net
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A TCP server/client library used at ALO7.
+test_files: []
+has_rdoc: