crap_server 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eedef645e51d16d796efdd9893f69809adce20d0
+  data.tar.gz: e220bbd8a3878f29037216942fb3cc00ba5d4e60
+SHA512:
+  metadata.gz: f2e78629c99e7564e0352f3a754623b7108e84ed9f695ce7f5f12e9f1c0ab1829830223f2f16aa43b343ed0423e8eb37f1f3e046a5939ba5bf48ffef88630163
+  data.tar.gz: 167fcab8bc1047971cee75ad00de1e0297b245e455de3210ce7a3dce0e8b032df6a0e94143a9ee49f1d5bd8a9e2b57418ab765164838228970e51edc7aa1336b

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+.idea/
+.idea/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andres B.
+
+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,60 @@
+# CrapServer
+
+Really thin a non intuitive ruby server and framework. Made to be fast and ready for really heavy servers (not only http server).
+
+# Another one?
+
+Yes. Why? because 2 main reasons. First, this is not a HTTP Web server, this is a generic server that can be used for any kind of TCP Socket server.
+Second and most important, because if funny :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crap_server'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crap_server
+
+## Basic Usage
+
+    CrapServer::Application.run! do |data|
+        if data =~ /^GET/
+            write "Hello world"
+        elsif data =~ /^SET/
+            write "Setting value"
+        else
+            write "Something is wrong"
+        end
+    end
+
+## Configuring the app
+
+    CrapServer::Application.configure do |config|
+        config.port = 80
+        config.read_method = :partial
+        config.read_buffer_size = 1024 # 1K
+    end
+
+See all available options in lib/crap_server/configure.rb
+
+# Running our application
+
+ruby my_app.rb
+
+# Production ready?
+
+No. At the moment is only a thin server that abstract you from TCP sockets works.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/crap_server/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 @@
+require "bundler/gem_tasks"

data/crap_server.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crap_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crap_server"
+  spec.version       = CrapServer::VERSION
+  spec.authors       = ["Andres Joser Borek"]
+  spec.email         = ["andres.b.dev@gmail.com"]
+  spec.summary       = %q{Really thin a non intuitive ruby server and framework.}
+  spec.description   = %q{Really thin a non intuitive ruby server and framework. Made to be fast and ready for really heavy servers (not only http server).}
+  spec.homepage      = ""
+  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"
+  # celluloid is for future use. Right now is not used
+  # spec.add_dependency "celluloid", '~> 0.15.2'
+end

data/lib/crap_server.rb

@@ -0,0 +1,8 @@
+require 'crap_server/version'
+require 'crap_server/configure'
+require 'crap_server/connection_instance'
+require 'crap_server/helpers/socket_reader'
+require 'crap_server/application'
+module CrapServer
+  # Your code goes here...
+end

data/lib/crap_server/application.rb

