cmdserver 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c4084d52fe2ef4f97a79630ee88c52ca99c2b1b
+  data.tar.gz: d389b6d35fc6c9670f395c4001a41167276a3081
+SHA512:
+  metadata.gz: 1cdf8084c4412313c54a5d2c13b49b06ec1ce3b824d9cb30edbeded8e79f07755e7e5e2a7352829235b9334e0355c6f530814098cc9cc287e0b34d4bf216d35c
+  data.tar.gz: 117b41f1ca968f3d8bd76725ea2f0589d3862045a23f238bdc6634c8cdbca7cdef5561654c2f8eb7c7efa8c4fcf577798cacda2b983ab1d3a620df75aa4b3e73

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cmdserver.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ernest Deák
+
+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,74 @@
+# Cmdserver
+
+Cmdserver gives you the ability to design a very simple command server.
+Simply create a .rb module under `~/.cmdserver/modules/` and override the module `Cmdserver::CmdProtocol`.   
+Fire up your server and you are done! It is ready to respond to the commands you have defined.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cmdserver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cmdserver
+
+## Usage
+
+By default, Cmdserver looks into `~/.cmdserver/modules` for any .rb files present. It then `require`s them into the program.   
+In these .rb files, you override the module `Cmdserver::CmdProtocol` as demonstrated bellow   
+
+```ruby
+module Cmdserver::CmdProtocol
+    def self.extend_protocol
+        @protocol_hash["CustomCommand"] = -> client_socket, arguments { client_socket.puts "You sent: #{arguments}" }
+    end
+
+    def self.default_action(client_socket, arguments)
+        client_socket.puts "#{arguments} - Command not recognized"
+    end
+end
+```
+
+Here we defined `CustomCommand` to be the string that will trigger the execution of the function we presented.
+The first argument passed to the function is the client socket, the second argument `arguments` is a __string__ of whatever
+is left, when we removed `CustomCommand` from the string we initially recieved from the client. This might change in the future.
+For now, argument parsing is left up to the individual functions.   
+
+Also note that overriding the default behaviour can be done only once. The last loaded module that redefines `self.default_action` is what is going to happen, when the command is not recognized. By default, it echoes back whatever it recieves.   
+
+The `@protocol_hash` can be destroied in any module. The hash gets copied into the core on a per-module basis. Note that this can introduce
+conflicts when many modules define the same keys for commands.
+    
+
+Then, in your program
+```ruby
+require "cmdserver"
+server = Cmdserver::TCPCommandServer.new(1234)
+server.start()
+```
+
+That starts the main loop which will then start accepting connections.   
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/majorendian/cmdserver.
+
+
+## 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,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 "cmdserver"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cmdserver.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cmdserver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cmdserver"
+  spec.version       = Cmdserver::VERSION
+  spec.authors       = ["Ernest Deák"]
+  spec.email         = ["gordon.zar@gmail.com"]
+
+  spec.summary       = %q{Simple, module based command execution server over tcp.}
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/majorendian/Modular-Tcp-Command-Server"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+      spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "release"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/cmdserver.rb

@@ -0,0 +1,136 @@
+require "socket"
+require "pathname"
+require "cmdserver/version"
+
+module Cmdserver
+
+    module CmdProtocol
+        # Protocol stuff goes here.
+        # Should be loaded from ~/.cmdserver/modules/*.rb
+        @protocol_hash = {}
+        def self.extend_protocol()
+            @protocol_hash = {
+                "dummy" => -> cs, args { cs.puts "Dummy reply"}
+            }
+        end
+
+        def self.default_action(cs, args)
+            cs.puts args
+        end
+
+        module_function
+        def getProtocolHash()
+            self.extend_protocol()
+            return @protocol_hash
+        end
+
+        # Default behaviour when querry was not found
+        module_function
+        def default(cs, args)
+            # NOTE: args is a String
+            self.default_action(cs, args)
+        end
+    end
+
+    class Settings
+
+        def initialize(config_dir="~/.cmdserver/")
+            @workdir = Pathname.new(File.expand_path(config_dir))
+            @config_rc = @workdir + "configrc"
+            @module_dir = @workdir + "modules"
+            if not @workdir.exist?
+                Dir.mkdir @workdir
+                if not @config_rc.exist?
+                    File.new @config_rc, "w"
+                end
+            end
+            if not @module_dir.exist?
+                Dir.mkdir @module_dir
+            end
+            # Load modules contained within the module
+            # directories
+            load_modules()
+        end
+
+        def load_modules
+            Dir.glob("#{@module_dir}/*.rb").each do |mod|
+                CmdProtocol.extend_protocol()
+                puts "Loading module: #{mod}"
+                require mod
+            end
+        end
+    end
+
+    class TCPCommandServer
+
+        attr_accessor :socket
+
+        def initialize(port, settings=nil, hash={}, debug=false)
+            if settings.nil?
+                @settings = Settings.new()
+            end
+            @socket = TCPServer.new(port)
+            @cmd_hash = hash # hash of commands
+            @debug = debug
+            load_cmd_proto()
+        end
+
+        def load_cmd_proto()
+            phash = CmdProtocol.getProtocolHash()
+            phash.each_key do |key|
+                @cmd_hash[key] = phash[key]
+            end
+        end
+
+        def registerCallback(string, aproc)
+            @cmd_hash[string] = aproc
+        end
+
+        def start()
+            loop do
+                client = @socket.accept
+                Thread.new{ process_client(client) }
+            end
+        end
+
+        def process_client(client)
+            #NOTE: This should remain as an isolated thread process
+            loop do
+                request = client.gets
+                if not request.nil?
+                    request.chomp! 
+                    puts "Got '#{request}'" if @debug
+                    real_key = nil
+                    @cmd_hash.each_key do |key|
+                        if request.include? key
+                            real_key = key
+                        end
+                    end
+                    puts "real_key:#{real_key}" if @debug
+                    if not real_key.nil?
+                        begin
+                            request.sub! real_key, ""
+                            request.chomp!
+                            if @cmd_hash.key? real_key
+                                puts "Request after processing: #{request}" if @debug
+                                @cmd_hash[real_key].call(client, request)
+                            end
+                        rescue Exception
+                            puts "ERROR: #{$!}"
+                            raise $!
+                        end
+                    else
+                        Cmdserver::CmdProtocol.default(client, request)
+                    end
+                else
+                    client.close()
+                    break
+                end
+            end
+        end
+    end
+end
+
+
+#server = TCPCommandServer.new(2121, {}, false)
+#server.start()

data/lib/cmdserver/version.rb

@@ -0,0 +1,3 @@
+module Cmdserver
+  VERSION = "0.9.1"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: cmdserver
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Ernest Deák
+autorequire: 
+bindir: release
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- gordon.zar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cmdserver.gemspec
+- lib/cmdserver.rb
+- lib/cmdserver/version.rb
+homepage: https://github.com/majorendian/Modular-Tcp-Command-Server
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simple, module based command execution server over tcp.
+test_files: []