rumid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1efccfe98577add2b171f4ebcec3e2cf24f6c95
+  data.tar.gz: 0b307b0dab72435318c1a26015250efb51d12507
+SHA512:
+  metadata.gz: 64c0ec1eb478e5fcae6821323e86117b7845aeb8aace9c6eb490ffdaa80e1e621bd2ea2083750ff9b5c740b4cdb7729f726867a77b44d557db862c62e8f078cb
+  data.tar.gz: bbd454a5f9649ae771c6f3e1936fa73d2ce4ed4984dfaa191ad1b92f905ca5ba388bb986904a0ec19b0aba25f4c104880ea23b730ddd08c90dbfecfa8ab02617

data/.gitignore

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

data/.yardopts

@@ -0,0 +1,2 @@
+--protected
+--private

data/Gemfile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rumid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dmitry Rubinstein
+
+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,40 @@
+# Rumid
+
+Use this gem to create uniprotocol TCP server. You can implement any protocol - for example modbus, using this gem. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rumid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rumid
+
+## Usage
+
+To run server you should implement `Request`, `Server`, and then start the server.
+
+## Documentation
+
+Buld docs by running
+
+    $ yardoc
+
+Start yard server by executing
+
+    $ yard server
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rumid/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  #begin
+  #  require 'serialport'
+  #rescue LoadError => e
+  #  spec.pattern.exclude("spec/rtu_client_spec.rb", "spec/rtu_server_spec.rb")
+  #end
+end
+
+task :default => :spec
+
+task :pry do
+  sh "bundle exec pry -r .lib/rumid.rb"
+end

data/lib/rumid.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'rumid/version'
+
+require 'timeout'
+require 'rumid/io'
+
+require 'rumid/errors'
+
+require 'gserver'
+require 'rumid/server'
+require 'rumid/request'
+
+require 'rumid/tcp_server'

data/lib/rumid/errors.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Rumid
+  # Module represents errors occuring during protocol serving
+  module Errors
+
+    # Standart time-out error to fire on packet end
+    class EndPacketError < StandardError;end
+
+    # Standart error, representing that request is not valid for this protocol
+    class NotValidRequestError < StandardError;end
+
+  end
+end

data/lib/rumid/io.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+# Extending of standart IO class
+class IO
+  include Timeout
+
+
+  # Reads the next "packet" from I/O stream. Packets are separated by time delay.
+  # @param time [Integer] time delay between packets in seconds.
+  # @example
+  #    server.print "Foo"
+  #    sleep 0.1
+  #    server.print "Bar"
+  #    sleep 0.1
+  #    server.print "Foo"
+  #    client.gett(0.1)    #=> "Foo"
+  #    client.gett(0.2)    #=> "BarFoo"
+  # @return [String] recieved packet string
+  def gett(time)
+    raw = getc
+    loop {
+      begin
+        timeout(time){raw << getc}
+      rescue Timeout::Error
+        break
+      end
+    }
+    raw
+  end
+end

data/lib/rumid/request.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Rumid
+
+  # Abstract class, representing Request. Should be extended to specify protocol.
+  # @abstract
+  # @example
+  #   class Foo < Request
+  #     read_wire do |io|
+  #       io.readline
+  #     end
+  #
+  #     format_request do |raw|
+  #       {route: raw[1], data: raw[2]}
+  #     end
+  #
+  #     validate_request do |raw|
+  #       raw[4] != raw[5]
+  #     end
+  #
+  #     validate_request do |raw|
+  #       raw[1]+raw[2] != raw[3]
+  #     end
+  #   end
+  class Request
+    include Errors
+    # Raw data from IO getter block
+    # @note Proc requires [IO]
+    @@wire_handler = nil
+    # Raw data to request hash parser.
+    # @note Proc requires [String] raw data
+    @@wire_parser = nil
+    # [Array(Proc)] validation procs array
+    # @note Proc requires [String] raw data
+    @@request_validators = []
+
+    # Initalize raw data from IO getter
+    # @param block [Proc] representing raw data from IO getter
+    # @note block requires requires [IO]
+    def self.read_wire(&block)
+      @@wire_handler = block
+    end
+
+    # Initialize raw data to request hash parser
+    # @param block [Proc] representing raw data to request hash parser
+    # @note block requires requires [String] raw data
+    def self.format_request(&block)
+      @@wire_parser = block
+    end
+
+    # Method gets only valid requests
+    # @param io [IO] representing raw data to request hash parser
+    # @note Typicaly you should not call this method
+    def get_request(io)
+      raw = @@wire_handler.call(io)
+      throw NotValidRequestError if @@request_validators.all?{|block| block.call(raw)}
+      @@wire_parser.call(raw)
+    end
+
+    # Initialize new request validator
+    # @param block [Proc] represent request validator
+    # @note Proc requires [Stirng] raw data
+    # @note Proc returns [Boolean] request validness
+    def self.validate_request(&block)
+      @@request_validators << block
+    end
+  end
+end