@@ -0,0 +1,196 @@
+require 'socket'
+require 'logger'
+
+module CrapServer
+  class ConnectionError < StandardError; end
+  # Example:
+  #
+  # Crap::Application.run! do |data|
+  #   if data =~ /^GET/i
+  #     write SomeDatabase.get('column')
+  #   elsif data =~/SET/
+  #     SomeDatabase.set('column', data.split(' ')[1])
+  #   else
+  #     write 'Error. Invalid action.'
+  #   end
+  # end
+  class Application
+    class << self
+
+      def configure(&block)
+        @config ||= CrapServer::Configure.new
+        block.yield @config
+      end
+
+      # Main method. This setup all the connections and make the logic of the app
+      def run!(&block)
+
+        # Bup the maximum opened file to the maximum allowed by the system
+        Process.setrlimit(:NOFILE, Process.getrlimit(:NOFILE)[1])
+
+        # Start IPv4 and IPv6 connection for the current port
+        open_connections
+
+
+        # Some log info to the user :)
+        logger.info 'Initializing Crap Server'
+        logger.info "Listening 0.0.0.0:#{config.port}"
+        logger.debug "Maximum allowed waiting connections: #{Socket::SOMAXCONN}"
+        logger.debug "Maximum number of allowed connections: #{Process.getrlimit(:NOFILE)[1]}" # Same as maximum of opened files
+        logger.info ''
+
+        # The main loop. Listening IPv4 and IPv6 connections
+        Socket.accept_loop([socket_ipv4, socket_ipv6]) do |remote_socket, address_info|
+          connection_loop(remote_socket, address_info, &block)
+        end
+
+        close_connections
+      # If any kind of error happens, we MUST close the sockets
+      rescue => e
+        close_connections
+
+        raise e
+      end
+
+      protected
+      def connection_loop(remote_socket, addres_info, &block)
+          # Work with the connection...
+          if we_should_read?
+            reader = CrapServer::Helpers::SocketReader.new(remote_socket, config.method)
+            reader.address = addres_info
+            reader.config = config
+            reader.on_message(&block)
+          else
+            begin
+              if block.parameters == 1
+                block.call(remote_socket)
+              else
+                block.call(remote_socket, addres_info)
+              end
+                # If we get out of data to read (but still having an opened connection), we wait for new data.
+            rescue IO::WaitReadable
+              # This, prevent to execute so many retry and block the code until a new bunch of data gets available
+              IO.select([remote_socket])
+              # Yay!, we have more data. Now we can continue!
+              retry
+            end
+          end
+          # ...
+
+        # Close the connection
+        remote_socket.close if config.auto_close_connection
+      end
+
+      # Return true or false if the read process is done by the server.
+      def we_should_read?
+        not config.manual_read
+      end
+
+      # Open TCP connection (IPv4 and IPv6)
+      def open_connections
+        start_ipv4_socket
+        start_ipv6_socket
+      end
+
+      # Close all the sockets.
+      def close_connections
+        # If any kind of error happens, we MUST close the sockets
+        if socket_ipv4
+          # Shuts down communication on all copies of the connection.
+          socket_ipv4.shutdown
+          socket_ipv4.close
+        end
+
+        if socket_ipv6
+          # Shuts down communication on all copies of the connection.
+          socket_ipv6.shutdown
+          socket_ipv6.close
+        end
+        # TODO: Close all opened sockets connections from other threads and processes
+      end
+
+      def start_ipv6_socket
+        # :INET6 is to open an IPv6 connection
+        # :STREAM is to open a TCP socket
+        # After this line, the app is not yet ready to work, we only opened a socket
+        socket_ipv6 = Socket.new(:INET6, :STREAM)
+
+        begin
+          # Now, bind the port.
+          # ::1 is loopback for IPv6
+          socket_ipv6.bind(Socket.pack_sockaddr_in(config.port, '::1'))
+        rescue Errno::EADDRINUSE
+          socket_ipv6.close
+          raise ConnectionError.new "Unable to bind #{config.port} port."
+        end
+        socket_ipv6.listen(config.max_pending_connections)
+        # Tell to the Kernel that is ok to rebind the port if is in TIME_WAIT state (after close the connection
+        # and the Kernel wait for client acknowledgement)
+        socket_ipv6.setsockopt(:SOCKET, :REUSEADDR, true)
+        @socket6 = socket_ipv6
+      end
+
+      def start_ipv4_socket
+        # :INET6 is to open an IPv6 connection
+        # :STREAM is to open a TCP socket
+        # After this line, the app is not yet ready to work, we only opened a socket
+        socket_ipv4 = Socket.new(:INET, :STREAM)
+
+        begin
+          # Now, bind the port.
+          socket_ipv4.bind(Socket.pack_sockaddr_in(config.port, '0.0.0.0'))
+        rescue Errno::EADDRINUSE
+          socket_ipv4.close
+          raise ConnectionError.new "Unable to bind #{config.port} port."
+        end
+
+        puts "config: #{config.manual_read}"
+
+        socket_ipv4.listen(config.max_pending_connections)
+        # Tell to the Kernel that is ok to rebind the port if is in TIME_WAIT state (after close the connection
+        # and the Kernel wait for client acknowledgement)
+        socket_ipv4.setsockopt(:SOCKET, :REUSEADDR, true)
+        @socket4 = socket_ipv4
+      end
+
+      def socket_ipv6
+        @socket6
+      end
+
+      def socket_ipv6=(value)
+        @socket6 = value
+      end
+
+      def socket_ipv4
+        @socket4
+      end
+
+      def socket_ipv4=(value)
+        @socket4 = value
+      end
+
+      # TCP Socket reader
+      def reader(socket)
+
+      end
+
+      # Main configuration.
+      # See Crap::Configure
+      def config
+        @config
+      end
+
+      def logger=(value)
+        @logger = value
+      end
+
+      def logger
+        if not @logger
+          @logger = Logger.new(config.log_file)
+          @logger.level = @config.log_level
+        end
+        @logger
+      end
+    end
+  end
+end

data/lib/crap_server/configure.rb

@@ -0,0 +1,41 @@
+module CrapServer
+  class Configure
+    # The port used.
+    # Default: 7331
+    attr_accessor :port
+    # Set to true if you want to manage the read.
+    # Default false
+    attr_accessor :manual_read
+    # Max read buffer size
+    # Default: 16K
+    attr_accessor :read_buffer_size
+    # The number of maximum penning connections.
+    # Default: Max allowed by the OS
+    attr_accessor :max_pending_connections
+    # Working method (read, write, accept, connect).
+    # Available values are:
+    #   :normal
+    #   :partial
+    #   :non_blocking
+    # If :non_blocking is used TODO
+    # Default :readpartial
+    attr_accessor :method
+    # Set to false if you want to manage the close of the connection.
+    # Note that this require manual_read set to true.
+    attr_accessor :auto_close_connection
+    # The file to use as log
+    attr_accessor :log_file
+    # The log level used
+    attr_accessor :log_level
+    def initialize
+      @port = 7331
+      @manual_read = false
+      @read_buffer_size = 1024*16 # 16K for read buffer
+      @max_pending_connections = Socket::SOMAXCONN
+      @method = :partial
+      @auto_close_connection = true
+      @log_file = STDOUT
+      @log_level = Logger::DEBUG
+    end
+  end
+end

data/lib/crap_server/connection_instance.rb

@@ -0,0 +1,53 @@
+module CrapServer
+  # This is the class used to bind the block that is passed to run!. Every method defined here is available inside
+  # the run! block
+  class ConnectionInstance
+    attr_accessor :socket
+    attr_accessor :address
+    attr_accessor :config
+    attr_accessor :method
+    def initialize; end
+
+    # This method execute the block sent to run! method
+    def run(&block)
+      # Undefine the last definition if was defined
+      undef :call if self.respond_to? :call
+      # Define the new method to bind the block with this class.
+      self.class.send :define_method, :call, &block
+      # Running the code depending of the number of args
+      if block.parameters.size == 1
+        self.call(read_data)
+      elsif block.parameters.size == 2
+        self.call(read_data, socket)
+      else
+        self.call(read_data, socket, address)
+      end
+    end
+
+    # Write to the client the given string
+    def write(string)
+      if @method == :normal or @method == :partial
+        @socket.write(string)
+      elsif  @method == :non_blocking
+        @socket.write_nonblock(string)
+      end
+    end
+
+    # Give access to logger class to the user
+    def logger
+      @config.logger
+    end
+    protected
+    # Read the data from the socket
+    def read_data
+      # Read the data from the socket
+      if @method == :normal
+        @socket.read(config.read_buffer_size)
+      elsif @method == :partial
+        @socket.readpartial(config.read_buffer_size)
+      elsif  @method == :non_blocking
+        @socket.read_nonblock(config.read_buffer_size)
+      end
+    end
+  end
+end

data/lib/crap_server/helpers/socket_reader.rb

@@ -0,0 +1,35 @@
+module CrapServer
+  module Helpers
+    # Makes easier work with sockets and read.
+    class SocketReader
+      attr_accessor :method
+      attr_accessor :socket
+      attr_accessor :address
+      attr_accessor :config
+      def initialize(socket_, method_=:partial)
+        @socket = socket_
+        @method = method_
+      end
+
+      def on_message(&block)
+        begin
+            instance = CrapServer::ConnectionInstance.new
+            instance.socket = socket
+            instance.config = config
+            instance.address = address
+            instance.send(:method=, method)
+            instance.run &block
+          # If we get out of data to read (but still having an opened connection), we wait for new data.
+        rescue IO::WaitReadable
+          # This, prevent to execute so many retry and block the code until a new bunch of data gets available
+          IO.select([@socket])
+          # Yay!, we have more data. Now we can continue!
+          retry
+        # When we use non_blocking method, and the client close the connection we will get EOF after that moment
+        # We do nothing special in that moment
+        rescue EOFError
+        end
+      end
+    end
+  end
+end

data/lib/crap_server/version.rb

@@ -0,0 +1,3 @@
+module CrapServer
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: crap_server
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andres Joser Borek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-04 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'
+description: Really thin a non intuitive ruby server and framework. Made to be fast
+  and ready for really heavy servers (not only http server).
+email:
+- andres.b.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crap_server.gemspec
+- lib/crap_server.rb
+- lib/crap_server/application.rb
+- lib/crap_server/configure.rb
+- lib/crap_server/connection_instance.rb
+- lib/crap_server/helpers/socket_reader.rb
+- lib/crap_server/version.rb
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Really thin a non intuitive ruby server and framework.
+test_files: []