reactomatic 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10fb81989a12a6d13e2c866a68f7d4834f452170
-  data.tar.gz: 678098ae122e7fe1af799865bb4e6b1183c94a54
+  metadata.gz: 7dc658891bae991380cbd03d824d72ed76335831
+  data.tar.gz: f5851a9911d30e03e12945908196882760da161a
 SHA512:
-  metadata.gz: aa2e188f6c81f71bd006ca24c318123ae3efa8bc5fb5dad81aa6ad04235a3361f6c1ffd36ca9b45a30dacdb172a1f60e830a7a08e77c5ab782be7bc9074c16b6
-  data.tar.gz: 0f89453b08af8af5e0dae8793a3e9fc320d7fe710537121163c4d11bc7225541c104461487eb2ca0852f157686f091d255634698e9ca15f4242e72cd3df0747d
+  metadata.gz: a2745cb296f950fe5aefd844845b3f1840d046a7a76ecbd3e0eb044fb3001d0e71ce8ab7783c0ceb691f1183e908e64d85e48cc23e395c44c486a7d9da0f498c
+  data.tar.gz: 642286d6232918b5309b9a32b5e4a27275f2163e39ff476cf05004c90146308f8d37b5f6c634b6be3d13d5633d6655d2e55e2460be3b3b1d4f9df62875fc56cb

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in reactomatic.gemspec
+gem 'coveralls', :require => false
+
 gemspec
 
 platforms :ruby do

data/README.md

@@ -1,16 +1,13 @@
-# Reactomatic
+# Reactomatic [![Build Status](https://travis-ci.org/chadrem/reactomatic.svg)](https://travis-ci.org/chadrem/reactomatic) [![Coverage Status](https://coveralls.io/repos/chadrem/reactomatic/badge.svg?branch=master&service=github)](https://coveralls.io/github/chadrem/reactomatic?branch=master)
 
-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/reactomatic`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Reactomatic is an implementation of the [Reactor Pattern](https://en.wikipedia.org/wiki/Reactor_pattern) for Ruby.
+It's built on top of the excellent [nio4r](https://github.com/celluloid/nio4r) gem.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'reactomatic'
-```
+    gem 'reactomatic'
 
 And then execute:
 
@@ -20,19 +17,75 @@ Or install it yourself as:
 
     $ gem install reactomatic
 
-## Usage
 
-TODO: Write usage instructions here
+## Reactors
+
+The ````Reactor```` class is the heart of Reactomatic.
+Reactors handle all the low level details of running an event loop in a dedicated thread.
+This means you get to focus on writing application logic instead of low level socket code.
+
+Reactomatic creates a default reactor that should be sufficient for most applications (you can also create custom ones):
+
+    Reactomatic.reactor
+
+*Instance methods:*
+
+- ````stop````: Stop the reactor and its dedicated thread.  This doesn't close any open connections or running servers.
+- ````start````: Start the reactor and its dedicated thread.
+- ````next_tick````: Run a block of code on the reactor's thread in the future (next time it loops).
+- ````schedule````: Run a block of code on the reactor's thread immediately if called from the reactor thread.  If called from a differet thread, the block will run in the future using ````next_tick````.
+
+## TCP Servers
+
+The ````TcpServer```` class lets you easily listen for new connections and pass them off to a connection class.
+Here is an example:
+
+    server = Reactomatic::TcpServer.new
+    server.listen('0.0.0.0', 9000, Reactomatic::TcpConnection)
+
+The above code will listen for new connections on ````0.0.0.0:9000````.
+When it receives one, it will create an instance of ````Reactomatic::TcpConnection```` to process data associated with the connection.  Below you will learn how to create your own custom connection class to override the default behavior.
+
+*Instance methods:*
+
+- ````listen(host, port, klass)````: Listen for incoming connections.
+- ````close````: Stop listening for incoming connections.  Already established connections will remain open.
+
+## TCP Connections
+
+The ````TcpConnection```` base class is how you interface your application logic with sending and receiving data.
+It's designed so that your custom connection classes inherit from it and override event handlers.
+Here's an example:
+
+    class MyConnection < Reactomatic::TcpConnection
+      private
+      def on_initialize
+        puts "MyConnection: initialized!"
+      end
+
+      def on_receive_data(data)
+        puts "MyConnection: received #{data.bytesize} bytes of data and echoing back!"
+        send_data(data)
+      end
+
+      def on_sent_data(num_bytes)
+        puts "MyConnection: sent #{num_bytes} of data!"
+      end
 
-## Development
+      def on_disconnect
+        puts "MyConnection: disconnected!"
+      end
+    end
 
-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.
+*Instance methods:*
 
-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).
+- ````reactor````: Returns a reference to this connections reactor.
+- ````send_data(data)````: Queues data for sending.  If it can't be sent immediately, the data will be buffered and sent in the future.
+- ````close````: Immediately closes the connection.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/reactomatic.
+Bug reports and pull requests are welcome on GitHub at https://github.com/chadrem/reactomatic.
 
 
 ## License

data/lib/reactomatic/tcp_connection.rb

@@ -24,10 +24,13 @@ module Reactomatic
     end
 
     def connect(host, port)
+      raise 'Not implemented yet.'
     end
 
     def send_data(data)
       @lock.synchronize do
+        return nil if @socket.nil?
+
         @write_buffer.append(data)
         write_nonblock
         register

data/lib/reactomatic/tcp_server.rb

@@ -15,7 +15,7 @@ module Reactomatic
       @klass = klass
 
       @socket = TCPServer.new(@host, @port)
-      @reactor.register(@socket, :r, method(:__selected__))
+      @reactor.register(@socket, :r, method(:selected))
 
       nil
     end
@@ -36,7 +36,7 @@ module Reactomatic
     # Internal methods (don't use).
     #
 
-    def __selected__(monitor)
+    def selected(monitor)
       if monitor.closed?
         @reactor.deregister(@server)
         return

data/lib/reactomatic/version.rb

@@ -1,3 +1,3 @@
 module Reactomatic
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,80 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: reactomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chad Remesch
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-  name: nio4r
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-  name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: minitest
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - chad@remesch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -93,24 +93,24 @@ homepage: https://github.com/chadrem/reactomatic
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+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.6
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
 specification_version: 4
 summary: A network library based on the reactor pattern.
 test_files: []