data/lib/rumid/server.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+module Rumid
+
+  # Abstract class, representing Server. Should be extended to specify protocol.
+  # @abstract
+  # @example
+  #   class Foo < Server
+  #     handle_request_with(BarRequest)
+  #
+  #     wrap_response do |response|
+  #       "Responce is: #{responce[:route]}|#{responce[:data]}"
+  #     end
+  #
+  #     route "foo" do |request|
+  #       {route: "foo", data: 1}
+  #     end
+  #
+  #     route "bar" do |request|
+  #       {route: "bar", data: 2}
+  #     end
+  #   end
+  class Server
+    include Errors
+
+    # @!constant routes [{String=>Proc}] representing routes strings and procs to handle requests
+    # @see Server.route
+    @@routes = {}
+
+    # @!constant request_handler [Request] klass, backed to handle this protocol requests
+    # @see Rumid::Request
+    @@request_handler = nil
+
+    def initialize
+      @responsed = false
+    end
+
+
+    # Main server function. Do all work from getting raw request to sending raw response
+    # @note Typicaly you should not call this method
+    # @param io [IO] I/O stream for getting requests and sending responces
+    def serve(io)
+      @io = io
+      request_hash = get_request
+      route_handle(request_hash)
+    end
+
+    # @return [Hash] hash with Keys - routes, Values - Procs for handling requests
+    def self.show_routes
+      @@routes
+    end
+
+    private
+
+    # Method reading data from I/O stream
+    # @note Typicaly you should not call this method
+    def get_request
+      raise NotImplementedError, "Request handler is not initialized." if @@request_handler.nil?
+      @@request_handler.get_request(@io)
+    end
+
+    # Method which sends request direct roated handler
+    # @note Typicaly you should not call this method
+    # @param request_hash [{Symbol=>Proc}] request hash
+    def route_handle(request_hash)
+      @@routes.each do |route,method|
+        return response_with(@@response_wrapper.call(method.call(request_hash))) unless (route =~ request_hash[:route]).nil?
+      end
+      warn "This request doesn't match any route."
+    end
+
+
+    # Initialising new route
+    # @param route [String] representing route string
+    # @param block [Proc] representing route handler
+    # @example
+    #   route "foo" do |request|
+    #     {route: "foo", data: 1}
+    #   end
+    # @note Proc requires [{Symbol=>String}] request hash
+    # @note Proc returns [{Symbol=>String}] response hash
+    def self.route(route, &block)
+      @@routes[Regexp.new(route)] = block
+    end
+
+    # Initializing how to pack responces to send back by protocol
+    # @param block [Proc] representing respose wrapper
+    # @example
+    #   wrap_response do |response|
+    #     "Responce is: #{responce[:route]}|#{responce[:data]}"
+    #   end
+    # @note Proc requires [{Symbol=>String}] response hash
+    # @note Proc returns [String] raw packet
+    def self.wrap_response(&block)
+      @@response_wrapper = block
+    end
+
+    # Initializing [Request] class to handle requests
+    # @param request_handler_class [Class] klass representing Request specified by protocol
+    # @example
+    #   handle_request_with FooRequest
+    # @note request_handler_class extends [Request]
+    def self.handle_request_with(request_handler_class)
+      @@request_handler = request_handler_class.new
+    end
+
+    # Method sending response. Checks response uniquness
+    # @param response [String] response raw string
+    def response_with(response)
+      if @responsed == true then
+        warn "Trying to response with:\n  #{response}\nfor already responsed request!"
+        return
+      end
+      @io.write(response)
+      @responsed = true
+    end
+  end
+end

data/lib/rumid/tcp_server.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Rumid
+  #Extended GServer, baked to work with Rumid::Server servers
+  class TcpServer < GServer
+    # @param port [Integer] port to be listened by the server
+    # @param protocol_server [Rumid::Server] klass the extended Server class
+    def initialize(port, protocol_server, *args)
+      super(port, *args)
+      @protocol_server = protocol_server
+    end
+
+
+    # Overriden Gserver#serve function.
+    # @note Typicaly you should not call this method
+    # @param session [IO] I/O stream from TCP connection
+    def serve(session)
+      loop{
+        begin
+          @protocol_server.new.serve(session)
+        rescue Rumid::Errors::NotValidRequestError
+          log "Error in validation occured!"
+        end
+      }
+    end
+  end
+end

data/lib/rumid/version.rb

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

data/rumid.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rumid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rumid"
+  spec.version       = Rumid::VERSION
+  spec.authors       = ["Dmitry Rubinstein"]
+  spec.email         = ["rubinsteindb@gmail.com"]
+  spec.summary       = %q{Uniprotocol TCP server.}
+  spec.description   = %q{Gem for creating servers with any protocol over TCP.}
+  spec.homepage      = "https://github.com/Virviil/rumid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 0'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rumid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Rubinstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Gem for creating servers with any protocol over TCP.
+email:
+- rubinsteindb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rumid.rb
+- lib/rumid/errors.rb
+- lib/rumid/io.rb
+- lib/rumid/request.rb
+- lib/rumid/server.rb
+- lib/rumid/tcp_server.rb
+- lib/rumid/version.rb
+- rumid.gemspec
+homepage: https://github.com/Virviil/rumid
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Uniprotocol TCP server.
+test_files: []
+has_rdoc: